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