/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

Added manual pages for:
      clients.conf
      mandos.conf
      mandos
      mandos-client
      password-prompt
      password-request

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
1
1
-*- org -*-
2
2
 
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
 
3
* README file
 
4
 
 
5
* COPYING file
 
6
  [[file:/usr/share/common-licenses/GPL-3][GPLv3]]
 
7
 
 
8
* Mandos-client
 
9
** [#A] Man page: man8/mandos-client.8mandos
 
10
** [#A] check return codes of all system calls
 
11
** [#B] header files/symbols tally
 
12
** use strsep instead of strtok?
 
13
** use config file in addition to arguments
 
14
** pass things in environment, like device name, etc
29
15
 
30
16
* Password-request
31
17
** [#A] Man page: man8/password-request.8mandos
32
 
** [#B] Temporarily lower kernel log level
33
 
   for less printouts during sucessfull boot.
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".
 
18
** [#A] check return codes of all system calls
 
19
** [#B] header files/symbols tally
59
20
** IPv4 support
60
21
** 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.
 
22
** Do not depend on GPG key rings on disk
 
23
   This would mean creating new GPG key rings with GPGME by importing
 
24
   the key files from scratch on every program start.
64
25
 
65
26
* Password-prompt
66
27
** [#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
28
** 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?]]
 
29
   [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
91
30
 
92
 
* Mandos (server)
 
31
* Server
93
32
** [#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
33
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
115
34
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
116
 
** [#A] /etc/init.d/mandos-server               :teddy:
 
35
** [#A] write PID file
 
36
** [#A] /etc/init.d/mandos-server
 
37
** Better comments in config files
117
38
** Log level
118
39
** /etc/mandos/clients.d/*.conf
119
40
   Watch this directory and add/remove/update clients?
120
41
** config for TXT record
121
42
** Run-time communication with server
122
 
   Probably using D-Bus
123
 
   See also [[*Mandos-tools]]
 
43
   probably using D-Bus
124
44
** Implement --foreground
125
45
   [[info:standards:Option%20Table][Table of Long Options]]
126
46
** Implement --socket
127
47
   [[info:standards:Option%20Table][Table of Long Options]]
128
 
** Date+time on console log messages
129
 
   Is this the default?
130
48
 
131
49
* Mandos-tools/utilities
132
50
  All of this probably using D-Bus
133
51
** List clients
 
52
** Enable client
134
53
** Disable client
135
 
** Enable client
136
54
 
137
55
* Installer
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
146
 
 
147
 
** mandos-keygen
148
 
*** [#A] Command man page: man8/mandos-keygen.8
149
 
*** [#A] Output cut-and-paste ready snippet for clients.conf.
150
 
 
151
 
* [#A] Package
152
 
** /usr/share/initramfs-tools/hooks/mandos
153
 
*** Do not install in initrd.img if configured not to
154
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
155
 
    question.
156
 
** /etc/bash_completion.d/mandos
157
 
*** From xml sources directly?
158
 
** unperish
159
 
** bzr-builddeb
160
 
 
161
 
* INSTALL file
162
 
 
163
 
* Web site
164
 
 
165
 
* Mailing list
166
 
 
167
 
* Announce project on news
168
 
  [[news:comp.os.linux.announce]]
 
56
** [#A] Change initrd.img file to not be publically readable
 
57
** [#A] Create GPG key ring files in initrd
169
58
 
170
59
 
171
60
#+STARTUP: showall