/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: 2008-08-30 19:49:24 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080830194924-f4liqq8wxajlbshn
* plugin-runner.xml (NAME): Improved wording.
  (SYNOPSIS): Use <option> and <replaceable> tags.  Unify short and
              long options.  Add "--global-envs" and "--envs-for"
              options.

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 use error() instead of perror()
9
 
** TODO [#B] Retry a server which has a non-definite reply:
10
 
*** A closed connection during the TLS handshake
11
 
*** A TCP timeout
12
 
** TODO [#B] Use capabilities instead of seteuid().
13
 
** TODO [#A] Retry --connect forever
14
 
 
15
 
* splashy
16
 
** TODO [#B] use scandir(3) instead of readdir(3)
17
 
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
18
 
** TODO [#B] use error() instead of perror()
19
 
 
20
 
* usplash
21
 
** TODO [#A] Make it work again
22
 
** TODO [#B] use scandir(3) instead of readdir(3)
23
 
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
24
 
** TODO [#B] use error() instead of perror()
25
 
 
26
 
* askpass-fifo
27
 
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
28
 
** TODO [#B] use error() instead of perror()
29
 
** 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
*** 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
30
60
 
31
61
* password-prompt
32
 
** TODO [#B] Prefix all debug output with "Mandos plugin " + program_invocation_short_name
33
 
** TODO [#B] use error() instead of perror()
34
 
** TODO [#B] lock stdin (with flock()?)
35
 
 
36
 
* TODO [#B] passdev
37
 
 
38
 
* plugin-runner
39
 
** TODO [#B] use scandir(3) instead of readdir(3)
40
 
** TODO [#C] use same file name rules as run-parts(8)
41
 
** kernel command line option for debug info
42
 
** TODO [#B] use error() instead of perror()
43
 
** TODO [#B] Use openat()
 
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?]]
44
67
 
45
68
* mandos (server)
46
 
** TODO [#B] Log level                                                    :BUGS:
47
 
** TODO Persistent state                                                  :BUGS:
48
 
   /var/lib/mandos/*
49
 
*** TODO /etc/mandos/clients.d/*.conf
50
 
    Watch this directory and add/remove/update clients?
51
 
** TODO [#C] config for TXT record
52
 
** TODO Log level option
53
 
   syslogger.setLevel(logging.WARNING)
54
 
   + SetLogLevel D-Bus call
55
 
** TODO Implement --foreground                                            :BUGS:
56
 
   [[info:standards:Option%20Table][Table of Long Options]]
57
 
** TODO Implement --socket
58
 
   [[info:standards:Option%20Table][Table of Long Options]]
59
 
** TODO Date+time on console log messages                                 :BUGS:
 
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:
60
82
   Is this the default?
61
 
** TODO [#C] DBusServiceObjectUsingSuper
62
 
** TODO [#B] Global enable/disable flag
63
 
** TODO [#B] By-client countdown on secrets given
64
 
** TODO [#B] Fix problem with fsck taking a really long time
65
 
   Whenever a client successfully gets a secret it could get a
66
 
   one-time timeout boost to allow for an fsck-incurred delay
67
 
** TODO [#A] Delay before client receives key
68
 
   This would give an operator opportunity to cancel the request if
69
 
   desired.
70
 
** TODO [#A] Client manual approval mode
71
 
   A client needs manual approval on the server before it gets the
72
 
   secret
73
 
** TODO [#B] Support RFC 3339 time duration syntax
74
 
** More D-Bus methods
75
 
*** NeedsApproval(50, True) -> timeout, default approve
76
 
    Default approval is configurable, but True by default
77
 
    + Approve(True) -> approve sending saved
78
 
    + Approve(False) -> Close client connection immediately
79
 
*** NeedsPassword(50) - Timeout, default disapprove
80
 
    + SetPass(u"gazonk", True) -> Approval, persistent
81
 
    + Approve(False) -> Close client connection immediately
82
 
** TODO [#C] python-parsedatetime
83
 
** TODO [#C] systemd/launchd
84
 
   http://0pointer.de/blog/projects/systemd.html
85
 
 
86
 
* mandos.xml
87
 
** [[file:mandos.xml::XXX][Document D-Bus interface]]
88
 
   Remove mention of lack of such interface in BUGS section
89
 
** Add mandos contact info in manual pages
90
 
 
91
 
* TODO [#A] Provide and install /etc/dbus-1/system.d/mandos.conf
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
 
** Urwid client data displayer
104
 
   Better view of client data in the listing
105
 
*** Properties popup
106
 
 
107
 
* mandos-keygen
108
 
** TODO Loop until passwords match when run interactively
109
 
** TODO "--secfile" option
110
 
   Using the "secfile" option instead of "secret"
111
 
** TODO [#B] "--test" option
112
 
   For testing decryption before rebooting.
113
 
 
114
 
* Makefile
115
 
** TODO Add "--Xlinker --as-needed"
116
 
   http://udrepper.livejournal.com/19395.html
117
 
** TODO [#C] Implement DEB_BUILD_OPTIONS
118
 
   http://www.debian.org/doc/debian-policy/ch-source.html#s-debianrules-options
119
 
 
120
 
* Package
 
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
 
95
    <arg> with inner <replaceable> and <option> tags
 
96
**** DONE mandos-clients.conf.xml
 
97
**** DONE mandos-keygen.xml
 
98
**** DONE mandos.conf.xml
 
99
**** DONE mandos.xml
 
100
**** DONE plugin-runner.xml
 
101
**** TODO plugins.d/password-prompt.xml
 
102
**** DONE plugins.d/password-request.xml
 
103
*** OPTIONS
 
104
    Separate <term> tags with <option> and <replaceable> tags
 
105
**** DONE mandos-clients.conf.xml
 
106
**** TODO mandos-keygen.xml
 
107
**** DONE mandos.conf.xml
 
108
**** TODO mandos.xml
 
109
**** TODO plugin-runner.xml
 
110
**** TODO plugins.d/password-prompt.xml
 
111
**** TODO plugins.d/password-request.xml
 
112
** Use xinclude for common sections
 
113
   Like copyright, authors, etc.
 
114
 
 
115
 
 
116
* Installer
 
117
** Client-side
 
118
*** Update initrd.img after installation
 
119
    This seems to use some kind of "trigger" system
 
120
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
 
121
    dpkg-trigger(1), deb-triggers(5)
 
122
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
123
    Must create in preinst if not pre-depending on cryptsetup
 
124
*** mandos-keygen
 
125
**** "--passfile" option
 
126
     Using the "secfile" option instead of "secret"
 
127
**** [#A] "--test" option
 
128
     For testing decryption before rebooting.
 
129
** Server-side
 
130
*** [#A] Create mandos user and group for server
 
131
*** [#A] Create /var/run/mandos directory with perm and ownership
 
132
 
 
133
* [#A] Package
121
134
** /usr/share/initramfs-tools/hooks/mandos
122
 
*** TODO [#C] use same file name rules as run-parts(8)
123
 
*** TODO [#C] Do not install in initrd.img if configured not to.
124
 
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
125
 
** TODO [#C] /etc/bash_completion.d/mandos
 
135
*** Do not install in initrd.img if configured not to.
 
136
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
 
137
    question.
 
138
** /etc/bash_completion.d/mandos
126
139
   From XML sources directly?
 
140
** unperish
 
141
** bzr-builddeb
 
142
 
 
143
* INSTALL file
 
144
 
 
145
* Web site
 
146
 
 
147
* Mailing list
 
148
 
 
149
* Announce project on news
 
150
  [[news:comp.os.linux.announce]]
127
151
 
128
152
 
129
153
#+STARTUP: showall