/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-12 19:47:50 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080812194750-uebbpk9ynxt3sjnt
* initramfs-tools-hook (gpg): Added "--no-random-seed-file" and
                              "--no-default-keyring".  Bug fix: moved
                              "--import" to end.

* mandos-keygen (gpg): Added "--no-options".

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