/mandos/trunk

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

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Teddy Hogeborn
  • Date: 2008-08-31 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved wording.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
2
2
 
3
3
* [#A] README file
4
4
 
5
 
* Mandos-client
6
 
** [#A] Change syntax for arguments
7
 
** [#A] Man page: man8/mandos-client.8mandos
8
 
*** DESCRIPTION
9
 
    Describe the plus sign syntax for passing options from crypttab
 
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
10
10
*** EXIT STATUS
11
 
    Text needed
12
 
*** EXAMPLES
 
11
*** ENVIRONMENT
 
12
    Environment is modified according to options and passed to plugins
 
13
*** EXAMPLE
13
14
    Examples of normal usage, debug usage, debugging single or all
14
 
    plugins, examples of crypttab lines with plus syntax, etc.
 
15
    plugins, etc.
15
16
*** FILES
16
 
    Text needed
17
17
*** SECURITY
18
 
    Text needed
19
 
*** NOTES
20
 
    Text needed
 
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).
21
22
*** BUGS
22
 
    Text needed
23
23
*** SEE ALSO
24
 
    Explaining test on what you can read
25
 
** Use asprintf instead of malloc and strcat?
26
 
** use strsep instead of strtok?
27
 
** use config file in addition to arguments
28
 
** pass things in environment, like device name, etc
29
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
30
 
   Must create in preinst if not pre-depending on cryptsetup
 
24
    Explaining text on what you can read
31
25
 
32
 
* Password-request
 
26
* password-request
33
27
** [#A] Man page: man8/password-request.8mandos
34
 
** [#B] Temporarily lower kernel log level
35
 
   for less printouts during sucessfull boot.
 
28
*** SYNOPSIS
 
29
    Document short options
36
30
*** DESCRIPTION
37
 
    Move options to new OPTIONS section.
38
31
    State that this command is not meant to be invoked directly, but
39
32
    is run as a plugin from mandos-client(8) and only run in the
40
33
    initrd environment, not the real system.
 
34
*** PURPOSE
 
35
    As in mandos.xml
 
36
*** OVERVIEW
 
37
    As in mandos.xml
41
38
*** EXIT STATUS
42
 
    Create this section
43
 
*** EXAMPLES
 
39
*** ENVIRONMENT
 
40
    Note that it does *not* currently use cryptsource or crypttarget.
 
41
*** FILES
 
42
    Describe the key files and the key ring files.  Also note that
 
43
    they should normally have been automatically created.
 
44
*** BUGS
 
45
*** EXAMPLE
44
46
    Examples of normal usage, debug usage, debugging by connecting
45
47
    directly, etc.
46
 
*** FILES
47
 
    Describe the key files and the key ring files.  Also note that
48
 
    they should normally have been automatically created.
49
 
*** DIAGNOSTICS
50
 
    Create this section
51
48
*** SECURITY
52
 
    Create this section
53
 
*** NOTES
54
 
    Create this section (if needed)
55
 
*** BUGS
56
 
    Create this section
57
49
*** SEE ALSO
58
 
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
 
50
    Update from mandos.xml
 
51
** [#B] Temporarily lower kernel log level
 
52
   for less printouts during sucessfull boot.
59
53
** IPv4 support
60
54
** use strsep instead of strtok?
61
55
** Do not depend on GnuPG key rings on disk
62
56
   This would mean creating new GnuPG key rings with GPGME by
63
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
64
60
 
65
 
* Password-prompt
66
 
** [#A] Man page: man8/password-prompt.8mandos
67
 
** Show getenv("cryptsource") and getenv("crypttarget") if set
68
 
   cryptsource will be the device, like "/dev/sda3", and crypttarget
69
 
   will be the device mapper name, like "sda3_crypt".
70
 
*** DESCRIPTION
71
 
    Move options to new OPTIONS section.
72
 
*** EXIT STATUS
73
 
    Create this section
74
 
*** EXAMPLES
75
 
    Examples of normal usage, debug usage, with a prefix, etc.
76
 
*** DIAGNOSTICS
77
 
    Create this section
78
 
*** SECURITY
79
 
    Create this section
80
 
    Not much to do here but it is noteworthy to state the danger of
81
 
    not having a fallback option.
82
 
*** NOTES
83
 
    Note that this is more or less a simple getpass(3) wrapper, even
84
 
    though actual use of getpass(3) is not guaranteed.
85
 
*** BUGS
86
 
    Create this section
87
 
*** SEE ALSO
88
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
89
 
** Use getpass(3)?
 
61
* password-prompt
 
62
** [#C] Use getpass(3)?
90
63
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
91
64
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
92
65
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
93
66
   [[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?]]
94
 
** Replace completely with "/lib/cryptsetup/askpass"?
95
67
 
96
 
* Mandos (server)
97
 
** [#A] Command man page: man8/mandos.8
98
 
*** DESCRIPTION
99
 
    Move options to new OPTIONS section
100
 
*** EXIT STATUS
101
 
    Create this section
102
 
*** EXAMPLES
103
 
    Create this section
104
 
*** FILES
105
 
    Describe briefly that the server gets global settings from
106
 
    mandos.conf and clients from clients.conf, but refer to their man
107
 
    pages for more details.
108
 
*** DIAGNOSTICS
109
 
    Create this section
110
 
*** SECURITY
111
 
    Create this section
112
 
*** NOTES
113
 
    Create this section (if needed)
114
 
*** BUGS
115
 
    Create this section
116
 
*** SEE ALSO
117
 
    Refer to the client man page
118
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
119
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
 
68
* mandos (server)
120
69
** [#A] /etc/init.d/mandos-server               :teddy:
121
 
** Log level
 
70
** [#B] Log level                               :bugs:
122
71
** /etc/mandos/clients.d/*.conf
123
72
   Watch this directory and add/remove/update clients?
124
73
** config for TXT record
125
 
** Run-time communication with server
 
74
** [#B] Run-time communication with server      :bugs:
126
75
   Probably using D-Bus
127
76
   See also [[*Mandos-tools]]
128
 
** Implement --foreground
 
77
** Implement --foreground                       :bugs:
129
78
   [[info:standards:Option%20Table][Table of Long Options]]
130
79
** Implement --socket
131
80
   [[info:standards:Option%20Table][Table of Long Options]]
132
 
** Date+time on console log messages
 
81
** Date+time on console log messages            :bugs:
133
82
   Is this the default?
134
83
 
135
84
* Mandos-tools/utilities
138
87
** Disable client
139
88
** Enable client
140
89
 
 
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
**** TODO mandos.xml
 
110
**** TODO plugin-runner.xml
 
111
**** TODO 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
 
141
117
* Installer
142
 
** Client
143
 
*** DONE [#A] Change initrd.img file to not be publically readable
144
 
    /usr/share/initramfs-tools/conf-hooks.d/mandos
145
 
    UMASK=027
 
118
** Client-side
146
119
*** Update initrd.img after installation
147
 
** Server
 
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
148
131
*** [#A] Create mandos user and group for server
149
132
*** [#A] Create /var/run/mandos directory with perm and ownership
150
133
 
151
 
** mandos-keygen
152
 
*** [#A] Command man page: man8/mandos-keygen.8
153
 
*** [#A] Output cut-and-paste ready snippet for clients.conf.
154
 
 
155
134
* [#A] Package
156
135
** /usr/share/initramfs-tools/hooks/mandos
157
 
*** Do not install in initrd.img if configured not to
 
136
*** Do not install in initrd.img if configured not to.
158
137
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
159
138
    question.
160
139
** /etc/bash_completion.d/mandos
161
 
*** From xml sources directly?
 
140
   From XML sources directly?
162
141
** unperish
163
142
** bzr-builddeb
164
143