/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

Documentation changes:

* DBUS-API: New file documenting the server D-Bus interface.

* clients.conf: Add examples of new approval settings.

* debian/mandos.docs: Added "DBUS-API".

* mandos-clients.conf.xml (OPTIONS): Added "approved_by_default",
                                     "approval_delay", and
                                     "approval_duration".
* mandos.xml (D-BUS INTERFACE): Refer to the "DBUS-API" file.
  (BUGS): Remove mention of lack of a remote query interface.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
1
1
-*- org -*-
2
2
 
3
 
* [#A] README file
 
3
* Use _attribute_((nonnull)) wherever possible.
 
4
 
 
5
* Release critical
 
6
** TODO Change make-run-server to not include --no-dbus
 
7
 
 
8
* mandos-client
 
9
** TODO [#B] use scandir(3) instead of readdir(3)
 
10
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
 
11
** TODO [#B] Retry a server which has a non-definite reply:
 
12
*** A closed connection during the TLS handshake
 
13
*** A TCP timeout
 
14
** TODO [#B] Use capabilities instead of seteuid().
 
15
** TODO [#A] Retry --connect forever
 
16
 
 
17
* splashy
 
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
 
 
21
* usplash
 
22
** TODO [#A] Make it work again
 
23
** TODO [#B] use scandir(3) instead of readdir(3)
 
24
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
 
25
** TODO Use [[info:libc:Argz%20Functions][argz_extract]]
 
26
 
 
27
* askpass-fifo
 
28
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
 
29
** TODO [#B] Drop privileges after opening FIFO.
 
30
 
 
31
* password-prompt
 
32
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
 
33
** TODO [#B] lock stdin (with flock()?)
 
34
 
 
35
* plymouth
 
36
** TODO Use [[info:libc:Argz%20Functions][argz_extract]]
 
37
 
 
38
* TODO [#B] passdev
4
39
 
5
40
* 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
 
*** ENVIRONMENT
12
 
    Environment is modified according to options and passed to plugins
13
 
*** EXAMPLE
14
 
    Examples of normal usage, debug usage, debugging single or all
15
 
    plugins, etc.
16
 
*** FILES
17
 
*** SECURITY
18
 
    Note the danger of using this program, since you might lock
19
 
    yourself out of your system without any means of entering the root
20
 
    file system password.  This is, however, very unlikely considering
21
 
    the fallback to getpass(3).
22
 
*** BUGS
23
 
*** SEE ALSO
24
 
    Explaining text on what you can read
25
 
 
26
 
* password-request
27
 
** [#A] Man page: man8/password-request.8mandos
28
 
*** SYNOPSIS
29
 
    Document short options
30
 
*** DESCRIPTION
31
 
    State that this command is not meant to be invoked directly, but
32
 
    is run as a plugin from mandos-client(8) and only run in the
33
 
    initrd environment, not the real system.
34
 
*** PURPOSE
35
 
    As in mandos.xml
36
 
*** OVERVIEW
37
 
    As in mandos.xml
38
 
*** EXIT STATUS
39
 
*** ENVIRONMENT
40
 
    Note that it does *not* currently use cryptsource or crypttarget.
41
 
*** FILES
42
 
    Describe the key files and the key ring files.  Also note that
43
 
    they should normally have been automatically created.
44
 
*** BUGS
45
 
*** EXAMPLE
46
 
    Examples of normal usage, debug usage, debugging by connecting
47
 
    directly, etc.
48
 
*** SECURITY
49
 
*** SEE ALSO
50
 
    Update from mandos.xml
51
 
** [#B] Temporarily lower kernel log level
52
 
   for less printouts during sucessfull boot.
53
 
** IPv4 support
54
 
** use strsep instead of strtok?
55
 
** Do not depend on GnuPG key rings on disk
56
 
   This would mean creating new GnuPG key rings with GPGME by
57
 
   importing the key files from scratch on every program start.
58
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
59
 
   Must create in preinst if not pre-depending on cryptsetup
60
 
 
61
 
* password-prompt
62
 
** [#C] Use getpass(3)?
63
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
64
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
65
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
66
 
   [[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?]]
 
41
** TODO [#B] use scandir(3) instead of readdir(3)
 
42
** TODO [#C] use same file name rules as run-parts(8)
 
43
** kernel command line option for debug info
 
44
** TODO [#B] Use openat()
67
45
 
68
46
* mandos (server)
69
 
** [#A] /etc/init.d/mandos-server               :teddy:
70
 
** [#B] Log level                               :bugs:
71
 
** /etc/mandos/clients.d/*.conf
72
 
   Watch this directory and add/remove/update clients?
73
 
** config for TXT record
74
 
** [#B] Run-time communication with server      :bugs:
75
 
   Probably using D-Bus
76
 
   See also [[*Mandos-tools]]
77
 
** Implement --foreground                       :bugs:
78
 
   [[info:standards:Option%20Table][Table of Long Options]]
79
 
** Implement --socket
80
 
   [[info:standards:Option%20Table][Table of Long Options]]
81
 
** Date+time on console log messages            :bugs:
 
47
** TODO [#B] Log level                                                    :BUGS:
 
48
** TODO Persistent state                                                  :BUGS:
 
49
   /var/lib/mandos/*
 
50
*** TODO /etc/mandos/clients.d/*.conf
 
51
    Watch this directory and add/remove/update clients?
 
52
** TODO [#C] config for TXT record
 
53
** TODO Log level option
 
54
   syslogger.setLevel(logging.WARNING)
 
55
   + SetLogLevel D-Bus call
 
56
** TODO Implement --foreground                                            :BUGS:
 
57
   [[info:standards:Option%20Table][Table of Long Options]]
 
58
** TODO Implement --socket
 
59
   [[info:standards:Option%20Table][Table of Long Options]]
 
60
** TODO Date+time on console log messages                                 :BUGS:
82
61
   Is this the default?
83
 
 
84
 
* Mandos-tools/utilities
85
 
  All of this probably using D-Bus
86
 
** List clients
87
 
** Disable client
88
 
** Enable client
89
 
 
90
 
* Man pages
91
 
** Tags
92
 
   Go through all man pages to conform to the style of tags chosen in
93
 
   [[http://svn.debian.org/wsvn/debian-xml-sgml/packages/docbook-xsl/trunk/debian/examples/foo.1.example_manpage.xml?op=file&rev=0&sc=0][foo.1.example_manpage.xml]].  In particular:
94
 
*** Synopsis <arg> and <option> tags
95
 
*** EXAMPLES &COMMANDNAME;
96
 
** Use xinclude for common sections
97
 
   Like copyright, authors, etc.
98
 
** SEE ALSO
99
 
   Alphabetize
100
 
 
101
 
 
102
 
* Installer
103
 
** Client-side
104
 
*** Update initrd.img after installation
105
 
    This seems to use some kind of "trigger" system
106
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
107
 
    dpkg-trigger(1), deb-triggers(5)
108
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
109
 
    Must create in preinst if not pre-depending on cryptsetup
110
 
*** mandos-keygen
111
 
**** "--passfile" option
112
 
     Using the "secfile" option instead of "secret"
113
 
**** [#A] "--test" option
114
 
     For testing decryption before rebooting.
115
 
** Server-side
116
 
*** [#A] Create mandos user and group for server
117
 
*** [#A] Create /var/run/mandos directory with perm and ownership
118
 
 
119
 
* [#A] Package
 
62
** TODO [#C] DBusServiceObjectUsingSuper
 
63
** TODO [#B] Global enable/disable flag
 
64
** TODO [#B] By-client countdown on secrets given
 
65
** TODO [#B] Fix problem with fsck taking a really long time
 
66
   Whenever a client successfully gets a secret it could get a
 
67
   one-time timeout boost to allow for an fsck-incurred delay
 
68
** TODO [#A] Delay before client receives key
 
69
   This would give an operator opportunity to cancel the request if
 
70
   desired.
 
71
** TODO [#A] Client manual approval mode
 
72
   A client needs manual approval on the server before it gets the
 
73
   secret
 
74
** TODO [#B] Support RFC 3339 time duration syntax
 
75
** More D-Bus methods
 
76
*** NeedsApproval(50, True) -> timeout, default approve
 
77
    Default approval is configurable, but True by default
 
78
    + Approve(True) -> approve sending saved
 
79
    + Approve(False) -> Close client connection immediately
 
80
*** NeedsPassword(50) - Timeout, default disapprove
 
81
    + SetPass(u"gazonk", True) -> Approval, persistent
 
82
    + Approve(False) -> Close client connection immediately
 
83
** TODO [#C] python-parsedatetime
 
84
** TODO [#C] systemd/launchd
 
85
   http://0pointer.de/blog/projects/systemd.html
 
86
** TODO Separate logging logic to own object
 
87
** TODO make clients to a dict!
 
88
** TODO [#A] Limit approval_delay to max gnutls/tls timeout value
 
89
 
 
90
* mandos.xml
 
91
** Add mandos contact info in manual pages
 
92
 
 
93
* mandos-ctl
 
94
*** Handle "no D-Bus server" and/or "no Mandos server found" better
 
95
*** [#B] --dump option
 
96
** TODO Support RFC 3339 time duration syntax
 
97
 
 
98
* TODO mandos-dispatch
 
99
  Listens for specified D-Bus signals and spawns shell commands with
 
100
  arguments.
 
101
 
 
102
* mandos-monitor
 
103
** TODO help should be toggable
 
104
** Urwid client data displayer
 
105
   Better view of client data in the listing
 
106
*** Properties popup
 
107
** Nicer crashes. Stack traces Messes up shell.
 
108
*** Print a nice "We are sorry" message, save stack trace to log.
 
109
 
 
110
* mandos-keygen
 
111
** TODO Loop until passwords match when run interactively
 
112
** TODO "--secfile" option
 
113
   Using the "secfile" option instead of "secret"
 
114
** TODO [#B] "--test" option
 
115
   For testing decryption before rebooting.
 
116
 
 
117
* Makefile
 
118
** TODO Add "--Xlinker --as-needed"
 
119
   http://udrepper.livejournal.com/19395.html
 
120
** TODO [#C] Implement DEB_BUILD_OPTIONS
 
121
   http://www.debian.org/doc/debian-policy/ch-source.html#s-debianrules-options
 
122
 
 
123
* Package
120
124
** /usr/share/initramfs-tools/hooks/mandos
121
 
*** Do not install in initrd.img if configured not to.
122
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
123
 
    question.
124
 
** /etc/bash_completion.d/mandos
 
125
*** TODO [#C] use same file name rules as run-parts(8)
 
126
*** TODO [#C] Do not install in initrd.img if configured not to.
 
127
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
 
128
** TODO [#C] /etc/bash_completion.d/mandos
125
129
   From XML sources directly?
126
 
** unperish
127
 
** bzr-builddeb
128
 
 
129
 
* INSTALL file
130
 
 
131
 
* Web site
132
 
 
133
 
* Mailing list
134
 
 
135
 
* Announce project on news
136
 
  [[news:comp.os.linux.announce]]
 
130
 
 
131
* Side Stuff
 
132
** TODO Locate which packet move the other bin/sh when busy box is deactivated
 
133
** TODO contact owner of packet, and ask them to have that shell static in position regardless of busybox
137
134
 
138
135
 
139
136
#+STARTUP: showall