/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
 
* [#A] COPYING file
6
 
  [[file:/usr/share/common-licenses/GPL-3][GPLv3]]
7
 
 
8
 
* Mandos-client
9
 
** [#A] Change syntaxt 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
 
24
*** SYNOPSIS
 
25
    Document short options
35
26
*** DESCRIPTION
36
 
    Move options to new OPTIONS section.
37
27
    State that this command is not meant to be invoked directly, but
38
28
    is run as a plugin from mandos-client(8) and only run in the
39
29
    initrd environment, not the real system.
 
30
*** PURPOSE
 
31
    As in mandos.xml
 
32
*** OVERVIEW
 
33
    As in mandos.xml
40
34
*** EXIT STATUS
41
 
    Create this section
42
 
*** 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
43
42
    Examples of normal usage, debug usage, debugging by connecting
44
43
    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
44
*** SECURITY
51
 
    Create this section
52
 
*** NOTES
53
 
    Create this section (if needed)
54
 
*** BUGS
55
 
    Create this section
56
45
*** SEE ALSO
57
 
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
58
 
** 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.
59
49
** IPv4 support
60
50
** 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.
 
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.
64
54
 
65
 
* Password-prompt
 
55
* password-prompt
66
56
** [#A] Man page: man8/password-prompt.8mandos
 
57
*** SYNOPSIS
 
58
    Document short options
67
59
*** DESCRIPTION
68
 
    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.
69
62
*** EXIT STATUS
70
 
    Create this section
71
 
*** EXAMPLES
 
63
*** ENVIRONMENT
 
64
    Document use of "cryptsource" and "crypttarget".
 
65
*** FILES
 
66
*** BUGS
 
67
*** EXAMPLE
72
68
    Examples of normal usage, debug usage, with a prefix, etc.
73
 
*** DIAGNOSTICS
74
 
    Create this section
75
69
*** SECURITY
76
 
    Create this section
77
70
    Not much to do here but it is noteworthy to state the danger of
78
71
    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
72
*** SEE ALSO
85
73
    Refer to mandos-client(8mandos) and password-request(8mandos)
 
74
    and also, perhaps, to cryptsetup(8)?
86
75
** Use getpass(3)?
87
76
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
88
77
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
89
78
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
90
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?]]
91
 
** Replace completely with "/lib/cryptsetup/askpass"?
92
80
 
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
 
81
* mandos (server)
115
82
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
116
83
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
117
84
** [#A] /etc/init.d/mandos-server               :teddy:
118
 
** Log level
 
85
** [#B] Log level                               :bugs:
119
86
** /etc/mandos/clients.d/*.conf
120
87
   Watch this directory and add/remove/update clients?
121
88
** config for TXT record
122
 
** Run-time communication with server
 
89
** [#B] Run-time communication with server      :bugs:
123
90
   Probably using D-Bus
124
91
   See also [[*Mandos-tools]]
125
 
** Implement --foreground
 
92
** Implement --foreground                       :bugs:
126
93
   [[info:standards:Option%20Table][Table of Long Options]]
127
94
** Implement --socket
128
95
   [[info:standards:Option%20Table][Table of Long Options]]
129
 
** Date+time on console log messages
 
96
** Date+time on console log messages            :bugs:
130
97
   Is this the default?
131
98
 
132
99
* Mandos-tools/utilities
136
103
** Enable client
137
104
 
138
105
* Installer
139
 
** DONE [#A] Change initrd.img file to not be publically readable
140
 
   /etc/initramfs-tools/conf.d/mandos
141
 
   UMASK=027
142
 
** Update initrd.img after installation
143
 
** [#A] Create mandos user and group for server
144
 
** [#A] Create /var/run/mandos directory with perm and ownership
 
106
** Client
 
107
*** Update initrd.img after installation
 
108
    This seems to use some kind of "trigger" system
 
109
** Server
 
110
*** [#A] Create mandos user and group for server
 
111
*** [#A] Create /var/run/mandos directory with perm and ownership
 
112
 
 
113
** mandos-keygen
 
114
*** [#A] Output cut-and-paste ready snippet for clients.conf.
145
115
 
146
116
* [#A] Package
 
117
** /usr/share/initramfs-tools/hooks/mandos
 
118
*** Do not install in initrd.img if configured not to.
 
119
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
 
120
    question.
147
121
** /etc/bash_completion.d/mandos
148
 
** /usr/share/initramfs-tools/hooks/mandos
149
 
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
150
 
*** Create GPG key ring files in initrd
 
122
*** From XML sources directly?
151
123
** unperish
152
124
** bzr-builddeb
153
125