/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-10-24 19:17:52 UTC
  • Revision ID: teddy@fukt.bsnet.se-20091024191752-7g6xlf6wpp2pdexb
Convert some programs to use the exit codes from <sysexits.h>.  Change
all programs using the "argp" parsing functions to use them correctly;
checking return value, using argp_error() to report parse errors etc.

* plugin-runner.c: Use <sysexits.h> exit codes.  Always use fallback,
                   even on option errors, except for "--help", etc.
  (getplugin): Make sure "errno" is set correctly on return.
  (main): Declare our own "--help", "--usage", and "--version"
          options which do not cause the fallback to be invoked.
          In all other options, use fallback on any error.
  (parse_opt, parse_opt_config_file): Reset errno at start and return
                                      errno.  No need to check "arg"
                                      for NULL.  New "--help",
                                      "--usage", and "--version"
                                      options.
  (parse_opt): Accept empty string as global option.  Do not print
               errors which will be detected and reported later.  Do
               "argp_error()" on parse error or empty plugin names.
* plugins.d/mandos-client.c: Use <sysexits.h> exit codes.  Do not
                             return successful exit code on "--help",
                             etc. since this would give the wrong
                             message to "plugin-runner".
  (main): Declare our own "--help", "--usage", and "--version"
          options which do not return a successful exit code.
  (parse_opt): Reset errno at start and return errno.  Do
               "argp_error()" on parse errors.  New "--help",
               "--usage", and "--version" options.
* plugins.d/password-prompt.c: Use exit codes from <sysexits.h>.  Do
                               not return successful exit code on
                               "--help", etc. since this would give
                               the wrong message to "plugin-runner".
  (main): Declare our own "--help", "--usage", and "--version" options
          which do not return a successful exit code.  Do
          close(STDOUT_FILENO) after writing to check its return code.
  (parse_opt): Reset errno at start and return errno.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
1
1
-*- org -*-
2
2
 
3
 
