/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

version 1.0

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