/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
** [#A] Man page: man8/plugin-runner.8mandos
 
10
*** DESCRIPTION
 
11
    Describe the plus sign syntax for passing options from crypttab
 
12
*** EXIT STATUS
 
13
    Text needed
 
14
*** EXAMPLES
 
15
    Examples of normal usage, debug usage, debugging single or all
 
16
    plugins, examples of crypttab lines with plus syntax, etc.
 
17
*** FILES
 
18
    Text needed
 
19
*** SECURITY
 
20
    Text needed
 
21
*** NOTES
 
22
    Text needed
 
23
*** BUGS
 
24
    Text needed
 
25
*** SEE ALSO
 
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
9
29
 
10
 
* password-request
 
30
* Password-request
11
31
** [#A] Man page: man8/password-request.8mandos
 
32
** [#B] Temporarily lower kernel log level
 
33
   for less printouts during sucessfull boot.
12
34
*** DESCRIPTION
 
35
    Move options to new OPTIONS section.
13
36
    State that this command is not meant to be invoked directly, but
14
37
    is run as a plugin from mandos-client(8) and only run in the
15
38
    initrd environment, not the real system.
16
 
*** PURPOSE
17
 
    As in mandos.xml
18
 
*** OVERVIEW
19
 
    As in mandos.xml
20
39
*** EXIT STATUS
21
 
*** ENVIRONMENT
22
 
    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.
23
44
*** FILES
24
45
    Describe the key files and the key ring files.  Also note that
25
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)
26
53
*** BUGS
27
 
*** EXAMPLE
28
 
    Examples of normal usage, debug usage, debugging by connecting
29
 
    directly, etc.
30
 
*** SECURITY
 
54
    Create this section
31
55
*** SEE ALSO
32
 
    Update from mandos.xml
33
 
** [#B] Temporarily lower kernel log level
34
 
   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".
35
59
** IPv4 support
36
60
** use strsep instead of strtok?
37
61
** Do not depend on GnuPG key rings on disk
38
62
   This would mean creating new GnuPG key rings with GPGME by
39
63
   importing the key files from scratch on every program start.
40
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
41
 
   Must create in preinst if not pre-depending on cryptsetup
42
64
 
43
 
* password-prompt
44
 
** [#C] Use getpass(3)?
 
65
* Password-prompt
 
66
** [#A] Man page: man8/password-prompt.8mandos
 
67
*** DESCRIPTION
 
68
    Move options to new OPTIONS section.
 
69
*** EXIT STATUS
 
70
    Create this section
 
71
*** EXAMPLES
 
72
    Examples of normal usage, debug usage, with a prefix, etc.
 
73
*** DIAGNOSTICS
 
74
    Create this section
 
75
*** SECURITY
 
76
    Create this section
 
77
    Not much to do here but it is noteworthy to state the danger of
 
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
 
84
*** SEE ALSO
 
85
    Refer to mandos-client(8mandos) and password-request(8mandos)
 
86
** Use getpass(3)?
45
87
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
46
88
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
47
89
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
48
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?]]
49
91
 
50
 
* 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)
51
116
** [#A] /etc/init.d/mandos-server               :teddy:
52
 
** [#B] Log level                               :bugs:
 
117
** Log level
53
118
** /etc/mandos/clients.d/*.conf
54
119
   Watch this directory and add/remove/update clients?
55
120
** config for TXT record
56
 
** [#B] Run-time communication with server      :bugs:
 
121
** Run-time communication with server
57
122
   Probably using D-Bus
58
123
   See also [[*Mandos-tools]]
59
 
** Implement --foreground                       :bugs:
 
124
** Implement --foreground
60
125
   [[info:standards:Option%20Table][Table of Long Options]]
61
126
** Implement --socket
62
127
   [[info:standards:Option%20Table][Table of Long Options]]
63
 
** Date+time on console log messages            :bugs:
 
128
** Date+time on console log messages
64
129
   Is this the default?
65
130
 
66
131
* Mandos-tools/utilities
69
134
** Disable client
70
135
** Enable client
71
136
 
72
 
* Man pages
73
 
** Use xinclude for common sections
74
 
   Like authors, etc.
75
 
 
76
 
 
77
137
* Installer
78
 
** 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
79
142
*** Update initrd.img after installation
80
 
    This seems to use some kind of "trigger" system
81
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
82
 
    dpkg-trigger(1), deb-triggers(5)
83
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
84
 
    Must create in preinst if not pre-depending on cryptsetup
85
 
*** mandos-keygen
86
 
**** "--passfile" option
87
 
     Using the "secfile" option instead of "secret"
88
 
**** [#A] "--test" option
89
 
     For testing decryption before rebooting.
90
 
** Server-side
 
143
** Server
91
144
*** [#A] Create mandos user and group for server
92
145
*** [#A] Create /var/run/mandos directory with perm and ownership
93
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
 
94
151
* [#A] Package
95
152
** /usr/share/initramfs-tools/hooks/mandos
96
 
*** Do not install in initrd.img if configured not to.
 
153
*** Do not install in initrd.img if configured not to
97
154
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
98
155
    question.
99
156
** /etc/bash_completion.d/mandos
100
 
   From XML sources directly?
 
157
*** From xml sources directly?
101
158
** unperish
102
159
** bzr-builddeb
103
160