/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
 
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
9
** [#A] Man page: man8/mandos-client.8mandos
10
 
*** EXIT STATUS
11
 
    Create this section
12
 
*** USAGE
13
 
    Describe the plus sign syntax for passing options from crypttab
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
 
    Describe plugin directory
19
 
*** DIAGNOSTICS
20
 
    Create this section
21
 
*** SECURITY
22
 
    Create this section
23
 
*** NOTES
24
 
    Create this section (if needed)
25
 
*** BUGS
26
 
    Create this section
27
 
*** SEE ALSO
28
 
    Refer to mandos(8), password-request(8mandos), and
29
 
    password-prompt(8mandos)
30
 
** Use asprintf instead of malloc and strcat?
 
10
** [#A] check return codes of all system calls
 
11
** [#B] header files/symbols tally
31
12
** use strsep instead of strtok?
32
13
** use config file in addition to arguments
33
14
** pass things in environment, like device name, etc
34
 
** Fallback
35
 
   As a fallback, if no plugins can be found or if all of them failed,
36
 
   run getpass(3) itself.
37
15
 
38
16
* Password-request
39
17
** [#A] Man page: man8/password-request.8mandos
40
 
*** DESCRIPTION
41
 
    Move options to new OPTIONS section.
42
 
    State that this command is not meant to be invoked directly, but
43
 
    is run as a plugin from mandos-client(8) and only run in the
44
 
    initrd environment, not the real system.
45
 
*** EXIT STATUS
46
 
    Create this section
47
 
*** EXAMPLES
48
 
    Examples of normal usage, debug usage, debugging by connecting
49
 
    directly, etc.
50
 
*** FILES
51
 
    Describe the key files and the key ring files.  Also note that
52
 
    they should normally have been automatically created.
53
 
*** DIAGNOSTICS
54
 
    Create this section
55
 
*** SECURITY
56
 
    Create this section
57
 
*** NOTES
58
 
    Create this section (if needed)
59
 
*** BUGS
60
 
    Create this section
61
 
*** SEE ALSO
62
 
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
63
 
** Use asprintf instead of malloc and memcpy?
 
18
** [#A] check return codes of all system calls
 
19
** [#B] header files/symbols tally
64
20
** IPv4 support
65
21
** use strsep instead of strtok?
66
22
** Do not depend on GPG key rings on disk
69
25
 
70
26
* Password-prompt
71
27
** [#A] Man page: man8/password-prompt.8mandos
72
 
*** DESCRIPTION
73
 
    Move options to new OPTIONS section.
74
 
*** EXIT STATUS
75
 
    Create this section
76
 
*** EXAMPLES
77
 
    Examples of normal usage, debug usage, with a prefix, etc.
78
 
*** DIAGNOSTICS
79
 
    Create this section
80
 
*** SECURITY
81
 
    Create this section
82
 
    Not much to do here but it is noteworthy to state the danger of
83
 
    not having a fallback option.
84
 
*** NOTES
85
 
    Note that this is more or less a simple getpass(3) wrapper, even
86
 
    though actual use of getpass(3) is not guaranteed.
87
 
*** BUGS
88
 
    Create this section
89
 
*** SEE ALSO
90
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
91
28
** Use getpass(3)?
92
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
93
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
94
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
95
 
   [[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]]
96
30
 
97
 
* Mandos (server)
 
31
* Server
98
32
** [#A] Command man page: man8/mandos.8
99
 
*** DESCRIPTION
100
 
    Move options to new OPTIONS section
101
 
*** EXIT STATUS
102
 
    Create this section
103
 
*** EXAMPLES
104
 
    Create this section
105
 
*** FILES
106
 
    Describe briefly that the server gets global settings from
107
 
    mandos.conf and clients from clients.conf, but refer to their man
108
 
    pages for more details.
109
 
*** DIAGNOSTICS
110
 
    Create this section
111
 
*** SECURITY
112
 
    Create this section
113
 
*** NOTES
114
 
    Create this section (if needed)
115
 
*** BUGS
116
 
    Create this section
117
 
*** SEE ALSO
118
 
    Refer to the client man page
119
33
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
120
34
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
121
 
** [#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
122
38
** Log level
123
39
** /etc/mandos/clients.d/*.conf
124
40
   Watch this directory and add/remove/update clients?
125
41
** config for TXT record
126
42
** Run-time communication with server
127
 
   Probably using D-Bus
128
 
   See also [[*Mandos-tools]]
 
43
   probably using D-Bus
129
44
** Implement --foreground
130
45
   [[info:standards:Option%20Table][Table of Long Options]]
131
46
** Implement --socket
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
 
** DONE [#A] Change initrd.img file to not be publically readable
142
 
   /etc/initramfs-tools/conf.d/mandos
143
 
   UMASK=027
144
 
** Update initrd.img after installation
145
 
** [#A] Create mandos user and group for server
146
 
** [#A] Create /var/run/mandos directory with perm and ownership
147
 
 
148
 
* [#A] Package
149
 
** /etc/bash_completion.d/mandos
150
 
** /etc/initramfs-tools/hooks/mandos
151
 
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
152
 
*** Create GPG key ring files in initrd
153
 
** unperish
154
 
** bzr-builddeb
155
 
 
156
 
* INSTALL file
157
 
 
158
 
* Web site
159
 
 
160
 
* Mailing list
161
 
 
162
 
* Announce project on news
163
 
  [[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
164
58
 
165
59
 
166
60
#+STARTUP: showall