/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: 2016-03-05 21:42:56 UTC
  • 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
 
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
4
32
 
5
33
* 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
 
** [#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?]]
 
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
67
38
 
68
39
* mandos (server)
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:
82
 
   Is this the default?
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 <replaceable> and <option> tags
96
 
*** OPTIONS
97
 
    Separate <term> tags with <option> and <replaceable> tags
98
 
** Use xinclude for common sections
99
 
   Like copyright, authors, etc.
100
 
 
101
 
 
102
 
* Installer
103
 
** Client-side
104
 
*** Update initrd.img after installation
105
 
    This seems to use some kind of "trigger" system
106
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
107
 
    dpkg-trigger(1), deb-triggers(5)
108
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
109
 
    Must create in preinst if not pre-depending on cryptsetup
110
 
*** mandos-keygen
111
 
**** "--passfile" option
112
 
     Using the "secfile" option instead of "secret"
113
 
**** [#A] "--test" option
114
 
     For testing decryption before rebooting.
115
 
** Server-side
116
 
*** [#A] Create mandos user and group for server
117
 
*** [#A] Create /var/run/mandos directory with perm and ownership
118
 
 
119
 
* [#A] Package
 
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
120
101
** /usr/share/initramfs-tools/hooks/mandos
121
 
*** Do not install in initrd.img if configured not to.
122
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
123
 
    question.
124
 
** /etc/bash_completion.d/mandos
 
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)
125
106
   From XML sources directly?
126
 
** unperish
127
 
** bzr-builddeb
128
 
 
129
 
* INSTALL file
130
 
 
131
 
* Web site
132
 
 
133
 
* Mailing list
134
 
 
135
 
* Announce project on news
136
 
  [[news:comp.os.linux.announce]]
 
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]]
137
113
 
138
114
 
139
115
#+STARTUP: showall