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