/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

updated some partial manual pages

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