/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 05:24:20 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080818052420-ab5eurrioz8n2qy6
* Makefile: Bug fix: fixed creation of man pages in "plugins.d".

* mandos-keygen Bug fix: make the --expire option modify
                KEYEXPIRE, not KEYCOMMENT.  Use the "--no-options"
                option to gpg when exporting keys from the temporary
                key ring files.

* mandos-keygen.xml (EXIT STATUS): Filled in.
  (ENVIRONMENT): New section, documenting use of TMPDIR.
  (FILES): Document use of key files and /tmp.
  (BUGS): Filled in.
  (EXAMPLE): Added two examples.
  (SECURITY): Added some text.

* plugins.d/password-prompt.xml (NOTES): Removed, since this is
                                         created automatically for
                                         footnotes.
  (ENVIRONMENT, FILES): Added empty sections.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

* plugins.d/password-request.xml: Reordered sections.
  (ENVIRONMENT): New empty section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).

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