/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

plugin-runner
        Freeing up memory during run-time.

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