/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 all sections needed for mandos-client manual page

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
1
1
-*- org -*-
2
2
 
3
 
* README file
 
3
* [#A] README file
4
4
 
5
 
* COPYING file
 
5
* [#A] 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
 
** [#A] check return codes of all system calls
11
 
** [#B] header files/symbols tally
 
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
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
12
31
** use strsep instead of strtok?
13
32
** use config file in addition to arguments
14
33
** 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.
15
37
 
16
38
* Password-request
17
39
** [#A] Man page: man8/password-request.8mandos
18
 
** [#A] check return codes of all system calls
19
 
** [#B] header files/symbols tally
 
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
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
 
64
** start_mandos_communication: loop around gnutls_handshake
 
65
   [[info:gnutls.info.gz:Core%20functions][gnutls_handshake]]
20
66
** IPv4 support
21
67
** use strsep instead of strtok?
22
68
** Do not depend on GPG key rings on disk
25
71
 
26
72
* Password-prompt
27
73
** [#A] Man page: man8/password-prompt.8mandos
 
74
*** DESCRIPTION
 
75
    Move options to new OPTIONS section.
 
76
*** EXIT STATUS
 
77
    Create this section
 
78
*** EXAMPLES
 
79
    Examples of normal usage, debug usage, with a prefix, etc.
 
80
*** DIAGNOSTICS
 
81
    Create this section
 
82
*** SECURITY
 
83
    Create this section
 
84
    Not much to do here but it is noteworthy to state the danger of
 
85
    not having a fallback option.
 
86
*** NOTES
 
87
    Note that this is more or less a simple getpass(3) wrapper, even
 
88
    though actual use of getpass(3) is not guaranteed.
 
89
*** BUGS
 
90
    Create this section
 
91
*** SEE ALSO
 
92
    Refer to mandos-client(8mandos) and password-request(8mandos)
28
93
** Use getpass(3)?
29
 
   [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
 
94
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
 
95
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
 
96
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
 
97
   [[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?]]
30
98
 
31
 
* Server
 
99
* Mandos (server)
32
100
** [#A] Command man page: man8/mandos.8
 
101
*** DESCRIPTION
 
102
    Move options to new OPTIONS section
 
103
*** EXIT STATUS
 
104
    Create this section
 
105
*** EXAMPLES
 
106
    Create this section
 
107
*** FILES
 
108
    Describe briefly that the server gets global settings from
 
109
    mandos.conf and clients from clients.conf, but refer to their man
 
110
    pages for more details.
 
111
*** DIAGNOSTICS
 
112
    Create this section
 
113
*** SECURITY
 
114
    Create this section
 
115
*** NOTES
 
116
    Create this section (if needed)
 
117
*** BUGS
 
118
    Create this section
 
119
*** SEE ALSO
 
120
    Refer to the client man page
33
121
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
34
122
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
35
 
** [#A] /etc/init.d/mandos-server
 
123
** [#A] /etc/init.d/mandos-server               :teddy:
36
124
** Log level
37
125
** /etc/mandos/clients.d/*.conf
38
126
   Watch this directory and add/remove/update clients?
39
127
** config for TXT record
40
128
** Run-time communication with server
41
 
   probably using D-Bus
 
129
   Probably using D-Bus
 
130
   See also [[*Mandos-tools]]
42
131
** Implement --foreground
43
132
   [[info:standards:Option%20Table][Table of Long Options]]
44
133
** Implement --socket
47
136
* Mandos-tools/utilities
48
137
  All of this probably using D-Bus
49
138
** List clients
 
139
** Disable client
50
140
** Enable client
51
 
** Disable client
52
141
 
53
142
* Installer
54
 
** [#A] Change initrd.img file to not be publically readable
55
 
** [#A] Create GPG key ring files in initrd
 
143
** DONE [#A] Change initrd.img file to not be publically readable
 
144
   /etc/initramfs-tools/conf.d/mandos
 
145
   UMASK=027
 
146
** Update initrd.img after installation
56
147
** [#A] Create mandos user and group for server
57
148
** [#A] Create /var/run/mandos directory with perm and ownership
58
149
 
 
150
* [#A] Package
 
151
** /etc/bash_completion.d/mandos
 
152
** /etc/initramfs-tools/hooks/mandos
 
153
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
 
154
*** Create GPG key ring files in initrd
 
155
 
 
156
* INSTALL file
 
157
 
 
158
* Web site
 
159
 
 
160
* Mailing list
 
161
 
 
162
* Announce project on news
 
163
  [[news:comp.os.linux.announce]]
 
164
 
59
165
 
60
166
#+STARTUP: showall