/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-23 07:17:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080823071728-wo1k2mtbje5910np
* Makefile (MANPOST): Bug fix: corrected patterns.

* mandos-options.xml: Bug fix: also change root node tag name in
                      DOCTYPE declaration.
  (interface, address): Improved wording.

* overview.xml: Changed "host computer" to "computer".

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 syntax 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
 
** Use asprintf instead of malloc and strcat?
29
 
** use strsep instead of strtok?
30
 
** use config file in addition to arguments
31
 
** pass things in environment, like device name, etc
 
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)
60
 
** 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.
61
53
** IPv4 support
62
54
** use strsep instead of strtok?
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.
 
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
66
60
 
67
 
* Password-prompt
 
61
* password-prompt
68
62
** [#A] Man page: man8/password-prompt.8mandos
 
63
*** SYNOPSIS
 
64
    Document short options
69
65
*** DESCRIPTION
70
 
    Move options to new OPTIONS section.
 
66
    Note that this is more or less a simple getpass(3) wrapper, even
 
67
    though actual use of getpass(3) is not guaranteed.
71
68
*** EXIT STATUS
72
 
    Create this section
73
 
*** EXAMPLES
 
69
*** ENVIRONMENT
 
70
    Document use of "cryptsource" and "crypttarget".
 
71
*** FILES
 
72
*** BUGS
 
73
*** EXAMPLE
74
74
    Examples of normal usage, debug usage, with a prefix, etc.
75
 
*** DIAGNOSTICS
76
 
    Create this section
77
75
*** SECURITY
78
 
    Create this section
79
76
    Not much to do here but it is noteworthy to state the danger of
80
77
    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
78
*** SEE ALSO
87
79
    Refer to mandos-client(8mandos) and password-request(8mandos)
 
80
    and also, perhaps, to cryptsetup(8)?
88
81
** Use getpass(3)?
89
82
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
90
83
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
91
84
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
92
85
   [[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?]]
93
 
** Replace completely with "/lib/cryptsetup/askpass"?
94
86
 
95
 
* Mandos (server)
96
 
** [#A] Command man page: man8/mandos.8
97
 
*** DESCRIPTION
98
 
    Move options to new OPTIONS section
99
 
*** EXIT STATUS
100
 
    Create this section
101
 
*** EXAMPLES
102
 
    Create this section
103
 
*** FILES
104
 
    Describe briefly that the server gets global settings from
105
 
    mandos.conf and clients from clients.conf, but refer to their man
106
 
    pages for more details.
107
 
*** DIAGNOSTICS
108
 
    Create this section
109
 
*** SECURITY
110
 
    Create this section
111
 
*** NOTES
112
 
    Create this section (if needed)
113
 
*** BUGS
114
 
    Create this section
115
 
*** SEE ALSO
116
 
    Refer to the client man page
117
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
 
87
* mandos (server)
118
88
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
 
89
*** For option "secret", document which program can help generate it.
119
90
** [#A] /etc/init.d/mandos-server               :teddy:
120
 
** Log level
 
91
** [#B] Log level                               :bugs:
121
92
** /etc/mandos/clients.d/*.conf
122
93
   Watch this directory and add/remove/update clients?
123
94
** config for TXT record
124
 
** Run-time communication with server
 
95
** [#B] Run-time communication with server      :bugs:
125
96
   Probably using D-Bus
126
97
   See also [[*Mandos-tools]]
127
 
** Implement --foreground
 
98
** Implement --foreground                       :bugs:
128
99
   [[info:standards:Option%20Table][Table of Long Options]]
129
100
** Implement --socket
130
101
   [[info:standards:Option%20Table][Table of Long Options]]
131
 
** Date+time on console log messages
 
102
** Date+time on console log messages            :bugs:
132
103
   Is this the default?
133
104
 
134
105
* Mandos-tools/utilities
138
109
** Enable client
139
110
 
140
111
* Installer
141
 
** Client
142
 
*** DONE [#A] Change initrd.img file to not be publically readable
143
 
    /usr/share/initramfs-tools/conf-hooks.d/mandos
144
 
    UMASK=027
 
112
** Client-side
145
113
*** Update initrd.img after installation
146
 
** Server
 
114
    This seems to use some kind of "trigger" system
 
115
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
116
    Must create in preinst if not pre-depending on cryptsetup
 
117
*** mandos-keygen
 
118
**** [#A] Output cut-and-paste ready snippet for clients.conf.
 
119
** Server-side
147
120
*** [#A] Create mandos user and group for server
148
121
*** [#A] Create /var/run/mandos directory with perm and ownership
149
122
 
150
 
** mandos-keygen
151
 
*** [#A] Command man page: man8/mandos-keygen.8
152
 
*** [#A] Output cut-and-paste ready snippet for clients.conf.
153
 
 
154
123
* [#A] Package
155
124
** /usr/share/initramfs-tools/hooks/mandos
156
 
*** Do not install in initrd.img if configured not to
 
125
*** Do not install in initrd.img if configured not to.
157
126
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
158
127
    question.
159
128
** /etc/bash_completion.d/mandos
160
 
*** From xml sources directly?
 
129
   From XML sources directly?
161
130
** unperish
162
131
** bzr-builddeb
163
132