/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 06:38:27 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080829063827-hbjl6t92tyjl5305
* mandos-clients.conf.xml (ENTITY TIMESTAMP): New.  Automatically
                                              updated by Emacs
                                              time-stamp by using
                                              Emacs local variables.
  (/refentry/refentryinfo/date): New; set to "&TIMESTAMP;".
* mandos-keygen.xml: - '' -
* mandos.conf.xml: - '' -
* mandos.xml: - '' -
* plugin-runner.xml: - '' -
* plugins.d/password-request.xml: - '' -

Show diffs side-by-side

added added

removed removed

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