/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: 2024-09-08 00:08:15 UTC
  • 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:
TODO
1
1
-*- org -*-
2
2
 
3
 
* [#A] README file
4
 
 
5
 
* [#A] COPYING file
6
 
  [[file:/usr/share/common-licenses/GPL-3][GPLv3]]
7
 
 
8
 
* Mandos-client
9
 
** [#A] Change syntax for arguments
10
 
** [#A] Man page: man8/mandos-client.8mandos
11
 
*** DESCRIPTION
12
 
    Describe the plus sign syntax for passing options from crypttab
13
 
*** EXIT STATUS
14
 
    Text needed
15
 
*** EXAMPLES
16
 
    Examples of normal usage, debug usage, debugging single or all
17
 
    plugins, examples of crypttab lines with plus syntax, etc.
18
 
*** FILES
19
 
    Text needed
20
 
*** SECURITY
21
 
    Text needed
22
 
*** NOTES
23
 
    Text needed
24
 
*** BUGS
25
 
    Text needed
26
 
*** SEE ALSO
27
 
    Explaining test on what you can read
28
 
** Use asprintf instead of malloc and strcat?
29
 
** use strsep instead of strtok?
30
 
** use config file in addition to arguments
31
 
** pass things in environment, like device name, etc
32
 
 
33
 
* Password-request
34
 
** [#A] Man page: man8/password-request.8mandos
35
 
** [#B] Temporarily lower kernel log level
36
 
   for less printouts during sucessfull boot.
37
 
*** DESCRIPTION
38
 
    Move options to new OPTIONS section.
39
 
    State that this command is not meant to be invoked directly, but
40
 
    is run as a plugin from mandos-client(8) and only run in the
41
 
    initrd environment, not the real system.
42
 
*** EXIT STATUS
43
 
    Create this section
44
 
*** EXAMPLES
45
 
    Examples of normal usage, debug usage, debugging by connecting
46
 
    directly, etc.
47
 
*** FILES
48
 
    Describe the key files and the key ring files.  Also note that
49
 
    they should normally have been automatically created.
50
 
*** DIAGNOSTICS
51
 
    Create this section
52
 
*** SECURITY
53
 
    Create this section
54
 
*** NOTES
55
 
    Create this section (if needed)
56
 
*** BUGS
57
 
    Create this section
58
 
*** SEE ALSO
59
 
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
60
 
** Use asprintf instead of malloc and memcpy?
61
 
** IPv4 support
62
 
** use strsep instead of strtok?
63
 
** Do not depend on GPG key rings on disk
64
 
   This would mean creating new GPG key rings with GPGME by importing
65
 
   the key files from scratch on every program start.
66
 
 
67
 
* Password-prompt
68
 
** [#A] Man page: man8/password-prompt.8mandos
69
 
*** DESCRIPTION
70
 
    Move options to new OPTIONS section.
71
 
*** EXIT STATUS
72
 
    Create this section
73
 
*** EXAMPLES
74
 
    Examples of normal usage, debug usage, with a prefix, etc.
75
 
*** DIAGNOSTICS
76
 
    Create this section
77
 
*** SECURITY
78
 
    Create this section
79
 
    Not much to do here but it is noteworthy to state the danger of
80
 
    not having a fallback option.
81
 
*** NOTES
82
 
    Note that this is more or less a simple getpass(3) wrapper, even
83
 
    though actual use of getpass(3) is not guaranteed.
84
 
*** BUGS
85
 
    Create this section
86
 
*** SEE ALSO
87
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
88
 
** Use getpass(3)?
89
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
90
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
91
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
92
 
   [[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?]]
93
 
** Replace completely with "/lib/cryptsetup/askpass"?
94
 
 
95
 
* Mandos (server)
96
 
** [#A] Command man page: man8/mandos.8
97
 
*** DESCRIPTION
98
 
    Move options to new OPTIONS section
99
 
*** EXIT STATUS
100
 
    Create this section
101
 
*** EXAMPLES
102
 
    Create this section
103
 
*** FILES
104
 
    Describe briefly that the server gets global settings from
105
 
    mandos.conf and clients from clients.conf, but refer to their man
106
 
    pages for more details.
107
 
*** DIAGNOSTICS
108
 
    Create this section
109
 
*** SECURITY
110
 
    Create this section
111
 
*** NOTES
112
 
    Create this section (if needed)
113
 
*** BUGS
114
 
    Create this section
115
 
*** SEE ALSO
116
 
    Refer to the client man page
117
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
118
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
119
 
** [#A] /etc/init.d/mandos-server               :teddy:
120
 
** Log level
121
 
** /etc/mandos/clients.d/*.conf
122
 
   Watch this directory and add/remove/update clients?
123
 
** config for TXT record
124
 
** Run-time communication with server
125
 
   Probably using D-Bus
126
 
   See also [[*Mandos-tools]]
127
 
** Implement --foreground
128
 
   [[info:standards:Option%20Table][Table of Long Options]]
129
 
** Implement --socket
130
 
   [[info:standards:Option%20Table][Table of Long Options]]
131
 
** Date+time on console log messages
132
 
   Is this the default?
133
 
 
134
 
* Mandos-tools/utilities
135
 
  All of this probably using D-Bus
136
 
** List clients
137
 
** Disable client
138
 
** Enable client
139
 
 
140
 
* Installer
141
 
** Client
142
 
*** DONE [#A] Change initrd.img file to not be publically readable
143
 
    /usr/share/initramfs-tools/conf-hooks.d/mandos
144
 
    UMASK=027
145
 
*** Update initrd.img after installation
146
 
** Server
147
 
*** [#A] Create mandos user and group for server
148
 
*** [#A] Create /var/run/mandos directory with perm and ownership
149
 
 
150
 
** mandos-keygen
151
 
*** [#A] Command man page: man8/mandos-keygen.8
152
 
*** [#A] Output cut-and-paste ready snippet for clients.conf.
153
 
 
154
 
* [#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 [[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
 
38
 
 
39
* plugin-runner
 
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~
 
45
 
 
46
* mandos (server)
 
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
155
105
** /usr/share/initramfs-tools/hooks/mandos
156
 
*** Do not install in initrd.img if configured not to
157
 
    Use "/etc/initramfs-tools/conf.d/mandos"?  Definitely a debconf
158
 
    question.
159
 
** /etc/bash_completion.d/mandos
160
 
*** From xml sources directly?
161
 
** unperish
162
 
** bzr-builddeb
163
 
 
164
 
* INSTALL file
165
 
 
166
 
* Web site
167
 
 
168
 
* Mailing list
169
 
 
170
 
* Announce project on news
171
 
  [[news:comp.os.linux.announce]]
 
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)~
 
110
   From XML sources directly?
 
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]]
172
117
 
173
118
 
174
119
#+STARTUP: showall
 
120
#+FILETAGS: :mandos: