/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-30 11:39:54 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830113954-sbvgeq7z0wkdvz17
* mandos-keygen.xml (ENVIRONMENT): Replaced <varname> with <envar>.
* mandos.xml (ENVIRONMENT): - '' -

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