/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

Code cleanup.

* mandos: Move some global stuff into classes.
  (server, group): Moved into "AvahiService".  All users changed.
  (AvahiService.group, AvahiService.server): New attributes.
  (entry_group_state_changed, server_state_changed): Moved into
                                                     "AvahiService".
                                                     All callers
                                                     changed.
  (AvahiService.cleanup, AvahiService.activate): New.
  (_datetime_to_dbus): Moved into "ClientDBus".  All callers changed.
  (ClientDBus._datetime_to_dbus): New.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
-*- org -*-
2
2
 
3
 
* [#A] README file
4
 
 
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.
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)
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.
45
 
 
46
 
* Password-request
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)
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]]
76
 
** IPv4 support
77
 
** use strsep instead of strtok?
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.
81
 
 
82
 
* Password-prompt
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)
105
 
** Use getpass(3)?
106
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
107
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
108
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
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?]]
110
 
 
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
135
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
136
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
137
 
** [#A] /etc/init.d/mandos-server               :teddy:
138
 
** Log level
139
 
** /etc/mandos/clients.d/*.conf
 
3
* mandos-client
 
4
** TODO [#A] Clean up /tmp directory on signal
 
5
 
 
6
* plugin-runner
 
7
** TODO [#B] use scandir(3) instead of readdir(3)
 
8
 
 
9
* mandos (server)
 
10
** TODO [#B] Log level                          :BUGS:
 
11
** TODO /etc/mandos/clients.d/*.conf
140
12
   Watch this directory and add/remove/update clients?
141
 
** config for TXT record
142
 
** Run-time communication with server
 
13
** TODO config for TXT record
 
14
** TODO [#B] Run-time communication with server :BUGS:
143
15
   Probably using D-Bus
144
 
   See also [[*Mandos-tools]]
145
 
** Implement --foreground
146
 
   [[info:standards:Option%20Table][Table of Long Options]]
147
 
** Implement --socket
148
 
   [[info:standards:Option%20Table][Table of Long Options]]
149
 
 
150
 
* Mandos-tools/utilities
151
 
  All of this probably using D-Bus
152
 
** List clients
153
 
** Disable client
154
 
** Enable client
155
 
 
156
 
* Installer
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
 
16
*** Client class
 
17
*** Main server
 
18
    + SetLogLevel
 
19
      syslogger.setLevel(logging.WARNING)
 
20
    + [[http://log.ometer.com/2007-05.html][Best D-Bus practices]]
 
21
** TODO Implement --foreground                  :BUGS:
 
22
   [[info:standards:Option%20Table][Table of Long Options]]
 
23
** TODO Implement --socket
 
24
   [[info:standards:Option%20Table][Table of Long Options]]
 
25
** TODO Date+time on console log messages       :BUGS:
 
26
   Is this the default?
 
27
** TODO Split IPv6_TCPServer into a generic and Mandos-specific class
 
28
** TODO move handle_ipc out of IPv6_TCPServer
 
29
** TODO DBusServiceObjectUsingSuper
 
30
 
 
31
* mandos.xml
 
32
** [[file:mandos.xml::XXX][Document D-Bus interface]]
 
33
 
 
34
* Provide and install /etc/dbus-1/system.d/mandos.conf
 
35
 
 
36
* mandos-ctl
 
37
*** Handle "no D-Bus server" and/or "no Mandos server found" better
 
38
*** [#B] --dump option
 
39
 
 
40
* mandos-name
 
41
** D-Bus mail loop w/ signal receiver
 
42
** Urwid/Newt client data displayer
 
43
*** Urwid scaffolding
 
44
*** Client Widgets
 
45
*** Properties popup
 
46
 
 
47
* mandos-keygen
 
48
** TODO Loop until passwords match when run interactively
 
49
** TODO "--secfile" option
 
50
   Using the "secfile" option instead of "secret"
 
51
** TODO [#B] "--test" option
 
52
   For testing decryption before rebooting.
165
53
 
166
54
* Package
167
 
** /etc/bash_completion.d/mandos
168
 
 
169
 
* INSTALL file
170
 
 
171
 
* Web site
172
 
 
173
 
* Mailing list
174
 
 
175
 
* Announce project on news
176
 
  [[news:comp.os.linux.announce]]
 
55
** /usr/share/initramfs-tools/hooks/mandos
 
56
*** TODO [#C] Do not install in initrd.img if configured not to.
 
57
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
 
58
** TODO [#C] /etc/bash_completion.d/mandos
 
59
   From XML sources directly?
177
60
 
178
61
 
179
62
#+STARTUP: showall