/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to TODO

  • Committer: Teddy Hogeborn
  • Date: 2008-08-18 23:55:28 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818235528-dn628nlbrtzl7z4f
* Makefile: Bug fix: fixed creation of man pages for section 5 pages.

* mandos (main): Changed from requiring "[server]" in mandos.conf(5)
                 to requiring "[DEFAULT]".

* mandos.conf ([server]): Renamed to "[DEFAULT]".

* mandos.conf.xml: Removed <?xml-stylesheet>.  New entity "&OVERVIEW;"
                   referring to "overview.xml".
  (DESCRIPTION): Updated to specify the syntax more precisely.  Use
                 <varname> around the option names.

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