/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 DBUS-API

  • Committer: Teddy Hogeborn
  • Date: 2019-02-09 23:23:26 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 370.
  • 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:
DBUS-API
5
5
This file documents the D-Bus interface to the Mandos server.
6
6
 
7
7
* Bus: System bus
8
 
  Bus name: "se.bsnet.fukt.Mandos"
 
8
  Bus name: "se.recompile.Mandos"
9
9
 
10
10
 
11
11
* Object Paths:
13
13
  | Path                  | Object            |
14
14
  |-----------------------+-------------------|
15
15
  | "/"                   | The Mandos Server |
16
 
  | "/clients/CLIENTNAME" | Mandos Client     |
17
 
 
18
 
  
 
16
 
 
17
  (To get a list of paths to client objects, use the standard D-Bus
 
18
  org.freedesktop.DBus.ObjectManager interface, which the server
 
19
  object supports.)
 
20
 
 
21
 
19
22
* Mandos Server Interface:
20
 
  Interface name: "se.bsnet.fukt.Mandos"
 
23
  Interface name: "se.recompile.Mandos"
21
24
  
22
25
** Methods:
23
 
*** GetAllClients() → (ao: Clients)
24
 
    Returns an array of all client D-Bus object paths
25
 
   
26
 
*** GetAllClientsWithProperties() → (a{oa{sv}}: ClientProperties)
27
 
    Returns an array of all clients and all their properties
28
 
   
29
26
*** RemoveClient(o: ObjectPath) → nothing
30
27
    Removes a client
31
28
   
32
29
** Signals:
33
 
*** ClientAdded(o: ObjectPath)
34
 
    A new client was added.
35
 
   
36
 
*** ClientNotFound(s: Fingerprint, s: Address)
37
 
    A client connected from Address using Fingerprint, but was
38
 
    rejected because it was not found in the server.  The fingerprint
 
30
*** ClientNotFound(s: KeyID, s: Address)
 
31
    A client connected from Address using KeyID, but was
 
32
    rejected because it was not found in the server.  The key ID
39
33
    is represented as a string of hexadecimal digits.  The address is
40
34
    an IPv4 or IPv6 address in its normal string format.
41
 
   
42
 
*** ClientRemoved(o: ObjectPath, s: Name)
43
 
    A client named Name on ObjectPath was removed.
44
35
 
45
36
 
46
37
* Mandos Client Interface:
47
 
  Interface name: "se.bsnet.fukt.Mandos.Client"
 
38
  Interface name: "se.recompile.Mandos.Client"
48
39
  
49
40
** Methods
50
41
*** Approve(b: Approve) → nothing
55
46
    Assert that this client has been checked and found to be alive.
56
47
    This will restart the timeout before disabling this client.  See
57
48
    also the "LastCheckedOK" property.
58
 
    
59
 
*** Disable() → nothing
60
 
    Disable this client.  See also the "Enabled" property.
61
 
    
62
 
*** Enable() → nothing
63
 
    Enable this client.  See also the "Enabled" property.
64
 
    
65
 
*** StartChecker() → nothing
66
 
    Start a new checker for this client, if none is currently
67
 
    running.  See also the "CheckerRunning" property.
68
 
    
69
 
*** StopChecker() → nothing
70
 
    Abort a running checker process for this client, if any.  See also
71
 
    the "CheckerRunning" property.
72
49
 
73
50
** Properties
74
51
   
86
63
   | CheckerRunning (c)      | b    | Read/Write | N/A                 |
87
64
   | Created (d)             | s    | Read       | N/A                 |
88
65
   | Enabled (e)             | b    | Read/Write | N/A                 |
 
66
   | Expires (f)             | s    | Read       | N/A                 |
 
67
   | ExtendedTimeout (a)     | t    | Read/Write | extended_timeout    |
89
68
   | Fingerprint             | s    | Read       | fingerprint         |
 
69
   | KeyID                   | s    | Read       | key_id              |
90
70
   | Host                    | s    | Read/Write | host                |
91
71
   | Interval (a)            | t    | Read/Write | interval            |
92
 
   | LastApprovalRequest (f) | s    | Read       | N/A                 |
93
 
   | LastCheckedOK (g)       | s    | Read/Write | N/A                 |
94
 
   | LastEnabled (h)         | s    | Read       | N/A                 |
 
72
   | LastApprovalRequest (g) | s    | Read       | N/A                 |
 
73
   | LastCheckedOK (h)       | s    | Read/Write | N/A                 |
 
74
   | LastCheckerStatus (i)   | n    | Read       | N/A                 |
 
75
   | LastEnabled (j)         | s    | Read       | N/A                 |
