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