/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: 2010-09-12 03:00:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100912030040-b0uopyennste9fdh
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
4
 
 
5
 
* [#A] COPYING file
6
 
  [[file:/usr/share/common-licenses/GPL-3][GPLv3]]
7
 
 
8
 
* Mandos-client
9
 
** [#A] Man page: man8/mandos-client.8mandos
10
 
*** SYNOPSIS
11
 
    Needs options listed, not just "[OPTION...]"
12
 
*** DESCRIPTION
13
 
    Move options to new OPTIONS section.
14
 
    State that this command is not meant to be invoked directly, but
15
 
    is meant to be run by cryptsetup by being specified in
16
 
    /etc/crypttab and only run in the initrd environment, not the real
17
 
    system.
18
 
*** EXIT STATUS
19
 
    Create this section
20
 
*** USAGE
21
 
    Describe the plus sign syntax for passing options from crypttab
22
 
*** EXAMPLES
23
 
    Examples of normal usage, debug usage, debugging single or all
24
 
    plugins, examples of crypttab lines with plus syntax, etc.
25
 
*** FILES
26
 
    Describe plugin directory
27
 
*** DIAGNOSTICS
28
 
    Create this section
29
 
*** SECURITY
30
 
    Create this section
31
 
*** NOTES
32
 
    Create this section (if needed)
33
 
*** BUGS
34
 
    Create this section
35
 
*** SEE ALSO
36
 
    Refer to mandos(8), password-request(8mandos), and
37
 
    password-prompt(8mandos)
38
 
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
39
 
** use strsep instead of strtok?
40
 
** use config file in addition to arguments
41
 
** pass things in environment, like device name, etc
42
 
** Fallback
43
 
   As a fallback, if no plugins can be found or if all of them failed,
44
 
   run getpass(3) itself.
45
 
 
46
 
* Password-request
47
 
** [#A] Man page: man8/password-request.8mandos
48
 
*** SYNOPSIS
49
 
    Needs options listed, not just "[OPTION...]"
50
 
*** DESCRIPTION
51
 
    Move options to new OPTIONS section.
52
 
    State that this command is not meant to be invoked directly, but
53
 
    is run as a plugin from mandos-client(8) and only run in the
54
 
    initrd environment, not the real system.
55
 
*** EXIT STATUS
56
 
    Create this section
57
 
*** EXAMPLES
58
 
    Examples of normal usage, debug usage, debugging by connecting
59
 
    directly, etc.
60
 
*** FILES
61
 
    Describe the key files and the key ring files.  Also note that
62
 
    they should normally have been automatically created.
63
 
*** DIAGNOSTICS
64
 
    Create this section
65
 
*** SECURITY
66
 
    Create this section
67
 
*** NOTES
68
 
    Create this section (if needed)
69
 
*** BUGS
70
 
    Create this section
71
 
*** SEE ALSO
72
 
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
73
 
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
74
 
** start_mandos_communication: loop around gnutls_handshake
75
 
   [[info:gnutls.info.gz:Core%20functions][gnutls_handshake]]
76
 
** IPv4 support
77
 
** use strsep instead of strtok?
78
 
** Do not depend on GPG key rings on disk
79
 
   This would mean creating new GPG key rings with GPGME by importing
80
 
   the key files from scratch on every program start.
81
 
 
82
 
* Password-prompt
83
 
** [#A] Man page: man8/password-prompt.8mandos
84
 
*** SYNOPSIS
85
 
    Needs options listed, not just "[OPTION...]"
86
 
*** DESCRIPTION
87
 
    Move options to new OPTIONS section.
88
 
*** EXIT STATUS
89
 
    Create this section
90
 
*** EXAMPLES
91
 
    Examples of normal usage, debug usage, with a prefix, etc.
92
 
*** DIAGNOSTICS
93
 
    Create this section
94
 
*** SECURITY
95
 
    Create this section
96
 
    Not much to do here but it is noteworthy to state the danger of
97
 
    not having a fallback option.
98
 
*** NOTES
99
 
    Note that this is more or less a simple getpass(3) wrapper, even
100
 
    though actual use of getpass(3) is not guaranteed.
101
 
*** BUGS
102
 
    Create this section
103
 
*** SEE ALSO
104
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
105
 
** Use getpass(3)?
106
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
107
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
108
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
109
 
   [[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?]]
110
 
 
111
 
* Mandos (server)
112
 
** [#A] Command man page: man8/mandos.8
113
 
*** SYNOPSIS
114
 
    Needs options listed, not just "[OPTION...]"
115
 
*** DESCRIPTION
116
 
    Move options to new OPTIONS section
117
 
*** EXIT STATUS
118
 
    Create this section
119
 
*** EXAMPLES
120
 
    Create this section
121
 
*** FILES
122
 
    Describe briefly that the server gets global settings from
123
 
    mandos.conf and clients from clients.conf, but refer to their man
124
 
    pages for more details.
125
 
*** DIAGNOSTICS
126
 
    Create this section
127
 
*** SECURITY
128
 
    Create this section
129
 
*** NOTES
130
 
    Create this section (if needed)
131
 
*** BUGS
132
 
    Create this section
133
 
*** SEE ALSO
134
 
    Refer to the client man page
135
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
136
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
137
 
** [#A] /etc/init.d/mandos-server               :teddy:
138
 
** Log level
139
 
** /etc/mandos/clients.d/*.conf
140
 
   Watch this directory and add/remove/update clients?
141
 
** config for TXT record
142
 
** Run-time communication with server
143
 
   Probably using D-Bus
144
 
   See also [[*Mandos-tools]]
145
 
** Implement --foreground
146
 
   [[info:standards:Option%20Table][Table of Long Options]]
147
 
** Implement --socket
148
 
   [[info:standards:Option%20Table][Table of Long Options]]
149
 
 
150
 
* Mandos-tools/utilities
151
 
  All of this probably using D-Bus
152
 
** List clients
153
 
** Disable client
154
 
** Enable client
155
 
 
156
 
* Installer
157
 
** DONE [#A] Change initrd.img file to not be publically readable
158
 
   /etc/initramfs-tools/conf.d/mandos
159
 
   UMASK=027
160
 
** Update initrd.img after installation
161
 
** [#A] Create mandos user and group for server
162
 
** [#A] Create /var/run/mandos directory with perm and ownership
163
 
 
164
 
* [#A] Package
165
 
** /etc/bash_completion.d/mandos
166
 
** /etc/initramfs-tools/hooks/mandos
167
 
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
168
 
*** Create GPG key ring files in initrd
169
 
 
170
 
* INSTALL file
171
 
 
172
 
* Web site
173
 
 
174
 
* Mailing list
175
 
 
176
 
* Announce project on news
177
 
  [[news:comp.os.linux.announce]]
 
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
 
39
 
 
40
* plugin-runner
 
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()
 
45
 
 
46
* mandos (server)
 
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:
 
61
   Is this the default?
 
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
 
124
** /usr/share/initramfs-tools/hooks/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
 
129
   From XML sources directly?
 
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
178
134
 
179
135
 
180
136
#+STARTUP: showall