/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:11:24 UTC
  • Revision ID: teddy@recompile.se-20240908001124-nq0ja17503ua9nmw
Minor documentation improvements 

* TODO (mandos-applet): Add link.
* debian/mandos-client.README.Debian: Fix spelling.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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] Man page: man8/mandos-client.8mandos
10
 
*** EXIT STATUS
11
 
    Create this section
12
 
*** USAGE
13
 
    Describe the plus sign syntax for passing options from crypttab
14
 
*** EXAMPLES
15
 
    Examples of normal usage, debug usage, debugging single or all
16
 
    plugins, examples of crypttab lines with plus syntax, etc.
17
 
*** FILES
18
 
    Describe plugin directory
19
 
*** DIAGNOSTICS
20
 
    Create this section
21
 
*** SECURITY
22
 
    Create this section
23
 
*** NOTES
24
 
    Create this section (if needed)
25
 
*** BUGS
26
 
    Create this section
27
 
*** SEE ALSO
28
 
    Refer to mandos(8), password-request(8mandos), and
29
 
    password-prompt(8mandos)
30
 
** Use asprintf instead of malloc and strcat?
31
 
** use strsep instead of strtok?
32
 
** use config file in addition to arguments
33
 
** pass things in environment, like device name, etc
34
 
** Fallback
35
 
   As a fallback, if no plugins can be found or if all of them failed,
36
 
   run getpass(3) itself.
37
 
 
38
 
* Password-request
39
 