95
76
   | Name                    | s    | Read       | (Section name)      |
96
 
   | ObjectPath              | o    | Read       | N/A                 |
97
 
   | Secret (i)              | ay   | Write      | secret (or secfile) |
 
77
   | Secret (k)              | ay   | Write      | secret (or secfile) |
98
78
   | Timeout (a)             | t    | Read/Write | timeout             |
99
79
   
100
80
   a) Represented as milliseconds.
101
81
   
102
82
   b) An approval is currently pending.
103
83
   
104
 
   c) Setting this property is equivalent to calling StartChecker() or
105
 
      StopChecker().
 
84
   c) Changing this property can either start a new checker or abort a
 
85
      running one.
106
86
   
107
87
   d) The creation time of this client object, as an RFC 3339 string.
108
88
   
109
 
   e) Setting this property is equivalent to calling Enable() or
110
 
      Disable().
111
 
   
112
 
   f) The time of the last approval request, as an RFC 3339 string, or
113
 
      an empty string if this has not happened.
114
 
   
115
 
   g) The last time a checker was successful, as an RFC 3339 string,
116
 
      or an empty string if this has not happened.  Setting this
117
 
      property is equivalent to calling CheckedOK(), i.e. the current
118
 
      time is set, regardless of the string sent.  Please always use
119
 
      an empty string when setting this property, to allow for
120
 
      possible future expansion.
121
 
   
122
 
   h) The last time this client was enabled, as an RFC 3339 string, or
123
 
      an empty string if this has not happened.
124
 
   
125
 
   i) A raw byte array, not hexadecimal digits.
 
89
   e) Changing this property enables or disables a client.
 
90
   
 
91
   f) The date and time this client will be disabled, as an RFC 3339
 
92
      string, or an empty string if this is not scheduled.
 
93
   
 
94
   g) The date and time of the last approval request, as an RFC 3339
 
95
      string, or an empty string if this has not happened.
 
96
   
 
97
   h) The date and time a checker was last successful, as an RFC 3339
 
98
      string, or an empty string if this has not happened.  Setting
 
99
      this property is equivalent to calling CheckedOK(), i.e. the
 
100
      current time is set, regardless of the string sent.  Please
 
101
      always use an empty string when setting this property, to allow
 
102
      for possible future expansion.
 
103
   
 
104
   i) The exit status of the last checker, -1 if it did not exit
 
105
      cleanly, -2 if a checker has not yet returned.
 
106
   
 
107
   j) The date and time this client was last enabled, as an RFC 3339
 
108
      string, or an empty string if this has not happened.
 
109
   
 
110
   k) A raw byte array, not hexadecimal digits.
126
111
 
127
112
** Signals
128
113
*** CheckerCompleted(n: Exitcode, x: Waitstatus, s: Command)
141
126
    milliseconds, depending on ApprovedByDefault.  Approve() can now
142
127
    usefully be called on this client object.
143
128
    
144
 
*** PropertyChanged(s: Property, v: Value)
145
 
    The Property on this client has changed to Value.
146
 
    
147
129
*** Rejected(s: Reason)
148
130
    This client was not given its secret for a specified Reason.
149
131
 
150
132
* Copyright
151
133
 
152
 
    Copyright © 2010-2011 Teddy Hogeborn
153
 
    Copyright © 2010-2011 Björn Påhlsson
 
134
    Copyright © 2010-2018 Teddy Hogeborn
 
135
    Copyright © 2010-2018 Björn Påhlsson
154
136
  
155
137
** License:
156
 
   
157
 
   This program is free software: you can redistribute it and/or
158
 
   modify it under the terms of the GNU General Public License as
159
 
   published by the Free Software Foundation, either version 3 of the
160
 
   License, or (at your option) any later version.
161
 
 
162
 
   This program is distributed in the hope that it will be useful, but
 
138
 
 
139
   This file is part of Mandos.
 
140
 
 
141
   Mandos is free software: you can redistribute it and/or modify it
 
142
   under the terms of the GNU General Public License as published by
 
143
   the Free Software Foundation, either version 3 of the License, or
 
144
   (at your option) any later version.
 
145
 
 
146
   Mandos is distributed in the hope that it will be useful, but
163
147
   WITHOUT ANY WARRANTY; without even the implied warranty of
164
148
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
165
149
   General Public License for more details.
166
150
 
167
151
   You should have received a copy of the GNU General Public License
168
 
   along with this program.  If not, see
169
 
   <http://www.gnu.org/licenses/>.
 
152
   along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
170
153
 
171
154
 
172
155
#+STARTUP: showall