/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-18 23:55:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818235528-dn628nlbrtzl7z4f
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.

* mandos (main): Changed from requiring "[server]" in mandos.conf(5)
                 to requiring "[DEFAULT]".

* mandos.conf ([server]): Renamed to "[DEFAULT]".

* mandos.conf.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
                   referring to "overview.xml".
  (DESCRIPTION): Updated to specify the syntax more precisely.  Use
                 <varname> around the option names.

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