/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: 2019-02-09 23:23:26 UTC
  • Revision ID: teddy@recompile.se-20190209232326-z1z2kzpgfixz7iaj
Add support for using raw public keys in TLS (RFC 7250)

Since GnuTLS removed support for OpenPGP keys in TLS (RFC 6091), and
no other library supports it, we have to change the protocol to use
something else.  We choose to use "raw public keys" (RFC 7250).  Since
we still use OpenPGP keys to decrypt the secret password, this means
that each client will have two keys: One OpenPGP key and one TLS
public/private key, and the key ID of the latter key is used to
identify clients instead of the fingerprint of the OpenPGP key.

Note that this code is still compatible with GnuTLS before version
3.6.0 (when OpenPGP key support was removed).  This commit merely adds
support for using raw pulic keys instead with GnuTLS 3.6.6. or later.

* DBUS-API (Signals/ClientNotFound): Change name of first parameter
                                     from "Fingerprint" to "KeyID".
  (Mandos Client Interface/Properties/KeyID): New.
* INSTALL: Document conflict with GnuTLS 3.6.0 (which removed OpenPGP
           key support) up until 3.6.6, when support for raw public
           keys was added.  Also document new dependency of client on
           "gnutls-bin" package (for certtool).
* Makefile (run-client): Depend on TLS key files, and also pass them
                         as arguments to client.
  (keydir/tls-privkey.pem, keydir/tls-pubkey.pem): New.
  (confdir/clients.conf): Add dependency on TLS public key.
  (purge-client): Add removal of TLS key files.
* clients.conf ([foo]/key_id, [bar]/key_id): New.
* debian/control (Source: mandos/Build-Depends): Also allow
                                                 libgnutls30 (>= 3.6.6)
  (Package: mandos/Depends): - '' -
  (Package: mandos/Description): Alter description to match new
                                 design.
  (Package: mandos-client/Description): - '' -
  (Package: mandos-client/Depends): Move "gnutls-bin | openssl" to
                                    here from "Recommends".
* debian/mandos-client.README.Debian: Add --tls-privkey and
                                      --tls-pubkey options to test
                                      command.
* debian/mandos-client.postinst (create_key): Renamed to "create_keys"
                                             (all callers changed),
                                             and also create TLS key.
* debian/mandos-client.postrm (purge): Also remove TLS key files.
* intro.xml (DESCRIPTION): Describe new dual-key design.
* mandos (GnuTLS): Define different functions depending on whether
                   support for raw public keys is detected.
  (Client.key_id): New attribute.
  (ClientDBus.KeyID_dbus_property): New method.
  (ProxyClient.__init__): Take new "key_id" parameter.
  (ClientHandler.handle): Use key IDs when using raw public keys and
                          use fingerprints when using OpenPGP keys.
  (ClientHandler.peer_certificate): Also handle raw public keys.
  (ClientHandler.key_id): New.
  (MandosServer.handle_ipc): Pass key ID over the pipe IPC.  Also
                             check for key ID matches when looking up
                             clients.
  (main): Default GnuTLS priority string depends on whether we are
          using raw public keys or not.  When unpickling clients, set
          key_id if not set in the pickle.
  (main/MandosDBusService.ClientNotFound): Change name of first
                                           parameter from
                                           "Fingerprint" to "KeyID".
* mandos-clients.conf.xml (OPTIONS): Document new "key_id" option.
  (OPTIONS/secret): Mention new key ID matchning.
  (EXPANSION/RUNTIME EXPANSION): Add new "key_id" option.
  (EXAMPLE): - '' -
* mandos-ctl (tablewords, main/keywords): Add new "KeyID" property.
* mandos-keygen: Create TLS key files.  New "--tls-keytype" (-T)
                 option.  Alter help text to be more clear about key
                 types.  When in password mode, also output "key_id"
                 option.
* mandos-keygen.xml (SYNOPSIS): Add new "--tls-keytype" (-T) option.
  (DESCRIPTION): Alter to match new dual-key design.
  (OVERVIEW): - '' -
  (FILES): Add TLS key files.
* mandos-options.xml (priority): Document new default priority string
                                 when using raw public keys.
* mandos.xml (NETWORK PROTOCOL): Describe new protocol using key ID.
  (BUGS): Remove issue about checking expire times of OpenPGP keys,
          since TLS public keys do not have expiration times.
  (SECURITY/CLIENT): Alter description to match new design.
  (SEE ALSO/GnuTLS): - '' -
  (SEE ALSO): Add reference to RFC 7250, and alter description of when
              RFC 6091 is used.
