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