/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-17 20:34:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817203418-l691ahxyc7vmezad
* Makefile (MANPOST): Bug fix: do not replace *all* "een" with "en".

* mandos.xml: More improvements.  Replaced " with <quote>'s.
  (NETWORK PROTOCOL): Replaced <informaltable> with <table> with a
                      <title>.
  (CHECKING): New section describing the continual checking of
              clients.
  (LOGGING): We log to /dev/log, not syslog(3).
  (FILES): Changed to use a <variablelist> instead of an
           <itemizedlist>.  Added "/dev/log" and brief descriptions of
           all files.
  (BUGS): Added content.
  (EXAMPLES): - '' -
  (SECURITY): Added content to subsections "SERVER" and "CLIENTS".

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] Man page: man8/mandos-client.8mandos
10
 
*** SYNOPSIS
11
 
    Needs options listed, not just "[OPTION...]"
12
 
*** DESCRIPTION
13
 
    Move options to new OPTIONS section.
14
 
    State that this command is not meant to be invoked directly, but
15
 
    is meant to be run by cryptsetup by being specified in
16
 
    /etc/crypttab and only run in the initrd environment, not the real
17
 
    system.
 
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
18
10
*** EXIT STATUS
19
 
    Create this section
20
 
*** USAGE
21
 
    Describe the plus sign syntax for passing options from crypttab
 
11
    Text needed
22
12
*** EXAMPLES
23
13
    Examples of normal usage, debug usage, debugging single or all
24
 
    plugins, examples of crypttab lines with plus syntax, etc.
 
14
    plugins, etc.
25
15
*** FILES
26
 
    Describe plugin directory
27
 
*** DIAGNOSTICS
28
 
    Create this section
 
16
    Text needed
29
17
*** SECURITY
30
 
    Create this section
31
 
*** NOTES
32
 
    Create this section (if needed)
 
18
    Text needed
33
19
*** BUGS
34
 
    Create this section
 
20
    Text needed
35
21
*** SEE ALSO
36
 
    Refer to mandos(8), password-request(8mandos), and
37
 
    password-prompt(8mandos)
38
 
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
39
 
** use strsep instead of strtok?
40
 
** use config file in addition to arguments
41
 
** pass things in environment, like device name, etc
42
 
** Fallback
43
 
   As a fallback, if no plugins can be found or if all of them failed,
44
 
   run getpass(3) itself.
 
22
    Explaining text on what you can read
 
23
** Keydir move: /etc/mandos -> /etc/keys/mandos
 
24
   Must create in preinst if not pre-depending on cryptsetup
45
25
 
46
26
* Password-request
47
27
** [#A] Man page: man8/password-request.8mandos
48
 
*** SYNOPSIS
49
 
    Needs options listed, not just "[OPTION...]"
 
28
** [#B] Temporarily lower kernel log level
 
29
   for less printouts during sucessfull boot.
50
30
*** DESCRIPTION
51
31
    Move options to new OPTIONS section.
52
32
    State that this command is not meant to be invoked directly, but
64
44
    Create this section
65
45
*** SECURITY
66
46
    Create this section
67
 
*** NOTES
68
 
    Create this section (if needed)
69
47
*** BUGS
70
48
    Create this section
71
49
*** SEE ALSO
72
50
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
73
 
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
74
 
** start_mandos_communication: loop around gnutls_handshake
75
 
   [[info:gnutls.info.gz:Core%20functions][gnutls_handshake]]
 
51
*** ENVIRONMENT
 
52
    Document use of "cryptsource" and "crypttarget".
76
53
** IPv4 support
77
54
** use strsep instead of strtok?
78
 
** Do not depend on GPG key rings on disk
79
 
   This would mean creating new GPG key rings with GPGME by importing
80
 
   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.
81
58
 
82
59
* Password-prompt
83
60
** [#A] Man page: man8/password-prompt.8mandos
84
 
*** SYNOPSIS
85
 
    Needs options listed, not just "[OPTION...]"
86
61
*** DESCRIPTION
87
62
    Move options to new OPTIONS section.
 
63
    Note that this is more or less a simple getpass(3) wrapper, even
 
64
    though actual use of getpass(3) is not guaranteed.
88
65
*** EXIT STATUS
89
66
    Create this section
90
67
*** EXAMPLES
95
72
    Create this section
96
73
    Not much to do here but it is noteworthy to state the danger of
97
74
    not having a fallback option.
98
 
*** NOTES
99
 
    Note that this is more or less a simple getpass(3) wrapper, even
100
 
    though actual use of getpass(3) is not guaranteed.
101
75
*** BUGS
102
76
    Create this section
103
77
*** SEE ALSO
110
84
 
111
85
* Mandos (server)
112
86
** [#A] Command man page: man8/mandos.8
113
 
*** SYNOPSIS
114
 
    Needs options listed, not just "[OPTION...]"
115
 
*** DESCRIPTION
116
 
    Move options to new OPTIONS section
117
 
*** EXIT STATUS
118
 
    Create this section
119
 
*** EXAMPLES
120
 
    Create this section
121
 
*** FILES
122
 
    Describe briefly that the server gets global settings from
123
 
    mandos.conf and clients from clients.conf, but refer to their man
124
 
    pages for more details.
125
 
*** DIAGNOSTICS
126
 
    Create this section
127
 
*** SECURITY
128
 
    Create this section
129
 
*** NOTES
130
 
    Create this section (if needed)
131
 
*** BUGS
132
 
    Create this section
133
 
*** SEE ALSO
134
 
    Refer to the client man page
135
87
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
136
88
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
137
89
** [#A] /etc/init.d/mandos-server               :teddy:
146
98
   [[info:standards:Option%20Table][Table of Long Options]]
147
99
** Implement --socket
148
100
   [[info:standards:Option%20Table][Table of Long Options]]
 
101
** Date+time on console log messages
 
102
   Is this the default?
149
103
 
150
104
* Mandos-tools/utilities
151
105
  All of this probably using D-Bus
154
108
** Enable client
155
109
 
156
110
* Installer
157
 
** DONE [#A] Change initrd.img file to not be publically readable
158
 
   /etc/initramfs-tools/conf.d/mandos
159
 
   UMASK=027
160
 
** Update initrd.img after installation
161
 
** [#A] Create mandos user and group for server
162
 
** [#A] Create /var/run/mandos directory with perm and ownership
 
111
** Client
 
112
*** DONE [#A] Change initrd.img file to not be publically readable
 
113
    /usr/share/initramfs-tools/conf-hooks.d/mandos
 
114
    UMASK=027
 
115
*** Update initrd.img after installation
 
116
** Server
 
117
*** [#A] Create mandos user and group for server
 
118
*** [#A] Create /var/run/mandos directory with perm and ownership
 
119
 
 
120
** mandos-keygen
 
121
*** [#A] Command man page: man8/mandos-keygen.8
 
122
**** EXIT STATUS
 
123
**** FILES
 
124
**** BUGS
 
125
**** EXAMPLES
 
126
**** SECURITY
 
127
*** [#A] Output cut-and-paste ready snippet for clients.conf.
163
128
 
164
129
* [#A] Package
 
130
** /usr/share/initramfs-tools/hooks/mandos
 
131
*** Do not install in initrd.img if configured not to.
 
132
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
 
133
    question.
165
134
** /etc/bash_completion.d/mandos
166
 
** /etc/initramfs-tools/hooks/mandos
167
 
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
168
 
*** Create GPG key ring files in initrd
 
135
*** From XML sources directly?
 
136
** unperish
 
137
** bzr-builddeb
169
138
 
170
139
* INSTALL file
171
140