/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 documentation todo

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
-*- org -*-
2
2
 
3
 
* [#A] README file
 
3
* mandos-client
 
4
** TODO [#B] use scandir(3) instead of readdir(3)
 
5
** TODO [#B] Prefix all debug output with argv[0]
 
6
** TODO [#B] Retry a server which has a non-definite reply:
 
7
*** A closed connection during the TLS handshake
 
8
*** A TCP timeout
 
9
** TODO [#B] Use capabilities instead of seteuid().
 
10
 
 
11
* splashy
 
12
** TODO [#B] use scandir(3) instead of readdir(3)
 
13
** TODO [#B] Prefix all debug output with "Mandos plugin " + argv[0]
 
14
 
 
15
* usplash
 
16
** TODO [#B] use scandir(3) instead of readdir(3)
 
17
** TODO [#B] Prefix all debug output with "Mandos plugin " + argv[0]
 
18
 
 
19
* askpass-fifo
 
20
** TODO [#B] Prefix all debug output with "Mandos plugin " + argv[0]
 
21
** TODO [#B] Drop privileges after opening FIFO.
 
22
 
 
23
* password-prompt
 
24
** TODO [#B] Prefix all debug output with "Mandos plugin " + argv[0]
 
25
 
 
26
* TODO passdev
4
27
 
5
28
* 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
 
*** EXAMPLES
12
 
    Examples of normal usage, debug usage, debugging single or all
13
 
    plugins, etc.
14
 
*** FILES
15
 
*** SECURITY
16
 
    Note the danger of using this program, since you might lock
17
 
    yourself out of your system without any means of entering the root
18
 
    file system password.  This is, however, very unlikely considering
19
 
    the fallback to getpass(3).
20
 
*** BUGS
21
 
*** SEE ALSO
22
 
    Explaining text on what you can read
23
 
 
24
 
* password-request
25
 
** [#A] Man page: man8/password-request.8mandos
26
 
*** SYNOPSIS
27
 
    Document short options
28
 
*** DESCRIPTION
29
 
    State that this command is not meant to be invoked directly, but
30
 
    is run as a plugin from mandos-client(8) and only run in the
31
 
    initrd environment, not the real system.
32
 
*** PURPOSE
33
 
    As in mandos.xml
34
 
*** OVERVIEW
35
 
    As in mandos.xml
36
 
*** EXIT STATUS
37
 
*** ENVIRONMENT
38
 
    Note that it does *not* currently use cryptsource or crypttarget.
39
 
*** FILES
40
 
    Describe the key files and the key ring files.  Also note that
41
 
    they should normally have been automatically created.
42
 
*** BUGS
43
 
*** EXAMPLE
44
 
    Examples of normal usage, debug usage, debugging by connecting
45
 
    directly, etc.
46
 
*** SECURITY
47
 
*** SEE ALSO
48
 
    Update from mandos.xml
49
 
** [#B] Temporarily lower kernel log level
50
 
   for less printouts during sucessfull boot.
51
 
** IPv4 support
52
 
** use strsep instead of strtok?
53
 
** Do not depend on GnuPG key rings on disk
54
 
   This would mean creating new GnuPG key rings with GPGME by
55
 
   importing the key files from scratch on every program start.
56
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
57
 
   Must create in preinst if not pre-depending on cryptsetup
58
 
 
59
 
* password-prompt
60
 
** [#A] Man page: man8/password-prompt.8mandos
61
 
*** SYNOPSIS
62
 
    Document short options
63
 
*** DESCRIPTION
64
 
    Note that this is more or less a simple getpass(3) wrapper, even
65
 
    though actual use of getpass(3) is not guaranteed.
66
 
*** EXIT STATUS
67
 
*** ENVIRONMENT
68
 
    Document use of "cryptsource" and "crypttarget".
69
 
*** FILES
70
 
*** BUGS
71
 
*** EXAMPLE
72
 
    Examples of normal usage, debug usage, with a prefix, etc.
73
 
*** SECURITY
74
 
    Not much to do here but it is noteworthy to state the danger of
75
 
    not having a fallback option.
76
 
*** SEE ALSO
77
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
78
 
    and also, perhaps, to cryptsetup(8)?
79
 
** 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
** TODO [#B] use scandir(3) instead of readdir(3)
 
30
** TODO [#C] use same file name rules as run-parts(8)
84
31
 
85
32
* mandos (server)
86
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
87
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
88
 
** [#A] /etc/init.d/mandos-server               :teddy:
89
 
** [#B] Log level                               :bugs:
90
 
** /etc/mandos/clients.d/*.conf
 
33
** TODO [#B] Log level                          :BUGS:
 
34
** TODO /etc/mandos/clients.d/*.conf
91
35
   Watch this directory and add/remove/update clients?
92
 
** config for TXT record
93
 
** [#B] Run-time communication with server      :bugs:
 
36
** TODO config for TXT record
 
37
** TODO [#B] Run-time communication with server :BUGS:
94
38
   Probably using D-Bus
95
 
   See also [[*Mandos-tools]]
96
 
** Implement --foreground                       :bugs:
97
 
   [[info:standards:Option%20Table][Table of Long Options]]
98
 
** Implement --socket
99
 
   [[info:standards:Option%20Table][Table of Long Options]]
100
 
** Date+time on console log messages            :bugs:
 
39
*** Client class
 
40
*** Main server
 
41
    + SetLogLevel
 
42
      syslogger.setLevel(logging.WARNING)
 
43
    + [[http://log.ometer.com/2007-05.html][Best D-Bus practices]]
 
44
** TODO Implement --foreground                  :BUGS:
 
45
   [[info:standards:Option%20Table][Table of Long Options]]
 
46
** TODO Implement --socket
 
47
   [[info:standards:Option%20Table][Table of Long Options]]
 
48
** TODO Date+time on console log messages       :BUGS:
101
49
   Is this the default?
102
 
 
103
 
* Mandos-tools/utilities
104
 
  All of this probably using D-Bus
105
 
** List clients
106
 
** Disable client
107
 
** Enable client
108
 
 
109
 
* Installer
110
 
** Client-side
111
 
*** Update initrd.img after installation
112
 
    This seems to use some kind of "trigger" system
113
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
114
 
    Must create in preinst if not pre-depending on cryptsetup
115
 
*** mandos-keygen
116
 
**** [#A] Output cut-and-paste ready snippet for clients.conf.
117
 
** Server-side
118
 
*** [#A] Create mandos user and group for server
119
 
*** [#A] Create /var/run/mandos directory with perm and ownership
120
 
 
121
 
* [#A] Package
 
50
** TODO DBusServiceObjectUsingSuper
 
51
** TODO Global enable/disable flag
 
52
** TODO By-client countdown on secrets given
 
53
** TODO Fix problem with fsck taking a really long time
 
54
   Whenever a client successfully gets a secret it could get a
 
55
   one-time timeout boost to allow for an fsck-incurred delay
 
56
** TODO Delay before client receives key
 
57
   This would give an operator opportunity to cancel the request if
 
58
   desired.
 
59
** TODO Client manual approval mode
 
60
   A client needs manual approval on the server before it gets the
 
61
   secret
 
62
** TODO Persistent state
 
63
   /var/lib/mandos/*
 
64
 
 
65
* mandos.xml
 
66
** [[file:mandos.xml::XXX][Document D-Bus interface]]
 
67
** Add mandos contact info in manual pages
 
68
 
 
69
* Provide and install /etc/dbus-1/system.d/mandos.conf
 
70
 
 
71
* mandos-ctl
 
72
*** Handle "no D-Bus server" and/or "no Mandos server found" better
 
73
*** [#B] --dump option
 
74
 
 
75
* TODO mandos-dispatch
 
76
  Listens for specified D-Bus signals and spawns shell commands with
 
77
  arguments.
 
78
 
 
79
* mandos-monitor
 
80
** D-Bus mail loop w/ signal receiver
 
81
** Snack/Newt client data displayer
 
82
*** Client Widgets
 
83
*** Properties popup
 
84
 
 
85
* mandos-keygen
 
86
** TODO Loop until passwords match when run interactively
 
87
** TODO "--secfile" option
 
88
   Using the "secfile" option instead of "secret"
 
89
** TODO [#B] "--test" option
 
90
   For testing decryption before rebooting.
 
91
 
 
92
* Makefile
 
93
** Implement DEB_BUILD_OPTIONS
 
94
   http://www.debian.org/doc/debian-policy/ch-source.html#s-debianrules-options
 
95
 
 
96
* Package
122
97
** /usr/share/initramfs-tools/hooks/mandos
123
 
*** Do not install in initrd.img if configured not to.
124
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
125
 
    question.
126
 
** /etc/bash_completion.d/mandos
 
98
*** TODO [#C] use same file name rules as run-parts(8)
 
99
*** TODO [#C] Do not install in initrd.img if configured not to.
 
100
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
 
101
** TODO [#C] /etc/bash_completion.d/mandos
127
102
   From XML sources directly?
128
 
** unperish
129
 
** bzr-builddeb
130
 
 
131
 
* INSTALL file
132
 
 
133
 
* Web site
134
 
 
135
 
* Mailing list
136
 
 
137
 
* Announce project on news
138
 
  [[news:comp.os.linux.announce]]
139
103
 
140
104
 
141
105
#+STARTUP: showall