/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Björn Påhlsson
  • Date: 2008-08-10 19:14:12 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 63.
  • Revision ID: belorn@braxen-20080810191412-0c8xxvnh5nalhdfq
updated mandos-client sections and added see also stuff

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
2
2
 
3
3
* [#A] README file
4
4
 
5
 
* plugin-runner
6
 
** [#B] Add more comments to code
7
 
** [#B] Add more if(debug) calls
8
 
** [#B] Seperate more code to function for more readability
9
 
** [#A] Man page: man8/plugin-runner.8mandos
 
5
* [#A] COPYING file
 
6
  [[file:/usr/share/common-licenses/GPL-3][GPLv3]]
 
7
 
 
8
* Mandos-client
 
9
** [#A] Man page: man8/mandos-client.8mandos
 
10
*** DESCRIPTION
 
11
    Describe the plus sign syntax for passing options from crypttab
10
12
*** EXIT STATUS
11
 
*** ENVIRONMENT
12
 
    Environment is modified according to options and passed to plugins
13
 
*** EXAMPLE
 
13
    Text needed
 
14
*** EXAMPLES
14
15
    Examples of normal usage, debug usage, debugging single or all
15
 
    plugins, etc.
 
16
    plugins, examples of crypttab lines with plus syntax, etc.
16
17
*** FILES
 
18
    Text needed
17
19
*** SECURITY
18
 
    Note the danger of using this program, since you might lock
19
 
    yourself out of your system without any means of entering the root
20
 
    file system password.  This is, however, very unlikely considering
21
 
    the fallback to getpass(3).
 
20
    Text needed
 
21
*** NOTES
 
22
    Text needed
22
23
*** BUGS
 
24
    Text needed
23
25
*** SEE ALSO
24
 
    Explaining text on what you can read
 
26
    Explaining test on what you can read
 
27
** Use asprintf instead of malloc and strcat?
 
28
** use strsep instead of strtok?
 
29
** use config file in addition to arguments
 
30
** pass things in environment, like device name, etc
 
31
** Fallback
 
32
   As a fallback, if no plugins can be found or if all of them failed,
 
33
   run getpass(3) itself.
25
34
 
26
 
* password-request
 
35
* Password-request
27
36
** [#A] Man page: man8/password-request.8mandos
28
 
*** SYNOPSIS
29
 
    Document short options
30
37
*** DESCRIPTION
 
38
    Move options to new OPTIONS section.
31
39
    State that this command is not meant to be invoked directly, but
32
40
    is run as a plugin from mandos-client(8) and only run in the
33
41
    initrd environment, not the real system.
34
 
*** PURPOSE
35
 
    As in mandos.xml
36
 
*** OVERVIEW
37
 
    As in mandos.xml
38
42
*** EXIT STATUS
39
 
*** ENVIRONMENT
40
 
    Note that it does *not* currently use cryptsource or crypttarget.
 
43
    Create this section
 
44
*** EXAMPLES
 
45
    Examples of normal usage, debug usage, debugging by connecting
 
46
    directly, etc.
41
47
*** FILES
42
48
    Describe the key files and the key ring files.  Also note that
43
49
    they should normally have been automatically created.
 
50
*** DIAGNOSTICS
 
51
    Create this section
 
52
*** SECURITY
 
53
    Create this section
 
54
*** NOTES
 
55
    Create this section (if needed)
44
56
*** BUGS
45
 
*** EXAMPLE
46
 
    Examples of normal usage, debug usage, debugging by connecting
47
 
    directly, etc.
48
 
*** SECURITY
 
57
    Create this section
49
58
*** SEE ALSO
50
 
    Update from mandos.xml
51
 
** [#B] Temporarily lower kernel log level
52
 
   for less printouts during sucessfull boot.
 
59
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
 
60
** Use asprintf instead of malloc and memcpy?
53
61
** IPv4 support
54
62
** use strsep instead of strtok?
55
 
** Do not depend on GnuPG key rings on disk
56
 
   This would mean creating new GnuPG key rings with GPGME by
57
 
   importing the key files from scratch on every program start.
58
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
59
 
   Must create in preinst if not pre-depending on cryptsetup
 
63
** Do not depend on GPG key rings on disk
 
64
   This would mean creating new GPG key rings with GPGME by importing
 
65
   the key files from scratch on every program start.
60
66
 
61
 
* password-prompt
62
 
** [#C] Use getpass(3)?
 
67
* Password-prompt
 
68
** [#A] Man page: man8/password-prompt.8mandos
 
69
*** DESCRIPTION
 
70
    Move options to new OPTIONS section.
 
71
*** EXIT STATUS
 
72
    Create this section
 
73
*** EXAMPLES
 
74
    Examples of normal usage, debug usage, with a prefix, etc.
 
75
*** DIAGNOSTICS
 
76
    Create this section
 
77
*** SECURITY
 
78
    Create this section
 
79
    Not much to do here but it is noteworthy to state the danger of
 
80
    not having a fallback option.
 
81
*** NOTES
 
82
    Note that this is more or less a simple getpass(3) wrapper, even
 
83
    though actual use of getpass(3) is not guaranteed.
 
84
*** BUGS
 
85
    Create this section
 
86
*** SEE ALSO
 
87
    Refer to mandos-client(8mandos) and password-request(8mandos)
 
88
** Use getpass(3)?
63
89
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
64
90
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
65
91
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
66
92
   [[http://www.steve.org.uk/Reference/Unix/faq_4.html#SEC48][Unix Programming FAQ 3.1 How can I make my program not echo input?]]
67
93
 
68
 
* mandos (server)
 
94
* Mandos (server)
 
95
** [#A] Command man page: man8/mandos.8
 
96
*** DESCRIPTION
 
97
    Move options to new OPTIONS section
 
98
*** EXIT STATUS
 
99
    Create this section
 
100
*** EXAMPLES
 
101
    Create this section
 
102
*** FILES
 
103
    Describe briefly that the server gets global settings from
 
104
    mandos.conf and clients from clients.conf, but refer to their man
 
105
    pages for more details.
 
106
*** DIAGNOSTICS
 
107
    Create this section
 
108
*** SECURITY
 
109
    Create this section
 
110
*** NOTES
 
111
    Create this section (if needed)
 
112
*** BUGS
 
113
    Create this section
 
114
*** SEE ALSO
 
115
    Refer to the client man page
 
116
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
 
117
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
69
118
** [#A] /etc/init.d/mandos-server               :teddy:
70
 
** [#B] Log level                               :bugs:
 
119
** Log level
71
120
** /etc/mandos/clients.d/*.conf
72
121
   Watch this directory and add/remove/update clients?
73
122
** config for TXT record
74
 
** [#B] Run-time communication with server      :bugs:
 
123
** Run-time communication with server
75
124
   Probably using D-Bus
76
125
   See also [[*Mandos-tools]]
77
 
** Implement --foreground                       :bugs:
 
126
** Implement --foreground
78
127
   [[info:standards:Option%20Table][Table of Long Options]]
79
128
** Implement --socket
80
129
   [[info:standards:Option%20Table][Table of Long Options]]
81
 
** Date+time on console log messages            :bugs:
82
 
   Is this the default?
83
130
 
84
131
* Mandos-tools/utilities
85
132
  All of this probably using D-Bus
87
134
** Disable client
88
135
** Enable client
89
136
 
90
 
* Man pages
91
 
** Tags
92
 
   Go through all man pages to conform to the style of tags chosen in
93
 
   [[http://svn.debian.org/wsvn/debian-xml-sgml/packages/docbook-xsl/trunk/debian/examples/foo.1.example_manpage.xml?op=file&rev=0&sc=0][foo.1.example_manpage.xml]].  In particular:
94
 
*** SYNOPSIS
95
 
    <arg> with inner <option> and <replaceable> tags
96
 
    Unify long and short options.
97
 
**** DONE mandos-clients.conf.xml
98
 
**** DONE mandos-keygen.xml
99
 
**** DONE mandos.conf.xml
100
 
**** DONE mandos.xml
101
 
**** DONE plugin-runner.xml
102
 
**** DONE plugins.d/password-prompt.xml
103
 
**** DONE plugins.d/password-request.xml
104
 
*** OPTIONS
105
 
    Separate <term> tags with <option> and <replaceable> tags.
106
 
**** DONE mandos-clients.conf.xml
107
 
**** DONE mandos-keygen.xml
108
 
**** DONE mandos.conf.xml
109
 
**** DONE mandos.xml
110
 
**** DONE plugin-runner.xml
111
 
**** DONE plugins.d/password-prompt.xml
112
 
**** TODO plugins.d/password-request.xml
113
 
** Use xinclude for common sections
114
 
   Like copyright, authors, etc.
115
 
 
116
 
 
117
137
* Installer
118
 
** Client-side
119
 
*** Update initrd.img after installation
120
 
    This seems to use some kind of "trigger" system
121
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
122
 
    dpkg-trigger(1), deb-triggers(5)
123
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
124
 
    Must create in preinst if not pre-depending on cryptsetup
125
 
*** mandos-keygen
126
 
**** "--passfile" option
127
 
     Using the "secfile" option instead of "secret"
128
 
**** [#A] "--test" option
129
 
     For testing decryption before rebooting.
130
 
** Server-side
131
 
*** [#A] Create mandos user and group for server
132
 
*** [#A] Create /var/run/mandos directory with perm and ownership
 
138
** DONE [#A] Change initrd.img file to not be publically readable
 
139
   /etc/initramfs-tools/conf.d/mandos
 
140
   UMASK=027
 
141
** Update initrd.img after installation
 
142
** [#A] Create mandos user and group for server
 
143
** [#A] Create /var/run/mandos directory with perm and ownership
133
144
 
134
145
* [#A] Package
135
 
** /usr/share/initramfs-tools/hooks/mandos
136
 
*** Do not install in initrd.img if configured not to.
137
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
138
 
    question.
139
146
** /etc/bash_completion.d/mandos
140
 
   From XML sources directly?
 
147
** /etc/initramfs-tools/hooks/mandos
 
148
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
 
149
*** Create GPG key ring files in initrd
141
150
** unperish
142
151
** bzr-builddeb
143
152