/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-31 08:47:38 UTC
  • Revision ID: teddy@fukt.bsnet.se-20080831084738-uu70kayyt876982d
* mandos-keygen: Minor help text change.

* mandos-keygen.xml: Changed plural "keys" to singular "key"
                     throughout.
  (NAME): Improved wording.
  (DESCRIPTION): Improved wording.
  (OPTIONS): Split options in <term> tags into separate <term> tags.
             Use <option> tags.  Move long options before short
             options.  Uppercase replaceables.
  (OVERVIEW): Improved wording.
  (EXIT STATUS): Also cover --password option.
  (EXAMPLE): Add two examples using the --password option.
  (SECURITY): Improved wording.

* overview.xml: Improved wording.

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
 
* Release critical
6
 
** Update copyright year to add 2010
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.
 
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] lock stdin (with flock()?)
34
 
 
35
 
* TODO [#B] passdev
36
 
 
37
 
* plugin-runner
38
 
** TODO [#B] use scandir(3) instead of readdir(3)
39
 
** TODO [#C] use same file name rules as run-parts(8)
40
 
** kernel command line option for debug info
41
 
** 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?]]
42
67
 
43
68
* mandos (server)
44
 
** TODO [#B] Log level                                                    :BUGS:
45
 
** TODO Persistent state                                                  :BUGS:
46
 
   /var/lib/mandos/*
47
 
*** TODO /etc/mandos/clients.d/*.conf
48
 
    Watch this directory and add/remove/update clients?
49
 
** TODO [#C] config for TXT record
50
 
** TODO Log level option
51
 
   syslogger.setLevel(logging.WARNING)
52
 
   + SetLogLevel D-Bus call
53
 
** TODO Implement --foreground                                            :BUGS:
54
 
   [[info:standards:Option%20Table][Table of Long Options]]
55
 
** TODO Implement --socket
56
 
   [[info:standards:Option%20Table][Table of Long Options]]
57
 
** 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:
58
82
   Is this the default?
59
 
** TODO [#C] DBusServiceObjectUsingSuper
60
 
** TODO [#B] Global enable/disable flag
61
 
** TODO [#B] By-client countdown on secrets given
62
 
** TODO [#B] Fix problem with fsck taking a really long time
63
 
   Whenever a client successfully gets a secret it could get a
64
 
   one-time timeout boost to allow for an fsck-incurred delay
65
 
** TODO [#A] Delay before client receives key
66
 
   This would give an operator opportunity to cancel the request if
67
 
   desired.
68
 
** TODO [#A] Client manual approval mode
69
 
   A client needs manual approval on the server before it gets the
70
 
   secret
71
 
** TODO [#B] Support RFC 3339 time duration syntax
72
 
** More D-Bus methods
73
 
*** NeedsApproval(50, True) -> timeout, default approve
74
 
    Default approval is configurable, but True by default
75
 
    + Approve(True) -> approve sending saved
76
 
    + Approve(False) -> Close client connection immediately
77
 
*** NeedsPassword(50) - Timeout, default disapprove
78
 
    + SetPass(u"gazonk", True) -> Approval, persistent
79
 
    + Approve(False) -> Close client connection immediately
80
 
** TODO [#C] python-parsedatetime
81
 
** TODO [#C] systemd/launchd
82
 
   http://0pointer.de/blog/projects/systemd.html
83
 
** TODO Separate logging logic to own object
84
 
** TODO make clients to a dict!
85
 
** TODO [#A] Limit approval_delay to max gnutls/tls timeout value
86
 
** TODO [#B] break the wait on approval_delay if connection dies
87
 
** TODO Generate Client.runtime_expansions from client options + extra
88
 
** TODO Allow %%(checker)s as a runtime expansion
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
 
** Show timeout countdown for approval
110
 
 
111
 
* mandos-keygen
112
 
** TODO Loop until passwords match when run interactively
113
 
** TODO "--secfile" option
114
 
   Using the "secfile" option instead of "secret"
115
 
** TODO [#B] "--test" option
116
 
   For testing decryption before rebooting.
117
 
 
118
 
* Makefile
119
 
** TODO Add "--Xlinker --as-needed"
120
 
   http://udrepper.livejournal.com/19395.html
121
 
** TODO [#C] Implement DEB_BUILD_OPTIONS
122
 
   http://www.debian.org/doc/debian-policy/ch-source.html#s-debianrules-options
123
 
 
124
 
* 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 <option> and <replaceable> tags
 
96
    Unify long and short options.
 
97
**** DONE mandos-clients.conf.xml
 
98
**** DONE mandos-keygen.xml
 
99
**** DONE mandos.conf.xml
 
100
**** DONE mandos.xml
 
101
**** DONE plugin-runner.xml
 
102
**** DONE plugins.d/password-prompt.xml
 
103
**** DONE plugins.d/password-request.xml
 
104
*** OPTIONS
 
105
    Separate <term> tags with <option> and <replaceable> tags.
 
106
**** DONE mandos-clients.conf.xml
 
107
**** DONE mandos-keygen.xml
 
108
**** DONE mandos.conf.xml
 
109
**** TODO mandos.xml
 
110
**** TODO plugin-runner.xml
 
111
**** TODO plugins.d/password-prompt.xml
 
112
**** TODO plugins.d/password-request.xml
 
113
** Use xinclude for common sections
 
114
   Like copyright, authors, etc.
 
115
 
 
116
 
 
117
* Installer
 
118
** Client-side
 
119
*** Update initrd.img after installation
 
120
    This seems to use some kind of "trigger" system
 
121
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
 
122
    dpkg-trigger(1), deb-triggers(5)
 
123
*** Keydir move: /etc/mandos -> /etc/keys/mandos
 
124
    Must create in preinst if not pre-depending on cryptsetup
 
125
*** mandos-keygen
 
126
**** "--passfile" option
 
127
     Using the "secfile" option instead of "secret"
 
128
**** [#A] "--test" option
 
129
     For testing decryption before rebooting.
 
130
** Server-side
 
131
*** [#A] Create mandos user and group for server
 
132
*** [#A] Create /var/run/mandos directory with perm and ownership
 
133
 
 
134
* [#A] Package
125
135
** /usr/share/initramfs-tools/hooks/mandos
126
 
*** TODO [#C] use same file name rules as run-parts(8)
127
 
*** TODO [#C] Do not install in initrd.img if configured not to.
128
 
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
129
 
** TODO [#C] /etc/bash_completion.d/mandos
 
136
*** Do not install in initrd.img if configured not to.
 
137
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
 
138
    question.
 
139
** /etc/bash_completion.d/mandos
130
140
   From XML sources directly?
131
 
 
132
 
* Side Stuff
133
 
** TODO Locate which packet move the other bin/sh when busy box is deactivated
134
 
** TODO contact owner of packet, and ask them to have that shell static in position regardless of busybox
 
141
** unperish
 
142
** bzr-builddeb
 
143
 
 
144
* INSTALL file
 
145
 
 
146
* Web site
 
147
 
 
148
* Mailing list
 
149
 
 
150
* Announce project on news
 
151
  [[news:comp.os.linux.announce]]
135
152
 
136
153
 
137
154
#+STARTUP: showall