/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-31 15:06:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831150639-tqdkyea3b9p3rou7
* Makefile: Make all DocBook rules include legalnotice.xml as a
            dependency.

* legalnotice.xml: New file with just the <legalnotice> tag in it.

* mandos-clients.conf.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".
* mandos-keygen.xml (/refentry/refentryinfo/legalnotice): - '' -
* mandos-conf.xml (/refentry/refentryinfo/legalnotice): - '' -
* mandos.xml (/refentry/refentryinfo/legalnotice): - '' -

* overview.xml: Changed root node tag name in DOCTYPE declaration.

* plugin-runner.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".

* plugins.d/password-prompt.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".

* plugins.d/password-request.xml (/refentry): Add XInclude namespace.
  (/refentry/refentryinfo/legalnotice): Replaced with an inclusion of
                                        "legalnotice.xml".

Show diffs side-by-side

added added

removed removed

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