/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-18 05:24:20 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818052420-ab5eurrioz8n2qy6
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".

* mandos-keygen Bug fix: make the --expire option modify
                KEYEXPIRE, not KEYCOMMENT.  Use the "--no-options"
                option to gpg when exporting keys from the temporary
                key ring files.

* mandos-keygen.xml (EXIT STATUS): Filled in.
  (ENVIRONMENT): New section, documenting use of TMPDIR.
  (FILES): Document use of key files and /tmp.
  (BUGS): Filled in.
  (EXAMPLE): Added two examples.
  (SECURITY): Added some text.

* plugins.d/password-prompt.xml (NOTES): Removed, since this is
                                         created automatically for
                                         footnotes.
  (ENVIRONMENT, FILES): Added empty sections.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

* plugins.d/password-request.xml: Reordered sections.
  (ENVIRONMENT): New empty section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

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