/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-25 06:44:13 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080825064413-smqg5qwxfvhkeop4
* Makefile (DOCBOOKTOMAN): Only cd to one directory.

* mandos-options.xml (interface): Removed mention of a specific
                                  replaceable.
  (debug): Reworded slightly.

* mandos.conf.xml (OPTIONS): Renamed some replaceable names.

* mandos.xml (SYNOPSIS, OPTIONS): Renamed replaceable of "interface"
                                  from "IF" to "NAME".

Show diffs side-by-side

added added

removed removed

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