/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: 2024-09-08 00:08:15 UTC
  • mto: This revision was merged to the branch mainline in revision 410.
  • Revision ID: teddy@recompile.se-20240908000815-x3gr5xion3kyyoio
Improve documentation

* mandos.conf.xml (DESCRIPTION): Remove the unnecessary word "simple".
* plugin-runner.xml (PLUGINS): Remove the unnecessary word "simply",
  and add the "executable" qualifier to the description of plugins.
* mandos-client.xml (DESCRIPTION, OPTIONS): Do not refer to
  "plugin-runner"; instead refer to the section "OVERVIEW".
  (OVERVIEW): Don't only describe plugin-runner; also describe
  how password-agent can start mandos-client.
  (EXAMPLE): Do not refer to "plugin-runner"; instead refer to the
  section "OVERVIEW".
  (SEE ALSO): Replace reference to "password-prompt" with
  "password-agent".

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 [[man:capabilities][capabilities]] instead of [[info:libc#Setting%20User%20ID][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~ [[man:bridge-utils-interfaces][bridge-utils-interfaces(5)]]
 
16
** TODO [#A] Detect partial writes to stdout and exit with ~EX_TEMPFAIL~
 
17
 
 
18
* splashy
 
19
** TODO [#B] use [[info:libc#Scanning%20Directory%20Content][scandir(3)]] instead of [[info:libc#Reading/Closing%20Directory][readdir(3)]]
 
20
** TODO [#A] Detect partial writes to stdout and exit with ~EX_TEMPFAIL~
 
21
 
 
22
* usplash (Deprecated)
 
23
** TODO [#B] Make it work again
 
24
** TODO [#B] use [[info:libc#Scanning%20Directory%20Content][scandir(3)]] instead of [[info:libc#Reading/Closing%20Directory][readdir(3)]]
 
25
** TODO [#A] Detect partial writes to stdout and exit with ~EX_TEMPFAIL~
 
26
 
 
27
* askpass-fifo
 
28
** TODO [#A] Detect partial writes to stdout and exit with ~EX_TEMPFAIL~
 
29
 
 
30
* password-prompt
 
31
** TODO [#B] lock stdin (with [[info:libc#File%20Locks][flock()]]?)
 
32
** TODO [#A] Detect partial writes to stdout and exit with ~EX_TEMPFAIL~
 
33
 
 
34
* plymouth
 
35
** TODO [#A] Detect partial writes to stdout and exit with ~EX_TEMPFAIL~
 
36
 
 
37
* TODO [#B] passdev
4
38
 
5
39
* 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
 
 
10
 
* password-request
11
 
** [#A] Man page: man8/password-request.8mandos
12
 
*** DESCRIPTION
13
 
    State that this command is not meant to be invoked directly, but
14
 
    is run as a plugin from mandos-client(8) and only run in the
15
 
    initrd environment, not the real system.
16
 
*** PURPOSE
17
 
    As in mandos.xml
18
 
*** OVERVIEW
19
 
    As in mandos.xml
20
 
*** EXIT STATUS
21
 
*** ENVIRONMENT
22
 
    Note that it does *not* currently use cryptsource or crypttarget.
23
 
*** FILES
24
 
    Describe the key files and the key ring files.  Also note that
25
 
    they should normally have been automatically created.
26
 
*** BUGS
27
 
*** EXAMPLE
28
 
    Examples of normal usage, debug usage, debugging by connecting
29
 
    directly, etc.
30
 
*** SECURITY
31
 
*** SEE ALSO
32
 
    Update from mandos.xml
33
 
** [#B] Temporarily lower kernel log level
34
 
   for less printouts during sucessfull boot.
35
 
** IPv4 support
36
 
** use strsep instead of strtok?
37
 
** Do not depend on GnuPG key rings on disk
38
 
   This would mean creating new GnuPG key rings with GPGME by
39
 
   importing the key files from scratch on every program start.
40
 
** Keydir move: /etc/mandos -> /etc/keys/mandos
41
 
   Must create in preinst if not pre-depending on cryptsetup
42
 
 
43
 
* password-prompt
44
 
** [#C] Use getpass(3)?
45
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
46
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
47
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
48
 
   [[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?]]
 
40
** TODO handle printing for errors for plugins
 
41
*** Hook up stderr of plugins, buffer them, and prepend "Mandos Plugin [plugin name]"
 
42
** TODO [#C] use same file name rules as [[man:run-parts][run-parts(8)]]
 
43
** kernel command line option for debug info
 
44
** TODO [#A] Restart plugins which exit with ~EX_TEMPFAIL~
49
45
 
50
46
* mandos (server)
51
 
** [#A] /etc/init.d/mandos-server               :teddy:
52
 
** [#B] Log level                               :bugs:
53
 
** /etc/mandos/clients.d/*.conf
54
 
   Watch this directory and add/remove/update clients?
55
 
** config for TXT record
56
 
** [#B] Run-time communication with server      :bugs:
57
 
   Probably using D-Bus
58
 
   See also [[*Mandos-tools]]
59
 
** Implement --foreground                       :bugs:
60
 
   [[info:standards:Option%20Table][Table of Long Options]]
61
 
** Implement --socket
62
 
   [[info:standards:Option%20Table][Table of Long Options]]
63
 
** Date+time on console log messages            :bugs:
64
 
   Is this the default?
65
 
 
66
 
* Mandos-tools/utilities
67
 
  All of this probably using D-Bus
68
 
** List clients
69
 
** Disable client
70
 
** Enable client
71
 
 
72
 
* Man pages
73
 
** Use xinclude for common sections
74
 
   Like authors, etc.
75
 
 
76
 
 
77
 
* Installer
78
 
** Client-side
79
 
*** Update initrd.img after installation
80
 
    This seems to use some kind of "trigger" system
81
 
    [[file:/usr/share/doc/dpkg/triggers.txt.gz]]
82
 
    dpkg-trigger(1), deb-triggers(5)
83
 
*** Keydir move: /etc/mandos -> /etc/keys/mandos
84
 
    Must create in preinst if not pre-depending on cryptsetup
85
 
*** mandos-keygen
86
 
**** "--passfile" option
87
 
     Using the "secfile" option instead of "secret"
88
 
**** [#A] "--test" option
89
 
     For testing decryption before rebooting.
90
 
** Server-side
91
 
*** [#A] Create mandos user and group for server
92
 
*** [#A] Create /var/run/mandos directory with perm and ownership
93
 
 
94
 
* [#A] Package
 
47
** TODO [#B] ~--notify-command~
 
48
   This would allow the mandos.service to use
 
49
   ~--notify-command="systemd-notify --pid --ready"~
 
50
** TODO [#B] python-systemd
 
51
*** import systemd.daemon; systemd.daemon.notify()
 
52
** TODO [#B] Log level                                                    :BUGS:
 
53
*** TODO /etc/mandos/clients.d/*.conf
 
54
    Watch this directory and add/remove/update clients?
 
55
** TODO [#C] config for TXT record
 
56
** TODO Log level dbus option
 
57
   SetLogLevel D-Bus call
 
58
** TODO [#C] DBusServiceObjectUsingSuper
 
59
** TODO [#B] Global enable/disable flag
 
60
** TODO [#B] By-client countdown on number of secrets given
 
61
** D-Bus Client method NeedsPassword(50) - Timeout, default disapprove
 
62
    + SetPass("gazonk", True) -> Approval, persistent
 
63
    + Approve(False) -> Close client connection immediately
 
64
** TODO [#C] python-parsedatetime
 
65
** TODO Separate logging logic to own object
 
66
** TODO [#B] Limit ~approval_delay~ to max GnuTLS/TLS timeout value
 
67
** TODO [#B] break the wait on ~approval_delay~ if connection dies
 
68
** TODO Generate ~Client.runtime_expansions~ from client options + extra
 
69
** TODO Allow %%(checker)s as a runtime expansion
 
70
** TODO D-Bus AddClient() method on server object
 
71
** TODO Use org.freedesktop.DBus.Method.NoReply annotation on async methods. :2:
 
72
** TODO Save state periodically to recover better from hard shutdowns
 
73
** TODO CheckerCompleted method, deprecate CheckedOK
 
74
** TODO [[https://standards.freedesktop.org/secret-service/][Secret Service]] API?
 
75
** TODO Remove D-Bus interfaces with old domain name                      :2:
 
76
** TODO Remove old ~string_to_delta~ format                               :2:
 
77
** TODO http://0pointer.de/blog/projects/stateless.html
 
78
*** File in /usr/lib/sysusers.d to create user+group "~_mandos~"
 
79
** TODO Error handling on error parsing config files
 
80
** TODO init.d script error handling
 
81
** TODO D-Bus server properties; address, port, interface, etc.           :2:
 
82
 
 
83
* mandos-ctl
 
84
** TODO Remove old string_to_delta format                                 :2:
 
85
 
 
86
* TODO mandos-dispatch
 
87
  Listens for specified D-Bus signals and spawns shell commands with
 
88
  arguments.
 
89
 
 
90
* mandos-monitor
 
91
** TODO ~--servicename~                                                :BUGS:
 
92
** TODO help should be toggleable
 
93
** Urwid client data displayer
 
94
   Better view of client data in the listing
 
95
*** Properties popup
 
96
** Print a nice "We are sorry" message, save stack trace to log.
 
97
 
 
98
* mandos-keygen
 
99
** TODO "~--secfile~" option
 
100
   Using the "secfile" option instead of "secret"
 
101
** TODO [#B] "~--test~" option
 
102
   For testing decryption before rebooting.
 
103
 
 
104
* Package
95
105
** /usr/share/initramfs-tools/hooks/mandos
96
 
*** Do not install in initrd.img if configured not to.
97
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
98
 
    question.
99
 
** /etc/bash_completion.d/mandos
 
106
*** TODO [#C] use same file name rules as [[man:run-parts][run-parts(8)]]
 
107
*** TODO [#C] Do not install in initrd.img if configured not to.
 
108
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
 
109
** TODO [#C] ~$(pkg-config --variable=completionsdir bash-completion)~
100
110
   From XML sources directly?
101
 
** unperish
102
 
** bzr-builddeb
103
 
 
104
 
* INSTALL file
105
 
 
106
 
* Web site
107
 
 
108
 
* Mailing list
109
 
 
110
 
* Announce project on news
111
 
  [[news:comp.os.linux.announce]]
 
111
 
 
112
* Side Stuff
 
113
** TODO Locate which package moves the other bin/sh when busybox is deactivated
 
114
** TODO contact owner of package, and ask them to have that shell static in position regardless of busybox
 
115
 
 
116
* [[http://www.undeadly.org/cgi?action=article&sid=20110530221728][OpenBSD]]
112
117
 
113
118
 
114
119
#+STARTUP: showall
 
120
#+FILETAGS: :mandos: