/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-09-02 13:04:42 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080902130442-ytnjsmllaph18e20
* plugin-runner.xml (PLUGINS/WRITING PLUGINS): New section.
  (BUGS): Commented out.  There are no bugs.
  (EXAMPLE): Added lots of examples.
  (SECURITY): Added text.
  (SEE ALSO): Added "crypttab(5)" and "execve(2)".

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