/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-29 16:53:41 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829165341-xzrp0xxxfrua5kzq
* mandos.xml (SYNOPSIS): Split <term> tags for the "--help" and
                         "--interface" options.

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] Free plugin name and args
7
 
   [[file:plugin-runner.c::free%20plugin_list][file:plugin-runner.c::free plugin_list]] (both places)
8
 
** [#A] Change syntax for arguments
 
5
* plugin-runner
9
6
** [#B] Add more comments to code
10
7
** [#B] Add more if(debug) calls
11
8
** [#B] Seperate more code to function for more readability
12
 
** [#B] Make free_plugin_list() function
13
9
** [#A] Man page: man8/plugin-runner.8mandos
14
 
*** DESCRIPTION
15
 
    Describe the plus sign syntax for passing options from crypttab
16
10
*** EXIT STATUS
17
 
    Text needed
18
 
*** EXAMPLES
 
11
*** ENVIRONMENT
 
12
    Environment is modified according to options and passed to plugins
 
13
*** EXAMPLE
19
14
    Examples of normal usage, debug usage, debugging single or all
20
 
    plugins, examples of crypttab lines with plus syntax, etc.
 
15
    plugins, etc.
21
16
*** FILES
22
 
    Text needed
23
17
*** SECURITY
24
 
    Text needed
25
 
*** NOTES
26
 
    Text needed
 
18
    Note the danger of using this program, since you might lock
 
19
    yourself out of your system without any means of entering the root
 
20
    file system password.  This is, however, very unlikely considering
 
21
    the fallback to getpass(3).
27
22
*** BUGS
28
 
    Text needed
29
23
*** SEE ALSO
30
 
    Explaining test on what you can read
31
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
32
 
   Must create in preinst if not pre-depending on cryptsetup
 
24
    Explaining text on what you can read
33
25
 
34
 
* Password-request
 
26
* password-request
35
27
** [#A] Man page: man8/password-request.8mandos
36
 
** [#B] Temporarily lower kernel log level
37
 
   for less printouts during sucessfull boot.
 
28
*** SYNOPSIS
 
29
    Document short options
38
30
*** DESCRIPTION
39
 
    Move options to new OPTIONS section.
40
31
    State that this command is not meant to be invoked directly, but
41
32
    is run as a plugin from mandos-client(8) and only run in the
42
33
    initrd environment, not the real system.
 
34
*** PURPOSE
 
35
    As in mandos.xml
 
36
*** OVERVIEW
 
37
    As in mandos.xml
43
38
*** EXIT STATUS
44
 
    Create this section
45
 
*** EXAMPLES
 
39
*** ENVIRONMENT
 
40
    Note that it does *not* currently use cryptsource or crypttarget.
 
41
*** FILES
 
42
    Describe the key files and the key ring files.  Also note that
 
43
    they should normally have been automatically created.
 
44
*** BUGS
 
45
*** EXAMPLE
46
46
    Examples of normal usage, debug usage, debugging by connecting
47
47
    directly, etc.
48
 
*** FILES
49
 
    Describe the key files and the key ring files.  Also note that
50
 
    they should normally have been automatically created.
51
 
*** DIAGNOSTICS
52
 
    Create this section
53
48
*** SECURITY
54
 
    Create this section
55
 
*** NOTES
56
 
    Create this section (if needed)
57
 
*** BUGS
58
 
    Create this section
59
49
*** SEE ALSO
60
 
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
61
 
*** ENVIRONMENT
62
 
    Document use of "cryptsource" and "crypttarget".
 
50
    Update from mandos.xml
 
51
** [#B] Temporarily lower kernel log level
 
52
   for less printouts during sucessfull boot.
63
53
** IPv4 support
64
54
** use strsep instead of strtok?
65
55
** Do not depend on GnuPG key rings on disk
66
56
   This would mean creating new GnuPG key rings with GPGME by
67
57
   importing the key files from scratch on every program start.
 
58
** Keydir move: /etc/mandos -> /etc/keys/mandos
 
59
   Must create in preinst if not pre-depending on cryptsetup
68
60
 
69
 
* Password-prompt
70
 
** [#A] Man page: man8/password-prompt.8mandos
71
 
** Show getenv("cryptsource") and getenv("crypttarget") if set
72
 
   cryptsource will be the device, like "/dev/sda3", and crypttarget
73
 
   will be the device mapper name, like "sda3_crypt".
74
 
*** DESCRIPTION
75
 
    Move options to new OPTIONS section.
76
 
*** EXIT STATUS
77
 
    Create this section
78
 
*** EXAMPLES
79
 
    Examples of normal usage, debug usage, with a prefix, etc.
80
 
*** DIAGNOSTICS
81
 
    Create this section
82
 
*** SECURITY
83
 
    Create this section
84
 
    Not much to do here but it is noteworthy to state the danger of
85
 
    not having a fallback option.
86
 
*** NOTES
87
 
    Note that this is more or less a simple getpass(3) wrapper, even
88
 
    though actual use of getpass(3) is not guaranteed.
89
 
*** BUGS
90
 
    Create this section
91
 
*** SEE ALSO
92
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
93
 
** Use getpass(3)?
 
61
* password-prompt
 
62
** [#C] Use getpass(3)?
94
63
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
95
64
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
96
65
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
97
66
   [[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?]]
98
 
** Replace completely with "/lib/cryptsetup/askpass"?
99
67
 
100
 
* Mandos (server)
101
 
** [#A] Command man page: man8/mandos.8
102
 
*** DESCRIPTION
103
 
    Move options to new OPTIONS section
104
 
*** EXIT STATUS
105
 
    Create this section
106
 
*** EXAMPLES
107
 
    Create this section
108
 
*** FILES
109
 
    Describe briefly that the server gets global settings from
110
 
    mandos.conf and clients from clients.conf, but refer to their man
111
 
    pages for more details.
112
 
*** DIAGNOSTICS
113
 
    Create this section
114
 
*** SECURITY
115
 
    Create this section
116
 
*** NOTES
117
 
    Create this section (if needed)
118
 
*** BUGS
119
 
    Create this section
120
 
*** SEE ALSO
121
 
    Refer to the client man page
122
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
123
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
 
68
* mandos (server)
124
69
** [#A] /etc/init.d/mandos-server               :teddy:
125
 
** Log level
 
70
** [#B] Log level                               :bugs:
126
71
** /etc/mandos/clients.d/*.conf
127
72
   Watch this directory and add/remove/update clients?
128
73
** config for TXT record
129
 
** Run-time communication with server
 
74
** [#B] Run-time communication with server      :bugs:
130
75
   Probably using D-Bus
131
76
   See also [[*Mandos-tools]]
132
 
** Implement --foreground
 
77
** Implement --foreground                       :bugs:
133
78
   [[info:standards:Option%20Table][Table of Long Options]]
134
79
** Implement --socket
135
80
   [[info:standards:Option%20Table][Table of Long Options]]
136
 
** Date+time on console log messages
 
81
** Date+time on console log messages            :bugs:
137
82
   Is this the default?
138
83
 
139
84
* Mandos-tools/utilities
142
87
** Disable client
143
88
** Enable client
144
89
 
 
90
* Man pages
 
91
** Tags
 
92
   Go through all man pages to conform to the style of tags chosen in
 
93
   [[http://svn.debian.org/wsvn/debian-xml-sgml/packages/docbook-xsl/trunk/debian/examples/foo.1.example_manpage.xml?op=file&rev=0&sc=0][foo.1.example_manpage.xml]].  In particular:
 
94
*** SYNOPSIS
 
95
    <arg> with inner <replaceable> and <option> tags
 
96
*** OPTIONS
 
97
    Separate <term> tags with <option> and <replaceable> tags
 
98
** Use xinclude for common sections
 
99
   Like copyright, authors, etc.
 
100
 
 
101
 
145
102
* Installer
146
 
** Client
147
 
*** DONE [#A] Change initrd.img file to not be publically readable
148
 
    /usr/share/initramfs-tools/conf-hooks.d/mandos
149
 
    UMASK=027
 
103
** Client-side
150
104
*** Update initrd.img after installation
151
 
** Server
 
105
    This seems to use some kind of "trigger" system
 
106
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
 
107
    dpkg-trigger(1), deb-triggers(5)
 
108
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
109
    Must create in preinst if not pre-depending on cryptsetup
 
110
*** mandos-keygen
 
111
**** "--passfile" option
 
112
     Using the "secfile" option instead of "secret"
 
113
**** [#A] "--test" option
 
114
     For testing decryption before rebooting.
 
115
** Server-side
152
116
*** [#A] Create mandos user and group for server
153
117
*** [#A] Create /var/run/mandos directory with perm and ownership
154
118
 
155
 
** mandos-keygen
156
 
*** [#A] Command man page: man8/mandos-keygen.8
157
 
*** [#A] Output cut-and-paste ready snippet for clients.conf.
158
 
 
159
119
* [#A] Package
160
120
** /usr/share/initramfs-tools/hooks/mandos
161
 
*** Do not install in initrd.img if configured not to
 
121
*** Do not install in initrd.img if configured not to.
162
122
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
163
123
    question.
164
124
** /etc/bash_completion.d/mandos
165
 
*** From xml sources directly?
 
125
   From XML sources directly?
166
126
** unperish
167
127
** bzr-builddeb
168
128