/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 12:23:33 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831122333-qgppahxb4d4b0coc
* plugins.d/password-request.xml (OPTIONS): Make replaceables match
                                            the ones in the SYNOPSIS.
                                            Split <term> tags into one
                                            for each option.  Use
                                            <option> tags instead of
                                            <literal>.  Moved long
                                            options before short.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
2
2
 
3
3
* [#A] README file
4
4
 
5
 
* [#A] COPYING file
6
 
  [[file:/usr/share/common-licenses/GPL-3][GPLv3]]
7
 
 
8
 
* Mandos-client
9
 
** [#A] Change syntaxt for arguments
10
 
** [#A] Man page: man8/mandos-client.8mandos
11
 
*** DESCRIPTION
12
 
    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
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
 
** [#A] Fallback on error
29
 
** Use asprintf instead of malloc and strcat?
30
 
** use strsep instead of strtok?
31
 
** use config file in addition to arguments
32
 
** pass things in environment, like device name, etc
 
24
    Explaining text on what you can read
33
25
 
34
 
* Password-request
 
26
* password-request
35
27
** [#A] Man page: man8/password-request.8mandos
 
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)
59
 
** Use asprintf instead of malloc and memcpy?
 
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
 
** Do not depend on GPG key rings on disk
63
 
   This would mean creating new GPG key rings with GPGME by importing
64
 
   the key files from scratch on every program start.
 
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
65
60
 
66
 
* Password-prompt
67
 
** [#A] Man page: man8/password-prompt.8mandos
68
 
*** DESCRIPTION
69
 
    Move options to new OPTIONS section.
70
 
*** EXIT STATUS
71
 
    Create this section
72
 
*** EXAMPLES
73
 
    Examples of normal usage, debug usage, with a prefix, etc.
74
 
*** DIAGNOSTICS
75
 
    Create this section
76
 
*** SECURITY
77
 
    Create this section
78
 
    Not much to do here but it is noteworthy to state the danger of
79
 
    not having a fallback option.
80
 
*** NOTES
81
 
    Note that this is more or less a simple getpass(3) wrapper, even
82
 
    though actual use of getpass(3) is not guaranteed.
83
 
*** BUGS
84
 
    Create this section
85
 
*** SEE ALSO
86
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
87
 
** Use getpass(3)?
 
61
* password-prompt
 
62
** [#C] Use getpass(3)?
88
63
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
89
64
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
90
65
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
91
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?]]
92
 
** Replace completely with "/lib/cryptsetup/askpass"?
93
67
 
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)
 
68
* mandos (server)
118
69
** [#A] /etc/init.d/mandos-server               :teddy:
119
 
** Log level
 
70
** [#B] Log level                               :bugs:
120
71
** /etc/mandos/clients.d/*.conf
121
72
   Watch this directory and add/remove/update clients?
122
73
** config for TXT record
123
 
** Run-time communication with server
 
74
** [#B] Run-time communication with server      :bugs:
124
75
   Probably using D-Bus
125
76
   See also [[*Mandos-tools]]
126
 
** Implement --foreground
 
77
** Implement --foreground                       :bugs:
127
78
   [[info:standards:Option%20Table][Table of Long Options]]
128
79
** Implement --socket
129
80
   [[info:standards:Option%20Table][Table of Long Options]]
130
 
** Date+time on console log messages
 
81
** Date+time on console log messages            :bugs:
131
82
   Is this the default?
132
83
 
133
84
* Mandos-tools/utilities
136
87
** Disable client
137
88
** Enable client
138
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
**** DONE mandos.xml
 
110
**** DONE plugin-runner.xml
 
111
**** DONE plugins.d/password-prompt.xml
 
112
**** DONE plugins.d/password-request.xml
 
113
** Use xinclude for common sections
 
114
   Like copyright, authors, etc.
 
115
 
 
116
 
139
117
* Installer
140
 
** DONE [#A] Change initrd.img file to not be publically readable
141
 
   /etc/initramfs-tools/conf.d/mandos
142
 
   UMASK=027
143
 
** Update initrd.img after installation
144
 
** [#A] Create mandos user and group for server
145
 
** [#A] Create /var/run/mandos directory with perm and ownership
 
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
146
133
 
147
134
* [#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.
148
139
** /etc/bash_completion.d/mandos
149
 
** /usr/share/initramfs-tools/hooks/mandos
150
 
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
151
 
*** Create GPG key ring files in initrd
 
140
   From XML sources directly?
152
141
** unperish
153
142
** bzr-builddeb
154
143