/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-09-04 13:36:59 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080904133659-0omre4j6luosb20q
* mandos-clients.conf.xml (OPTIONS): Improved spelling.

* mandos.conf.xml (BUGS): - '' -

* mandos.xml (BUGS): - '' -

* plugin-runner.xml (NAME): Fix spelling by changing wording.
  (OPTIONS): Improved spelling.
  (EXAMPLE): Do not use obsolete "--keydir" option.  Improved wording.

* plugins.d/password-prompt.xml (DESCRIPTION): Improved spelling.
  (EXAMPLE): Add <acronym> tag.
  (SECURITY): Improved spelling.

* plugins.d/password-request.xml (SYNOPSIS): Changed replaceable to
                                             match OPTIONS section.
  (DESCRIPTION, OVERVIEW): Improved spelling.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
-*- org -*-
2
2
 
3
 
* [#A] README file
4
 
 
5
 
* Plugin-runner
6
 
** [#A] Free plugin name and args
7
 
   [[file:plugin-runner.c::free%20plugin_list][file:plugin-runner.c::free plugin_list]] (both places)
8
 
** [#A] Change syntax for arguments
9
 
** [#B] Add more comments to code
10
 
** [#B] Add more if(debug) calls
11
 
** [#B] Seperate more code to function for more readability
12
 
** [#B] Make free_plugin_list() function
13
 
** [#A] Man page: man8/plugin-runner.8mandos
14
 
*** DESCRIPTION
15
 
    Describe the plus sign syntax for passing options from crypttab
16
 
*** EXIT STATUS
17
 
    Text needed
18
 
*** EXAMPLES
19
 
    Examples of normal usage, debug usage, debugging single or all
20
 
    plugins, examples of crypttab lines with plus syntax, etc.
21
 
*** FILES
22
 
    Text needed
23
 
*** SECURITY
24
 
    Text needed
25
 
*** NOTES
26
 
    Text needed
27
 
*** BUGS
28
 
    Text needed
29
 
*** SEE ALSO
30
 
    Explaining test on what you can read
31
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
32
 
   Must create in preinst if not pre-depending on cryptsetup
33
 
 
34
 
* Password-request
35
 
** [#A] Man page: man8/password-request.8mandos
 
3
* plugin-runner
 
4
 
 
5
* password-request
36
6
** [#B] Temporarily lower kernel log level
37
7
   for less printouts during sucessfull boot.
38
 
*** DESCRIPTION
39
 
    Move options to new OPTIONS section.
40
 
    State that this command is not meant to be invoked directly, but
41
 
    is run as a plugin from mandos-client(8) and only run in the
42
 
    initrd environment, not the real system.
43
 
*** EXIT STATUS
44
 
    Create this section
45
 
*** EXAMPLES
46
 
    Examples of normal usage, debug usage, debugging by connecting
47
 
    directly, etc.
48
 
*** FILES
49
 
    Describe the key files and the key ring files.  Also note that
50
 
    they should normally have been automatically created.
51
 
*** DIAGNOSTICS
52
 
    Create this section
53
 
*** SECURITY
54
 
    Create this section
55
 
*** NOTES
56
 
    Create this section (if needed)
57
 
*** BUGS
58
 
    Create this section
59
 
*** SEE ALSO
60
 
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
61
 
*** ENVIRONMENT
62
 
    Document use of "cryptsource" and "crypttarget".
63
8
** IPv4 support
64
9
** use strsep instead of strtok?
65
10
** Do not depend on GnuPG key rings on disk
66
11
   This would mean creating new GnuPG key rings with GPGME by
67
12
   importing the key files from scratch on every program start.
68
 
 
69
 
* Password-prompt
70
 
** [#A] Man page: man8/password-prompt.8mandos
71
 
** Show getenv("cryptsource") and getenv("crypttarget") if set
72
 
   cryptsource will be the device, like "/dev/sda3", and crypttarget
73
 
   will be the device mapper name, like "sda3_crypt".
74
 
*** DESCRIPTION
75
 
    Move options to new OPTIONS section.
76
 
*** EXIT STATUS
77
 
    Create this section
78
 
*** EXAMPLES
79
 
    Examples of normal usage, debug usage, with a prefix, etc.
80
 
*** DIAGNOSTICS
81
 
    Create this section
82
 
*** SECURITY
83
 
    Create this section
84
 
    Not much to do here but it is noteworthy to state the danger of
85
 
    not having a fallback option.
86
 
*** NOTES
87
 
    Note that this is more or less a simple getpass(3) wrapper, even
88
 
    though actual use of getpass(3) is not guaranteed.
89
 
*** BUGS
90
 
    Create this section
91
 
*** SEE ALSO
92
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
93
 
** Use getpass(3)?
94
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
95
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
96
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
97
 
   [[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?]]
98
 
** Replace completely with "/lib/cryptsetup/askpass"?
99
 
 
100
 
* Mandos (server)
101
 
** [#A] Command man page: man8/mandos.8
102
 
*** DESCRIPTION
103
 
    Move options to new OPTIONS section
104
 
*** EXIT STATUS
105
 
    Create this section
106
 
*** EXAMPLES
107
 
    Create this section
108
 
*** FILES
109
 
    Describe briefly that the server gets global settings from
110
 
    mandos.conf and clients from clients.conf, but refer to their man
111
 
    pages for more details.
112
 
*** DIAGNOSTICS
113
 
    Create this section
114
 
*** SECURITY
115
 
    Create this section
116
 
*** NOTES
117
 
    Create this section (if needed)
118
 
*** BUGS
119
 
    Create this section
120
 
*** SEE ALSO
121
 
    Refer to the client man page
122
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
123
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
 
13
** Keydir move: /etc/mandos -> /etc/keys/mandos
 
14
   Must create in preinst if not pre-depending on cryptsetup
 
15
 
 
16
* password-prompt
 
17
 
 
18
* mandos (server)
124
19
** [#A] /etc/init.d/mandos-server               :teddy:
125
 
** Log level
 
20
** [#B] Log level                               :bugs:
126
21
** /etc/mandos/clients.d/*.conf
127
22
   Watch this directory and add/remove/update clients?
128
23
** config for TXT record
129
 
** Run-time communication with server
 
24
** [#B] Run-time communication with server      :bugs:
130
25
   Probably using D-Bus
131
26
   See also [[*Mandos-tools]]
132
 
** Implement --foreground
 
27
** Implement --foreground                       :bugs:
133
28
   [[info:standards:Option%20Table][Table of Long Options]]
134
29
** Implement --socket
135
30
   [[info:standards:Option%20Table][Table of Long Options]]
136
 
** Date+time on console log messages
 
31
** Date+time on console log messages            :bugs:
137
32
   Is this the default?
 
33
** delete hook when clients fall out by timeout
138
34
 
139
35
* Mandos-tools/utilities
140
36
  All of this probably using D-Bus
141
37
** List clients
142
38
** Disable client
143
39
** Enable client
 
40
** Reboot timer
 
41
 
 
42
* Man pages
 
43
** Use xinclude for common sections
 
44
   Like authors, etc.
 
45
 
144
46
 
145
47
* Installer
146
 
** Client
147
 
*** DONE [#A] Change initrd.img file to not be publically readable
148
 
    /usr/share/initramfs-tools/conf-hooks.d/mandos
149
 
    UMASK=027
 
48
** Client-side
150
49
*** Update initrd.img after installation
151
 
** Server
 
50
    This seems to use some kind of "trigger" system
 
51
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
 
52
    dpkg-trigger(1), deb-triggers(5)
 
53
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
54
    Must create in preinst if not pre-depending on cryptsetup
 
55
*** mandos-keygen
 
56
**** "--passfile" option
 
57
     Using the "secfile" option instead of "secret"
 
58
**** [#A] "--test" option
 
59
     For testing decryption before rebooting.
 
60
** Server-side
152
61
*** [#A] Create mandos user and group for server
153
62
*** [#A] Create /var/run/mandos directory with perm and ownership
154
63
 
155
 
** mandos-keygen
156
 
*** [#A] Command man page: man8/mandos-keygen.8
157
 
*** [#A] Output cut-and-paste ready snippet for clients.conf.
158
 
 
159
64
* [#A] Package
160
65
** /usr/share/initramfs-tools/hooks/mandos
161
 
*** Do not install in initrd.img if configured not to
 
66
*** Do not install in initrd.img if configured not to.
162
67
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
163
68
    question.
164
69
** /etc/bash_completion.d/mandos
165
 
*** From xml sources directly?
 
70
   From XML sources directly?
166
71
** unperish
167
72
** bzr-builddeb
168
73