/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

synopsis changed

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
7
7
 
8
8
* Mandos-client
9
9
** [#A] Man page: man8/mandos-client.8mandos
 
10
*** SYNOPSIS
 
11
    Needs options listed, not just "[OPTION...]"
 
12
*** DESCRIPTION
 
13
    Move options to new OPTIONS section.
 
14
    State that this command is not meant to be invoked directly, but
 
15
    is meant to be run by cryptsetup by being specified in
 
16
    /etc/crypttab and only run in the initrd environment, not the real
 
17
    system.
 
18
*** EXIT STATUS
 
19
    Create this section
 
20
*** USAGE
 
21
    Describe the plus sign syntax for passing options from crypttab
 
22
*** EXAMPLES
 
23
    Examples of normal usage, debug usage, debugging single or all
 
24
    plugins, examples of crypttab lines with plus syntax, etc.
 
25
*** FILES
 
26
    Describe plugin directory
 
27
*** DIAGNOSTICS
 
28
    Create this section
 
29
*** SECURITY
 
30
    Create this section
 
31
*** NOTES
 
32
    Create this section (if needed)
 
33
*** BUGS
 
34
    Create this section
 
35
*** SEE ALSO
 
36
    Refer to mandos(8), password-request(8mandos), and
 
37
    password-prompt(8mandos)
10
38
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
11
39
** use strsep instead of strtok?
12
40
** use config file in addition to arguments
13
41
** pass things in environment, like device name, etc
 
42
** Fallback
 
43
   As a fallback, if no plugins can be found or if all of them failed,
 
44
   run getpass(3) itself.
14
45
 
15
46
* Password-request
16
47
** [#A] Man page: man8/password-request.8mandos
 
48
*** SYNOPSIS
 
49
    Needs options listed, not just "[OPTION...]"
 
50
*** DESCRIPTION
 
51
    Move options to new OPTIONS section.
 
52
    State that this command is not meant to be invoked directly, but
 
53
    is run as a plugin from mandos-client(8) and only run in the
 
54
    initrd environment, not the real system.
 
55
*** EXIT STATUS
 
56
    Create this section
 
57
*** EXAMPLES
 
58
    Examples of normal usage, debug usage, debugging by connecting
 
59
    directly, etc.
 
60
*** FILES
 
61
    Describe the key files and the key ring files.  Also note that
 
62
    they should normally have been automatically created.
 
63
*** DIAGNOSTICS
 
64
    Create this section
 
65
*** SECURITY
 
66
    Create this section
 
67
*** NOTES
 
68
    Create this section (if needed)
 
69
*** BUGS
 
70
    Create this section
 
71
*** SEE ALSO
 
72
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
17
73
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
18
74
** start_mandos_communication: loop around gnutls_handshake
19
75
   [[info:gnutls.info.gz:Core%20functions][gnutls_handshake]]
25
81
 
26
82
* Password-prompt
27
83
** [#A] Man page: man8/password-prompt.8mandos
 
84
*** SYNOPSIS
 
85
    Needs options listed, not just "[OPTION...]"
 
86
*** DESCRIPTION
 
87
    Move options to new OPTIONS section.
 
88
*** EXIT STATUS
 
89
    Create this section
 
90
*** EXAMPLES
 
91
    Examples of normal usage, debug usage, with a prefix, etc.
 
92
*** DIAGNOSTICS
 
93
    Create this section
 
94
*** SECURITY
 
95
    Create this section
 
96
    Not much to do here but it is noteworthy to state the danger of
 
97
    not having a fallback option.
 
98
*** NOTES
 
99
    Note that this is more or less a simple getpass(3) wrapper, even
 
100
    though actual use of getpass(3) is not guaranteed.
 
101
*** BUGS
 
102
    Create this section
 
103
*** SEE ALSO
 
104
    Refer to mandos-client(8mandos) and password-request(8mandos)
28
105
** Use getpass(3)?
29
106
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
30
107
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
31
108
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
32
109
   [[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?]]
33
110
 
34
 
* Server
 
111
* Mandos (server)
35
112
** [#A] Command man page: man8/mandos.8
 
113
*** SYNOPSIS
 
114
    Needs options listed, not just "[OPTION...]"
 
115
*** DESCRIPTION
 
116
    Move options to new OPTIONS section
 
117
*** EXIT STATUS
 
118
    Create this section
 
119
*** EXAMPLES
 
120
    Create this section
 
121
*** FILES
 
122
    Describe briefly that the server gets global settings from
 
123
    mandos.conf and clients from clients.conf, but refer to their man
 
124
    pages for more details.
 
125
*** DIAGNOSTICS
 
126
    Create this section
 
127
*** SECURITY
 
128
    Create this section
 
129
*** NOTES
 
130
    Create this section (if needed)
 
131
*** BUGS
 
132
    Create this section
 
133
*** SEE ALSO
 
134
    Refer to the client man page
36
135
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
37
136
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
38
137
** [#A] /etc/init.d/mandos-server               :teddy:
55
154
** Enable client
56
155
 
57
156
* Installer
58
 
** [#A] Change initrd.img file to not be publically readable
 
157
** DONE [#A] Change initrd.img file to not be publically readable
59
158
   /etc/initramfs-tools/conf.d/mandos
60
159
   UMASK=027
61
160
** [#A] Create /etc/initramfs-tools/hooks/mandos
64
163
** [#A] Create mandos user and group for server
65
164
** [#A] Create /var/run/mandos directory with perm and ownership
66
165
 
 
166
* Package
 
167
** /etc/bash_completion.d/mandos
 
168
 
67
169
* INSTALL file
68
170
 
69
 
* Website
 
171
* Web site
70
172
 
71
173
* Mailing list
72
174
 
73
175
* Announce project on news
74
 
  news:comp.os.linux.announce
 
176
  [[news:comp.os.linux.announce]]
75
177
 
76
178
 
77
179
#+STARTUP: showall