/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: 2009-12-25 23:13:47 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091225231347-gg9u9ru0wj0f24hh
More consistent terminology: Clients are no longer "invalid" - they
are "disabled".  All code and documentation changed to reflect this.

D=Bus API change: The "properties" argument was removed from the
"ClientAdded" signal on interface "se.bsnet.fukt.Mandos".  All code in
both "mandos" and "mandos-monitor" changed to reflect this.

* mandos: Replaced "with closing(F)" with simply "with F" in all
          places where F is a file object.
  (Client.still_valid): Removed.  All callers changed to look at
                        "Client.enabled" instead.
  (dbus_service_property): Check for unsupported signatures with the
                           "byte_arrays" option.
  (DBusObjectWithProperties.Set): - '' -
  (ClientHandler.handle): Use the reverse pipe to receive the
                          "Client.enabled" attribute instead of the
                          now-removed "Client.still_valid()" method.
  (ForkingMixInWithPipe): Renamed to "ForkingMixInWithPipes" (all
                          users changed).  Now also create a reverse
                          pipe for sending data to the child process.
  (ForkingMixInWithPipes.add_pipe): Now takes two pipe fd's as
                                    arguments.  All callers changed.
  (IPv6_TCPServer.handle_ipc): Take an additional "reply_fd" argument
                               (all callers changed).  Close the reply
                               pipe when the child data pipe is
                               closed.  New "GETATTR" IPC method; will
                               pickle client attribute and send it
                               over the reply pipe FD.
  (MandosDBusService.ClientAdded): Removed "properties" argument.  All
                                   emitters changed.
* mandos-clients.conf.xml (DESCRIPTION, OPTIONS): Use
                                                  "enabled/disabled"
                                                  terminology.
* mandos-ctl: Option "--is-valid" renamed to "--is-enabled".
* mandos-monitor: Enable user locale.  Try to log exceptions.
  (MandosClientPropertyCache.__init__): Removed "properties" argument.
                                        All callers changed.
  (UserInterface.add_new_client): Remove "properties" argument.  All
                                  callers changed.  Supply "logger"
                                  argument to MandosClientWidget().
  (UserInterface.add_client): New "logger" argument.  All callers
                              changed.
* mandos.xml (BUGS, SECURITY/CLIENTS): Use "enabled/disabled"
                                       terminology.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
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 [#B] use scandir(3) instead of readdir(3)
 
5
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
 
6
** TODO use error() instead of perror()
 
7
** TODO [#B] Retry a server which has a non-definite reply:
 
8
*** A closed connection during the TLS handshake
 
9
*** A TCP timeout
 
10
** TODO [#B] Use capabilities instead of seteuid().
 
11
 
 
12
* splashy
 
13
** TODO [#B] use scandir(3) instead of readdir(3)
 
14
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
 
15
** TODO use error() instead of perror()
 
16
 
 
17
* usplash
 
18
** TODO [#B] use scandir(3) instead of readdir(3)
 
19
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
 
20
** TODO use error() instead of perror()
 
21
 
 
22
* askpass-fifo
 
23
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
 
24
** TODO use error() instead of perror()
 
25
** TODO [#B] Drop privileges after opening FIFO.
 
26
 
 
27
* password-prompt
 
28
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
 
29
** TODO use error() instead of perror()
 
30
** TODO lock stdin (with flock()?)
 
31
 
 
32
* TODO passdev
 
33
 
 
34
* plugin-runner
 
35
** TODO [#B] use scandir(3) instead of readdir(3)
 
36
** TODO [#C] use same file name rules as run-parts(8)
 
37
** TODO use error() instead of perror()
 
38
 
 
39
* mandos (server)
 
40
** TODO [#B] Log level                          :BUGS:
 
41
** TODO /etc/mandos/clients.d/*.conf
140
42
   Watch this directory and add/remove/update clients?
141
 
** config for TXT record
142
 
** Run-time communication with server
 
43
** TODO config for TXT record
 
44
** TODO [#B] Run-time communication with server :BUGS:
143
45
   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
 
** Update initrd.img after installation
161
 
** [#A] Create mandos user and group for server
162
 
** [#A] Create /var/run/mandos directory with perm and ownership
163
 
 
164
 
* [#A] Package
165
 
** /etc/bash_completion.d/mandos
166
 
** /etc/initramfs-tools/hooks/mandos
167
 
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
168
 
*** Create GPG key ring files in initrd
169
 
 
170
 
* INSTALL file
171
 
 
172
 
* Web site
173
 
 
174
 
* Mailing list
175
 
 
176
 
* Announce project on news
177
 
  [[news:comp.os.linux.announce]]
 
46
*** Client class
 
47
*** Main server
 
48
    + SetLogLevel
 
49
      syslogger.setLevel(logging.WARNING)
 
50
    + [[http://log.ometer.com/2007-05.html][Best D-Bus practices]]
 
51
** TODO Implement --foreground                  :BUGS:
 
52
   [[info:standards:Option%20Table][Table of Long Options]]
 
53
** TODO Implement --socket
 
54
   [[info:standards:Option%20Table][Table of Long Options]]
 
55
** TODO Date+time on console log messages       :BUGS:
 
56
   Is this the default?
 
57
** TODO DBusServiceObjectUsingSuper
 
58
** TODO Global enable/disable flag
 
59
** TODO By-client countdown on secrets given
 
60
** TODO Fix problem with fsck taking a really long time
 
61
   Whenever a client successfully gets a secret it could get a
 
62
   one-time timeout boost to allow for an fsck-incurred delay
 
63
** TODO Delay before client receives key
 
64
   This would give an operator opportunity to cancel the request if
 
65
   desired.
 
66
** TODO Client manual approval mode
 
67
   A client needs manual approval on the server before it gets the
 
68
   secret
 
69
** TODO Persistent state
 
70
   /var/lib/mandos/*
 
71
** TODO Support RFC 3339 time duration syntax
 
72
 
 
73
* mandos.xml
 
74
** [[file:mandos.xml::XXX][Document D-Bus interface]]
 
75
 
 
76
* Provide and install /etc/dbus-1/system.d/mandos.conf
 
77
 
 
78
* mandos-ctl
 
79
*** Handle "no D-Bus server" and/or "no Mandos server found" better
 
80
*** [#B] --dump option
 
81
** TODO Support RFC 3339 time duration syntax
 
82
 
 
83
* TODO mandos-dispatch
 
84
  Listens for specified D-Bus signals and spawns shell commands with
 
85
  arguments.
 
86
 
 
87
* mandos-monitor
 
88
** Urwid client data displayer
 
89
*** Properties popup
 
90
 
 
91
* mandos-keygen
 
92
** TODO Loop until passwords match when run interactively
 
93
** TODO "--secfile" option
 
94
   Using the "secfile" option instead of "secret"
 
95
** TODO [#B] "--test" option
 
96
   For testing decryption before rebooting.
 
97
 
 
98
* Makefile
 
99
** Implement DEB_BUILD_OPTIONS
 
100
   http://www.debian.org/doc/debian-policy/ch-source.html#s-debianrules-options
 
101
 
 
102
* Package
 
103
** /usr/share/initramfs-tools/hooks/mandos
 
104
*** TODO [#C] use same file name rules as run-parts(8)
 
105
*** TODO [#C] Do not install in initrd.img if configured not to.
 
106
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
 
107
** TODO [#C] /etc/bash_completion.d/mandos
 
108
   From XML sources directly?
178
109
 
179
110
 
180
111
#+STARTUP: showall