/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: Björn Påhlsson
  • Date: 2008-08-16 20:31:21 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 80.
  • Revision ID: belorn@braxen-20080816203121-u3uavdi14y1xjj0b
updated some partial manual pages

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
-*- org -*-
2
2
 
3
 
* plugin-runner
4
 
** TODO Man page  for plugin-runner.conf.5
5
 
   link to plugin-runner.8
6
 
 
7
 
* mandos-client
8
 
** TODO [#B] Temporarily lower kernel log level
 
3
* [#A] README file
 
4
 
 
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
*** DESCRIPTION
 
11
    Describe the plus sign syntax for passing options from crypttab
 
12
*** EXIT STATUS
 
13
    Text needed
 
14
*** EXAMPLES
 
15
    Examples of normal usage, debug usage, debugging single or all
 
16
    plugins, examples of crypttab lines with plus syntax, etc.
 
17
*** FILES
 
18
    Text needed
 
19
*** SECURITY
 
20
    Text needed
 
21
*** NOTES
 
22
    Text needed
 
23
*** BUGS
 
24
    Text needed
 
25
*** SEE ALSO
 
26
    Explaining test on what you can read
 
27
** Keydir move: /etc/mandos -> /etc/keys/mandos
 
28
   Must create in preinst if not pre-depending on cryptsetup
 
29
 
 
30
* Password-request
 
31
** [#A] Man page: man8/password-request.8mandos
 
32
** [#B] Temporarily lower kernel log level
9
33
   for less printouts during sucessfull boot.
10
 
** TODO [#C] IPv4 support
11
 
 
12
 
* DONE password-prompt
13
 
 
14
 
* mandos (server)
15
 
** TODO [#B] Log level                          :bugs:
16
 
** TODO /etc/mandos/clients.d/*.conf
 
34
*** DESCRIPTION
 
35
    Move options to new OPTIONS section.
 
36
    State that this command is not meant to be invoked directly, but
 
37
    is run as a plugin from mandos-client(8) and only run in the
 
38
    initrd environment, not the real system.
 
39
*** EXIT STATUS
 
40
    Create this section
 
41
*** EXAMPLES
 
42
    Examples of normal usage, debug usage, debugging by connecting
 
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
*** SECURITY
 
50
    Create this section
 
51
*** NOTES
 
52
    Create this section (if needed)
 
53
*** BUGS
 
54
    Create this section
 
55
*** SEE ALSO
 
56
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
 
57
*** ENVIRONMENT
 
58
    Document use of "cryptsource" and "crypttarget".
 
59
** IPv4 support
 
60
** use strsep instead of strtok?
 
61
** Do not depend on GnuPG key rings on disk
 
62
   This would mean creating new GnuPG key rings with GPGME by
 
63
   importing the key files from scratch on every program start.
 
64
 
 
65
* Password-prompt
 
66
** [#A] Man page: man8/password-prompt.8mandos
 
67
*** DESCRIPTION
 
68
    Move options to new OPTIONS section.
 
69
*** EXIT STATUS
 
70
    Create this section
 
71
*** EXAMPLES
 
72
    Examples of normal usage, debug usage, with a prefix, etc.
 
73
*** DIAGNOSTICS
 
74
    Create this section
 
75
*** SECURITY
 
76
    Create this section
 
77
    Not much to do here but it is noteworthy to state the danger of
 
78
    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
*** SEE ALSO
 
85
    Refer to mandos-client(8mandos) and password-request(8mandos)
 
86
** Use getpass(3)?
 
87
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
 
88
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
 
89
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
 
90
   [[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
 
 
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
 
114
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
 
115
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
 
116
** [#A] /etc/init.d/mandos-server               :teddy:
 
117
** Log level
 
118
** /etc/mandos/clients.d/*.conf
17
119
   Watch this directory and add/remove/update clients?
18
 
** TODO config for TXT record
19
 
** TODO [#B] Run-time communication with server :bugs:
 
120
** config for TXT record
 
121
** Run-time communication with server
20
122
   Probably using D-Bus
21
123
   See also [[*Mandos-tools]]
22
 
** TODO Implement --foreground                  :bugs:
23
 
   [[info:standards:Option%20Table][Table of Long Options]]
24
 
** TODO Implement --socket
25
 
   [[info:standards:Option%20Table][Table of Long Options]]
26
 
** TODO Date+time on console log messages       :bugs:
 
124
** Implement --foreground
 
125
   [[info:standards:Option%20Table][Table of Long Options]]
 
126
** Implement --socket
 
127
   [[info:standards:Option%20Table][Table of Long Options]]
 
128
** Date+time on console log messages
27
129
   Is this the default?
28
 
** TODO delete hook when clients fall out by timeout
29
130
 
30
131
* Mandos-tools/utilities
31
132
  All of this probably using D-Bus
32
 
** TODO List clients
33
 
** TODO Disable client
34
 
** TODO Enable client
35
 
** TODO Reset timer
36
 
 
37
 
* Man pages
38
 
** TODO Use xinclude for all common sections
39
 
   Like authors, etc.
40
 
 
 
133
** List clients
 
134
** Disable client
 
135
** Enable client
41
136
 
42
137
* Installer
43
 
** Client-side
44
 
*** TODO Update initrd.img after installation
45
 
    This seems to use some kind of "trigger" system
46
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
47
 
    dpkg-trigger(1), deb-triggers(5)
48
 
*** mandos-keygen
49
 
**** TODO [#A] Ask for password twice for confirmation
50
 
**** TODO "--passfile" option
51
 
     Using the "secfile" option instead of "secret"
52
 
**** TODO [#B] "--test" option
53
 
     For testing decryption before rebooting.
54
 
** Server-side
55
 
*** TODO [#A] Create mandos user and group for server
 
138
** 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
*** Update initrd.img after installation
 
143
** Server
 
144
*** [#A] Create mandos user and group for server
 
145
*** [#A] Create /var/run/mandos directory with perm and ownership
56
146
 
 
147
** mandos-keygen
 
148
*** [#A] Command man page: man8/mandos-keygen.8
 
149
*** [#A] Output cut-and-paste ready snippet for clients.conf.
57
150
 
58
151
* [#A] Package
59
152
** /usr/share/initramfs-tools/hooks/mandos
60
 
*** TODO Do not install in initrd.img if configured not to.
 
153
*** Do not install in initrd.img if configured not to
61
154
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
62
155
    question.
63
 
** TODO /etc/bash_completion.d/mandos
64
 
   From XML sources directly?
65
 
** TODO unperish
66
 
** DONE bzr-builddeb
67
 
** TODO mandos user/group creation
68
 
** TODO Key creation in postinst
69
 
 
70
 
* TODO Web site
71
 
** DONE http://www.fukt.bsnet.se/mandos
72
 
   Redirects to the wiki page
73
 
** TODO http://wiki.fukt.bsnet.se/wiki/Mandos
 
156
** /etc/bash_completion.d/mandos
 
157
*** From xml sources directly?
 
158
** unperish
 
159
** bzr-builddeb
 
160
 
 
161
* INSTALL file
 
162
 
 
163
* Web site
74
164
 
75
165
* Mailing list
76
 
** DONE mandos-dev
77
 
*** TODO http://gmane.org/subscribe.php
78
166
 
79
 
* TODO Announce project on Usenet
 
167
* Announce project on news
80
168
  [[news:comp.os.linux.announce]]
81
169
 
82
170