/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 23:13:41 UTC
  • mfrom: (24.1.48 mandos)
  • Revision ID: teddy@fukt.bsnet.se-20080812231341-2qd2xg3h3bkjthl2
* Makefile (COVERAGE): Change back to "--coverage".

* mandos-keygen: Implemented "--version" and "--help".

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
* 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
10
*** EXIT STATUS
11
 
*** ENVIRONMENT
12
 
    Environment is modified according to options and passed to plugins
13
 
*** EXAMPLE
 
11
    Text needed
 
12
*** EXAMPLES
14
13
    Examples of normal usage, debug usage, debugging single or all
15
 
    plugins, etc.
 
14
    plugins, examples of crypttab lines with plus syntax, etc.
16
15
*** FILES
 
16
    Text needed
17
17
*** 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).
 
18
    Text needed
 
19
*** NOTES
 
20
    Text needed
22
21
*** BUGS
 
22
    Text needed
23
23
*** SEE ALSO
24
 
    Explaining text on what you can read
 
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
25
29
 
26
 
* password-request
 
30
* Password-request
27
31
** [#A] Man page: man8/password-request.8mandos
28
 
*** SYNOPSIS
29
 
    Document short options
 
32
** [#B] Temporarily lower kernel log level
 
33
   for less printouts during sucessfull boot.
30
34
*** DESCRIPTION
 
35
    Move options to new OPTIONS section.
31
36
    State that this command is not meant to be invoked directly, but
32
37
    is run as a plugin from mandos-client(8) and only run in the
33
38
    initrd environment, not the real system.
34
 
*** PURPOSE
35
 
    As in mandos.xml
36
 
*** OVERVIEW
37
 
    As in mandos.xml
38
39
*** EXIT STATUS
39
 
*** ENVIRONMENT
40
 
    Note that it does *not* currently use cryptsource or crypttarget.
 
40
    Create this section
 
41
*** EXAMPLES
 
42
    Examples of normal usage, debug usage, debugging by connecting
 
43
    directly, etc.
41
44
*** FILES
42
45
    Describe the key files and the key ring files.  Also note that
43
46
    they should normally have been automatically created.
 
47
*** DIAGNOSTICS
 
48
    Create this section
 
49
*** SECURITY
 
50
    Create this section
 
51
*** NOTES
 
52
    Create this section (if needed)
44
53
*** BUGS
45
 
*** EXAMPLE
46
 
    Examples of normal usage, debug usage, debugging by connecting
47
 
    directly, etc.
48
 
*** SECURITY
 
54
    Create this section
49
55
*** SEE ALSO
50
 
    Update from mandos.xml
51
 
** [#B] Temporarily lower kernel log level
52
 
   for less printouts during sucessfull boot.
 
56
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
 
57
** Use asprintf instead of malloc and memcpy?
53
58
** IPv4 support
54
59
** use strsep instead of strtok?
55
60
** Do not depend on GnuPG key rings on disk
56
61
   This would mean creating new GnuPG key rings with GPGME by
57
62
   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
60
63
 
61
 
* password-prompt
62
 
** [#C] Use getpass(3)?
 
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)?
63
86
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
64
87
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
65
88
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
66
89
   [[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"?
67
91
 
68
 
* mandos (server)
 
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)
69
116
** [#A] /etc/init.d/mandos-server               :teddy:
70
 
** [#B] Log level                               :bugs:
 
117
** Log level
71
118
** /etc/mandos/clients.d/*.conf
72
119
   Watch this directory and add/remove/update clients?
73
120
** config for TXT record
74
 
** [#B] Run-time communication with server      :bugs:
 
121
** Run-time communication with server
75
122
   Probably using D-Bus
76
123
   See also [[*Mandos-tools]]
77
 
** Implement --foreground                       :bugs:
 
124
** Implement --foreground
78
125
   [[info:standards:Option%20Table][Table of Long Options]]
79
126
** Implement --socket
80
127
   [[info:standards:Option%20Table][Table of Long Options]]
81
 
** Date+time on console log messages            :bugs:
 
128
** Date+time on console log messages
82
129
   Is this the default?
83
130
 
84
131
* Mandos-tools/utilities
87
134
** Disable client
88
135
** Enable client
89
136
 
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
 
**** TODO 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
137
* Installer
118
 
** Client-side
 
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
119
142
*** 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
 
143
** Server
131
144
*** [#A] Create mandos user and group for server
132
145
*** [#A] Create /var/run/mandos directory with perm and ownership
133
146
 
 
147
** mandos-keygen
 
148
*** [#A] Command man page: man8/mandos-keygen.8
 
149
*** [#A] Output cut-and-paste ready snippet for clients.conf.
 
150
 
134
151
* [#A] Package
135
152
** /usr/share/initramfs-tools/hooks/mandos
136
 
*** Do not install in initrd.img if configured not to.
 
153
*** Do not install in initrd.img if configured not to
137
154
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
138
155
    question.
139
156
** /etc/bash_completion.d/mandos
140
 
   From XML sources directly?
 
157
*** From xml sources directly?
141
158
** unperish
142
159
** bzr-builddeb
143
160