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
6
[[file:/usr/share/common-licenses/GPL-3][GPLv3]]
9
** [#A] Man page: man8/mandos-client.8mandos
11
Needs options listed, not just "[OPTION...]"
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
12
Environment is modified according to options and passed to plugins
21
Describe the plus sign syntax for passing options from crypttab
14
23
Examples of normal usage, debug usage, debugging single or all
24
plugins, examples of crypttab lines with plus syntax, etc.
26
Describe plugin directory
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).
32
Create this section (if needed)
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
43
As a fallback, if no plugins can be found or if all of them failed,
44
run getpass(3) itself.
27
47
** [#A] Man page: man8/password-request.8mandos
29
Document short options
49
Needs options listed, not just "[OPTION...]"
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.
40
Note that it does *not* currently use cryptsource or crypttarget.
58
Examples of normal usage, debug usage, debugging by connecting
42
61
Describe the key files and the key ring files. Also note that
43
62
they should normally have been automatically created.
68
Create this section (if needed)
46
Examples of normal usage, debug usage, debugging by connecting
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]]
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.
62
** [#C] Use getpass(3)?
83
** [#A] Man page: man8/password-prompt.8mandos
85
Needs options listed, not just "[OPTION...]"
87
Move options to new OPTIONS section.
91
Examples of normal usage, debug usage, with a prefix, etc.
96
Not much to do here but it is noteworthy to state the danger of
97
not having a fallback option.
99
Note that this is more or less a simple getpass(3) wrapper, even
100
though actual use of getpass(3) is not guaranteed.
104
Refer to mandos-client(8mandos) and password-request(8mandos)
63
106
Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
64
107
does not. See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
65
108
[[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
66
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?]]
112
** [#A] Command man page: man8/mandos.8
114
Needs options listed, not just "[OPTION...]"
116
Move options to new OPTIONS section
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.
130
Create this section (if needed)
134
Refer to the client man page
135
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
136
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
69
137
** [#A] /etc/init.d/mandos-server :teddy:
70
** [#B] Log level :bugs:
71
139
** /etc/mandos/clients.d/*.conf
72
140
Watch this directory and add/remove/update clients?
73
141
** config for TXT record
74
** [#B] Run-time communication with server :bugs:
142
** Run-time communication with server
75
143
Probably using D-Bus
76
144
See also [[*Mandos-tools]]
77
** Implement --foreground :bugs:
145
** Implement --foreground
78
146
[[info:standards:Option%20Table][Table of Long Options]]
79
147
** Implement --socket
80
148
[[info:standards:Option%20Table][Table of Long Options]]
81
** Date+time on console log messages :bugs:
84
150
* Mandos-tools/utilities
85
151
All of this probably using D-Bus
92
Go through all man pages to conform to the style of tags chosen in
93
[[http://svn.debian.org/wsvn/debian-xml-sgml/packages/docbook-xsl/trunk/debian/examples/foo.1.example_manpage.xml?op=file&rev=0&sc=0][foo.1.example_manpage.xml]]. In particular:
94
*** Synopsis <arg> and <option> tags
95
** Use xinclude for common sections
96
Like copyright, authors, etc.
101
*** Update initrd.img after installation
102
This seems to use some kind of "trigger" system
103
[[file:/usr/share/doc/dpkg/triggers.txt.gz]]
104
dpkg-trigger(1), deb-triggers(5)
105
*** Keydir move: /etc/mandos -> /etc/keys/mandos
106
Must create in preinst if not pre-depending on cryptsetup
108
**** "--passfile" option
109
Using the "secfile" option instead of "secret"
110
**** [#A] "--test" option
111
For testing decryption before rebooting.
113
*** [#A] Create mandos user and group for server
114
*** [#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
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
117
** /usr/share/initramfs-tools/hooks/mandos
118
*** Do not install in initrd.img if configured not to.
119
Use "/etc/initramfs-tools/conf.d/mandos"? Definitely a debconf
121
165
** /etc/bash_completion.d/mandos
122
From XML sources directly?
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