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