/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-08 01:31:58 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 50.
  • Revision ID: belorn@braxen-20080808013158-weqgqkxni7du1ke5
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
 
3
* README file
4
4
 
5
 
* [#A] COPYING file
 
5
* COPYING file
6
6
  [[file:/usr/share/common-licenses/GPL-3][GPLv3]]
7
7
 
8
8
* Mandos-client
9
 
** [#A] Change syntax for arguments
10
9
** [#A] Man page: man8/mandos-client.8mandos
11
 
*** DESCRIPTION
12
 
    Describe the plus sign syntax for passing options from crypttab
13
 
*** EXIT STATUS
14
 
    Text needed
15
 
*** EXAMPLES
16
 
    Examples of normal usage, debug usage, debugging single or all
17
 
    plugins, examples of crypttab lines with plus syntax, etc.
18
 
*** FILES
19
 
    Text needed
20
 
*** SECURITY
21
 
    Text needed
22
 
*** NOTES
23
 
    Text needed
24
 
*** BUGS
25
 
    Text needed
26
 
*** SEE ALSO
27
 
    Explaining test on what you can read
28
 
** Use asprintf instead of malloc and strcat?
 
10
** [#A] check return codes of all system calls
 
11
** [#B] header files/symbols tally
29
12
** use strsep instead of strtok?
30
13
** use config file in addition to arguments
31
14
** pass things in environment, like device name, etc
32
15
 
33
16
* Password-request
34
17
** [#A] Man page: man8/password-request.8mandos
35
 
** [#B] Temporarily lower kernel log level
36
 
   for less printouts during sucessfull boot.
37
 
*** DESCRIPTION
38
 
    Move options to new OPTIONS section.
39
 
    State that this command is not meant to be invoked directly, but
40
 
    is run as a plugin from mandos-client(8) and only run in the
41
 
    initrd environment, not the real system.
42
 
*** EXIT STATUS
43
 
    Create this section
44
 
*** EXAMPLES
45
 
    Examples of normal usage, debug usage, debugging by connecting
46
 
    directly, etc.
47
 
*** FILES
48
 
    Describe the key files and the key ring files.  Also note that
49
 
    they should normally have been automatically created.
50
 
*** DIAGNOSTICS
51
 
    Create this section
52
 
*** SECURITY
53
 
    Create this section
54
 
*** NOTES
55
 
    Create this section (if needed)
56
 
*** BUGS
57
 
    Create this section
58
 
*** SEE ALSO
59
 
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
60
 
** Use asprintf instead of malloc and memcpy?
 
18
** [#A] check return codes of all system calls
 
19
** [#B] header files/symbols tally
61
20
** IPv4 support
62
21
** use strsep instead of strtok?
63
22
** Do not depend on GPG key rings on disk
66
25
 
67
26
* Password-prompt
68
27
** [#A] Man page: man8/password-prompt.8mandos
69
 
*** DESCRIPTION
70
 
    Move options to new OPTIONS section.
71
 
*** EXIT STATUS
72
 
    Create this section
73
 
*** EXAMPLES
74
 
    Examples of normal usage, debug usage, with a prefix, etc.
75
 
*** DIAGNOSTICS
76
 
    Create this section
77
 
*** SECURITY
78
 
    Create this section
79
 
    Not much to do here but it is noteworthy to state the danger of
80
 
    not having a fallback option.
81
 
*** NOTES
82
 
    Note that this is more or less a simple getpass(3) wrapper, even
83
 
    though actual use of getpass(3) is not guaranteed.
84
 
*** BUGS
85
 
    Create this section
86
 
*** SEE ALSO
87
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
88
28
** Use getpass(3)?
89
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
90
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
91
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
92
 
   [[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?]]
93
 
** Replace completely with "/lib/cryptsetup/askpass"?
 
29
   [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
94
30
 
95
 
* Mandos (server)
 
31
* Server
96
32
** [#A] Command man page: man8/mandos.8
97
 
*** DESCRIPTION
98
 
    Move options to new OPTIONS section
99
 
*** EXIT STATUS
100
 
    Create this section
101
 
*** EXAMPLES
102
 
    Create this section
103
 
*** FILES
104
 
    Describe briefly that the server gets global settings from
105
 
    mandos.conf and clients from clients.conf, but refer to their man
106
 
    pages for more details.
107
 
*** DIAGNOSTICS
108
 
    Create this section
109
 
*** SECURITY
110
 
    Create this section
111
 
*** NOTES
112
 
    Create this section (if needed)
113
 
*** BUGS
114
 
    Create this section
115
 
*** SEE ALSO
116
 
    Refer to the client man page
117
33
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
118
34
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
119
 
** [#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
120
38
** Log level
121
39
** /etc/mandos/clients.d/*.conf
122
40
   Watch this directory and add/remove/update clients?
123
41
** config for TXT record
124
42
** Run-time communication with server
125
 
   Probably using D-Bus
126
 
   See also [[*Mandos-tools]]
 
43
   probably using D-Bus
127
44
** Implement --foreground
128
45
   [[info:standards:Option%20Table][Table of Long Options]]
129
46
** Implement --socket
130
47
   [[info:standards:Option%20Table][Table of Long Options]]
131
 
** Date+time on console log messages
132
 
   Is this the default?
133
48
 
134
49
* Mandos-tools/utilities
135
50
  All of this probably using D-Bus
136
51
** List clients
 
52
** Enable client
137
53
** Disable client
138
 
** Enable client
139
54
 
140
55
* Installer
141
 
** Client
142
 
*** DONE [#A] Change initrd.img file to not be publically readable
143
 
    /usr/share/initramfs-tools/conf-hooks.d/mandos
144
 
    UMASK=027
145
 
*** Update initrd.img after installation
146
 
** Server
147
 
*** [#A] Create mandos user and group for server
148
 
*** [#A] Create /var/run/mandos directory with perm and ownership
149
 
 
150
 
** mandos-keygen
151
 
*** [#A] Command man page: man8/mandos-keygen.8
152
 
*** [#A] Output cut-and-paste ready snippet for clients.conf.
153
 
 
154
 
* [#A] Package
155
 
** /usr/share/initramfs-tools/hooks/mandos
156
 
*** Do not install in initrd.img if configured not to
157
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
158
 
    question.
159
 
** /etc/bash_completion.d/mandos
160
 
*** From xml sources directly?
161
 
** unperish
162
 
** bzr-builddeb
163
 
 
164
 
* INSTALL file
165
 
 
166
 
* Web site
167
 
 
168
 
* Mailing list
169
 
 
170
 
* Announce project on news
171
 
  [[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
172
58
 
173
59
 
174
60
#+STARTUP: showall