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