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