/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: Teddy Hogeborn
  • Date: 2008-08-19 13:25:14 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080819132514-wawrvgmfjovg9poj
* Makefile (DOCBOOKTOMAN): Added "--xinclude".

* mandos-options.xml: New file; moved mandos(8) option descriptions
                      here.

* mandos.conf.xml: Add XInclude namespace.
  (OPTIONS): New separate section with options from old "DESCRIPTION"
             section.  Changed all options to include a synopsis and
             include its paragraph from "mandos-options.xml".
  (FILES): Moved to before "EXAMPLES".
  (BUGS): New section.
  (EXAMPLES): Renamed to "EXAMPLE", as per man-pages(7).  Unindented
              example text.

* mandos.xml: Removed OVERVIEW entity.  Add XInclude namespace.
  (OPTIONS): Moved all descriptive paragraphs to "mandos-options.xml"
             and just <xi:include/> them from here.
  (OVERVIEW): Changed to do <xi:include/>.

* overview.xml: Added DOCTYPE; reportedly needed for XInclude to work.

Show diffs side-by-side

added added

removed removed

Lines of Context:
TODO
1
1
-*- org -*-
2
2
 
3
 
* Use _attribute_((nonnull)) wherever possible.
4
 
 
5
 
* mandos-client
6
 
** TODO [#B] use scandir(3) instead of readdir(3)
7
 
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
8
 
** TODO [#B] Retry a server which has a non-definite reply:
9
 
*** A closed connection during the TLS handshake
10
 
*** A TCP timeout
11
 
** TODO [#B] Use capabilities instead of seteuid().
12
 
** TODO [#A] Retry --connect forever
13
 
 
14
 
* splashy
15
 
** TODO [#B] use scandir(3) instead of readdir(3)
16
 
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
17
 
 
18
 
* usplash
19
 
** TODO [#A] Make it work again
20
 
** TODO [#B] use scandir(3) instead of readdir(3)
21
 
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
22
 
** TODO Use [[info:libc:Argz%20Functions][argz_extract]]
23
 
 
24
 
* askpass-fifo
25
 
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
26
 
** TODO [#B] Drop privileges after opening FIFO.
 
3
* [#A] README file
 
4
 
 
5
* 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
27
58
 
28
59
* password-prompt
29
 
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
30
 
** TODO [#B] lock stdin (with flock()?)
31
 
 
32
 
* TODO [#B] 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
 
** kernel command line option for debug info
38
 
** TODO [#B] Use openat()
 
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?]]
39
84
 
40
85
* mandos (server)
41
 
** TODO [#B] Log level                                                    :BUGS:
42
 
** TODO Persistent state                                                  :BUGS:
43
 
   /var/lib/mandos/*
44
 
*** TODO /etc/mandos/clients.d/*.conf
45
 
    Watch this directory and add/remove/update clients?
46
 
** TODO [#C] config for TXT record
47
 
** TODO Log level option
48
 
   syslogger.setLevel(logging.WARNING)
49
 
   + SetLogLevel D-Bus call
50
 
** TODO Implement --foreground                                            :BUGS:
51
 
   [[info:standards:Option%20Table][Table of Long Options]]
52
 
** TODO Implement --socket
53
 
   [[info:standards:Option%20Table][Table of Long Options]]
54
 
** TODO Date+time on console log messages                                 :BUGS:
 
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
 
91
   Watch this directory and add/remove/update clients?
 
92
** config for TXT record
 
93
** [#B] Run-time communication with server      :bugs:
 
94
   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:
55
101
   Is this the default?
56
 
** TODO [#C] DBusServiceObjectUsingSuper
57
 
** TODO [#B] Global enable/disable flag
58
 
** TODO [#B] By-client countdown on secrets given
59
 
** TODO [#B] Fix problem with fsck taking a really long time
60
 
   Whenever a client successfully gets a secret it could get a
61
 
   one-time timeout boost to allow for an fsck-incurred delay
62
 
** TODO [#A] Delay before client receives key
63
 
   This would give an operator opportunity to cancel the request if
64
 
   desired.
65
 
** TODO [#A] Client manual approval mode
66
 
   A client needs manual approval on the server before it gets the
67
 
   secret
68
 
** TODO [#B] Support RFC 3339 time duration syntax
69
 
** More D-Bus methods
70
 
*** NeedsApproval(50, True) -> timeout, default approve
71
 
    Default approval is configurable, but True by default
72
 
    + Approve(True) -> approve sending saved
73
 
    + Approve(False) -> Close client connection immediately
74
 
*** NeedsPassword(50) - Timeout, default disapprove
75
 
    + SetPass(u"gazonk", True) -> Approval, persistent
76
 
    + Approve(False) -> Close client connection immediately
77
 
** TODO [#C] python-parsedatetime
78
 
** TODO [#C] systemd/launchd
79
 
   http://0pointer.de/blog/projects/systemd.html
80
 
** TODO Separate logging logic to own object
81
 
** TODO make clients to a dict!
82
 
** TODO [#A] Limit approval_delay to max gnutls/tls timeout value
83
 
** TODO [#B] break the wait on approval_delay if connection dies
84
 
** TODO Generate Client.runtime_expansions from client options + extra
85
 
** TODO Allow %%(checker)s as a runtime expansion
86
 
 
87
 
* mandos.xml
88
 
** Add mandos contact info in manual pages
89
 
 
90
 
* mandos-ctl
91
 
*** Handle "no D-Bus server" and/or "no Mandos server found" better
92
 
*** [#B] --dump option
93
 
** TODO Support RFC 3339 time duration syntax
94
 
 
95
 
* TODO mandos-dispatch
96
 
  Listens for specified D-Bus signals and spawns shell commands with
97
 
  arguments.
98
 
 
99
 
* mandos-monitor
100
 
** TODO help should be toggable
101
 
** Urwid client data displayer
102
 
   Better view of client data in the listing
103
 
*** Properties popup
104
 
** Nicer crashes. Stack traces Messes up shell.
105
 
*** Print a nice "We are sorry" message, save stack trace to log.
106
 
** Show timeout countdown for approval
107
 
 
108
 
* mandos-keygen
109
 
** TODO Loop until passwords match when run interactively
110
 
** TODO "--secfile" option
111
 
   Using the "secfile" option instead of "secret"
112
 
** TODO [#B] "--test" option
113
 
   For testing decryption before rebooting.
114
 
 
115
 
* Makefile
116
 
** TODO Add "--Xlinker --as-needed"
117
 
   http://udrepper.livejournal.com/19395.html
118
 
** TODO [#C] Implement DEB_BUILD_OPTIONS
119
 
   http://www.debian.org/doc/debian-policy/ch-source.html#s-debianrules-options
120
 
 
121
 
* Package
 
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
122
122
** /usr/share/initramfs-tools/hooks/mandos
123
 
*** TODO [#C] use same file name rules as run-parts(8)
124
 
*** TODO [#C] Do not install in initrd.img if configured not to.
125
 
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
126
 
** TODO [#C] /etc/bash_completion.d/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
127
127
   From XML sources directly?
128
 
 
129
 
* Side Stuff
130
 
** TODO Locate which packet move the other bin/sh when busy box is deactivated
131
 
** TODO contact owner of packet, and ask them to have that shell static in position regardless of busybox
 
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]]
132
139
 
133
140
 
134
141
#+STARTUP: showall