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