/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
    Create this section
 
12
*** USAGE
 
13
    Describe the plus sign syntax for passing options from crypttab
11
14
*** EXAMPLES
12
15
    Examples of normal usage, debug usage, debugging single or all
13
 
    plugins, etc.
 
16
    plugins, examples of crypttab lines with plus syntax, etc.
14
17
*** FILES
 
18
    Describe plugin directory
 
19
*** DIAGNOSTICS
 
20
    Create this section
15
21
*** 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).
 
22
    Create this section
 
23
*** NOTES
 
24
    Create this section (if needed)
20
25
*** BUGS
 
26
    Create this section
21
27
*** SEE ALSO
22
 
    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.
23
37
 
24
 
* password-request
 
38
* Password-request
25
39
** [#A] Man page: man8/password-request.8mandos
26
 
*** SYNOPSIS
27
 
    Document short options
28
40
*** DESCRIPTION
 
41
    Move options to new OPTIONS section.
29
42
    State that this command is not meant to be invoked directly, but
30
43
    is run as a plugin from mandos-client(8) and only run in the
31
44
    initrd environment, not the real system.
32
 
*** PURPOSE
33
 
    As in mandos.xml
34
 
*** OVERVIEW
35
 
    As in mandos.xml
36
45
*** EXIT STATUS
37
 
*** ENVIRONMENT
38
 
    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.
39
50
*** FILES
40
51
    Describe the key files and the key ring files.  Also note that
41
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)
42
59
*** BUGS
43
 
*** EXAMPLE
44
 
    Examples of normal usage, debug usage, debugging by connecting
45
 
    directly, etc.
46
 
*** SECURITY
 
60
    Create this section
47
61
*** SEE ALSO
48
 
    Update from mandos.xml
49
 
** [#B] Temporarily lower kernel log level
50
 
   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]]
51
66
** IPv4 support
52
67
** 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
 
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.
58
71
 
59
 
* password-prompt
 
72
* Password-prompt
60
73
** [#A] Man page: man8/password-prompt.8mandos
61
 
*** SYNOPSIS
62
 
    Document short options
63
74
*** 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.
 
75
    Move options to new OPTIONS section.
66
76
*** EXIT STATUS
67
 
*** ENVIRONMENT
68
 
    Document use of "cryptsource" and "crypttarget".
69
 
*** FILES
70
 
*** BUGS
71
 
*** EXAMPLE
 
77
    Create this section
 
78
*** EXAMPLES
72
79
    Examples of normal usage, debug usage, with a prefix, etc.
 
80
*** DIAGNOSTICS
 
81
    Create this section
73
82
*** SECURITY
 
83
    Create this section
74
84
    Not much to do here but it is noteworthy to state the danger of
75
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
76
91
*** SEE ALSO
77
92
    Refer to mandos-client(8mandos) and password-request(8mandos)
78
 
    and also, perhaps, to cryptsetup(8)?
79
93
** Use getpass(3)?
80
94
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
81
95
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
82
96
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
83
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?]]
84
98
 
85
 
* 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)
86
122
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
87
 
*** For option "secret", document which program can help generate it.
88
123
** [#A] /etc/init.d/mandos-server               :teddy:
89
 
** [#B] Log level                               :bugs:
 
124
** Log level
90
125
** /etc/mandos/clients.d/*.conf
91
126
   Watch this directory and add/remove/update clients?
92
127
** config for TXT record
93
 
** [#B] Run-time communication with server      :bugs:
 
128
** Run-time communication with server
94
129
   Probably using D-Bus
95
130
   See also [[*Mandos-tools]]
96
 
** Implement --foreground                       :bugs:
 
131
** Implement --foreground
97
132
   [[info:standards:Option%20Table][Table of Long Options]]
98
133
** Implement --socket
99
134
   [[info:standards:Option%20Table][Table of Long Options]]
100
 
** Date+time on console log messages            :bugs:
101
 
   Is this the default?
102
135
 
103
136
* Mandos-tools/utilities
104
137
  All of this probably using D-Bus
107
140
** Enable client
108
141
 
109
142
* 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
 
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
120
149
 
121
150
* [#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
151
** /etc/bash_completion.d/mandos
127
 
   From XML sources directly?
128
 
** unperish
129
 
** 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
130
155
 
131
156
* INSTALL file
132
157