** [#A] Man page: man8/password-request.8mandos
40
 
*** DESCRIPTION
41
 
    Move options to new OPTIONS section.
42
 
    State that this command is not meant to be invoked directly, but
43
 
    is run as a plugin from mandos-client(8) and only run in the
44
 
    initrd environment, not the real system.
45
 
*** EXIT STATUS
46
 
    Create this section
47
 
*** EXAMPLES
48
 
    Examples of normal usage, debug usage, debugging by connecting
49
 
    directly, etc.
50
 
*** FILES
51
 
    Describe the key files and the key ring files.  Also note that
52
 
    they should normally have been automatically created.
53
 
*** DIAGNOSTICS
54
 
    Create this section
55
 
*** SECURITY
56
 
    Create this section
57
 
*** NOTES
58
 
    Create this section (if needed)
59
 
*** BUGS
60
 
    Create this section
61
 
*** SEE ALSO
62
 
    Refer to mandos-client(8mandos) and password-prompt(8mandos)
63
 
** Use asprintf instead of malloc and memcpy?
64
 
** IPv4 support
65
 
** use strsep instead of strtok?
66
 
** Do not depend on GPG key rings on disk
67
 
   This would mean creating new GPG key rings with GPGME by importing
68
 
   the key files from scratch on every program start.
69
 
 
70
 
* Password-prompt
71
 
** [#A] Man page: man8/password-prompt.8mandos
72
 
*** DESCRIPTION
73
 
    Move options to new OPTIONS section.
74
 
*** EXIT STATUS
75
 
    Create this section
76
 
*** EXAMPLES
77
 
    Examples of normal usage, debug usage, with a prefix, etc.
78
 
*** DIAGNOSTICS
79
 
    Create this section
80
 
*** SECURITY
81
 
    Create this section
82
 
    Not much to do here but it is noteworthy to state the danger of
83
 
    not having a fallback option.
84
 
*** NOTES
85
 
    Note that this is more or less a simple getpass(3) wrapper, even
86
 
    though actual use of getpass(3) is not guaranteed.
87
 
*** BUGS
88
 
    Create this section
89
 
*** SEE ALSO
90
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
91
 
** Use getpass(3)?
92
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
93
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
94
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
95
 
   [[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?]]
96
 
 
97
 
* Mandos (server)
98
 
** [#A] Command man page: man8/mandos.8
99
 
*** DESCRIPTION
100
 
    Move options to new OPTIONS section
101
 
*** EXIT STATUS
102
 
    Create this section
103
 
*** EXAMPLES
104
 
    Create this section
105
 
*** FILES
106
 
    Describe briefly that the server gets global settings from
107
 
    mandos.conf and clients from clients.conf, but refer to their man
108
 
    pages for more details.
109
 
*** DIAGNOSTICS
110
 
    Create this section
111
 
*** SECURITY
112
 
    Create this section
113
 
*** NOTES
114
 
    Create this section (if needed)
115
 
*** BUGS
116
 
    Create this section
117
 
*** SEE ALSO
118
 
    Refer to the client man page
119
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
120
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
121
 
** [#A] /etc/init.d/mandos-server               :teddy:
122
 
** Log level
123
 
** /etc/mandos/clients.d/*.conf
124
 
   Watch this directory and add/remove/update clients?
125
 
** config for TXT record
126
 
** Run-time communication with server
127
 
   Probably using D-Bus
128
 
   See also [[*Mandos-tools]]
129
 
** Implement --foreground
130
 
   [[info:standards:Option%20Table][Table of Long Options]]
131
 
** Implement --socket
132
 
   [[info:standards:Option%20Table][Table of Long Options]]
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
 
** DONE [#A] Change initrd.img file to not be publically readable
142
 
   /etc/initramfs-tools/conf.d/mandos
143
 
   UMASK=027
144
 
** Update initrd.img after installation
145
 
** [#A] Create mandos user and group for server
146
 
** [#A] Create /var/run/mandos directory with perm and ownership
147
 
 
148
 
* [#A] Package
149
 
** /etc/bash_completion.d/mandos
150
 
** /etc/initramfs-tools/hooks/mandos
151
 
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
152
 
*** Create GPG key ring files in initrd
153
 
** unperish
154
 
** bzr-builddeb
155
 
 
156
 
* INSTALL file
157
 
 
158
 
* Web site
159
 
 
160
 
* Mailing list
161
 
 
162
 
* Announce project on news
163
 
  [[news:comp.os.linux.announce]]
 
3
* Testing
 
4
** python-nemu
 
5
 
 
6
* mandos-applet
 
7
** [[https://www.freedesktop.org/software/polkit/docs/latest/polkit-apps.html][Writing polkit applications]]
 
8
 
 
9
* mandos-client
 
10
** TODO A ~--server~ option which only adds to the server list.
 
11
   (Unlike ~--connect~, which implicitly disables ZeroConf.)
 
12
** TODO [#B] Use [[man:capabilities][capabilities]] instead of [[info:libc#Setting%20User%20ID][seteuid()]].
 
13
   [[https://forums.grsecurity.net/viewtopic.php?f=7&t=2522]]
 
14
** TODO [#B] Use ~getaddrinfo(hints=AI_NUMERICHOST)~ instead of ~inet_pton()~
 
15
** TODO [#C] Make ~start_mandos_communication()~ take ~struct server~.
 
16
** TODO [#C] ~--interfaces=regex,eth*,noregex~ [[man:bridge-utils-interfaces][bridge-utils-interfaces(5)]]
 
17
** TODO [#A] Detect partial writes to stdout and exit with ~EX_TEMPFAIL~
 
18
 
 
19
* splashy
 
20
** TODO [#B] use [[info:libc#Scanning%20Directory%20Content][scandir(3)]] instead of [[info:libc#Reading/Closing%20Directory][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 [[info:libc#Scanning%20Directory%20Content][scandir(3)]] instead of [[info:libc#Reading/Closing%20Directory][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 [[info:libc#File%20Locks][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
 
 
38
* TODO [#B] passdev
 
39
 
 
40
* plugin-runner
 
41
** TODO handle printing for errors for plugins
 
42
*** Hook up stderr of plugins, buffer them, and prepend "Mandos Plugin [plugin name]"
 
43
** TODO [#C] use same file name rules as [[man:run-parts][run-parts(8)]]
 
44
** kernel command line option for debug info
 
45
** TODO [#A] Restart plugins which exit with ~EX_TEMPFAIL~
 
46
 
 
47
* mandos (server)
 
48
** TODO [#B] ~--notify-command~
 
49
   This would allow the mandos.service to use
 
50
   ~--notify-command="systemd-notify --pid --ready"~
 
51
** TODO [#B] python-systemd
 
52
*** import systemd.daemon; systemd.daemon.notify()
 
53
** TODO [#B] Log level                                                    :BUGS:
 
54
*** TODO /etc/mandos/clients.d/*.conf
 
55
    Watch this directory and add/remove/update clients?
 
56
** TODO [#C] config for TXT record
 
57
** TODO Log level dbus option
 
58
   SetLogLevel D-Bus call
 
59
** TODO [#C] DBusServiceObjectUsingSuper
 
60
** TODO [#B] Global enable/disable flag
 
61
** TODO [#B] By-client countdown on number of secrets given
 
62
** D-Bus Client method NeedsPassword(50) - Timeout, default disapprove
 
63
    + SetPass("gazonk", True) -> Approval, persistent
 
64
    + Approve(False) -> Close client connection immediately
 
65
** TODO [#C] python-parsedatetime
 
66
** TODO Separate logging logic to own object
 
67
** TODO [#B] Limit ~approval_delay~ to max GnuTLS/TLS timeout value
 
68
** TODO [#B] break the wait on ~approval_delay~ if connection dies
 
69
** TODO Generate ~Client.runtime_expansions~ from client options + extra
 
70
** TODO Allow %%(checker)s as a runtime expansion
 
71
** TODO D-Bus AddClient() method on server object
 
72
** TODO Use org.freedesktop.DBus.Method.NoReply annotation on async methods. :2:
 
73
** TODO Save state periodically to recover better from hard shutdowns
 
74
** TODO CheckerCompleted method, deprecate CheckedOK
 
75
** TODO [[https://standards.freedesktop.org/secret-service/][Secret Service]] API?
 
76
** TODO Remove D-Bus interfaces with old domain name                      :2:
 
77
** TODO Remove old ~string_to_delta~ format                               :2:
 
78
** TODO http://0pointer.de/blog/projects/stateless.html
 
79
*** File in /usr/lib/sysusers.d to create user+group "~_mandos~"
 
80
** TODO Error handling on error parsing config files
 
81
** TODO init.d script error handling
 
82
** TODO D-Bus server properties; address, port, interface, etc.           :2:
 
83
 
 
84
* mandos-ctl
 
85
** TODO Remove old string_to_delta format                                 :2:
 
86
 
 
87
* TODO mandos-dispatch
 
88
  Listens for specified D-Bus signals and spawns shell commands with
 
89
  arguments.
 
90
 
 
91
* mandos-monitor
 
92
** TODO ~--servicename~                                                :BUGS:
 
93
** TODO help should be toggleable
 
94
** Urwid client data displayer
 
95
   Better view of client data in the listing
 
96
*** Properties popup
 
97
** Print a nice "We are sorry" message, save stack trace to log.
 
98
 
 
99
* mandos-keygen
 
100
** TODO "~--secfile~" option
 
101
   Using the "secfile" option instead of "secret"
 
102
** TODO [#B] "~--test~" option
 
103
   For testing decryption before rebooting.
 
104
 
 
105
* Package
 
106
** /usr/share/initramfs-tools/hooks/mandos
 
107
*** TODO [#C] use same file name rules as [[man:run-parts][run-parts(8)]]
 
108
*** TODO [#C] Do not install in initrd.img if configured not to.
 
109
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
 
110
** TODO [#C] ~$(pkg-config --variable=completionsdir bash-completion)~
 
111
   From XML sources directly?
 
112
 
 
113
* Side Stuff
 
114
** TODO Locate which package moves the other bin/sh when busybox is deactivated
 
115
** TODO contact owner of package, and ask them to have that shell static in position regardless of busybox
 
116
 
 
117
* [[http://www.undeadly.org/cgi?action=article&sid=20110530221728][OpenBSD]]
164
118
 
165
119
 
166
120
#+STARTUP: showall
 
121
#+FILETAGS: :mandos: