/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-09-02 10:27:08 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902102708-j5k6ec3lcgkaeipv
* plugin-runner.xml: Changed short option for "--global-env" to "-G",
                     changed short option for "--env-for" to "-E".
                     added new options "--enable" ("-e") and
                     "--config-file".
  (ENVIRONMENT): Added text.
  (FILES): Changed id to "files".  Improved wording and add more text.

Show diffs side-by-side

added added

removed removed

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