/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: 2019-07-27 10:11:45 UTC
  • mto: This revision was merged to the branch mainline in revision 384.
  • Revision ID: teddy@recompile.se-20190727101145-jnpbpf8220gldbcd
Add dracut(8) support

Add support for the dracut(8) system for generating initramfs image
files; dracut is an alternative to the "initramfs-tools" package.

* .bzrignore (dracut-module/password-agent): Ignore new binary file.
* dracut-module: New directory for the dracut module.
* INSTALL (Prerequisites/Libraries/Mandos Client): Add dracut as an
                                                   alternative to
                                                   initramfs-tools,
                                                   and also add GLib.
* Makefile (DRACUTMODULE, GLIB_CFLAGS, GLIB_LIBS): New.
  (CPROGS): Add "dracut-module/password-agent".
  (DOCS): Add "dracut-module/password-agent.8mandos".
  (dracut-module/password-agent.8mandos): New.
  (dracut-module/password-agent.8mandos.xhtml): - '' -
  (dracut-module/password-agent): - '' -
  (check): Add command to run tests of password-agent(8mandos).
  (install-client-nokey): Also install the dracut module directory,
                          its files, and the password-agent(8mandos)
                          manual page.
  (install-client): To update the initramfs image file, run
                    update-initramfs or dracut depending on what is
                    installed.
  (uninstall-client): - '' - and also uninstall the the files in the
                      dracut module directory, that directory itself,
                      and the password-agent(8mandos) manual page.
* debian/control (Build-Depends): Add "libglib2.0-dev (>=2.40)".
  (Package: mandos-client/Depends): Add "dracut (>= 044+241-3)" as an
                                    alternative dependency to
                                    initramfs-tools.
  (Package: mandos-client/Conflicts): New; set to
                                      "dracut-config-generic".
  (debian/mandos-client.README.Debian): Document alternative commands
                                        to update the initramfs image
                                        for when dracut is used.
* debian/mandos-client.postinst (update_initramfs): Use alternative
                                                    commands to update
                                                    the initramfs
                                                    image for when
                                                    dracut is used.
* debian/tests/control (password-agent, password-agent-suid): Add two
                                                              new tests.
* dracut-module/ask-password-mandos.path: New.
* dracut-module/ask-password-mandos.service: - '' -
* dracut-module/cmdline-mandos.sh: - '' -
* dracut-module/module-setup.sh: - '' -
* dracut-module/password-agent.c: - '' -
* dracut-module/password-agent.xml: - '' -
* initramfs-unpack: Use the dracut "skipcpio" command, if available.
                    Also be more flexible and try hard to detect where
                    compressed data starts.
* plugins.d/mandos-client.xml (SECURITY): Be more precise that the
                                          mandos-client binary might
                                          not always be setuid, but
                                          that the program assumes
                                          that it has been started
                                          that way.
* plugins.d/password-prompt.c: Add new "--prompt" option.
  (conflict_detection): First try to detect the new PID file of
                        plymouth.
  (main): Define and use new "prompt" variable.
* plugins.d/password-prompt.xml (SYNOPSIS): Show new --prompt option.
  (DESCRIPTION): Describe new behavior of looking for plymouth PID
                 file.
  (OPTIONS): Document new "--prompt" option.
  (ENVIRONMENT): Clarify that the CRYPTTAB_SOURCE and CRYPTTAB_NAME
                 environment variables are not used if the --prompt
                 option is used.  Remove unnecessarily specific
                 details about where the CRYPTTAB_SOURCE and
                 CRYPTTAB_NAME comes from, since this can now be
                 either initramfs-tools or dracut.
  (SEE ALSO): Remove superfluous crypttab(5) reference, and add commas
              to separate the other references.
* plugins.d/plymouth.c: Add new "--prompt" and "--debug" options.
  (debug): New global flag.
  (fprintf_plus): New function, used for debug output.
  (exec_and_wait): Add extra "const" to "argv" argument.
  (main): Define and use new "prompt" variable.  Add debug output.
  (main/options, main/parse_opt): New; used to parse options.
* plugins.d/plymouth.xml (SYNOPSIS): Show new options.
  (OPTIONS): Document new options.
  (ENVIRONMENT): Clarify that the cryptsource and crypttarget
                 environment variables are not used if the --prompt
                 option is used.  Remove unnecessarily specific
                 details about where the cryptsource and crypttarget
                 comes from, since this can now be either
                 initramfs-tools or dracut.
  (EXAMPLE): Add an example using an option.
  (SEE ALSO): Remove superfluous crypttab(5) reference.
* plugins.d/splashy.xml (ENVIRONMENT): Clarify that the cryptsource
                                       and crypttarget environment
                                       variables are not used if the
                                       --prompt option is used.
                                       Remove unnecessarily specific
                                       details about where the
                                       cryptsource and crypttarget
                                       comes from, since this can now
                                       be either initramfs-tools or
                                       dracut.
  (SEE ALSO): Remove superfluous crypttab(5) reference.
* plugins.d/usplash.xml (ENVIRONMENT): Clarify that the cryptsource
                                       and crypttarget environment
                                       variables are not used if the
                                       --prompt option is used.
                                       Remove unnecessarily specific
                                       details about where the
                                       cryptsource and crypttarget
                                       comes from, since this can now
                                       be either initramfs-tools or
                                       dracut.
  (SEE ALSO): Remove superfluous crypttab(5) reference.

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