/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

  • Committer: Teddy Hogeborn
  • Date: 2008-08-09 20:29:39 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080809202939-xn04n8dmrgjt9ftc
* TODO: More notes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
2
2
 
3
3
* [#A] README file
4
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
 
5
* [#A] COPYING file
 
6
  [[file:/usr/share/common-licenses/GPL-3][GPLv3]]
 
7
 
 
8
* Mandos-client
 
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.
10
18
*** EXIT STATUS
11
 
    Text needed
 
19
    Create this section
 
20
*** USAGE
 
21
    Describe the plus sign syntax for passing options from crypttab
12
22
*** EXAMPLES
13
23
    Examples of normal usage, debug usage, debugging single or all
14
 
    plugins, etc.
 
24
    plugins, examples of crypttab lines with plus syntax, etc.
15
25
*** FILES
16
 
    Text needed
 
26
    Describe plugin directory
 
27
*** DIAGNOSTICS
 
28
    Create this section
17
29
*** SECURITY
18
 
    Text needed
 
30
    Create this section
 
31
*** NOTES
 
32
    Create this section (if needed)
19
33
*** BUGS
20
 
    Text needed
 
34
    Create this section
21
35
*** 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
 
36
    Refer to mandos(8), password-request(8mandos), and
 
37
    password-prompt(8mandos)
 
38
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
 
39
** use strsep instead of strtok?
 
40
** use config file in addition to arguments
 
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.
25
45
 
26
46
* Password-request
27
47
** [#A] Man page: man8/password-request.8mandos
28
 
** [#B] Temporarily lower kernel log level
29
 
   for less printouts during sucessfull boot.
 
48
*** SYNOPSIS
 
49
    Needs options listed, not just "[OPTION...]"
30
50
*** DESCRIPTION
31
51
    Move options to new OPTIONS section.
32
52
    State that this command is not meant to be invoked directly, but
44
64
    Create this section
45
65
*** SECURITY
46
66
    Create this section
 
67
*** NOTES
 
68
    Create this section (if needed)
47
69
*** BUGS
48
70
    Create this section
49
71
*** SEE ALSO
50
72
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
51
 
*** ENVIRONMENT
52
 
    Document use of "cryptsource" and "crypttarget".
 
73
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
 
74
** start_mandos_communication: loop around gnutls_handshake
 
75
   [[info:gnutls.info.gz:Core%20functions][gnutls_handshake]]
53
76
** IPv4 support
54
77
** 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.
 
78
** Do not depend on GPG key rings on disk
 
79
   This would mean creating new GPG key rings with GPGME by importing
 
80
   the key files from scratch on every program start.
58
81
 
59
82
* Password-prompt
60
83
** [#A] Man page: man8/password-prompt.8mandos
 
84
*** SYNOPSIS
 
85
    Needs options listed, not just "[OPTION...]"
61
86
*** DESCRIPTION
62
87
    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
88
*** EXIT STATUS
66
89
    Create this section
67
90
*** EXAMPLES
72
95
    Create this section
73
96
    Not much to do here but it is noteworthy to state the danger of
74
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.
75
101
*** BUGS
76
102
    Create this section
77
103
*** SEE ALSO
83
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?]]
84
110
 
85
111
* Mandos (server)
 
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
86
135
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
87
136
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
88
137
** [#A] /etc/init.d/mandos-server               :teddy:
89
 
** [#B] Log level                               :bugs:
 
138
** Log level
90
139
** /etc/mandos/clients.d/*.conf
91
140
   Watch this directory and add/remove/update clients?
92
141
** config for TXT record
93
 
** [#B] Run-time communication with server      :bugs:
 
142
** Run-time communication with server
94
143
   Probably using D-Bus
95
144
   See also [[*Mandos-tools]]
96
 
** Implement --foreground                       :bugs:
 
145
** Implement --foreground
97
146
   [[info:standards:Option%20Table][Table of Long Options]]
98
147
** Implement --socket
99
148
   [[info:standards:Option%20Table][Table of Long Options]]
100
 
** Date+time on console log messages            :bugs:
101
 
   Is this the default?
102
149
 
103
150
* Mandos-tools/utilities
104
151
  All of this probably using D-Bus
107
154
** Enable client
108
155
 
109
156
* Installer
110
 
** Client
111
 
*** Update initrd.img after installation
112
 
    This seems to use some kind of "trigger" system
113
 
** Server
114
 
*** [#A] Create mandos user and group for server
115
 
*** [#A] Create /var/run/mandos directory with perm and ownership
116
 
 
117
 
** mandos-keygen
118
 
*** [#A] Command man page: man8/mandos-keygen.8
119
 
**** EXIT STATUS
120
 
**** FILES
121
 
**** BUGS
122
 
**** EXAMPLES
123
 
**** SECURITY
124
 
*** [#A] Output cut-and-paste ready snippet for clients.conf.
125
 
 
126
 
* [#A] Package
127
 
** /usr/share/initramfs-tools/hooks/mandos
128
 
*** Do not install in initrd.img if configured not to.
129
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
130
 
    question.
 
157
** DONE [#A] Change initrd.img file to not be publically readable
 
158
   /etc/initramfs-tools/conf.d/mandos
 
159
   UMASK=027
 
160
** [#A] Create /etc/initramfs-tools/hooks/mandos
 
161
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
 
162
** [#A] Create GPG key ring files in initrd
 
163
** [#A] Create mandos user and group for server
 
164
** [#A] Create /var/run/mandos directory with perm and ownership
 
165
 
 
166
* Package
131
167
** /etc/bash_completion.d/mandos
132
 
*** From XML sources directly?
133
 
** unperish
134
 
** bzr-builddeb
135
 
 
136
 
* INSTALL file
137
 
 
138
 
* Web site
139
 
 
140
 
* Mailing list
141
 
 
142
 
* Announce project on news
143
 
  [[news:comp.os.linux.announce]]
 
168
 
 
169
* [[http://en.tldp.org/HOWTO/Software-Release-Practice-HOWTO/][Software Release Practice HOWTO]]
144
170
 
145
171
 
146
172
#+STARTUP: showall