* overview.xml: Alter text to match new design.
* plugin-runner.xml (EXAMPLE): Add --tls-pubkey and --tls-privkey
                               options to mandos-client options.
* plugins.d/mandos-client.c: Use raw public keys when compiling with
                             supporting GnuTLS versions. Add new
                             "--tls-pubkey" and "--tls-privkey"
                             options (which do nothing if GnuTLS
                             library does not support raw public
                             keys).  Alter text throughout to reflect
                             new design.  Only generate new DH
                             parameters (based on size of OpenPGP key)
                             when using OpenPGP in TLS.  Default
                             GnuTLS priority string depends on whether
                             we are using raw public keys or not.
* plugins.d/mandos-client.xml (SYNOPSIS): Add new "--tls-privkey" (-t)
                                          and "--tls-pubkey" (-T)
                                          options.
  (DESCRIPTION): Describe new dual-key design.
  (OPTIONS): Document new "--tls-privkey" (-t) and "--tls-pubkey" (-T)
             options.
  (OPTIONS/--dh-bits): No longer necessarily depends on OpenPGP key
                       size.
  (FILES): Add default locations for TLS public and private key files.
  (EXAMPLE): Use new --tls-pubkey and --tls-privkey options.
  (SECURITY): Alter wording slightly to reflect new dual-key design.
  (SEE ALSO/GnuTLS): Alter description to match new design.
  (SEE ALSO): Add reference to RFC 7250, and alter description of when
              RFC 6091 is used.

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] 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
 
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
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
 
