/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

Added all sections needed for mandos-client manual page

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
-*- org -*-
2
2
 
3
 
* Use _attribute_((nonnull)) wherever possible.
4
 
 
5
 
* mandos-applet
6
 
 
7
 
* Convert README into intro(8mandos) man page
8
 
 
9
 
* mandos-client
10
 
** TODO [#B] Use capabilities instead of seteuid().
11
 
** TODO [#B] Use struct sockaddr_storage instead of a union
12
 
** TODO [#B] Use getaddrinfo(hints=AI_NUMERICHOST) instead of inet_pton()
13
 
** TODO [#B] Use getnameinfo(serv=NULL, NI_NUMERICHOST) instead of inet_ntop()
14
 
** TODO [#B] Accept [] around IPv6 address in --connect option; see [[http://tools.ietf.org/html/rfc5952][RFC 5952 - A Recommendation for IPv6 Address Text Representation]]
15
 
 
16
 
* splashy
17
 
** TODO [#B] use scandir(3) instead of readdir(3)
18
 
 
19
 
* usplash
20
 
** TODO [#A] Make it work again
21
 
** TODO [#B] use scandir(3) instead of readdir(3)
22
 
** TODO Use [[info:libc:Argz%20Functions][argz_extract]]
23
 
 
24
 
* askpass-fifo
25
 
** TODO [#B] Drop privileges after opening FIFO.
26
 
 
27
 
* password-prompt
28
 
** TODO [#B] lock stdin (with flock()?)
29
 
** TODO [#A] Free direntries after scandir()
30
 
 
31
 
* plymouth
32
 
** TODO [#A] Free direntries after scandir()
33
 
 
34
 
* TODO [#B] passdev
35
 
 
36
 
* plugin-runner
37
 
** TODO handle printing for errors for plugins
38
 
*** Hook up stderr of plugins, buffer them, and prepend mandos pluig [plugin name]
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 openat()
43
 
 
44
 
* mandos (server)
45
 
** TODO [#B] Log level                                                    :BUGS:
46
 
** TODO Persistent state                                                  :BUGS:
47
 
   /var/lib/mandos/*
48
 
*** TODO /etc/mandos/clients.d/*.conf
49
 
    Watch this directory and add/remove/update clients?
50
 
** TODO [#C] config for TXT record
51
 
** TODO Log level option
52
 
   syslogger.setLevel(logging.WARNING)
53
 
   + SetLogLevel D-Bus call
54
 
** TODO Implement --foreground                                            :BUGS:
55
 
   [[info:standards:Option%20Table][Table of Long Options]]
56
 
** TODO Implement --socket
57
 
   [[info:standards:Option%20Table][Table of Long Options]]
58
 
** TODO Date+time on console log messages                                 :BUGS:
59
 
   Is this the default?
60
 
** TODO [#C] DBusServiceObjectUsingSuper
61
 
** TODO [#B] Global enable/disable flag
62
 
** TODO [#B] By-client countdown on secrets given
63
 
** TODO [#B] Fix problem with fsck taking a really long time
64
 
   Whenever a client successfully gets a secret it could get a
65
 
   one-time timeout boost to allow for an fsck-incurred delay
66
 
** TODO [#A] Delay before client receives key
67
 
   This would give an operator opportunity to cancel the request if
68
 
   desired.
69
 
** TODO [#A] Client manual approval mode
70
 
   A client needs manual approval on the server before it gets the
71
 
   secret
72
 
** TODO [#B] Support RFC 3339 time duration syntax
73
 
** More D-Bus methods
74
 
*** NeedsApproval(50, True) -> timeout, default approve
75
 
    Default approval is configurable, but True by default
76
 
    + Approve(True) -> approve sending saved
77
 
    + Approve(False) -> Close client connection immediately
78
 
*** NeedsPassword(50) - Timeout, default disapprove
79
 
    + SetPass(u"gazonk", True) -> Approval, persistent
80
 
    + Approve(False) -> Close client connection immediately
81
 
** TODO [#C] python-parsedatetime
82
 
** TODO [#C] systemd/launchd
83
 
   http://0pointer.de/blog/projects/systemd.html
84
 
** TODO Separate logging logic to own object
85
 
** TODO make clients to a dict!
86
 
** TODO [#A] Limit approval_delay to max gnutls/tls timeout value
87
 
** TODO [#B] break the wait on approval_delay if connection dies
88
 
** TODO Generate Client.runtime_expansions from client options + extra
89
 
** TODO Allow %%(checker)s as a runtime expansion
90
 
** TODO Use python-tlslite?
91
 
 
92
 
* mandos.xml
93
 
** Add mandos contact info in manual pages
94
 
 
95
 
* mandos-ctl
96
 
*** Handle "no D-Bus server" and/or "no Mandos server found" better
97
 
*** [#B] --dump option
98
 
** TODO Support RFC 3339 time duration syntax
99
 
 
100
 
* TODO mandos-dispatch
101
 
  Listens for specified D-Bus signals and spawns shell commands with
102
 
  arguments.
103
 
 
104
 
* mandos-monitor
105
 
** TODO help should be toggleable
106
 
** Urwid client data displayer
107
 
   Better view of client data in the listing
108
 
*** Properties popup
109
 
** Nicer crashes. Stack traces Messes up shell.
110
 
*** Print a nice "We are sorry" message, save stack trace to log.
111
 
** Show timeout countdown for approval
112
 
 
113
 
* mandos-keygen
114
 
** TODO Loop until passwords match when run interactively
115
 
** TODO "--secfile" option
116
 
   Using the "secfile" option instead of "secret"
117
 
** TODO [#B] "--test" option
118
 
   For testing decryption before rebooting.
119
 
 
120
 
* Makefile
121
 
** TODO Add "--Xlinker --as-needed"
122
 
   http://udrepper.livejournal.com/19395.html
123
 
** TODO [#C] Implement DEB_BUILD_OPTIONS
124
 
   http://www.debian.org/doc/debian-policy/ch-source.html#s-debianrules-options
125
 
 
126
 
* Package
127
 
** /usr/share/initramfs-tools/hooks/mandos
128
 
*** TODO [#C] use same file name rules as run-parts(8)
129
 
*** TODO [#C] Do not install in initrd.img if configured not to.
130
 
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
131
 
** TODO [#C] /etc/bash_completion.d/mandos
132
 
   From XML sources directly?
133
 
 
134
 
* Side Stuff
135
 
** TODO Locate which packet move the other bin/sh when busy box is deactivated
136
 
** TODO contact owner of packet, and ask them to have that shell static in position regardless of busybox
 
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
*** EXIT STATUS
 
11
    Create this section
 
12
*** USAGE
 
13
    Describe the plus sign syntax for passing options from crypttab
 
14
*** EXAMPLES
 
15
    Examples of normal usage, debug usage, debugging single or all
 
16
    plugins, examples of crypttab lines with plus syntax, etc.
 
17
*** FILES
 
18
    Describe plugin directory
 
19
*** DIAGNOSTICS
 
20
    Create this section
 
21
*** SECURITY
 
22
    Create this section
 
23
*** NOTES
 
24
    Create this section (if needed)
 
25
*** BUGS
 
26
    Create this section
 
27
*** SEE ALSO
 
28
    Refer to mandos(8), password-request(8mandos), and
 
29
    password-prompt(8mandos)
 
30
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
 
31
** use strsep instead of strtok?
 
32
** use config file in addition to arguments
 
33
** pass things in environment, like device name, etc
 
34
** Fallback
 
35
   As a fallback, if no plugins can be found or if all of them failed,
 
36
   run getpass(3) itself.
 
37
 
 
38
* Password-request
 
39
** [#A] Man page: man8/password-request.8mandos
 
40
*** DESCRIPTION
 
41
    Move options to new OPTIONS section.
 
42
    State that this command is not meant to be invoked directly, but
 
43
    is run as a plugin from mandos-client(8) and only run in the
 
44
    initrd environment, not the real system.
 
45
*** EXIT STATUS
 
46
    Create this section
 
47
*** EXAMPLES
 
48
    Examples of normal usage, debug usage, debugging by connecting
 
49
    directly, etc.
 
50
*** FILES
 
51
    Describe the key files and the key ring files.  Also note that
 
52
    they should normally have been automatically created.
 
53
*** DIAGNOSTICS
 
54
    Create this section
 
55
*** SECURITY
 
56
    Create this section
 
57
*** NOTES
 
58
    Create this section (if needed)
 
59
*** BUGS
 
60
    Create this section
 
61
*** SEE ALSO
 
62
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
 
63
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
 
64
** start_mandos_communication: loop around gnutls_handshake
 
65
   [[info:gnutls.info.gz:Core%20functions][gnutls_handshake]]
 
66
** IPv4 support
 
67
** use strsep instead of strtok?
 
68
** Do not depend on GPG key rings on disk
 
69
   This would mean creating new GPG key rings with GPGME by importing
 
70
   the key files from scratch on every program start.
 
71
 
 
72
* Password-prompt
 
73
** [#A] Man page: man8/password-prompt.8mandos
 
74
*** DESCRIPTION
 
75
    Move options to new OPTIONS section.
 
76
*** EXIT STATUS
 
77
    Create this section
 
78
*** EXAMPLES
 
79
    Examples of normal usage, debug usage, with a prefix, etc.
 
80
*** DIAGNOSTICS
 
81
    Create this section
 
82
*** SECURITY
 
83
    Create this section
 
84
    Not much to do here but it is noteworthy to state the danger of
 
85
    not having a fallback option.
 
86
*** NOTES
 
87
    Note that this is more or less a simple getpass(3) wrapper, even
 
88
    though actual use of getpass(3) is not guaranteed.
 
89
*** BUGS
 
90
    Create this section
 
91
*** SEE ALSO
 
92
    Refer to mandos-client(8mandos) and password-request(8mandos)
 
93
** Use getpass(3)?
 
94
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
 
95
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
 
96
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
 
97
   [[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?]]
 
98
 
 
99
* Mandos (server)
 
100
** [#A] Command man page: man8/mandos.8
 
101
*** DESCRIPTION
 
102
    Move options to new OPTIONS section
 
103
*** EXIT STATUS
 
104
    Create this section
 
105
*** EXAMPLES
 
106
    Create this section
 
107
*** FILES
 
108
    Describe briefly that the server gets global settings from
 
109
    mandos.conf and clients from clients.conf, but refer to their man
 
110
    pages for more details.
 
111
*** DIAGNOSTICS
 
112
    Create this section
 
113
*** SECURITY
 
114
    Create this section
 
115
*** NOTES
 
116
    Create this section (if needed)
 
117
*** BUGS
 
118
    Create this section
 
119
*** SEE ALSO
 
120
    Refer to the client man page
 
121
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
 
122
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
 
123
** [#A] /etc/init.d/mandos-server               :teddy:
 
124
** Log level
 
125
** /etc/mandos/clients.d/*.conf
 
126
   Watch this directory and add/remove/update clients?
 
127
** config for TXT record
 
128
** Run-time communication with server
 
129
   Probably using D-Bus
 
130
   See also [[*Mandos-tools]]
 
131
** Implement --foreground
 
132
   [[info:standards:Option%20Table][Table of Long Options]]
 
133
** Implement --socket
 
134
   [[info:standards:Option%20Table][Table of Long Options]]
 
135
 
 
136
* Mandos-tools/utilities
 
137
  All of this probably using D-Bus
 
138
** List clients
 
139
** Disable client
 
140
** Enable client
 
141
 
 
142
* Installer
 
143
** DONE [#A] Change initrd.img file to not be publically readable
 
144
   /etc/initramfs-tools/conf.d/mandos
 
145
   UMASK=027
 
146
** Update initrd.img after installation
 
147
** [#A] Create mandos user and group for server
 
148
** [#A] Create /var/run/mandos directory with perm and ownership
 
149
 
 
150
* [#A] Package
 
151
** /etc/bash_completion.d/mandos
 
152
** /etc/initramfs-tools/hooks/mandos
 
153
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
 
154
*** Create GPG key ring files in initrd
 
155
 
 
156
* INSTALL file
 
157
 
 
158
* Web site
 
159
 
 
160
* Mailing list
 
161
 
 
162
* Announce project on news
 
163
  [[news:comp.os.linux.announce]]
137
164
 
138
165
 
139
166
#+STARTUP: showall