/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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-19 23:44:17 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080819234417-8dz5prw19ihrklx6
* Makefile (DOCBOOKTOMAN): Include all DocBook-to-manpage-related
                           commands here, and use it everywhere.
  (mandos.8, mandos.conf.5): New; also depend on "mandos-options.xml".

* mandos-keygen.xml: Removed OVERVIEW entity.  Add XInclude namespace.
  (OVERVIEW): Changed to do <xi:include/>.

* mandos-options.xml (<simplesect>): Changed to a <section>.
  ([@id="address"]): Reordered sentences.

* mandos.conf.xml (OPTIONS): Removed illegal <arg> tags.
  (EXAMPLE): Added empty example.

* mandos.xml (NETWORK PROTOCOL): Bug fix: Changed "1\r\en" back to
                                 "1\r\n".
  (CHECKING): Do not refer to the non-relevant mandos.conf(5) manual.

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