** [#B] Fix %d format strings to use [[https://secure.wikimedia.org/wikipedia/en/wiki/Inttypes.h][<inttypes.h>]]
64
 
** start_mandos_communication: loop around gnutls_handshake
65
 
   [[info:gnutls.info.gz:Core%20functions][gnutls_handshake]]
66
 
** IPv4 support
67
 
** use strsep instead of strtok?
68
 
** Do not depend on GPG key rings on disk
69
 
   This would mean creating new GPG key rings with GPGME by importing
70
 
   the key files from scratch on every program start.
71
 
 
72
 
* Password-prompt
73
 
** [#A] Man page: man8/password-prompt.8mandos
74
 
*** DESCRIPTION
75
 
    Move options to new OPTIONS section.
76
 
*** EXIT STATUS
77
 
    Create this section
78
 
*** EXAMPLES
79
 
    Examples of normal usage, debug usage, with a prefix, etc.
80
 
*** DIAGNOSTICS
81
 
    Create this section
82
 
*** SECURITY
83
 
    Create this section
84
 
    Not much to do here but it is noteworthy to state the danger of
85
 
    not having a fallback option.
86
 
*** NOTES
87
 
    Note that this is more or less a simple getpass(3) wrapper, even
88
 
    though actual use of getpass(3) is not guaranteed.
89
 
*** BUGS
90
 
    Create this section
91
 
*** SEE ALSO
92
 
    Refer to mandos-client(8mandos) and password-request(8mandos)
93
 
** Use getpass(3)?
94
 
   Man page says "obsolete", but [[info:libc:getpass][GNU LibC Manual: Reading Passwords]]
95
 
   does not.  See also [[http://sources.redhat.com/ml/libc-alpha/2003-05/msg00251.html][Marcus Brinkmann: Re: getpass obsolete?]] and
96
 
   [[http://article.gmane.org/gmane.comp.lib.glibc.alpha/4906][Petter Reinholdtsen: Re: getpass obsolete?]], and especially also
97
 
   [[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?]]
98
 
 
99
 
* Mandos (server)
100
 
** [#A] Command man page: man8/mandos.8
101
 
*** DESCRIPTION
102
 
    Move options to new OPTIONS section
103
 
*** EXIT STATUS
104
 
    Create this section
105
 
*** EXAMPLES
106
 
    Create this section
107
 
*** FILES
108
 
    Describe briefly that the server gets global settings from
109
 
    mandos.conf and clients from clients.conf, but refer to their man
110
 
    pages for more details.
111
 
*** DIAGNOSTICS
112
 
    Create this section
113
 
*** SECURITY
114
 
    Create this section
115
 
*** NOTES
116
 
    Create this section (if needed)
117
 
*** BUGS
118
 
    Create this section
119
 
*** SEE ALSO
120
 
    Refer to the client man page
121
 
** [#A] Config file man page: man5/mandos.conf (mandos.conf)
122
 
** [#A] Config file man page: man5/mandos-clients.conf (clients.conf)
123
 
** [#A] /etc/init.d/mandos-server               :teddy:
124
 
** Log level
125
 
** /etc/mandos/clients.d/*.conf
126
 
   Watch this directory and add/remove/update clients?
127
 
** config for TXT record
128
 
** Run-time communication with server
129
 
   Probably using D-Bus
130
 
   See also [[*Mandos-tools]]
131
 
** Implement --foreground
132
 
   [[info:standards:Option%20Table][Table of Long Options]]
133
 
** Implement --socket
134
 
   [[info:standards:Option%20Table][Table of Long Options]]
135
 
 
136
 
* Mandos-tools/utilities
137
 
  All of this probably using D-Bus
138
 
** List clients
139
 
** Disable client
140
 
** Enable client
141
 
 
142
 
* Installer
143
 
** DONE [#A] Change initrd.img file to not be publically readable
144
 
   /etc/initramfs-tools/conf.d/mandos
145
 
   UMASK=027
146
 
** Update initrd.img after installation
147
 
** [#A] Create mandos user and group for server
148
 
** [#A] Create /var/run/mandos directory with perm and ownership
149
 
 
150
 
* [#A] Package
151
 
** /etc/bash_completion.d/mandos
152
 
** /etc/initramfs-tools/hooks/mandos
153
 
   [[file:/usr/share/doc/initramfs-tools/examples/example_hook][Example initramfs-tools hook script]]
154
 
*** Create GPG key ring files in initrd
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
 
 
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
 
 
18
* splashy
 
19
** TODO [#B] use scandir(3) instead of 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 scandir(3) instead of 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 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 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(u"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 Secret Service API?
 
75
   https://standards.freedesktop.org/secret-service/
 
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
** Python 3                                                               :2:
 
84
*** TODO [#C] In Python 3.3, use shlex.quote() instead of re.escape()
 
85
 
 
86
* mandos-ctl
 
87
*** Handle "no D-Bus server" and/or "no Mandos server found" better
 
88
** TODO Remove old string_to_delta format                                 :2:
 
89
 
 
90
* TODO mandos-dispatch
 
91
  Listens for specified D-Bus signals and spawns shell commands with
 
92
  arguments.
 
93
 
 
94
* mandos-monitor
 
95
** TODO --servicename                                                  :BUGS:
 
96
** TODO help should be toggleable
 
97
** Urwid client data displayer
 
98
   Better view of client data in the listing
 
99
*** Properties popup
 
100
** Print a nice "We are sorry" message, save stack trace to log.
 
101
 
 
102
* mandos-keygen
 
103
** TODO "--secfile" option
 
104
   Using the "secfile" option instead of "secret"
 
105
** TODO [#B] "--test" option
 
106
   For testing decryption before rebooting.
 
107
 
 
108
* Package
 
109
** /usr/share/initramfs-tools/hooks/mandos
 
110
*** TODO [#C] use same file name rules as run-parts(8)
 
111
*** TODO [#C] Do not install in initrd.img if configured not to.
 
112
    Use "/etc/initramfs-tools/hooksconf.d/mandos"?
 
113
** TODO [#C] $(pkg-config --variable=completionsdir bash-completion)
 
114
   From XML sources directly?
 
115
 
 
116
* Side Stuff
 
117
** TODO Locate which package moves the other bin/sh when busybox is deactivated
 
118
** TODO contact owner of package, and ask them to have that shell static in position regardless of busybox
 
119
 
 
120
* [[http://www.undeadly.org/cgi?action=article&sid=20110530221728][OpenBSD]]
 
121
 
 
122
* TODO Use raw public keys (RFC 7250) for TLS communications              :2:
 
123
** Support for this is planned for GnuTLS version 3.6
 
124
   https://gitlab.com/gnutls/gnutls/issues/26
 
125
** Rationale
 
126
*** The client key is used both for communication and encryption
 
127
    Using raw keys in GnuTLS instead uses separate keys for
 
128
    communication and password decryption.
 
129
*** GnuTLS 3.5.9 has deprecated the OpenPGP functions
 
130
    The functions are still available, but deprecated:
 
131
    https://gitlab.com/gnutls/gnutls/issues/102
164
132
 
165
133
 
166
134
#+STARTUP: showall