/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: 2019-07-29 16:35:53 UTC
  • Revision ID: teddy@recompile.se-20190729163553-1i442i2cbx64c537
Make tests and man page examples match

Make the tests test_manual_page_example[1-5] match exactly what is
written in the manual page, and add comments to manual page as
reminders to keep tests and manual page examples in sync.

* mandos-ctl (Test_commands_from_options.test_manual_page_example_1):
  Remove "--verbose" option, since the manual does not have it as the
  first example, and change assertion to match.
* mandos-ctl.xml (EXAMPLE): Add comments to all examples documenting
  which test function they correspond to.  Also remove unnecessary
  quotes from option arguments in fourth example, and clarify language
  slightly in fifth example.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
-*- org -*-
2
2
 
3
 
* [#A] README file
 
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
** TODO [#A] Detect partial writes to stdout and exit with EX_TEMPFAIL
 
17
** TODO [#B] Use reallocarray() with GNU LibC 2.29 or later.
 
18
 
 
19
* splashy
 
20
** TODO [#B] use scandir(3) instead of readdir(3)
 
21
** TODO [#A] Detect partial writes to stdout and exit with EX_TEMPFAIL
 
22
 
 
23
* usplash (Deprecated)
 
24
** TODO [#B] Make it work again
 
25
** TODO [#B] use scandir(3) instead of readdir(3)
 
26
** TODO [#A] Detect partial writes to stdout and exit with EX_TEMPFAIL
 
27
 
 
28
* askpass-fifo
 
29
** TODO [#A] Detect partial writes to stdout and exit with EX_TEMPFAIL
 
30
 
 
31
* password-prompt
 
32
** TODO [#B] lock stdin (with flock()?)
 
33
** TODO [#A] Detect partial writes to stdout and exit with EX_TEMPFAIL
 
34
 
 
35
* plymouth
 
36
** TODO [#A] Detect partial writes to stdout and exit with EX_TEMPFAIL
 
37
** TODO [#B] Use reallocarray() with GNU LibC 2.29 or later.
 
38
 
 
39
* TODO [#B] passdev
4
40
 
5
41
* 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
60
 
 
61
 
* password-prompt
62
 
** [#A] Man page: man8/password-prompt.8mandos
63
 
*** SYNOPSIS
64
 
    Document short options
65
 
*** DESCRIPTION
66
 
    Note that this is more or less a simple getpass(3) wrapper, even
67
 
    though actual use of getpass(3) is not guaranteed.
68
 
*** EXIT STATUS
69
 
*** ENVIRONMENT
70
 
    Document use of "cryptsource" and "crypttarget".
71
 
*** FILES
72
 
*** BUGS
73
 
*** EXAMPLE
74
 
    Examples of normal usage, debug usage, with a prefix, etc.
75
 
*** SECURITY
76
 
    Not much to do here but it is noteworthy to state the danger of
77
 
    not having a fallback option.
78
 
*** SEE ALSO
79
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
80
 
    and also, perhaps, to cryptsetup(8)?
81
 
** Use getpass(3)?
82
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
83
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
84
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
85
 
   [[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
** TODO handle printing for errors for plugins
 
43
*** Hook up stderr of plugins, buffer them, and prepend "Mandos Plugin [plugin name]"
 
44
** TODO [#C] use same file name rules as run-parts(8)
 
45
** kernel command line option for debug info
 
46
** TODO [#A] Restart plugins which exit with EX_TEMPFAIL
86
47
 
87
48
* mandos (server)
88
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
89
 
*** For option "secret", document which program can help generate it.
90
 
** [#A] /etc/init.d/mandos-server               :teddy:
91
 
** [#B] Log level                               :bugs:
92
 
** /etc/mandos/clients.d/*.conf
93
 
   Watch this directory and add/remove/update clients?
94
 
** config for TXT record
95
 
** [#B] Run-time communication with server      :bugs:
96
 
   Probably using D-Bus
97
 
   See also [[*Mandos-tools]]
98
 
** Implement --foreground                       :bugs:
99
 
   [[info:standards:Option%20Table][Table of Long Options]]
100
 
** Implement --socket
101
 
   [[info:standards:Option%20Table][Table of Long Options]]
102
 
** Date+time on console log messages            :bugs:
103
 
   Is this the default?
104
 
 
105
 
* Mandos-tools/utilities
106
 
  All of this probably using D-Bus
107
 
** List clients
108
 
** Disable client
109
 
** Enable client
110
 
 
111
 
* Installer
112
 
** Client-side
113
 
*** Update initrd.img after installation
114
 
    This seems to use some kind of "trigger" system
115
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
116
 
    Must create in preinst if not pre-depending on cryptsetup
117
 
*** mandos-keygen
118
 
**** [#A] "--test" option
119
 
     For testing decryption before rebooting.
120
 
** Server-side
121
 
*** [#A] Create mandos user and group for server
122
 
*** [#A] Create /var/run/mandos directory with perm and ownership
123
 
 
124
 
* [#A] Package
 
49
** TODO [#B] --notify-command
 
50
   This would allow the mandos.service to use
 
51
   --notify-command="systemd-notify --pid --ready"
 
52
** TODO [#B] python-systemd
 
53
*** import systemd.daemon; systemd.daemon.notify()
 
54
** TODO [#B] Log level                                                    :BUGS:
 
55
*** TODO /etc/mandos/clients.d/*.conf
 
56
    Watch this directory and add/remove/update clients?
 
57
** TODO [#C] config for TXT record
 
58
** TODO Log level dbus option
 
59
   SetLogLevel D-Bus call
 
60
** TODO [#C] DBusServiceObjectUsingSuper
 
61
** TODO [#B] Global enable/disable flag
 
62
** TODO [#B] By-client countdown on number of secrets given
 
63
** D-Bus Client method NeedsPassword(50) - Timeout, default disapprove
 
64
    + SetPass(u"gazonk", True) -> Approval, persistent
 
65
    + Approve(False) -> Close client connection immediately
 
66
** TODO [#C] python-parsedatetime
 
67
** TODO Separate logging logic to own object
 
68
** TODO [#B] Limit approval_delay to max gnutls/tls timeout value
 
69
** TODO [#B] break the wait on approval_delay if connection dies
 
70
** TODO Generate Client.runtime_expansions from client options + extra
 
71
** TODO Allow %%(checker)s as a runtime expansion
 
72
** TODO D-Bus AddClient() method on server object
 
73
** TODO Use org.freedesktop.DBus.Method.NoReply annotation on async methods. :2:
 
74
** TODO Save state periodically to recover better from hard shutdowns
 
75
** TODO CheckerCompleted method, deprecate CheckedOK
 
76
** TODO Secret Service API?
 
77
   https://standards.freedesktop.org/secret-service/
 
78
** TODO Remove D-Bus interfaces with old domain name                      :2:
 
79
** TODO Remove old string_to_delta format                                 :2:
 
80
** TODO http://0pointer.de/blog/projects/stateless.html
 
81
*** File in /usr/lib/sysusers.d to create user+group "_mandos"
 
82
** TODO Error handling on error parsing config files
 
83
** TODO init.d script error handling
 
84
** TODO D-Bus server properties; address, port, interface, etc.           :2:
 
85
** Python 3                                                               :2:
 
86
*** TODO [#C] In Python 3.3, use shlex.quote() instead of re.escape()
 
87
 
 
88
* mandos-ctl
 
89
** TODO Remove old string_to_delta format                                 :2:
 
90
 
 
91
* TODO mandos-dispatch
 
92
  Listens for specified D-Bus signals and spawns shell commands with
 
93
  arguments.
 
94
 
 
95
* mandos-monitor
 
96
** TODO --servicename                                                  :BUGS:
 
97
** TODO help should be toggleable
 
98
** Urwid client data displayer
 
99
   Better view of client data in the listing
 
100
*** Properties popup
 
101
** Print a nice "We are sorry" message, save stack trace to log.
 
102
 
 
103
* mandos-keygen
 
104
** TODO "--secfile" option
 
105
   Using the "secfile" option instead of "secret"
 
106
** TODO [#B] "--test" option
 
107
   For testing decryption before rebooting.
 
108
 
 
109
* Package
125
110
** /usr/share/initramfs-tools/hooks/mandos
126
 
*** Do not install in initrd.img if configured not to.
127
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
128
 
    question.
129
 
** /etc/bash_completion.d/mandos
 
111
*** TODO [#C] use same file name rules as run-parts(8)
 
112
*** TODO [#C] Do not install in initrd.img if configured not to.
 
113
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
 
114
** TODO [#C] $(pkg-config --variable=completionsdir bash-completion)
130
115
   From XML sources directly?
131
 
** unperish
132
 
** bzr-builddeb
133
 
 
134
 
* INSTALL file
135
 
 
136
 
* Web site
137
 
 
138
 
* Mailing list
139
 
 
140
 
* Announce project on news
141
 
  [[news:comp.os.linux.announce]]
 
116
 
 
117
* Side Stuff
 
118
** TODO Locate which package moves the other bin/sh when busybox is deactivated
 
119
** TODO contact owner of package, and ask them to have that shell static in position regardless of busybox
 
120
 
 
121
* [[http://www.undeadly.org/cgi?action=article&sid=20110530221728][OpenBSD]]
142
122
 
143
123
 
144
124
#+STARTUP: showall