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