/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

synopsis changed

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
2
2
 
3
3
* [#A] README file
4
4
 
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
 
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.
10
18
*** EXIT STATUS
11
 
*** ENVIRONMENT
12
 
    Environment is modified according to options and passed to plugins
13
 
*** EXAMPLE
 
19
    Create this section
 
20
*** USAGE
 
21
    Describe the plus sign syntax for passing options from crypttab
 
22
*** EXAMPLES
14
23
    Examples of normal usage, debug usage, debugging single or all
15
 
    plugins, etc.
 
24
    plugins, examples of crypttab lines with plus syntax, etc.
16
25
*** FILES
 
26
    Describe plugin directory
 
27
*** DIAGNOSTICS
 
28
    Create this section
17
29
*** SECURITY
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).
 
30
    Create this section
 
31
*** NOTES
 
32
    Create this section (if needed)
22
33
*** BUGS
 
34
    Create this section
23
35
*** SEE ALSO
24
 
    Explaining text on what you can read
 
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.
25
45
 
26
 
* password-request
 
46
* Password-request
27
47
** [#A] Man page: man8/password-request.8mandos
28
48
*** SYNOPSIS
29
 
    Document short options
 
49
    Needs options listed, not just "[OPTION...]"
30
50
*** DESCRIPTION
 
51
    Move options to new OPTIONS section.
31
52
    State that this command is not meant to be invoked directly, but
32
53
    is run as a plugin from mandos-client(8) and only run in the
33
54
    initrd environment, not the real system.
34
 
*** PURPOSE
35
 
    As in mandos.xml
36
 
*** OVERVIEW
37
 
    As in mandos.xml
38
55
*** EXIT STATUS
39
 
*** ENVIRONMENT
40
 
    Note that it does *not* currently use cryptsource or crypttarget.
 
56
    Create this section
 
57
*** EXAMPLES
 
58
    Examples of normal usage, debug usage, debugging by connecting
 
59
    directly, etc.
41
60
*** FILES
42
61
    Describe the key files and the key ring files.  Also note that
43
62
    they should normally have been automatically created.
 
63
*** DIAGNOSTICS
 
64
    Create this section
 
65
*** SECURITY
 
66
    Create this section
 
67
*** NOTES
 
68
    Create this section (if needed)
44
69
*** BUGS
45
 
*** EXAMPLE
46
 
    Examples of normal usage, debug usage, debugging by connecting
47
 
    directly, etc.
48
 
*** SECURITY
 
70
    Create this section
49
71
*** SEE ALSO
50
 
    Update from mandos.xml
51
 
** [#B] Temporarily lower kernel log level
52
 
   for less printouts during sucessfull boot.
 
72
    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]]
53
76
** IPv4 support
54
77
** use strsep instead of strtok?
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
 
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.
60
81
 
61
 
* password-prompt
 
82
* Password-prompt
62
83
** [#A] Man page: man8/password-prompt.8mandos
63
84
*** SYNOPSIS
64
 
    Document short options
 
85
    Needs options listed, not just "[OPTION...]"
65
86
*** DESCRIPTION
66
 
    Note that this is more or less a simple getpass(3) wrapper, even
67
 
    though actual use of getpass(3) is not guaranteed.
 
87
    Move options to new OPTIONS section.
68
88
*** EXIT STATUS
69
 
*** ENVIRONMENT
70
 
    Document use of "cryptsource" and "crypttarget".
71
 
*** FILES
72
 
*** BUGS
73
 
*** EXAMPLE
 
89
    Create this section
 
90
*** EXAMPLES
74
91
    Examples of normal usage, debug usage, with a prefix, etc.
 
92
*** DIAGNOSTICS
 
93
    Create this section
75
94
*** SECURITY
 
95
    Create this section
76
96
    Not much to do here but it is noteworthy to state the danger of
77
97
    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
*** BUGS
 
102
    Create this section
78
103
*** SEE ALSO
79
104
    Refer to mandos-client(8mandos) and password-request(8mandos)
80
 
    and also, perhaps, to cryptsetup(8)?
81
105
** Use getpass(3)?
82
106
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
83
107
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
84
108
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
85
109
   [[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?]]
86
110
 
87
 
* mandos (server)
88
 
** run gnutls_openpgp_crt_verify_self() and verify clients certificates
 
111
* Mandos (server)
 
112
** [#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
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
89
136
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
90
 
*** For option "secret", document which program can help generate it.
91
137
** [#A] /etc/init.d/mandos-server               :teddy:
92
 
** [#B] Log level                               :bugs:
 
138
** Log level
93
139
** /etc/mandos/clients.d/*.conf
94
140
   Watch this directory and add/remove/update clients?
95
141
** config for TXT record
96
 
** [#B] Run-time communication with server      :bugs:
 
142
** Run-time communication with server
97
143
   Probably using D-Bus
98
144
   See also [[*Mandos-tools]]
99
 
** Implement --foreground                       :bugs:
 
145
** Implement --foreground
100
146
   [[info:standards:Option%20Table][Table of Long Options]]
101
147
** Implement --socket
102
148
   [[info:standards:Option%20Table][Table of Long Options]]
103
 
** Date+time on console log messages            :bugs:
104
 
   Is this the default?
105
149
 
106
150
* Mandos-tools/utilities
107
151
  All of this probably using D-Bus
110
154
** Enable client
111
155
 
112
156
* Installer
113
 
** Client-side
114
 
*** Update initrd.img after installation
115
 
    This seems to use some kind of "trigger" system
116
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
117
 
    Must create in preinst if not pre-depending on cryptsetup
118
 
*** mandos-keygen
119
 
**** [#A] Output cut-and-paste ready snippet for clients.conf.
120
 
** Server-side
121
 
*** [#A] Create mandos user and group for server
122
 
*** [#A] Create /var/run/mandos directory with perm and ownership
 
157
** DONE [#A] Change initrd.img file to not be publically readable
 
158
   /etc/initramfs-tools/conf.d/mandos
 
159
   UMASK=027
 
160
** [#A] Create /etc/initramfs-tools/hooks/mandos
 
161
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
 
162
** [#A] Create GPG key ring files in initrd
 
163
** [#A] Create mandos user and group for server
 
164
** [#A] Create /var/run/mandos directory with perm and ownership
123
165
 
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.
 
166
* Package
129
167
** /etc/bash_completion.d/mandos
130
 
   From XML sources directly?
131
 
** unperish
132
 
** bzr-builddeb
133
168
 
134
169
* INSTALL file
135
170