/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

merge

Show diffs side-by-side

added added

removed removed

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