/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-08-12 19:22:34 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080812192234-8bm17713ltih9ud1
* initramfs-tools-hook: New.
* initramfs-tools-hook-conf: New.

Show diffs side-by-side

added added

removed removed

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