/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

Added all sections needed for mandos-client manual page

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
10
*** EXIT STATUS
11
 
*** ENVIRONMENT
12
 
    Environment is modified according to options and passed to plugins
13
 
*** EXAMPLE
 
11
    Create this section
 
12
*** USAGE
 
13
    Describe the plus sign syntax for passing options from crypttab
 
14
*** EXAMPLES
14
15
    Examples of normal usage, debug usage, debugging single or all
15
 
    plugins, etc.
 
16
    plugins, examples of crypttab lines with plus syntax, etc.
16
17
*** FILES
 
18
    Describe plugin directory
 
19
*** DIAGNOSTICS
 
20
    Create this section
17
21
*** 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).
 
22
    Create this section
 
23
*** NOTES
 
24
    Create this section (if needed)
22
25
*** BUGS
 
26
    Create this section
23
27
*** SEE ALSO
24
 
    Explaining text on what you can read
 
28
    Refer to mandos(8), password-request(8mandos), and
 
29
    password-prompt(8mandos)
 
30
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
 
31
** use strsep instead of strtok?
 
32
** use config file in addition to arguments
 
33
** pass things in environment, like device name, etc
 
34
** Fallback
 
35
   As a fallback, if no plugins can be found or if all of them failed,
 
36
   run getpass(3) itself.
25
37
 
26
 
* password-request
 
38
* Password-request
27
39
** [#A] Man page: man8/password-request.8mandos
28
 
*** SYNOPSIS
29
 
    Document short options
30
40
*** DESCRIPTION
 
41
    Move options to new OPTIONS section.
31
42
    State that this command is not meant to be invoked directly, but
32
43
    is run as a plugin from mandos-client(8) and only run in the
33
44
    initrd environment, not the real system.
34
 
*** PURPOSE
35
 
    As in mandos.xml
36
 
*** OVERVIEW
37
 
    As in mandos.xml
38
45
*** EXIT STATUS
39
 
*** ENVIRONMENT
40
 
    Note that it does *not* currently use cryptsource or crypttarget.
 
46
    Create this section
 
47
*** EXAMPLES
 
48
    Examples of normal usage, debug usage, debugging by connecting
 
49
    directly, etc.
41
50
*** FILES
42
51
    Describe the key files and the key ring files.  Also note that
43
52
    they should normally have been automatically created.
 
53
*** DIAGNOSTICS
 
54
    Create this section
 
55
*** SECURITY
 
56
    Create this section
 
57
*** NOTES
 
58
    Create this section (if needed)
44
59
*** BUGS
45
 
*** EXAMPLE
46
 
    Examples of normal usage, debug usage, debugging by connecting
47
 
    directly, etc.
48
 
*** SECURITY
 
60
    Create this section
49
61
*** SEE ALSO
50
 
    Update from mandos.xml
51
 
** [#B] Temporarily lower kernel log level
52
 
   for less printouts during sucessfull boot.
 
62
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
 
63
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
 
64
** start_mandos_communication: loop around gnutls_handshake
 
65
   [[info:gnutls.info.gz:Core%20functions][gnutls_handshake]]
53
66
** IPv4 support
54
67
** 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
 
68
** Do not depend on GPG key rings on disk
 
69
   This would mean creating new GPG key rings with GPGME by importing
 
70
   the key files from scratch on every program start.
60
71
 
61
 
* password-prompt
 
72
* Password-prompt
62
73
** [#A] Man page: man8/password-prompt.8mandos
63
 
*** SYNOPSIS
64
 
    Document short options
65
74
*** 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.
 
75
    Move options to new OPTIONS section.
68
76
*** EXIT STATUS
69
 
*** ENVIRONMENT
70
 
    Document use of "cryptsource" and "crypttarget".
71
 
*** FILES
72
 
*** BUGS
73
 
*** EXAMPLE
 
77
    Create this section
 
78
*** EXAMPLES
74
79
    Examples of normal usage, debug usage, with a prefix, etc.
 
80
*** DIAGNOSTICS
 
81
    Create this section
75
82
*** SECURITY
 
83
    Create this section
76
84
    Not much to do here but it is noteworthy to state the danger of
77
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
78
91
*** SEE ALSO
79
92
    Refer to mandos-client(8mandos) and password-request(8mandos)
80
 
    and also, perhaps, to cryptsetup(8)?
81
93
** Use getpass(3)?
82
94
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
83
95
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
84
96
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
85
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?]]
86
98
 
87
 
* mandos (server)
 
99
* Mandos (server)
 
100
** [#A] Command man page: man8/mandos.8
 
101
*** DESCRIPTION
 
102
    Move options to new OPTIONS section
 
103
*** EXIT STATUS
 
104
    Create this section
 
105
*** EXAMPLES
 
106
    Create this section
 
107
*** FILES
 
108
    Describe briefly that the server gets global settings from
 
109
    mandos.conf and clients from clients.conf, but refer to their man
 
110
    pages for more details.
 
111
*** DIAGNOSTICS
 
112
    Create this section
 
113
*** SECURITY
 
114
    Create this section
 
115
*** NOTES
 
116
    Create this section (if needed)
 
117
*** BUGS
 
118
    Create this section
 
119
*** SEE ALSO
 
120
    Refer to the client man page
 
121
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
88
122
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
89
 
*** For option "secret", document which program can help generate it.
90
123
** [#A] /etc/init.d/mandos-server               :teddy:
91
 
** [#B] Log level                               :bugs:
 
124
** Log level
92
125
** /etc/mandos/clients.d/*.conf
93
126
   Watch this directory and add/remove/update clients?
94
127
** config for TXT record
95
 
** [#B] Run-time communication with server      :bugs:
 
128
** Run-time communication with server
96
129
   Probably using D-Bus
97
130
   See also [[*Mandos-tools]]
98
 
** Implement --foreground                       :bugs:
 
131
** Implement --foreground
99
132
   [[info:standards:Option%20Table][Table of Long Options]]
100
133
** Implement --socket
101
134
   [[info:standards:Option%20Table][Table of Long Options]]
102
 
** Date+time on console log messages            :bugs:
103
 
   Is this the default?
104
135
 
105
136
* Mandos-tools/utilities
106
137
  All of this probably using D-Bus
109
140
** Enable client
110
141
 
111
142
* Installer
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
 
143
** DONE [#A] Change initrd.img file to not be publically readable
 
144
   /etc/initramfs-tools/conf.d/mandos
 
145
   UMASK=027
 
146
** Update initrd.img after installation
 
147
** [#A] Create mandos user and group for server
 
148
** [#A] Create /var/run/mandos directory with perm and ownership
123
149
 
124
150
* [#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.
129
151
** /etc/bash_completion.d/mandos
130
 
   From XML sources directly?
131
 
** unperish
132
 
** bzr-builddeb
 
152
** /etc/initramfs-tools/hooks/mandos
 
153
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
 
154
*** Create GPG key ring files in initrd
133
155
 
134
156
* INSTALL file
135
157