/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-08-29 07:30:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829073017-tvryowganbf75zp5
* mandos-clients.conf.xml (SEE ALSO): Alphabetized, as per
                                      man-pages(7).
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml (SEE ALSO): Changed from an
                                             <itemizedlist> to a
                                             <para>, as per
                                             man-pages(7).  Also
                                             alphabetize.

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.
 
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
18
10
*** EXIT STATUS
19
 
    Create this section
20
 
*** USAGE
21
 
    Describe the plus sign syntax for passing options from crypttab
22
 
*** EXAMPLES
 
11
*** ENVIRONMENT
 
12
    Environment is modified according to options and passed to plugins
 
13
*** EXAMPLE
23
14
    Examples of normal usage, debug usage, debugging single or all
24
 
    plugins, examples of crypttab lines with plus syntax, etc.
 
15
    plugins, etc.
25
16
*** FILES
26
 
    Describe plugin directory
27
 
*** DIAGNOSTICS
28
 
    Create this section
29
17
*** SECURITY
30
 
    Create this section
31
 
*** NOTES
32
 
    Create this section (if needed)
 
18
    Note the danger of using this program, since you might lock
 
19
    yourself out of your system without any means of entering the root
 
20
    file system password.  This is, however, very unlikely considering
 
21
    the fallback to getpass(3).
33
22
*** BUGS
34
 
    Create this section
35
23
*** 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.
 
24
    Explaining text on what you can read
45
25
 
46
 
* Password-request
 
26
* password-request
47
27
** [#A] Man page: man8/password-request.8mandos
48
28
*** SYNOPSIS
49
 
    Needs options listed, not just "[OPTION...]"
 
29
    Document short options
50
30
*** DESCRIPTION
51
 
    Move options to new OPTIONS section.
52
31
    State that this command is not meant to be invoked directly, but
53
32
    is run as a plugin from mandos-client(8) and only run in the
54
33
    initrd environment, not the real system.
 
34
*** PURPOSE
 
35
    As in mandos.xml
 
36
*** OVERVIEW
 
37
    As in mandos.xml
55
38
*** EXIT STATUS
56
 
    Create this section
57
 
*** EXAMPLES
 
39
*** ENVIRONMENT
 
40
    Note that it does *not* currently use cryptsource or crypttarget.
 
41
*** FILES
 
42
    Describe the key files and the key ring files.  Also note that
 
43
    they should normally have been automatically created.
 
44
*** BUGS
 
45
*** EXAMPLE
58
46
    Examples of normal usage, debug usage, debugging by connecting
59
47
    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
48
*** SECURITY
66
 
    Create this section
67
 
*** NOTES
68
 
    Create this section (if needed)
69
 
*** BUGS
70
 
    Create this section
71
49
*** 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]]
 
50
    Update from mandos.xml
 
51
** [#B] Temporarily lower kernel log level
 
52
   for less printouts during sucessfull boot.
76
53
** IPv4 support
77
54
** 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.
 
55
** Do not depend on GnuPG key rings on disk
 
56
   This would mean creating new GnuPG key rings with GPGME by
 
57
   importing the key files from scratch on every program start.
 
58
** Keydir move: /etc/mandos -> /etc/keys/mandos
 
59
   Must create in preinst if not pre-depending on cryptsetup
81
60
 
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)?
 
61
* password-prompt
 
62
** [#C] Use getpass(3)?
106
63
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
107
64
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
108
65
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
109
66
   [[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
67
 
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)
 
68
* mandos (server)
137
69
** [#A] /etc/init.d/mandos-server               :teddy:
138
 
** Log level
 
70
** [#B] Log level                               :bugs:
139
71
** /etc/mandos/clients.d/*.conf
140
72
   Watch this directory and add/remove/update clients?
141
73
** config for TXT record
142
 
** Run-time communication with server
 
74
** [#B] Run-time communication with server      :bugs:
143
75
   Probably using D-Bus
144
76
   See also [[*Mandos-tools]]
145
 
** Implement --foreground
 
77
** Implement --foreground                       :bugs:
146
78
   [[info:standards:Option%20Table][Table of Long Options]]
147
79
** Implement --socket
148
80
   [[info:standards:Option%20Table][Table of Long Options]]
 
81
** Date+time on console log messages            :bugs:
 
82
   Is this the default?
149
83
 
150
84
* Mandos-tools/utilities
151
85
  All of this probably using D-Bus
153
87
** Disable client
154
88
** Enable client
155
89
 
 
90
* Man pages
 
91
** Tags
 
92
   Go through all man pages to conform to the style of tags chosen in
 
93
   [[http://svn.debian.org/wsvn/debian-xml-sgml/packages/docbook-xsl/trunk/debian/examples/foo.1.example_manpage.xml?op=file&rev=0&sc=0][foo.1.example_manpage.xml]].  In particular:
 
94
*** Synopsis <arg> and <option> tags
 
95
** Use xinclude for common sections
 
96
   Like copyright, authors, etc.
 
97
 
 
98
 
156
99
* 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
 
100
** Client-side
 
101
*** Update initrd.img after installation
 
102
    This seems to use some kind of "trigger" system
 
103
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
 
104
    dpkg-trigger(1), deb-triggers(5)
 
105
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
106
    Must create in preinst if not pre-depending on cryptsetup
 
107
*** mandos-keygen
 
108
**** "--passfile" option
 
109
     Using the "secfile" option instead of "secret"
 
110
**** [#A] "--test" option
 
111
     For testing decryption before rebooting.
 
112
** Server-side
 
113
*** [#A] Create mandos user and group for server
 
114
*** [#A] Create /var/run/mandos directory with perm and ownership
163
115
 
164
116
* [#A] Package
 
117
** /usr/share/initramfs-tools/hooks/mandos
 
118
*** Do not install in initrd.img if configured not to.
 
119
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
 
120
    question.
165
121
** /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
 
122
   From XML sources directly?
 
123
** unperish
 
124
** bzr-builddeb
169
125
 
170
126
* INSTALL file
171
127