/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 at recompile
  • Date: 2020-02-09 03:42:50 UTC
  • mto: This revision was merged to the branch mainline in revision 396.
  • Revision ID: teddy@recompile.se-20200209034250-dxkkuq0eevnzk8py
Update formatting in TODO file

* TODO: Add markup, links and a file-wide tag.

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
 
** [#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?]]
 
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~
86
45
 
87
46
* 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
 
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
125
105
** /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
 
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)~
130
110
   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]]
 
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]]
142
117
 
143
118
 
144
119
#+STARTUP: showall
 
120
#+FILETAGS: :mandos: