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