/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

  • Committer: Björn Påhlsson
  • Date: 2009-09-21 21:57:23 UTC
  • mto: (237.7.1 mandos) (24.1.154 mandos)
  • mto: This revision was merged to the branch mainline in revision 270.
  • Revision ID: belorn@braxen-20090921215723-no1445t10clzl0e1
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
 
*** BUGS
17
 
*** SEE ALSO
18
 
    Explaining text on what you can read
19
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
20
 
   Must create in preinst if not pre-depending on cryptsetup
21
 
 
22
 
* password-request
23
 
** [#A] Man page: man8/password-request.8mandos
24
 
*** SYNOPSIS
25
 
    Document short options
26
 
*** DESCRIPTION
27
 
    State that this command is not meant to be invoked directly, but
28
 
    is run as a plugin from mandos-client(8) and only run in the
29
 
    initrd environment, not the real system.
30
 
*** PURPOSE
31
 
    As in mandos.xml
32
 
*** OVERVIEW
33
 
    As in mandos.xml
34
 
*** EXIT STATUS
35
 
*** ENVIRONMENT
36
 
    Note that it does *not* currently use cryptsource or crypttarget.
37
 
*** FILES
38
 
    Describe the key files and the key ring files.  Also note that
39
 
    they should normally have been automatically created.
40
 
*** BUGS
41
 
*** EXAMPLE
42
 
    Examples of normal usage, debug usage, debugging by connecting
43
 
    directly, etc.
44
 
*** SECURITY
45
 
*** SEE ALSO
46
 
    Update from mandos.xml
47
 
** [#B] Temporarily lower kernel log level
48
 
   for less printouts during sucessfull boot.
49
 
** IPv4 support
50
 
** use strsep instead of strtok?
51
 
** Do not depend on GnuPG key rings on disk
52
 
   This would mean creating new GnuPG key rings with GPGME by
53
 
   importing the key files from scratch on every program start.
54
 
 
55
 
* password-prompt
56
 
** [#A] Man page: man8/password-prompt.8mandos
57
 
*** SYNOPSIS
58
 
    Document short options
59
 
*** DESCRIPTION
60
 
    Note that this is more or less a simple getpass(3) wrapper, even
61
 
    though actual use of getpass(3) is not guaranteed.
62
 
*** EXIT STATUS
63
 
*** ENVIRONMENT
64
 
    Document use of "cryptsource" and "crypttarget".
65
 
*** FILES
66
 
*** BUGS
67
 
*** EXAMPLE
68
 
    Examples of normal usage, debug usage, with a prefix, etc.
69
 
*** SECURITY
70
 
    Not much to do here but it is noteworthy to state the danger of
71
 
    not having a fallback option.
72
 
*** SEE ALSO
73
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
74
 
    and also, perhaps, to cryptsetup(8)?
75
 
** Use getpass(3)?
76
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
77
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
78
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
79
 
   [[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)
80
31
 
81
32
* mandos (server)
82
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
83
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
84
 
** [#A] /etc/init.d/mandos-server               :teddy:
85
 
** [#B] Log level                               :bugs:
86
 
** /etc/mandos/clients.d/*.conf
 
33
** TODO [#B] Log level                          :BUGS:
 
34
** TODO /etc/mandos/clients.d/*.conf
87
35
   Watch this directory and add/remove/update clients?
88
 
** config for TXT record
89
 
** [#B] Run-time communication with server      :bugs:
 
36
** TODO config for TXT record
 
37
** TODO [#B] Run-time communication with server :BUGS:
90
38
   Probably using D-Bus
91
 
   See also [[*Mandos-tools]]
92
 
** Implement --foreground                       :bugs:
93
 
   [[info:standards:Option%20Table][Table of Long Options]]
94
 
** Implement --socket
95
 
   [[info:standards:Option%20Table][Table of Long Options]]
96
 
** 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:
97
49
   Is this the default?
98
 
 
99
 
* Mandos-tools/utilities
100
 
  All of this probably using D-Bus
101
 
** List clients
102
 
** Disable client
103
 
** Enable client
104
 
 
105
 
* Installer
106
 
** Client
107
 
*** Update initrd.img after installation
108
 
    This seems to use some kind of "trigger" system
109
 
** Server
110
 
*** [#A] Create mandos user and group for server
111
 
*** [#A] Create /var/run/mandos directory with perm and ownership
112
 
 
113
 
** mandos-keygen
114
 
*** [#A] Output cut-and-paste ready snippet for clients.conf.
115
 
 
116
 
* [#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
117
97
** /usr/share/initramfs-tools/hooks/mandos
118
 
*** Do not install in initrd.img if configured not to.
119
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
120
 
    question.
121
 
** /etc/bash_completion.d/mandos
122
 
*** From XML sources directly?
123
 
** unperish
124
 
** bzr-builddeb
125
 
 
126
 
* INSTALL file
127
 
 
128
 
* Web site
129
 
 
130
 
* Mailing list
131
 
 
132
 
* Announce project on news
133
 
  [[news:comp.os.linux.announce]]
 
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
 
102
   From XML sources directly?
134
103
 
135
104
 
136
105
#+STARTUP: showall