/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: 2016-03-05 21:42:56 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 335.
  • Revision ID: teddy@recompile.se-20160305214256-79progf0wfkd9068
Add bug reporting information to manual pages

* bugs.xml: New file.
* intro.xml (BUGS): New section; include "bugs.xml".
* mandos-clients.conf.xml (BUGS): Include "bugs.xml".
* mandos-ctl.xml (BUGS): Uncommented; include "bugs.xml".
* mandos-keygen.xml (BUGS): - '' -
* mandos-monitor.xml (BUGS): Include "bugs.xml".
* mandos.conf.xml (BUGS): - '' -
* mandos.xml (BUGS): - '' -
* plugin-runner.xml (BUGS): - '' -
* plugins.d/askpass-fifo.xml (BUGS): New section; include
                                     "../bugs.xml".
* plugins.d/mandos-client.xml (BUGS): Uncommented; include
                                     "../bugs.xml".
* plugins.d/password-prompt.xml (BUGS): Include "../bugs.xml".
* plugins.d/plymouth.xml (BUGS): - '' -
* plugins.d/splashy.xml (BUGS): - '' -
* plugins.d/usplash.xml (BUGS): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
-*- org -*-
2
2
 
3
 
* [#A] README file
4
 
 
5
 
* Mandos-client
6
 
** [#A] Change syntax for arguments
7
 
** [#A] Man page: man8/mandos-client.8mandos
8
 
*** DESCRIPTION
9
 
    Describe the plus sign syntax for passing options from crypttab
10
 
*** EXIT STATUS
11
 
    Text needed
12
 
*** EXAMPLES
13
 
    Examples of normal usage, debug usage, debugging single or all
14
 
    plugins, examples of crypttab lines with plus syntax, etc.
15
 
*** FILES
16
 
    Text needed
17
 
*** SECURITY
18
 
    Text needed
19
 
*** NOTES
20
 
    Text needed
21
 
*** BUGS
22
 
    Text needed
23
 
*** SEE ALSO
24
 
    Explaining test on what you can read
25
 
** Use asprintf instead of malloc and strcat?
26
 
** use strsep instead of strtok?
27
 
** use config file in addition to arguments
28
 
** pass things in environment, like device name, etc
29
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
30
 
   Must create in preinst if not pre-depending on cryptsetup
31
 
 
32
 
* Password-request
33
 
** [#A] Man page: man8/password-request.8mandos
34
 
** [#B] Temporarily lower kernel log level
35
 
   for less printouts during sucessfull boot.
36
 
*** DESCRIPTION
37
 
    Move options to new OPTIONS section.
38
 
    State that this command is not meant to be invoked directly, but
39
 
    is run as a plugin from mandos-client(8) and only run in the
40
 
    initrd environment, not the real system.
41
 
*** EXIT STATUS
42
 
    Create this section
43
 
*** EXAMPLES
44
 
    Examples of normal usage, debug usage, debugging by connecting
45
 
    directly, etc.
46
 
*** FILES
47
 
    Describe the key files and the key ring files.  Also note that
48
 
    they should normally have been automatically created.
49
 
*** DIAGNOSTICS
50
 
    Create this section
51
 
*** SECURITY
52
 
    Create this section
53
 
*** NOTES
54
 
    Create this section (if needed)
55
 
*** BUGS
56
 
    Create this section
57
 
*** SEE ALSO
58
 
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
59
 
** Use asprintf instead of malloc and memcpy?
60
 
** IPv4 support
61
 
** use strsep instead of strtok?
62
 
** Do not depend on GnuPG key rings on disk
63
 
   This would mean creating new GnuPG key rings with GPGME by
64
 
   importing the key files from scratch on every program start.
65
 
 
66
 
* Password-prompt
67
 
** [#A] Man page: man8/password-prompt.8mandos
68
 
** Show getenv("cryptsource") and getenv("crypttarget") if set
69
 
   cryptsource will be the device, like "/dev/sda3", and crypttarget
70
 
   will be the device mapper name, like "sda3_crypt".
71
 
*** DESCRIPTION
72
 
    Move options to new OPTIONS section.
73
 
*** EXIT STATUS
74
 
    Create this section
75
 
*** EXAMPLES
76
 
    Examples of normal usage, debug usage, with a prefix, etc.
77
 
*** DIAGNOSTICS
78
 
    Create this section
79
 
*** SECURITY
80
 
    Create this section
81
 
    Not much to do here but it is noteworthy to state the danger of
82
 
    not having a fallback option.
83
 
*** NOTES
84
 
    Note that this is more or less a simple getpass(3) wrapper, even
85
 
    though actual use of getpass(3) is not guaranteed.
86
 
*** BUGS
87
 
    Create this section
88
 
*** SEE ALSO
89
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
90
 
** Use getpass(3)?
91
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
92
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
93
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
94
 
   [[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?]]
95
 
** Replace completely with "/lib/cryptsetup/askpass"?
96
 
 
97
 
* Mandos (server)
98
 
** [#A] Command man page: man8/mandos.8
99
 
*** DESCRIPTION
100
 
    Move options to new OPTIONS section
101
 
*** EXIT STATUS
102
 
    Create this section
103
 
*** EXAMPLES
104
 
    Create this section
105
 
*** FILES
106
 
    Describe briefly that the server gets global settings from
107
 
    mandos.conf and clients from clients.conf, but refer to their man
108
 
    pages for more details.
109
 
*** DIAGNOSTICS
110
 
    Create this section
111
 
*** SECURITY
112
 
    Create this section
113
 
*** NOTES
114
 
    Create this section (if needed)
115
 
*** BUGS
116
 
    Create this section
117
 
*** SEE ALSO
118
 
    Refer to the client man page
119
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
120
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
121
 
** [#A] /etc/init.d/mandos-server               :teddy:
122
 
** Log level
123
 
** /etc/mandos/clients.d/*.conf
124
 
   Watch this directory and add/remove/update clients?
125
 
** config for TXT record
126
 
** Run-time communication with server
127
 
   Probably using D-Bus
128
 
   See also [[*Mandos-tools]]
129
 
** Implement --foreground
130
 
   [[info:standards:Option%20Table][Table of Long Options]]
131
 
** Implement --socket
132
 
   [[info:standards:Option%20Table][Table of Long Options]]
133
 
** Date+time on console log messages
134
 
   Is this the default?
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
 
** Client
144
 
*** DONE [#A] Change initrd.img file to not be publically readable
145
 
    /usr/share/initramfs-tools/conf-hooks.d/mandos
146
 
    UMASK=027
147
 
*** Update initrd.img after installation
148
 
** Server
149
 
*** [#A] Create mandos user and group for server
150
 
*** [#A] Create /var/run/mandos directory with perm and ownership
151
 
 
152
 
** mandos-keygen
153
 
*** [#A] Command man page: man8/mandos-keygen.8
154
 
*** [#A] Output cut-and-paste ready snippet for clients.conf.
155
 
 
156
 
* [#A] Package
 
3
* Testing
 
4
** python-nemu
 
5
 
 
6
* mandos-applet
 
7
 
 
8
* mandos-client
 
9
** TODO A --server option which only adds to the server list.
 
10
   (Unlike --connect, which implicitly disables zeroconf.)
 
11
** TODO [#B] Use capabilities instead of seteuid().
 
12
   https://forums.grsecurity.net/viewtopic.php?f=7&t=2522
 
13
** TODO [#B] Use getaddrinfo(hints=AI_NUMERICHOST) instead of inet_pton()
 
14
** TODO [#C] Make start_mandos_communication() take "struct server".
 
15
** TODO [#C] --interfaces=regex,eth*,noregex (bridge-utils-interfaces(5))
 
16
 
 
17
* splashy
 
18
** TODO [#B] use scandir(3) instead of readdir(3)
 
19
 
 
20
* usplash (Deprecated)
 
21
** TODO [#B] Make it work again
 
22
** TODO [#B] use scandir(3) instead of readdir(3)
 
23
 
 
24
* askpass-fifo
 
25
 
 
26
* password-prompt
 
27
** TODO [#B] lock stdin (with flock()?)
 
28
 
 
29
* plymouth
 
30
 
 
31
* TODO [#B] passdev
 
32
 
 
33
* plugin-runner
 
34
** TODO handle printing for errors for plugins
 
35
*** Hook up stderr of plugins, buffer them, and prepend "Mandos Plugin [plugin name]"
 
36
** TODO [#C] use same file name rules as run-parts(8)
 
37
** kernel command line option for debug info
 
38
 
 
39
* mandos (server)
 
40
** TODO [#B] --notify-command
 
41
   This would allow the mandos.service to use
 
42
   --notify-command="systemd-notify --pid READY=1"
 
43
** TODO [#B] Log level                                                    :BUGS:
 
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 dbus option
 
48
   SetLogLevel D-Bus call
 
49
** TODO [#C] DBusServiceObjectUsingSuper
 
50
** TODO [#B] Global enable/disable flag
 
51
** TODO [#B] By-client countdown on number of secrets given
 
52
** D-Bus Client method NeedsPassword(50) - Timeout, default disapprove
 
53
    + SetPass(u"gazonk", True) -> Approval, persistent
 
54
    + Approve(False) -> Close client connection immediately
 
55
** TODO [#C] python-parsedatetime
 
56
** TODO Separate logging logic to own object
 
57
** TODO [#B] Limit approval_delay to max gnutls/tls timeout value
 
58
** TODO [#B] break the wait on approval_delay if connection dies
 
59
** TODO Generate Client.runtime_expansions from client options + extra
 
60
** TODO Allow %%(checker)s as a runtime expansion
 
61
** TODO D-Bus AddClient() method on server object
 
62
** TODO Use org.freedesktop.DBus.Method.NoReply annotation on async methods. :2:
 
63
** TODO Save state periodically to recover better from hard shutdowns
 
64
** TODO CheckerCompleted method, deprecate CheckedOK
 
65
** TODO Secret Service API?
 
66
   http://standards.freedesktop.org/secret-service/
 
67
** TODO Remove D-Bus interfaces with old domain name                      :2:
 
68
** TODO Remove old string_to_delta format                                 :2:
 
69
** TODO http://0pointer.de/blog/projects/stateless.html
 
70
*** tmpfiles snippet to create /var/lib/mandos with right user+perms
 
71
*** File in /usr/lib/sysusers.d to create user+group "_mandos"
 
72
** TODO Error handling on error parsing config files
 
73
** TODO init.d script error handling
 
74
** TODO D-Bus server properties; address, port, interface, etc.           :2:
 
75
** TODO [#C] In Python 3.3, use shlex.quote() instead of re.escape()
 
76
 
 
77
* mandos-ctl
 
78
*** Handle "no D-Bus server" and/or "no Mandos server found" better
 
79
*** [#B] --dump option
 
80
** TODO Remove old string_to_delta format                                 :2:
 
81
 
 
82
* TODO mandos-dispatch
 
83
  Listens for specified D-Bus signals and spawns shell commands with
 
84
  arguments.
 
85
 
 
86
* mandos-monitor
 
87
** TODO --servicename                                                  :BUGS:
 
88
** TODO help should be toggleable
 
89
** Urwid client data displayer
 
90
   Better view of client data in the listing
 
91
*** Properties popup
 
92
** Print a nice "We are sorry" message, save stack trace to log.
 
93
 
 
94
* mandos-keygen
 
95
** TODO "--secfile" option
 
96
   Using the "secfile" option instead of "secret"
 
97
** TODO [#B] "--test" option
 
98
   For testing decryption before rebooting.
 
99
 
 
100
* Package
157
101
** /usr/share/initramfs-tools/hooks/mandos
158
 
*** Do not install in initrd.img if configured not to
159
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
160
 
    question.
161
 
** /etc/bash_completion.d/mandos
162
 
*** From xml sources directly?
163
 
** unperish
164
 
** bzr-builddeb
165
 
 
166
 
* INSTALL file
167
 
 
168
 
* Web site
169
 
 
170
 
* Mailing list
171
 
 
172
 
* Announce project on news
173
 
  [[news:comp.os.linux.announce]]
 
102
*** TODO [#C] use same file name rules as run-parts(8)
 
103
*** TODO [#C] Do not install in initrd.img if configured not to.
 
104
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
 
105
** TODO [#C] $(pkg-config --variable=completionsdir bash-completion)
 
106
   From XML sources directly?
 
107
 
 
108
* Side Stuff
 
109
** TODO Locate which package moves the other bin/sh when busybox is deactivated
 
110
** TODO contact owner of package, and ask them to have that shell static in position regardless of busybox
 
111
 
 
112
* [[http://www.undeadly.org/cgi?action=article&sid=20110530221728][OpenBSD]]
174
113
 
175
114
 
176
115
#+STARTUP: showall