* [#A] README file
4
 
 
5
 
* Mandos-client
6
 
** [#A] Change syntax for arguments
7
 
** [#A] Man page: man8/mandos-client.8mandos
8
 
*** DESCRIPTION
9
 
    Describe the plus sign syntax for passing options from crypttab
10
 
*** EXIT STATUS
11
 
    Text needed
12
 
*** EXAMPLES
13
 
    Examples of normal usage, debug usage, debugging single or all
14
 
    plugins, examples of crypttab lines with plus syntax, etc.
15
 
*** FILES
16
 
    Text needed
17
 
*** SECURITY
18
 
    Text needed
19
 
*** NOTES
20
 
    Text needed
21
 
*** BUGS
22
 
    Text needed
23
 
*** SEE ALSO
24
 
    Explaining test on what you can read
25
 
** Use asprintf instead of malloc and strcat?
26
 
** use strsep instead of strtok?
27
 
** use config file in addition to arguments
28
 
** pass things in environment, like device name, etc
29
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
30
 
   Must create in preinst if not pre-depending on cryptsetup
31
 
 
32
 
* Password-request
33
 
** [#A] Man page: man8/password-request.8mandos
34
 
** [#B] Temporarily lower kernel log level
35
 
   for less printouts during sucessfull boot.
36
 
*** DESCRIPTION
37
 
    Move options to new OPTIONS section.
38
 
    State that this command is not meant to be invoked directly, but
39
 
    is run as a plugin from mandos-client(8) and only run in the
40
 
    initrd environment, not the real system.
41
 
*** EXIT STATUS
42
 
    Create this section
43
 
*** EXAMPLES
44
 
    Examples of normal usage, debug usage, debugging by connecting
45
 
    directly, etc.
46
 
*** FILES
47
 
    Describe the key files and the key ring files.  Also note that
48
 
    they should normally have been automatically created.
49
 
*** DIAGNOSTICS
50
 
    Create this section
51
 
*** SECURITY
52
 
    Create this section
53
 
*** NOTES
54
 
    Create this section (if needed)
55
 
*** BUGS
56
 
    Create this section
57
 
*** SEE ALSO
58
 
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
59
 
** Use asprintf instead of malloc and memcpy?
60
 
** IPv4 support
61
 
** use strsep instead of strtok?
62
 
** Do not depend on GnuPG key rings on disk
63
 
   This would mean creating new GnuPG key rings with GPGME by
64
 
   importing the key files from scratch on every program start.
65
 
 
66
 
* Password-prompt
67
 
** [#A] Man page: man8/password-prompt.8mandos
68
 
** Show getenv("cryptsource") and getenv("crypttarget") if set
69
 
   cryptsource will be the device, like "/dev/sda3", and crypttarget
70
 
   will be the device mapper name, like "sda3_crypt".
71
 
*** DESCRIPTION
72
 
    Move options to new OPTIONS section.
73
 
*** EXIT STATUS
74
 
    Create this section
75
 
*** EXAMPLES
76
 
    Examples of normal usage, debug usage, with a prefix, etc.
77
 
*** DIAGNOSTICS
78
 
    Create this section
79
 
*** SECURITY
80
 
    Create this section
81
 
    Not much to do here but it is noteworthy to state the danger of
82
 
    not having a fallback option.
83
 
*** NOTES
84
 
    Note that this is more or less a simple getpass(3) wrapper, even
85
 
    though actual use of getpass(3) is not guaranteed.
86
 
*** BUGS
87
 
    Create this section
88
 
*** SEE ALSO
89
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
90
 
** Use getpass(3)?
91
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
92
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
93
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
94
 
   [[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?]]
95
 
** Replace completely with "/lib/cryptsetup/askpass"?
96
 
 
97
 
* Mandos (server)
98
 
** [#A] Command man page: man8/mandos.8
99
 
*** DESCRIPTION
100
 
    Move options to new OPTIONS section
101
 
*** EXIT STATUS
102
 
    Create this section
103
 
*** EXAMPLES
104
 
    Create this section
105
 
*** FILES
106
 
    Describe briefly that the server gets global settings from
107
 
    mandos.conf and clients from clients.conf, but refer to their man
108
 
    pages for more details.
109
 
*** DIAGNOSTICS
110
 
    Create this section
111
 
*** SECURITY
112
 
    Create this section
113
 
*** NOTES
114
 
    Create this section (if needed)
115
 
*** BUGS
116
 
    Create this section
117
 
*** SEE ALSO
118
 
    Refer to the client man page
119
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
120
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
121
 
** [#A] /etc/init.d/mandos-server               :teddy:
122
 
** Log level
123
 
** /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
** TODO use EX_* from <sysexits.h>
 
12
 
 
13
* splashy
 
14
** TODO [#B] use scandir(3) instead of readdir(3)
 
15
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
 
16
** TODO use error() instead of perror()
 
17
 
 
18
* usplash
 
19
** TODO [#B] use scandir(3) instead of readdir(3)
 
20
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
 
21
** TODO use error() instead of perror()
 
22
** TODO use EX_* from <sysexits.h>
 
23
 
 
24
* askpass-fifo
 
25
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
 
26
** TODO use error() instead of perror()
 
27
** TODO [#B] Drop privileges after opening FIFO.
 
28
 
 
29
* password-prompt
 
30
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
 
31
** TODO use error() instead of perror()
 
32
** TODO lock stdin (with flock()?)
 
33
 
 
34
* TODO passdev
 
35
 
 
36
* plugin-runner
 
37
** TODO [#B] use scandir(3) instead of readdir(3)
 
38
** TODO [#C] use same file name rules as run-parts(8)
 
39
** TODO use EX_* from <sysexits.h>
 
40
** TODO use error() instead of perror()
 
41
 
 
42
* mandos (server)
 
43
** TODO [#B] Log level                          :BUGS:
 
44
** TODO /etc/mandos/clients.d/*.conf
124
45
   Watch this directory and add/remove/update clients?
125
 
** config for TXT record
126
 
** Run-time communication with server
 
46
** TODO config for TXT record
 
47
** TODO [#B] Run-time communication with server :BUGS:
127
48
   Probably using D-Bus
128
 
   See also [[*Mandos-tools]]
129
 
** Implement --foreground
130
 
   [[info:standards:Option%20Table][Table of Long Options]]
131
 
** Implement --socket
132
 
   [[info:standards:Option%20Table][Table of Long Options]]
133
 
** Date+time on console log messages
 
49
*** Client class
 
50
*** Main server
 
51
    + SetLogLevel
 
52
      syslogger.setLevel(logging.WARNING)
 
53
    + [[http://log.ometer.com/2007-05.html][Best D-Bus practices]]
 
54
** TODO Implement --foreground                  :BUGS:
 
55
   [[info:standards:Option%20Table][Table of Long Options]]
 
56
** TODO Implement --socket
 
57
   [[info:standards:Option%20Table][Table of Long Options]]
 
58
** TODO Date+time on console log messages       :BUGS:
134
59
   Is this the default?
135
 
 
136
 
* Mandos-tools/utilities
137
 
  All of this probably using D-Bus
138
 
** List clients
139
 
** Disable client
140
 
** Enable client
141
 
 
142
 
* Installer
143
 
** Client
144
 
*** DONE [#A] Change initrd.img file to not be publically readable
145
 
    /usr/share/initramfs-tools/conf-hooks.d/mandos
146
 
    UMASK=027
147
 
*** Update initrd.img after installation
148
 
** Server
149
 
*** [#A] Create mandos user and group for server
150
 
*** [#A] Create /var/run/mandos directory with perm and ownership
151
 
 
152
 
** mandos-keygen
153
 
*** [#A] Command man page: man8/mandos-keygen.8
154
 
*** [#A] Output cut-and-paste ready snippet for clients.conf.
155
 
 
156
 
* [#A] Package
 
60
** TODO DBusServiceObjectUsingSuper
 
61
** TODO Global enable/disable flag
 
62
** TODO By-client countdown on secrets given
 
63
** TODO Fix problem with fsck taking a really long time
 
64
   Whenever a client successfully gets a secret it could get a
 
65
   one-time timeout boost to allow for an fsck-incurred delay
 
66
** TODO Delay before client receives key
 
67
   This would give an operator opportunity to cancel the request if
 
68
   desired.
 
69
** TODO Client manual approval mode
 
70
   A client needs manual approval on the server before it gets the
 
71
   secret
 
72
** TODO Persistent state
 
73
   /var/lib/mandos/*
 
74
 
 
75
* mandos.xml
 
76
** [[file:mandos.xml::XXX][Document D-Bus interface]]
 
77
 
 
78
* Provide and install /etc/dbus-1/system.d/mandos.conf
 
79
 
 
80
* mandos-ctl
 
81
*** Handle "no D-Bus server" and/or "no Mandos server found" better
 
82
*** [#B] --dump option
 
83
 
 
84
* TODO mandos-dispatch
 
85
  Listens for specified D-Bus signals and spawns shell commands with
 
86
  arguments.
 
87
 
 
88
* mandos-monitor
 
89
** D-Bus main loop w/ signal receiver
 
90
** Urwid client data displayer
 
91
*** Urwid scaffolding
 
92
*** Client Widgets
 
93
*** Properties popup
 
94
 
 
95
* mandos-keygen
 
96
** TODO Loop until passwords match when run interactively
 
97
** TODO "--secfile" option
 
98
   Using the "secfile" option instead of "secret"
 
99
** TODO [#B] "--test" option
 
100
   For testing decryption before rebooting.
 
101
 
 
102
* Makefile
 
103
** Implement DEB_BUILD_OPTIONS
 
104
   http://www.debian.org/doc/debian-policy/ch-source.html#s-debianrules-options
 
105
 
 
106
* Package
157
107
** /usr/share/initramfs-tools/hooks/mandos
158
 
*** Do not install in initrd.img if configured not to
159
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
160
 
    question.
161
 
** /etc/bash_completion.d/mandos
162
 
*** From xml sources directly?
163
 
** unperish
164
 
** bzr-builddeb
165
 
 
166
 
* INSTALL file
167
 
 
168
 
* Web site
169
 
 
170
 
* Mailing list
171
 
 
172
 
* Announce project on news
173
 
  [[news:comp.os.linux.announce]]
 
108
*** TODO [#C] use same file name rules as run-parts(8)
 
109
*** TODO [#C] Do not install in initrd.img if configured not to.
 
110
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
 
111
** TODO [#C] /etc/bash_completion.d/mandos
 
112
   From XML sources directly?
174
113
 
175
114
 
176
115
#+STARTUP: showall