/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

merge

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