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