/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-17 06:17:10 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080817061710-epkw87paysoo9g7w
* mandos-keygen.xml (NOTES): Removed section, since it is
                             automatically created for footnotes.

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