/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 mandos

  • 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:
1
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
 
 
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
 
 
5
#
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>.  This includes the
9
9
# methods "add", "remove", "server_state_changed",
10
10
# "entry_group_state_changed", "cleanup", and "activate" in the
11
11
# "AvahiService" class, and some lines in "main".
12
 
 
12
#
13
13
# Everything else is
14
 
# Copyright © 2008-2016 Teddy Hogeborn
15
 
# Copyright © 2008-2016 Björn Påhlsson
16
 
17
 
# This program is free software: you can redistribute it and/or modify
18
 
# it under the terms of the GNU General Public License as published by
 
14
# Copyright © 2008-2018 Teddy Hogeborn
 
15
# Copyright © 2008-2018 Björn Påhlsson
 
16
#
 
17
# This file is part of Mandos.
 
18
#
 
19
# Mandos is free software: you can redistribute it and/or modify it
 
20
# under the terms of the GNU General Public License as published by
19
21
# the Free Software Foundation, either version 3 of the License, or
20
22
# (at your option) any later version.
21
23
#
22
 
#     This program is distributed in the hope that it will be useful,
23
 
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
24
#     Mandos is distributed in the hope that it will be useful, but
 
25
#     WITHOUT ANY WARRANTY; without even the implied warranty of
24
26
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25
27
#     GNU General Public License for more details.
26
 
 
28
#
27
29
# You should have received a copy of the GNU General Public License
28
 
# along with this program.  If not, see
29
 
# <http://www.gnu.org/licenses/>.
30
 
 
30
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
 
31
#
31
32
# Contact the authors at <mandos@recompile.se>.
32
 
 
33
#
33
34
 
34
35
from __future__ import (division, absolute_import, print_function,
35
36
                        unicode_literals)
79
80
 
80
81
import dbus
81
82
import dbus.service
82
 
try:
83
 
    from gi.repository import GObject
84
 
except ImportError:
85
 
    import gobject as GObject
 
83
from gi.repository import GLib
86
84
from dbus.mainloop.glib import DBusGMainLoop
87
85
import ctypes
88
86
import ctypes.util
89
87
import xml.dom.minidom
90
88
import inspect
91
89
 
 
90
# Try to find the value of SO_BINDTODEVICE:
92
91
try:
 
92
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
 
93
    # newer, and it is also the most natural place for it:
93
94
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
94
95
except AttributeError:
95
96
    try:
 
97
        # This is where SO_BINDTODEVICE was up to and including Python
 
98
        # 2.6, and also 3.2:
96
99
        from IN import SO_BINDTODEVICE
97
100
    except ImportError:
98
 
        SO_BINDTODEVICE = None
 
101
        # In Python 2.7 it seems to have been removed entirely.
 
102
        # Try running the C preprocessor:
 
103
        try:
 
104
            cc = subprocess.Popen(["cc", "--language=c", "-E",
 
105
                                   "/dev/stdin"],
 
106
                                  stdin=subprocess.PIPE,
 
107
                                  stdout=subprocess.PIPE)
 
108
            stdout = cc.communicate(
 
109
                "#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
 
110
            SO_BINDTODEVICE = int(stdout.splitlines()[-1])
 
111
        except (OSError, ValueError, IndexError):
 
112
            # No value found
 
113
            SO_BINDTODEVICE = None
99
114
 
100
115
if sys.version_info.major == 2:
101
116
    str = unicode
102
117
 
103
 
version = "1.7.5"
 
118
version = "1.7.20"
104
119
stored_state_file = "clients.pickle"
105
120
 
106
121
logger = logging.getLogger()
110
125
    if_nametoindex = ctypes.cdll.LoadLibrary(
111
126
        ctypes.util.find_library("c")).if_nametoindex
112
127
except (OSError, AttributeError):
113
 
    
 
128
 
114
129
    def if_nametoindex(interface):
115
130
        "Get an interface index the hard way, i.e. using fcntl()"
116
131
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
139
154
 
140
155
def initlogger(debug, level=logging.WARNING):
141
156
    """init logger and add loglevel"""
142
 
    
 
157
 
143
158
    global syslogger
144
159
    syslogger = (logging.handlers.SysLogHandler(
145
 
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
146
 
        address = "/dev/log"))
 
160
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
 
161
        address="/dev/log"))
147
162
    syslogger.setFormatter(logging.Formatter
148
163
                           ('Mandos [%(process)d]: %(levelname)s:'
149
164
                            ' %(message)s'))
150
165
    logger.addHandler(syslogger)
151
 
    
 
166
 
152
167
    if debug:
153
168
        console = logging.StreamHandler()
154
169
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
166
181
 
167
182
class PGPEngine(object):
168
183
    """A simple class for OpenPGP symmetric encryption & decryption"""
169
 
    
 
184
 
170
185
    def __init__(self):
171
186
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
172
187
        self.gpg = "gpg"
183
198
        self.gnupgargs = ['--batch',
184
199
                          '--homedir', self.tempdir,
185
200
                          '--force-mdc',
186
 
                          '--quiet',
187
 
                          '--no-use-agent']
188
 
    
 
201
                          '--quiet']
 
202
        # Only GPG version 1 has the --no-use-agent option.
 
203
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
 
204
            self.gnupgargs.append("--no-use-agent")
 
205
 
189
206
    def __enter__(self):
190
207
        return self
191
 
    
 
208
 
192
209
    def __exit__(self, exc_type, exc_value, traceback):
193
210
        self._cleanup()
194
211
        return False
195
 
    
 
212
 
196
213
    def __del__(self):
197
214
        self._cleanup()
198
 
    
 
215
 
199
216
    def _cleanup(self):
200
217
        if self.tempdir is not None:
201
218
            # Delete contents of tempdir
202
219
            for root, dirs, files in os.walk(self.tempdir,
203
 
                                             topdown = False):
 
220
                                             topdown=False):
204
221
                for filename in files:
205
222
                    os.remove(os.path.join(root, filename))
206
223
                for dirname in dirs:
208
225
            # Remove tempdir
209
226
            os.rmdir(self.tempdir)
210
227
            self.tempdir = None
211
 
    
 
228
 
212
229
    def password_encode(self, password):
213
230
        # Passphrase can not be empty and can not contain newlines or
214
231
        # NUL bytes.  So we prefix it and hex encode it.
219
236
                       .replace(b"\n", b"\\n")
220
237
                       .replace(b"\0", b"\\x00"))
221
238
        return encoded
222
 
    
 
239
 
223
240
    def encrypt(self, data, password):
224
241
        passphrase = self.password_encode(password)
225
242
        with tempfile.NamedTemporaryFile(
230
247
                                     '--passphrase-file',
231
248
                                     passfile.name]
232
249
                                    + self.gnupgargs,
233
 
                                    stdin = subprocess.PIPE,
234
 
                                    stdout = subprocess.PIPE,
235
 
                                    stderr = subprocess.PIPE)
236
 
            ciphertext, err = proc.communicate(input = data)
 
250
                                    stdin=subprocess.PIPE,
 
251
                                    stdout=subprocess.PIPE,
 
252
                                    stderr=subprocess.PIPE)
 
253
            ciphertext, err = proc.communicate(input=data)
237
254
        if proc.returncode != 0:
238
255
            raise PGPError(err)
239
256
        return ciphertext
240
 
    
 
257
 
241
258
    def decrypt(self, data, password):
242
259
        passphrase = self.password_encode(password)
243
260
        with tempfile.NamedTemporaryFile(
244
 
                dir = self.tempdir) as passfile:
 
261
                dir=self.tempdir) as passfile:
245
262
            passfile.write(passphrase)
246
263
            passfile.flush()
247
264
            proc = subprocess.Popen([self.gpg, '--decrypt',
248
265
                                     '--passphrase-file',
249
266
                                     passfile.name]
250
267
                                    + self.gnupgargs,
251
 
                                    stdin = subprocess.PIPE,
252
 
                                    stdout = subprocess.PIPE,
253
 
                                    stderr = subprocess.PIPE)
254
 
            decrypted_plaintext, err = proc.communicate(input = data)
 
268
                                    stdin=subprocess.PIPE,
 
269
                                    stdout=subprocess.PIPE,
 
270
                                    stderr=subprocess.PIPE)
 
271
            decrypted_plaintext, err = proc.communicate(input=data)
255
272
        if proc.returncode != 0:
256
273
            raise PGPError(err)
257
274
        return decrypted_plaintext
258
275
 
 
276
 
259
277
# Pretend that we have an Avahi module
260
278
class Avahi(object):
261
279
    """This isn't so much a class as it is a module-like namespace.
262
280
    It is instantiated once, and simulates having an Avahi module."""
263
 
    IF_UNSPEC = -1              # avahi-common/address.h
264
 
    PROTO_UNSPEC = -1           # avahi-common/address.h
265
 
    PROTO_INET = 0              # avahi-common/address.h
266
 
    PROTO_INET6 = 1             # avahi-common/address.h
 
281
    IF_UNSPEC = -1               # avahi-common/address.h
 
282
    PROTO_UNSPEC = -1            # avahi-common/address.h
 
283
    PROTO_INET = 0               # avahi-common/address.h
 
284
    PROTO_INET6 = 1              # avahi-common/address.h
267
285
    DBUS_NAME = "org.freedesktop.Avahi"
268
286
    DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
269
287
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
270
288
    DBUS_PATH_SERVER = "/"
 
289
 
271
290
    def string_array_to_txt_array(self, t):
272
291
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
273
292
                           for s in t), signature="ay")
274
 
    ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
275
 
    ENTRY_GROUP_COLLISION = 3   # avahi-common/defs.h
276
 
    ENTRY_GROUP_FAILURE = 4     # avahi-common/defs.h
277
 
    SERVER_INVALID = 0          # avahi-common/defs.h
278
 
    SERVER_REGISTERING = 1      # avahi-common/defs.h
279
 
    SERVER_RUNNING = 2          # avahi-common/defs.h
280
 
    SERVER_COLLISION = 3        # avahi-common/defs.h
281
 
    SERVER_FAILURE = 4          # avahi-common/defs.h
 
293
    ENTRY_GROUP_ESTABLISHED = 2  # avahi-common/defs.h
 
294
    ENTRY_GROUP_COLLISION = 3    # avahi-common/defs.h
 
295
    ENTRY_GROUP_FAILURE = 4      # avahi-common/defs.h
 
296
    SERVER_INVALID = 0           # avahi-common/defs.h
 
297
    SERVER_REGISTERING = 1       # avahi-common/defs.h
 
298
    SERVER_RUNNING = 2           # avahi-common/defs.h
 
299
    SERVER_COLLISION = 3         # avahi-common/defs.h
 
300
    SERVER_FAILURE = 4           # avahi-common/defs.h
282
301
avahi = Avahi()
283
302
 
 
303
 
284
304
class AvahiError(Exception):
285
305
    def __init__(self, value, *args, **kwargs):
286
306
        self.value = value
298
318
 
299
319
class AvahiService(object):
300
320
    """An Avahi (Zeroconf) service.
301
 
    
 
321
 
302
322
    Attributes:
303
323
    interface: integer; avahi.IF_UNSPEC or an interface index.
304
324
               Used to optionally bind to the specified interface.
316
336
    server: D-Bus Server
317
337
    bus: dbus.SystemBus()
318
338
    """
319
 
    
 
339
 
320
340
    def __init__(self,
321
 
                 interface = avahi.IF_UNSPEC,
322
 
                 name = None,
323
 
                 servicetype = None,
324
 
                 port = None,
325
 
                 TXT = None,
326
 
                 domain = "",
327
 
                 host = "",
328
 
                 max_renames = 32768,
329
 
                 protocol = avahi.PROTO_UNSPEC,
330
 
                 bus = None):
 
341
                 interface=avahi.IF_UNSPEC,
 
342
                 name=None,
 
343
                 servicetype=None,
 
344
                 port=None,
 
345
                 TXT=None,
 
346
                 domain="",
 
347
                 host="",
 
348
                 max_renames=32768,
 
349
                 protocol=avahi.PROTO_UNSPEC,
 
350
                 bus=None):
331
351
        self.interface = interface
332
352
        self.name = name
333
353
        self.type = servicetype
342
362
        self.server = None
343
363
        self.bus = bus
344
364
        self.entry_group_state_changed_match = None
345
 
    
 
365
 
346
366
    def rename(self, remove=True):
347
367
        """Derived from the Avahi example code"""
348
368
        if self.rename_count >= self.max_renames:
368
388
                logger.critical("D-Bus Exception", exc_info=error)
369
389
                self.cleanup()
370
390
                os._exit(1)
371
 
    
 
391
 
372
392
    def remove(self):
373
393
        """Derived from the Avahi example code"""
374
394
        if self.entry_group_state_changed_match is not None:
376
396
            self.entry_group_state_changed_match = None
377
397
        if self.group is not None:
378
398
            self.group.Reset()
379
 
    
 
399
 
380
400
    def add(self):
381
401
        """Derived from the Avahi example code"""
382
402
        self.remove()
399
419
            dbus.UInt16(self.port),
400
420
            avahi.string_array_to_txt_array(self.TXT))
401
421
        self.group.Commit()
402
 
    
 
422
 
403
423
    def entry_group_state_changed(self, state, error):
404
424
        """Derived from the Avahi example code"""
405
425
        logger.debug("Avahi entry group state change: %i", state)
406
 
        
 
426
 
407
427
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
408
428
            logger.debug("Zeroconf service established.")
409
429
        elif state == avahi.ENTRY_GROUP_COLLISION:
413
433
            logger.critical("Avahi: Error in group state changed %s",
414
434
                            str(error))
415
435
            raise AvahiGroupError("State changed: {!s}".format(error))
416
 
    
 
436
 
417
437
    def cleanup(self):
418
438
        """Derived from the Avahi example code"""
419
439
        if self.group is not None:
424
444
                pass
425
445
            self.group = None
426
446
        self.remove()
427
 
    
 
447
 
428
448
    def server_state_changed(self, state, error=None):
429
449
        """Derived from the Avahi example code"""
430
450
        logger.debug("Avahi server state change: %i", state)
459
479
                logger.debug("Unknown state: %r", state)
460
480
            else:
461
481
                logger.debug("Unknown state: %r: %r", state, error)
462
 
    
 
482
 
463
483
    def activate(self):
464
484
        """Derived from the Avahi example code"""
465
485
        if self.server is None:
476
496
class AvahiServiceToSyslog(AvahiService):
477
497
    def rename(self, *args, **kwargs):
478
498
        """Add the new name to the syslog messages"""
479
 
        ret = AvahiService.rename(self, *args, **kwargs)
 
499
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
480
500
        syslogger.setFormatter(logging.Formatter(
481
501
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
482
502
            .format(self.name)))
483
503
        return ret
484
504
 
 
505
 
485
506
# Pretend that we have a GnuTLS module
486
507
class GnuTLS(object):
487
508
    """This isn't so much a class as it is a module-like namespace.
488
509
    It is instantiated once, and simulates having a GnuTLS module."""
489
 
    
490
 
    _library = ctypes.cdll.LoadLibrary(
491
 
        ctypes.util.find_library("gnutls"))
 
510
 
 
511
    library = ctypes.util.find_library("gnutls")
 
512
    if library is None:
 
513
        library = ctypes.util.find_library("gnutls-deb0")
 
514
    _library = ctypes.cdll.LoadLibrary(library)
 
515
    del library
492
516
    _need_version = b"3.3.0"
 
517
    _tls_rawpk_version = b"3.6.6"
 
518
 
493
519
    def __init__(self):
494
 
        # Need to use class name "GnuTLS" here, since this method is
495
 
        # called before the assignment to the "gnutls" global variable
496
 
        # happens.
497
 
        if GnuTLS.check_version(self._need_version) is None:
498
 
            raise GnuTLS.Error("Needs GnuTLS {} or later"
499
 
                               .format(self._need_version))
500
 
    
 
520
        # Need to use "self" here, since this method is called before
 
521
        # the assignment to the "gnutls" global variable happens.
 
522
        if self.check_version(self._need_version) is None:
 
523
            raise self.Error("Needs GnuTLS {} or later"
 
524
                             .format(self._need_version))
 
525
 
501
526
    # Unless otherwise indicated, the constants and types below are
502
527
    # all from the gnutls/gnutls.h C header file.
503
 
    
 
528
 
504
529
    # Constants
505
530
    E_SUCCESS = 0
506
531
    E_INTERRUPTED = -52
507
532
    E_AGAIN = -28
508
533
    CRT_OPENPGP = 2
 
534
    CRT_RAWPK = 3
509
535
    CLIENT = 2
510
536
    SHUT_RDWR = 0
511
537
    CRD_CERTIFICATE = 1
512
538
    E_NO_CERTIFICATE_FOUND = -49
 
539
    X509_FMT_DER = 0
 
540
    NO_TICKETS = 1<<10
 
541
    ENABLE_RAWPK = 1<<18
 
542
    CTYPE_PEERS = 3
 
543
    KEYID_USE_SHA256 = 1        # gnutls/x509.h
513
544
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
514
 
    
 
545
 
515
546
    # Types
516
547
    class session_int(ctypes.Structure):
517
548
        _fields_ = []
518
549
    session_t = ctypes.POINTER(session_int)
 
550
 
519
551
    class certificate_credentials_st(ctypes.Structure):
520
552
        _fields_ = []
521
553
    certificate_credentials_t = ctypes.POINTER(
522
554
        certificate_credentials_st)
523
555
    certificate_type_t = ctypes.c_int
 
556
 
524
557
    class datum_t(ctypes.Structure):
525
558
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
526
559
                    ('size', ctypes.c_uint)]
 
560
 
527
561
    class openpgp_crt_int(ctypes.Structure):
528
562
        _fields_ = []
529
563
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
530
 
    openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
 
564
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
531
565
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
532
566
    credentials_type_t = ctypes.c_int
533
567
    transport_ptr_t = ctypes.c_void_p
534
568
    close_request_t = ctypes.c_int
535
 
    
 
569
 
536
570
    # Exceptions
537
571
    class Error(Exception):
538
572
        # We need to use the class name "GnuTLS" here, since this
539
573
        # exception might be raised from within GnuTLS.__init__,
540
574
        # which is called before the assignment to the "gnutls"
541
575
        # global variable has happened.
542
 
        def __init__(self, message = None, code = None, args=()):
 
576
        def __init__(self, message=None, code=None, args=()):
543
577
            # Default usage is by a message string, but if a return
544
578
            # code is passed, convert it to a string with
545
579
            # gnutls.strerror()
548
582
                message = GnuTLS.strerror(code)
549
583
            return super(GnuTLS.Error, self).__init__(
550
584
                message, *args)
551
 
    
 
585
 
552
586
    class CertificateSecurityError(Error):
553
587
        pass
554
 
    
 
588
 
555
589
    # Classes
556
590
    class Credentials(object):
557
591
        def __init__(self):
559
593
            gnutls.certificate_allocate_credentials(
560
594
                ctypes.byref(self._c_object))
561
595
            self.type = gnutls.CRD_CERTIFICATE
562
 
        
 
596
 
563
597
        def __del__(self):
564
598
            gnutls.certificate_free_credentials(self._c_object)
565
 
    
 
599
 
566
600
    class ClientSession(object):
567
 
        def __init__(self, socket, credentials = None):
 
601
        def __init__(self, socket, credentials=None):
568
602
            self._c_object = gnutls.session_t()
569
 
            gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
 
603
            gnutls_flags = gnutls.CLIENT
 
604
            if gnutls.check_version("3.5.6"):
 
605
                gnutls_flags |= gnutls.NO_TICKETS
 
606
            if gnutls.has_rawpk:
 
607
                gnutls_flags |= gnutls.ENABLE_RAWPK
 
608
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
 
609
            del gnutls_flags
570
610
            gnutls.set_default_priority(self._c_object)
571
611
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
572
612
            gnutls.handshake_set_private_extensions(self._c_object,
578
618
                                   ctypes.cast(credentials._c_object,
579
619
                                               ctypes.c_void_p))
580
620
            self.credentials = credentials
581
 
        
 
621
 
582
622
        def __del__(self):
583
623
            gnutls.deinit(self._c_object)
584
 
        
 
624
 
585
625
        def handshake(self):
586
626
            return gnutls.handshake(self._c_object)
587
 
        
 
627
 
588
628
        def send(self, data):
589
629
            data = bytes(data)
590
630
            data_len = len(data)
592
632
                data_len -= gnutls.record_send(self._c_object,
593
633
                                               data[-data_len:],
594
634
                                               data_len)
595
 
        
 
635
 
596
636
        def bye(self):
597
637
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
598
 
    
 
638
 
599
639
    # Error handling functions
600
640
    def _error_code(result):
601
641
        """A function to raise exceptions on errors, suitable
603
643
        if result >= 0:
604
644
            return result
605
645
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
606
 
            raise gnutls.CertificateSecurityError(code = result)
607
 
        raise gnutls.Error(code = result)
608
 
    
 
646
            raise gnutls.CertificateSecurityError(code=result)
 
647
        raise gnutls.Error(code=result)
 
648
 
609
649
    def _retry_on_error(result, func, arguments):
610
650
        """A function to retry on some errors, suitable
611
651
        for the 'errcheck' attribute on ctypes functions"""
614
654
                return _error_code(result)
615
655
            result = func(*arguments)
616
656
        return result
617
 
    
 
657
 
618
658
    # Unless otherwise indicated, the function declarations below are
619
659
    # all from the gnutls/gnutls.h C header file.
620
 
    
 
660
 
621
661
    # Functions
622
662
    priority_set_direct = _library.gnutls_priority_set_direct
623
663
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
624
664
                                    ctypes.POINTER(ctypes.c_char_p)]
625
665
    priority_set_direct.restype = _error_code
626
 
    
 
666
 
627
667
    init = _library.gnutls_init
628
668
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
629
669
    init.restype = _error_code
630
 
    
 
670
 
631
671
    set_default_priority = _library.gnutls_set_default_priority
632
672
    set_default_priority.argtypes = [session_t]
633
673
    set_default_priority.restype = _error_code
634
 
    
 
674
 
635
675
    record_send = _library.gnutls_record_send
636
676
    record_send.argtypes = [session_t, ctypes.c_void_p,
637
677
                            ctypes.c_size_t]
638
678
    record_send.restype = ctypes.c_ssize_t
639
679
    record_send.errcheck = _retry_on_error
640
 
    
 
680
 
641
681
    certificate_allocate_credentials = (
642
682
        _library.gnutls_certificate_allocate_credentials)
643
683
    certificate_allocate_credentials.argtypes = [
644
684
        ctypes.POINTER(certificate_credentials_t)]
645
685
    certificate_allocate_credentials.restype = _error_code
646
 
    
 
686
 
647
687
    certificate_free_credentials = (
648
688
        _library.gnutls_certificate_free_credentials)
649
 
    certificate_free_credentials.argtypes = [certificate_credentials_t]
 
689
    certificate_free_credentials.argtypes = [
 
690
        certificate_credentials_t]
650
691
    certificate_free_credentials.restype = None
651
 
    
 
692
 
652
693
    handshake_set_private_extensions = (
653
694
        _library.gnutls_handshake_set_private_extensions)
654
695
    handshake_set_private_extensions.argtypes = [session_t,
655
696
                                                 ctypes.c_int]
656
697
    handshake_set_private_extensions.restype = None
657
 
    
 
698
 
658
699
    credentials_set = _library.gnutls_credentials_set
659
700
    credentials_set.argtypes = [session_t, credentials_type_t,
660
701
                                ctypes.c_void_p]
661
702
    credentials_set.restype = _error_code
662
 
    
 
703
 
663
704
    strerror = _library.gnutls_strerror
664
705
    strerror.argtypes = [ctypes.c_int]
665
706
    strerror.restype = ctypes.c_char_p
666
 
    
 
707
 
667
708
    certificate_type_get = _library.gnutls_certificate_type_get
668
709
    certificate_type_get.argtypes = [session_t]
669
710
    certificate_type_get.restype = _error_code
670
 
    
 
711
 
671
712
    certificate_get_peers = _library.gnutls_certificate_get_peers
672
713
    certificate_get_peers.argtypes = [session_t,
673
714
                                      ctypes.POINTER(ctypes.c_uint)]
674
715
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
675
 
    
 
716
 
676
717
    global_set_log_level = _library.gnutls_global_set_log_level
677
718
    global_set_log_level.argtypes = [ctypes.c_int]
678
719
    global_set_log_level.restype = None
679
 
    
 
720
 
680
721
    global_set_log_function = _library.gnutls_global_set_log_function
681
722
    global_set_log_function.argtypes = [log_func]
682
723
    global_set_log_function.restype = None
683
 
    
 
724
 
684
725
    deinit = _library.gnutls_deinit
685
726
    deinit.argtypes = [session_t]
686
727
    deinit.restype = None
687
 
    
 
728
 
688
729
    handshake = _library.gnutls_handshake
689
730
    handshake.argtypes = [session_t]
690
731
    handshake.restype = _error_code
691
732
    handshake.errcheck = _retry_on_error
692
 
    
 
733
 
693
734
    transport_set_ptr = _library.gnutls_transport_set_ptr
694
735
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
695
736
    transport_set_ptr.restype = None
696
 
    
 
737
 
697
738
    bye = _library.gnutls_bye
698
739
    bye.argtypes = [session_t, close_request_t]
699
740
    bye.restype = _error_code
700
741
    bye.errcheck = _retry_on_error
701
 
    
 
742
 
702
743
    check_version = _library.gnutls_check_version
703
744
    check_version.argtypes = [ctypes.c_char_p]
704
745
    check_version.restype = ctypes.c_char_p
705
 
    
706
 
    # All the function declarations below are from gnutls/openpgp.h
707
 
    
708
 
    openpgp_crt_init = _library.gnutls_openpgp_crt_init
709
 
    openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
710
 
    openpgp_crt_init.restype = _error_code
711
 
    
712
 
    openpgp_crt_import = _library.gnutls_openpgp_crt_import
713
 
    openpgp_crt_import.argtypes = [openpgp_crt_t,
714
 
                                   ctypes.POINTER(datum_t),
715
 
                                   openpgp_crt_fmt_t]
716
 
    openpgp_crt_import.restype = _error_code
717
 
    
718
 
    openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
719
 
    openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
720
 
                                        ctypes.POINTER(ctypes.c_uint)]
721
 
    openpgp_crt_verify_self.restype = _error_code
722
 
    
723
 
    openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
724
 
    openpgp_crt_deinit.argtypes = [openpgp_crt_t]
725
 
    openpgp_crt_deinit.restype = None
726
 
    
727
 
    openpgp_crt_get_fingerprint = (
728
 
        _library.gnutls_openpgp_crt_get_fingerprint)
729
 
    openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
730
 
                                            ctypes.c_void_p,
731
 
                                            ctypes.POINTER(
732
 
                                                ctypes.c_size_t)]
733
 
    openpgp_crt_get_fingerprint.restype = _error_code
734
 
    
 
746
 
 
747
    has_rawpk = bool(check_version(_tls_rawpk_version))
 
748
 
 
749
    if has_rawpk:
 
750
        # Types
 
751
        class pubkey_st(ctypes.Structure):
 
752
            _fields = []
 
753
        pubkey_t = ctypes.POINTER(pubkey_st)
 
754
 
 
755
        x509_crt_fmt_t = ctypes.c_int
 
756
 
 
757
        # All the function declarations below are from gnutls/abstract.h
 
758
        pubkey_init = _library.gnutls_pubkey_init
 
759
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
 
760
        pubkey_init.restype = _error_code
 
761
 
 
762
        pubkey_import = _library.gnutls_pubkey_import
 
763
        pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
 
764
                                  x509_crt_fmt_t]
 
765
        pubkey_import.restype = _error_code
 
766
 
 
767
        pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
 
768
        pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
 
769
                                      ctypes.POINTER(ctypes.c_ubyte),
 
770
                                      ctypes.POINTER(ctypes.c_size_t)]
 
771
        pubkey_get_key_id.restype = _error_code
 
772
 
 
773
        pubkey_deinit = _library.gnutls_pubkey_deinit
 
774
        pubkey_deinit.argtypes = [pubkey_t]
 
775
        pubkey_deinit.restype = None
 
776
    else:
 
777
        # All the function declarations below are from gnutls/openpgp.h
 
778
 
 
779
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
780
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
781
        openpgp_crt_init.restype = _error_code
 
782
 
 
783
        openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
784
        openpgp_crt_import.argtypes = [openpgp_crt_t,
 
785
                                       ctypes.POINTER(datum_t),
 
786
                                       openpgp_crt_fmt_t]
 
787
        openpgp_crt_import.restype = _error_code
 
788
 
 
789
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
790
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
791
                                            ctypes.POINTER(ctypes.c_uint)]
 
792
        openpgp_crt_verify_self.restype = _error_code
 
793
 
 
794
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
795
        openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
796
        openpgp_crt_deinit.restype = None
 
797
 
 
798
        openpgp_crt_get_fingerprint = (
 
799
            _library.gnutls_openpgp_crt_get_fingerprint)
 
800
        openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
801
                                                ctypes.c_void_p,
 
802
                                                ctypes.POINTER(
 
803
                                                    ctypes.c_size_t)]
 
804
        openpgp_crt_get_fingerprint.restype = _error_code
 
805
 
 
806
    if check_version("3.6.4"):
 
807
        certificate_type_get2 = _library.gnutls_certificate_type_get2
 
808
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
 
809
        certificate_type_get2.restype = _error_code
 
810
 
735
811
    # Remove non-public functions
736
812
    del _error_code, _retry_on_error
737
813
# Create the global "gnutls" object, simulating a module
738
814
gnutls = GnuTLS()
739
815
 
 
816
 
740
817
def call_pipe(connection,       # : multiprocessing.Connection
741
818
              func, *args, **kwargs):
742
819
    """This function is meant to be called by multiprocessing.Process
743
 
    
 
820
 
744
821
    This function runs func(*args, **kwargs), and writes the resulting
745
822
    return value on the provided multiprocessing.Connection.
746
823
    """
747
824
    connection.send(func(*args, **kwargs))
748
825
    connection.close()
749
826
 
 
827
 
750
828
class Client(object):
751
829
    """A representation of a client host served by this server.
752
 
    
 
830
 
753
831
    Attributes:
754
832
    approved:   bool(); 'None' if not yet approved/disapproved
755
833
    approval_delay: datetime.timedelta(); Time to wait for approval
757
835
    checker:    subprocess.Popen(); a running checker process used
758
836
                                    to see if the client lives.
759
837
                                    'None' if no process is running.
760
 
    checker_callback_tag: a GObject event source tag, or None
 
838
    checker_callback_tag: a GLib event source tag, or None
761
839
    checker_command: string; External command which is run to check
762
840
                     if client lives.  %() expansions are done at
763
841
                     runtime with vars(self) as dict, so that for
764
842
                     instance %(name)s can be used in the command.
765
 
    checker_initiator_tag: a GObject event source tag, or None
 
843
    checker_initiator_tag: a GLib event source tag, or None
766
844
    created:    datetime.datetime(); (UTC) object creation
767
845
    client_structure: Object describing what attributes a client has
768
846
                      and is used for storing the client at exit
769
847
    current_checker_command: string; current running checker_command
770
 
    disable_initiator_tag: a GObject event source tag, or None
 
848
    disable_initiator_tag: a GLib event source tag, or None
771
849
    enabled:    bool()
772
850
    fingerprint: string (40 or 32 hexadecimal digits); used to
773
 
                 uniquely identify the client
 
851
                 uniquely identify an OpenPGP client
 
852
    key_id: string (64 hexadecimal digits); used to uniquely identify
 
853
            a client using raw public keys
774
854
    host:       string; available for use by the checker command
775
855
    interval:   datetime.timedelta(); How often to start a new checker
776
856
    last_approval_request: datetime.datetime(); (UTC) or None
792
872
                disabled, or None
793
873
    server_settings: The server_settings dict from main()
794
874
    """
795
 
    
 
875
 
796
876
    runtime_expansions = ("approval_delay", "approval_duration",
797
 
                          "created", "enabled", "expires",
 
877
                          "created", "enabled", "expires", "key_id",
798
878
                          "fingerprint", "host", "interval",
799
879
                          "last_approval_request", "last_checked_ok",
800
880
                          "last_enabled", "name", "timeout")
809
889
        "approved_by_default": "True",
810
890
        "enabled": "True",
811
891
    }
812
 
    
 
892
 
813
893
    @staticmethod
814
894
    def config_parser(config):
815
895
        """Construct a new dict of client settings of this form:
822
902
        for client_name in config.sections():
823
903
            section = dict(config.items(client_name))
824
904
            client = settings[client_name] = {}
825
 
            
 
905
 
826
906
            client["host"] = section["host"]
827
907
            # Reformat values from string types to Python types
828
908
            client["approved_by_default"] = config.getboolean(
829
909
                client_name, "approved_by_default")
830
910
            client["enabled"] = config.getboolean(client_name,
831
911
                                                  "enabled")
832
 
            
833
 
            # Uppercase and remove spaces from fingerprint for later
834
 
            # comparison purposes with return value from the
835
 
            # fingerprint() function
 
912
 
 
913
            # Uppercase and remove spaces from key_id and fingerprint
 
914
            # for later comparison purposes with return value from the
 
915
            # key_id() and fingerprint() functions
 
916
            client["key_id"] = (section.get("key_id", "").upper()
 
917
                                .replace(" ", ""))
836
918
            client["fingerprint"] = (section["fingerprint"].upper()
837
919
                                     .replace(" ", ""))
838
920
            if "secret" in section:
859
941
            client["last_approval_request"] = None
860
942
            client["last_checked_ok"] = None
861
943
            client["last_checker_status"] = -2
862
 
        
 
944
 
863
945
        return settings
864
 
    
865
 
    def __init__(self, settings, name = None, server_settings=None):
 
946
 
 
947
    def __init__(self, settings, name=None, server_settings=None):
866
948
        self.name = name
867
949
        if server_settings is None:
868
950
            server_settings = {}
870
952
        # adding all client settings
871
953
        for setting, value in settings.items():
872
954
            setattr(self, setting, value)
873
 
        
 
955
 
874
956
        if self.enabled:
875
957
            if not hasattr(self, "last_enabled"):
876
958
                self.last_enabled = datetime.datetime.utcnow()
880
962
        else:
881
963
            self.last_enabled = None
882
964
            self.expires = None
883
 
        
 
965
 
884
966
        logger.debug("Creating client %r", self.name)
 
967
        logger.debug("  Key ID: %s", self.key_id)
885
968
        logger.debug("  Fingerprint: %s", self.fingerprint)
886
969
        self.created = settings.get("created",
887
970
                                    datetime.datetime.utcnow())
888
 
        
 
971
 
889
972
        # attributes specific for this server instance
890
973
        self.checker = None
891
974
        self.checker_initiator_tag = None
900
983
                                 for attr in self.__dict__.keys()
901
984
                                 if not attr.startswith("_")]
902
985
        self.client_structure.append("client_structure")
903
 
        
 
986
 
904
987
        for name, t in inspect.getmembers(
905
988
                type(self), lambda obj: isinstance(obj, property)):
906
989
            if not name.startswith("_"):
907
990
                self.client_structure.append(name)
908
 
    
 
991
 
909
992
    # Send notice to process children that client state has changed
910
993
    def send_changedstate(self):
911
994
        with self.changedstate:
912
995
            self.changedstate.notify_all()
913
 
    
 
996
 
914
997
    def enable(self):
915
998
        """Start this client's checker and timeout hooks"""
916
999
        if getattr(self, "enabled", False):
921
1004
        self.last_enabled = datetime.datetime.utcnow()
922
1005
        self.init_checker()
923
1006
        self.send_changedstate()
924
 
    
 
1007
 
925
1008
    def disable(self, quiet=True):
926
1009
        """Disable this client."""
927
1010
        if not getattr(self, "enabled", False):
929
1012
        if not quiet:
930
1013
            logger.info("Disabling client %s", self.name)
931
1014
        if getattr(self, "disable_initiator_tag", None) is not None:
932
 
            GObject.source_remove(self.disable_initiator_tag)
 
1015
            GLib.source_remove(self.disable_initiator_tag)
933
1016
            self.disable_initiator_tag = None
934
1017
        self.expires = None
935
1018
        if getattr(self, "checker_initiator_tag", None) is not None:
936
 
            GObject.source_remove(self.checker_initiator_tag)
 
1019
            GLib.source_remove(self.checker_initiator_tag)
937
1020
            self.checker_initiator_tag = None
938
1021
        self.stop_checker()
939
1022
        self.enabled = False
940
1023
        if not quiet:
941
1024
            self.send_changedstate()
942
 
        # Do not run this again if called by a GObject.timeout_add
 
1025
        # Do not run this again if called by a GLib.timeout_add
943
1026
        return False
944
 
    
 
1027
 
945
1028
    def __del__(self):
946
1029
        self.disable()
947
 
    
 
1030
 
948
1031
    def init_checker(self):
949
1032
        # Schedule a new checker to be started an 'interval' from now,
950
1033
        # and every interval from then on.
951
1034
        if self.checker_initiator_tag is not None:
952
 
            GObject.source_remove(self.checker_initiator_tag)
953
 
        self.checker_initiator_tag = GObject.timeout_add(
 
1035
            GLib.source_remove(self.checker_initiator_tag)
 
1036
        self.checker_initiator_tag = GLib.timeout_add(
954
1037
            int(self.interval.total_seconds() * 1000),
955
1038
            self.start_checker)
956
1039
        # Schedule a disable() when 'timeout' has passed
957
1040
        if self.disable_initiator_tag is not None:
958
 
            GObject.source_remove(self.disable_initiator_tag)
959
 
        self.disable_initiator_tag = GObject.timeout_add(
 
1041
            GLib.source_remove(self.disable_initiator_tag)
 
1042
        self.disable_initiator_tag = GLib.timeout_add(
960
1043
            int(self.timeout.total_seconds() * 1000), self.disable)
961
1044
        # Also start a new checker *right now*.
962
1045
        self.start_checker()
963
 
    
 
1046
 
964
1047
    def checker_callback(self, source, condition, connection,
965
1048
                         command):
966
1049
        """The checker has completed, so take appropriate actions."""
969
1052
        # Read return code from connection (see call_pipe)
970
1053
        returncode = connection.recv()
971
1054
        connection.close()
972
 
        
 
1055
 
973
1056
        if returncode >= 0:
974
1057
            self.last_checker_status = returncode
975
1058
            self.last_checker_signal = None
985
1068
            logger.warning("Checker for %(name)s crashed?",
986
1069
                           vars(self))
987
1070
        return False
988
 
    
 
1071
 
989
1072
    def checked_ok(self):
990
1073
        """Assert that the client has been seen, alive and well."""
991
1074
        self.last_checked_ok = datetime.datetime.utcnow()
992
1075
        self.last_checker_status = 0
993
1076
        self.last_checker_signal = None
994
1077
        self.bump_timeout()
995
 
    
 
1078
 
996
1079
    def bump_timeout(self, timeout=None):
997
1080
        """Bump up the timeout for this client."""
998
1081
        if timeout is None:
999
1082
            timeout = self.timeout
1000
1083
        if self.disable_initiator_tag is not None:
1001
 
            GObject.source_remove(self.disable_initiator_tag)
 
1084
            GLib.source_remove(self.disable_initiator_tag)
1002
1085
            self.disable_initiator_tag = None
1003
1086
        if getattr(self, "enabled", False):
1004
 
            self.disable_initiator_tag = GObject.timeout_add(
 
1087
            self.disable_initiator_tag = GLib.timeout_add(
1005
1088
                int(timeout.total_seconds() * 1000), self.disable)
1006
1089
            self.expires = datetime.datetime.utcnow() + timeout
1007
 
    
 
1090
 
1008
1091
    def need_approval(self):
1009
1092
        self.last_approval_request = datetime.datetime.utcnow()
1010
 
    
 
1093
 
1011
1094
    def start_checker(self):
1012
1095
        """Start a new checker subprocess if one is not running.
1013
 
        
 
1096
 
1014
1097
        If a checker already exists, leave it running and do
1015
1098
        nothing."""
1016
1099
        # The reason for not killing a running checker is that if we
1021
1104
        # checkers alone, the checker would have to take more time
1022
1105
        # than 'timeout' for the client to be disabled, which is as it
1023
1106
        # should be.
1024
 
        
 
1107
 
1025
1108
        if self.checker is not None and not self.checker.is_alive():
1026
1109
            logger.warning("Checker was not alive; joining")
1027
1110
            self.checker.join()
1031
1114
            # Escape attributes for the shell
1032
1115
            escaped_attrs = {
1033
1116
                attr: re.escape(str(getattr(self, attr)))
1034
 
                for attr in self.runtime_expansions }
 
1117
                for attr in self.runtime_expansions}
1035
1118
            try:
1036
1119
                command = self.checker_command % escaped_attrs
1037
1120
            except TypeError as error:
1049
1132
            # The exception is when not debugging but nevertheless
1050
1133
            # running in the foreground; use the previously
1051
1134
            # created wnull.
1052
 
            popen_args = { "close_fds": True,
1053
 
                           "shell": True,
1054
 
                           "cwd": "/" }
 
1135
            popen_args = {"close_fds": True,
 
1136
                          "shell": True,
 
1137
                          "cwd": "/"}
1055
1138
            if (not self.server_settings["debug"]
1056
1139
                and self.server_settings["foreground"]):
1057
1140
                popen_args.update({"stdout": wnull,
1058
 
                                   "stderr": wnull })
1059
 
            pipe = multiprocessing.Pipe(duplex = False)
 
1141
                                   "stderr": wnull})
 
1142
            pipe = multiprocessing.Pipe(duplex=False)
1060
1143
            self.checker = multiprocessing.Process(
1061
 
                target = call_pipe,
1062
 
                args = (pipe[1], subprocess.call, command),
1063
 
                kwargs = popen_args)
 
1144
                target=call_pipe,
 
1145
                args=(pipe[1], subprocess.call, command),
 
1146
                kwargs=popen_args)
1064
1147
            self.checker.start()
1065
 
            self.checker_callback_tag = GObject.io_add_watch(
1066
 
                pipe[0].fileno(), GObject.IO_IN,
 
1148
            self.checker_callback_tag = GLib.io_add_watch(
 
1149
                pipe[0].fileno(), GLib.IO_IN,
1067
1150
                self.checker_callback, pipe[0], command)
1068
 
        # Re-run this periodically if run by GObject.timeout_add
 
1151
        # Re-run this periodically if run by GLib.timeout_add
1069
1152
        return True
1070
 
    
 
1153
 
1071
1154
    def stop_checker(self):
1072
1155
        """Force the checker process, if any, to stop."""
1073
1156
        if self.checker_callback_tag:
1074
 
            GObject.source_remove(self.checker_callback_tag)
 
1157
            GLib.source_remove(self.checker_callback_tag)
1075
1158
            self.checker_callback_tag = None
1076
1159
        if getattr(self, "checker", None) is None:
1077
1160
            return
1086
1169
                          byte_arrays=False):
1087
1170
    """Decorators for marking methods of a DBusObjectWithProperties to
1088
1171
    become properties on the D-Bus.
1089
 
    
 
1172
 
1090
1173
    The decorated method will be called with no arguments by "Get"
1091
1174
    and with one argument by "Set".
1092
 
    
 
1175
 
1093
1176
    The parameters, where they are supported, are the same as
1094
1177
    dbus.service.method, except there is only "signature", since the
1095
1178
    type from Get() and the type sent to Set() is the same.
1099
1182
    if byte_arrays and signature != "ay":
1100
1183
        raise ValueError("Byte arrays not supported for non-'ay'"
1101
1184
                         " signature {!r}".format(signature))
1102
 
    
 
1185
 
1103
1186
    def decorator(func):
1104
1187
        func._dbus_is_property = True
1105
1188
        func._dbus_interface = dbus_interface
1108
1191
        func._dbus_name = func.__name__
1109
1192
        if func._dbus_name.endswith("_dbus_property"):
1110
1193
            func._dbus_name = func._dbus_name[:-14]
1111
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
 
1194
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1112
1195
        return func
1113
 
    
 
1196
 
1114
1197
    return decorator
1115
1198
 
1116
1199
 
1117
1200
def dbus_interface_annotations(dbus_interface):
1118
1201
    """Decorator for marking functions returning interface annotations
1119
 
    
 
1202
 
1120
1203
    Usage:
1121
 
    
 
1204
 
1122
1205
    @dbus_interface_annotations("org.example.Interface")
1123
1206
    def _foo(self):  # Function name does not matter
1124
1207
        return {"org.freedesktop.DBus.Deprecated": "true",
1125
1208
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
1126
1209
                    "false"}
1127
1210
    """
1128
 
    
 
1211
 
1129
1212
    def decorator(func):
1130
1213
        func._dbus_is_interface = True
1131
1214
        func._dbus_interface = dbus_interface
1132
1215
        func._dbus_name = dbus_interface
1133
1216
        return func
1134
 
    
 
1217
 
1135
1218
    return decorator
1136
1219
 
1137
1220
 
1138
1221
def dbus_annotations(annotations):
1139
1222
    """Decorator to annotate D-Bus methods, signals or properties
1140
1223
    Usage:
1141
 
    
 
1224
 
1142
1225
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1143
1226
                       "org.freedesktop.DBus.Property."
1144
1227
                       "EmitsChangedSignal": "false"})
1146
1229
                           access="r")
1147
1230
    def Property_dbus_property(self):
1148
1231
        return dbus.Boolean(False)
1149
 
    
 
1232
 
1150
1233
    See also the DBusObjectWithAnnotations class.
1151
1234
    """
1152
 
    
 
1235
 
1153
1236
    def decorator(func):
1154
1237
        func._dbus_annotations = annotations
1155
1238
        return func
1156
 
    
 
1239
 
1157
1240
    return decorator
1158
1241
 
1159
1242
 
1177
1260
 
1178
1261
class DBusObjectWithAnnotations(dbus.service.Object):
1179
1262
    """A D-Bus object with annotations.
1180
 
    
 
1263
 
1181
1264
    Classes inheriting from this can use the dbus_annotations
1182
1265
    decorator to add annotations to methods or signals.
1183
1266
    """
1184
 
    
 
1267
 
1185
1268
    @staticmethod
1186
1269
    def _is_dbus_thing(thing):
1187
1270
        """Returns a function testing if an attribute is a D-Bus thing
1188
 
        
 
1271
 
1189
1272
        If called like _is_dbus_thing("method") it returns a function
1190
1273
        suitable for use as predicate to inspect.getmembers().
1191
1274
        """
1192
1275
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1193
1276
                                   False)
1194
 
    
 
1277
 
1195
1278
    def _get_all_dbus_things(self, thing):
1196
1279
        """Returns a generator of (name, attribute) pairs
1197
1280
        """
1200
1283
                for cls in self.__class__.__mro__
1201
1284
                for name, athing in
1202
1285
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
1203
 
    
 
1286
 
1204
1287
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1205
 
                         out_signature = "s",
1206
 
                         path_keyword = 'object_path',
1207
 
                         connection_keyword = 'connection')
 
1288
                         out_signature="s",
 
1289
                         path_keyword='object_path',
 
1290
                         connection_keyword='connection')
1208
1291
    def Introspect(self, object_path, connection):
1209
1292
        """Overloading of standard D-Bus method.
1210
 
        
 
1293
 
1211
1294
        Inserts annotation tags on methods and signals.
1212
1295
        """
1213
1296
        xmlstring = dbus.service.Object.Introspect(self, object_path,
1214
1297
                                                   connection)
1215
1298
        try:
1216
1299
            document = xml.dom.minidom.parseString(xmlstring)
1217
 
            
 
1300
 
1218
1301
            for if_tag in document.getElementsByTagName("interface"):
1219
1302
                # Add annotation tags
1220
1303
                for typ in ("method", "signal"):
1247
1330
                    if_tag.appendChild(ann_tag)
1248
1331
                # Fix argument name for the Introspect method itself
1249
1332
                if (if_tag.getAttribute("name")
1250
 
                                == dbus.INTROSPECTABLE_IFACE):
 
1333
                    == dbus.INTROSPECTABLE_IFACE):
1251
1334
                    for cn in if_tag.getElementsByTagName("method"):
1252
1335
                        if cn.getAttribute("name") == "Introspect":
1253
1336
                            for arg in cn.getElementsByTagName("arg"):
1266
1349
 
1267
1350
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1268
1351
    """A D-Bus object with properties.
1269
 
    
 
1352
 
1270
1353
    Classes inheriting from this can use the dbus_service_property
1271
1354
    decorator to expose methods as D-Bus properties.  It exposes the
1272
1355
    standard Get(), Set(), and GetAll() methods on the D-Bus.
1273
1356
    """
1274
 
    
 
1357
 
1275
1358
    def _get_dbus_property(self, interface_name, property_name):
1276
1359
        """Returns a bound method if one exists which is a D-Bus
1277
1360
        property with the specified name and interface.
1282
1365
                if (value._dbus_name == property_name
1283
1366
                    and value._dbus_interface == interface_name):
1284
1367
                    return value.__get__(self)
1285
 
        
 
1368
 
1286
1369
        # No such property
1287
1370
        raise DBusPropertyNotFound("{}:{}.{}".format(
1288
1371
            self.dbus_object_path, interface_name, property_name))
1289
 
    
 
1372
 
1290
1373
    @classmethod
1291
1374
    def _get_all_interface_names(cls):
1292
1375
        """Get a sequence of all interfaces supported by an object"""
1295
1378
                                     for x in (inspect.getmro(cls))
1296
1379
                                     for attr in dir(x))
1297
1380
                if name is not None)
1298
 
    
 
1381
 
1299
1382
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1300
1383
                         in_signature="ss",
1301
1384
                         out_signature="v")
1309
1392
        if not hasattr(value, "variant_level"):
1310
1393
            return value
1311
1394
        return type(value)(value, variant_level=value.variant_level+1)
1312
 
    
 
1395
 
1313
1396
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
1314
1397
    def Set(self, interface_name, property_name, value):
1315
1398
        """Standard D-Bus property Set() method, see D-Bus standard.
1327
1410
            value = dbus.ByteArray(b''.join(chr(byte)
1328
1411
                                            for byte in value))
1329
1412
        prop(value)
1330
 
    
 
1413
 
1331
1414
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1332
1415
                         in_signature="s",
1333
1416
                         out_signature="a{sv}")
1334
1417
    def GetAll(self, interface_name):
1335
1418
        """Standard D-Bus property GetAll() method, see D-Bus
1336
1419
        standard.
1337
 
        
 
1420
 
1338
1421
        Note: Will not include properties with access="write".
1339
1422
        """
1340
1423
        properties = {}
1351
1434
                properties[name] = value
1352
1435
                continue
1353
1436
            properties[name] = type(value)(
1354
 
                value, variant_level = value.variant_level + 1)
 
1437
                value, variant_level=value.variant_level + 1)
1355
1438
        return dbus.Dictionary(properties, signature="sv")
1356
 
    
 
1439
 
1357
1440
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1358
1441
    def PropertiesChanged(self, interface_name, changed_properties,
1359
1442
                          invalidated_properties):
1361
1444
        standard.
1362
1445
        """
1363
1446
        pass
1364
 
    
 
1447
 
1365
1448
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1366
1449
                         out_signature="s",
1367
1450
                         path_keyword='object_path',
1368
1451
                         connection_keyword='connection')
1369
1452
    def Introspect(self, object_path, connection):
1370
1453
        """Overloading of standard D-Bus method.
1371
 
        
 
1454
 
1372
1455
        Inserts property tags and interface annotation tags.
1373
1456
        """
1374
1457
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
1376
1459
                                                         connection)
1377
1460
        try:
1378
1461
            document = xml.dom.minidom.parseString(xmlstring)
1379
 
            
 
1462
 
1380
1463
            def make_tag(document, name, prop):
1381
1464
                e = document.createElement("property")
1382
1465
                e.setAttribute("name", name)
1383
1466
                e.setAttribute("type", prop._dbus_signature)
1384
1467
                e.setAttribute("access", prop._dbus_access)
1385
1468
                return e
1386
 
            
 
1469
 
1387
1470
            for if_tag in document.getElementsByTagName("interface"):
1388
1471
                # Add property tags
1389
1472
                for tag in (make_tag(document, name, prop)
1431
1514
                         exc_info=error)
1432
1515
        return xmlstring
1433
1516
 
 
1517
 
1434
1518
try:
1435
1519
    dbus.OBJECT_MANAGER_IFACE
1436
1520
except AttributeError:
1437
1521
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1438
1522
 
 
1523
 
1439
1524
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1440
1525
    """A D-Bus object with an ObjectManager.
1441
 
    
 
1526
 
1442
1527
    Classes inheriting from this exposes the standard
1443
1528
    GetManagedObjects call and the InterfacesAdded and
1444
1529
    InterfacesRemoved signals on the standard
1445
1530
    "org.freedesktop.DBus.ObjectManager" interface.
1446
 
    
 
1531
 
1447
1532
    Note: No signals are sent automatically; they must be sent
1448
1533
    manually.
1449
1534
    """
1450
1535
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1451
 
                         out_signature = "a{oa{sa{sv}}}")
 
1536
                         out_signature="a{oa{sa{sv}}}")
1452
1537
    def GetManagedObjects(self):
1453
1538
        """This function must be overridden"""
1454
1539
        raise NotImplementedError()
1455
 
    
 
1540
 
1456
1541
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1457
 
                         signature = "oa{sa{sv}}")
 
1542
                         signature="oa{sa{sv}}")
1458
1543
    def InterfacesAdded(self, object_path, interfaces_and_properties):
1459
1544
        pass
1460
 
    
1461
 
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
 
1545
 
 
1546
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1462
1547
    def InterfacesRemoved(self, object_path, interfaces):
1463
1548
        pass
1464
 
    
 
1549
 
1465
1550
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1466
 
                         out_signature = "s",
1467
 
                         path_keyword = 'object_path',
1468
 
                         connection_keyword = 'connection')
 
1551
                         out_signature="s",
 
1552
                         path_keyword='object_path',
 
1553
                         connection_keyword='connection')
1469
1554
    def Introspect(self, object_path, connection):
1470
1555
        """Overloading of standard D-Bus method.
1471
 
        
 
1556
 
1472
1557
        Override return argument name of GetManagedObjects to be
1473
1558
        "objpath_interfaces_and_properties"
1474
1559
        """
1477
1562
                                                         connection)
1478
1563
        try:
1479
1564
            document = xml.dom.minidom.parseString(xmlstring)
1480
 
            
 
1565
 
1481
1566
            for if_tag in document.getElementsByTagName("interface"):
1482
1567
                # Fix argument name for the GetManagedObjects method
1483
1568
                if (if_tag.getAttribute("name")
1484
 
                                == dbus.OBJECT_MANAGER_IFACE):
 
1569
                    == dbus.OBJECT_MANAGER_IFACE):
1485
1570
                    for cn in if_tag.getElementsByTagName("method"):
1486
1571
                        if (cn.getAttribute("name")
1487
1572
                            == "GetManagedObjects"):
1497
1582
        except (AttributeError, xml.dom.DOMException,
1498
1583
                xml.parsers.expat.ExpatError) as error:
1499
1584
            logger.error("Failed to override Introspection method",
1500
 
                         exc_info = error)
 
1585
                         exc_info=error)
1501
1586
        return xmlstring
1502
1587
 
 
1588
 
1503
1589
def datetime_to_dbus(dt, variant_level=0):
1504
1590
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1505
1591
    if dt is None:
1506
 
        return dbus.String("", variant_level = variant_level)
 
1592
        return dbus.String("", variant_level=variant_level)
1507
1593
    return dbus.String(dt.isoformat(), variant_level=variant_level)
1508
1594
 
1509
1595
 
1512
1598
    dbus.service.Object, it will add alternate D-Bus attributes with
1513
1599
    interface names according to the "alt_interface_names" mapping.
1514
1600
    Usage:
1515
 
    
 
1601
 
1516
1602
    @alternate_dbus_interfaces({"org.example.Interface":
1517
1603
                                    "net.example.AlternateInterface"})
1518
1604
    class SampleDBusObject(dbus.service.Object):
1519
1605
        @dbus.service.method("org.example.Interface")
1520
1606
        def SampleDBusMethod():
1521
1607
            pass
1522
 
    
 
1608
 
1523
1609
    The above "SampleDBusMethod" on "SampleDBusObject" will be
1524
1610
    reachable via two interfaces: "org.example.Interface" and
1525
1611
    "net.example.AlternateInterface", the latter of which will have
1526
1612
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1527
1613
    "true", unless "deprecate" is passed with a False value.
1528
 
    
 
1614
 
1529
1615
    This works for methods and signals, and also for D-Bus properties
1530
1616
    (from DBusObjectWithProperties) and interfaces (from the
1531
1617
    dbus_interface_annotations decorator).
1532
1618
    """
1533
 
    
 
1619
 
1534
1620
    def wrapper(cls):
1535
1621
        for orig_interface_name, alt_interface_name in (
1536
1622
                alt_interface_names.items()):
1576
1662
                            attribute._dbus_annotations)
1577
1663
                    except AttributeError:
1578
1664
                        pass
 
1665
 
1579
1666
                    # Define a creator of a function to call both the
1580
1667
                    # original and alternate functions, so both the
1581
1668
                    # original and alternate signals gets sent when
1584
1671
                        """This function is a scope container to pass
1585
1672
                        func1 and func2 to the "call_both" function
1586
1673
                        outside of its arguments"""
1587
 
                        
 
1674
 
1588
1675
                        @functools.wraps(func2)
1589
1676
                        def call_both(*args, **kwargs):
1590
1677
                            """This function will emit two D-Bus
1591
1678
                            signals by calling func1 and func2"""
1592
1679
                            func1(*args, **kwargs)
1593
1680
                            func2(*args, **kwargs)
1594
 
                        # Make wrapper function look like a D-Bus signal
 
1681
                        # Make wrapper function look like a D-Bus
 
1682
                        # signal
1595
1683
                        for name, attr in inspect.getmembers(func2):
1596
1684
                            if name.startswith("_dbus_"):
1597
1685
                                setattr(call_both, name, attr)
1598
 
                        
 
1686
 
1599
1687
                        return call_both
1600
1688
                    # Create the "call_both" function and add it to
1601
1689
                    # the class
1647
1735
                        (copy_function(attribute)))
1648
1736
            if deprecate:
1649
1737
                # Deprecate all alternate interfaces
1650
 
                iname="_AlternateDBusNames_interface_annotation{}"
 
1738
                iname = "_AlternateDBusNames_interface_annotation{}"
1651
1739
                for interface_name in interface_names:
1652
 
                    
 
1740
 
1653
1741
                    @dbus_interface_annotations(interface_name)
1654
1742
                    def func(self):
1655
 
                        return { "org.freedesktop.DBus.Deprecated":
1656
 
                                 "true" }
 
1743
                        return {"org.freedesktop.DBus.Deprecated":
 
1744
                                "true"}
1657
1745
                    # Find an unused name
1658
1746
                    for aname in (iname.format(i)
1659
1747
                                  for i in itertools.count()):
1670
1758
                    cls = type("{}Alternate".format(cls.__name__),
1671
1759
                               (cls, ), attr)
1672
1760
        return cls
1673
 
    
 
1761
 
1674
1762
    return wrapper
1675
1763
 
1676
1764
 
1678
1766
                            "se.bsnet.fukt.Mandos"})
1679
1767
class ClientDBus(Client, DBusObjectWithProperties):
1680
1768
    """A Client class using D-Bus
1681
 
    
 
1769
 
1682
1770
    Attributes:
1683
1771
    dbus_object_path: dbus.ObjectPath
1684
1772
    bus: dbus.SystemBus()
1685
1773
    """
1686
 
    
 
1774
 
1687
1775
    runtime_expansions = (Client.runtime_expansions
1688
1776
                          + ("dbus_object_path", ))
1689
 
    
 
1777
 
1690
1778
    _interface = "se.recompile.Mandos.Client"
1691
 
    
 
1779
 
1692
1780
    # dbus.service.Object doesn't use super(), so we can't either.
1693
 
    
1694
 
    def __init__(self, bus = None, *args, **kwargs):
 
1781
 
 
1782
    def __init__(self, bus=None, *args, **kwargs):
1695
1783
        self.bus = bus
1696
1784
        Client.__init__(self, *args, **kwargs)
1697
1785
        # Only now, when this client is initialized, can it show up on
1703
1791
            "/clients/" + client_object_name)
1704
1792
        DBusObjectWithProperties.__init__(self, self.bus,
1705
1793
                                          self.dbus_object_path)
1706
 
    
 
1794
 
1707
1795
    def notifychangeproperty(transform_func, dbus_name,
1708
1796
                             type_func=lambda x: x,
1709
1797
                             variant_level=1,
1711
1799
                             _interface=_interface):
1712
1800
        """ Modify a variable so that it's a property which announces
1713
1801
        its changes to DBus.
1714
 
        
 
1802
 
1715
1803
        transform_fun: Function that takes a value and a variant_level
1716
1804
                       and transforms it to a D-Bus type.
1717
1805
        dbus_name: D-Bus name of the variable
1720
1808
        variant_level: D-Bus variant level.  Default: 1
1721
1809
        """
1722
1810
        attrname = "_{}".format(dbus_name)
1723
 
        
 
1811
 
1724
1812
        def setter(self, value):
1725
1813
            if hasattr(self, "dbus_object_path"):
1726
1814
                if (not hasattr(self, attrname) or
1733
1821
                    else:
1734
1822
                        dbus_value = transform_func(
1735
1823
                            type_func(value),
1736
 
                            variant_level = variant_level)
 
1824
                            variant_level=variant_level)
1737
1825
                        self.PropertyChanged(dbus.String(dbus_name),
1738
1826
                                             dbus_value)
1739
1827
                        self.PropertiesChanged(
1740
1828
                            _interface,
1741
 
                            dbus.Dictionary({ dbus.String(dbus_name):
1742
 
                                              dbus_value }),
 
1829
                            dbus.Dictionary({dbus.String(dbus_name):
 
1830
                                             dbus_value}),
1743
1831
                            dbus.Array())
1744
1832
            setattr(self, attrname, value)
1745
 
        
 
1833
 
1746
1834
        return property(lambda self: getattr(self, attrname), setter)
1747
 
    
 
1835
 
1748
1836
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1749
1837
    approvals_pending = notifychangeproperty(dbus.Boolean,
1750
1838
                                             "ApprovalPending",
1751
 
                                             type_func = bool)
 
1839
                                             type_func=bool)
1752
1840
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1753
1841
    last_enabled = notifychangeproperty(datetime_to_dbus,
1754
1842
                                        "LastEnabled")
1755
1843
    checker = notifychangeproperty(
1756
1844
        dbus.Boolean, "CheckerRunning",
1757
 
        type_func = lambda checker: checker is not None)
 
1845
        type_func=lambda checker: checker is not None)
1758
1846
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1759
1847
                                           "LastCheckedOK")
1760
1848
    last_checker_status = notifychangeproperty(dbus.Int16,
1765
1853
                                               "ApprovedByDefault")
1766
1854
    approval_delay = notifychangeproperty(
1767
1855
        dbus.UInt64, "ApprovalDelay",
1768
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1856
        type_func=lambda td: td.total_seconds() * 1000)
1769
1857
    approval_duration = notifychangeproperty(
1770
1858
        dbus.UInt64, "ApprovalDuration",
1771
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1859
        type_func=lambda td: td.total_seconds() * 1000)
1772
1860
    host = notifychangeproperty(dbus.String, "Host")
1773
1861
    timeout = notifychangeproperty(
1774
1862
        dbus.UInt64, "Timeout",
1775
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1863
        type_func=lambda td: td.total_seconds() * 1000)
1776
1864
    extended_timeout = notifychangeproperty(
1777
1865
        dbus.UInt64, "ExtendedTimeout",
1778
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1866
        type_func=lambda td: td.total_seconds() * 1000)
1779
1867
    interval = notifychangeproperty(
1780
1868
        dbus.UInt64, "Interval",
1781
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1869
        type_func=lambda td: td.total_seconds() * 1000)
1782
1870
    checker_command = notifychangeproperty(dbus.String, "Checker")
1783
1871
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1784
1872
                                  invalidate_only=True)
1785
 
    
 
1873
 
1786
1874
    del notifychangeproperty
1787
 
    
 
1875
 
1788
1876
    def __del__(self, *args, **kwargs):
1789
1877
        try:
1790
1878
            self.remove_from_connection()
1793
1881
        if hasattr(DBusObjectWithProperties, "__del__"):
1794
1882
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1795
1883
        Client.__del__(self, *args, **kwargs)
1796
 
    
 
1884
 
1797
1885
    def checker_callback(self, source, condition,
1798
1886
                         connection, command, *args, **kwargs):
1799
1887
        ret = Client.checker_callback(self, source, condition,
1815
1903
                                      | self.last_checker_signal),
1816
1904
                                  dbus.String(command))
1817
1905
        return ret
1818
 
    
 
1906
 
1819
1907
    def start_checker(self, *args, **kwargs):
1820
1908
        old_checker_pid = getattr(self.checker, "pid", None)
1821
1909
        r = Client.start_checker(self, *args, **kwargs)
1825
1913
            # Emit D-Bus signal
1826
1914
            self.CheckerStarted(self.current_checker_command)
1827
1915
        return r
1828
 
    
 
1916
 
1829
1917
    def _reset_approved(self):
1830
1918
        self.approved = None
1831
1919
        return False
1832
 
    
 
1920
 
1833
1921
    def approve(self, value=True):
1834
1922
        self.approved = value
1835
 
        GObject.timeout_add(int(self.approval_duration.total_seconds()
1836
 
                                * 1000), self._reset_approved)
 
1923
        GLib.timeout_add(int(self.approval_duration.total_seconds()
 
1924
                             * 1000), self._reset_approved)
1837
1925
        self.send_changedstate()
1838
 
    
1839
 
    ## D-Bus methods, signals & properties
1840
 
    
1841
 
    ## Interfaces
1842
 
    
1843
 
    ## Signals
1844
 
    
 
1926
 
 
1927
    #  D-Bus methods, signals & properties
 
1928
 
 
1929
    #  Interfaces
 
1930
 
 
1931
    #  Signals
 
1932
 
1845
1933
    # CheckerCompleted - signal
1846
1934
    @dbus.service.signal(_interface, signature="nxs")
1847
1935
    def CheckerCompleted(self, exitcode, waitstatus, command):
1848
1936
        "D-Bus signal"
1849
1937
        pass
1850
 
    
 
1938
 
1851
1939
    # CheckerStarted - signal
1852
1940
    @dbus.service.signal(_interface, signature="s")
1853
1941
    def CheckerStarted(self, command):
1854
1942
        "D-Bus signal"
1855
1943
        pass
1856
 
    
 
1944
 
1857
1945
    # PropertyChanged - signal
1858
1946
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1859
1947
    @dbus.service.signal(_interface, signature="sv")
1860
1948
    def PropertyChanged(self, property, value):
1861
1949
        "D-Bus signal"
1862
1950
        pass
1863
 
    
 
1951
 
1864
1952
    # GotSecret - signal
1865
1953
    @dbus.service.signal(_interface)
1866
1954
    def GotSecret(self):
1869
1957
        server to mandos-client
1870
1958
        """
1871
1959
        pass
1872
 
    
 
1960
 
1873
1961
    # Rejected - signal
1874
1962
    @dbus.service.signal(_interface, signature="s")
1875
1963
    def Rejected(self, reason):
1876
1964
        "D-Bus signal"
1877
1965
        pass
1878
 
    
 
1966
 
1879
1967
    # NeedApproval - signal
1880
1968
    @dbus.service.signal(_interface, signature="tb")
1881
1969
    def NeedApproval(self, timeout, default):
1882
1970
        "D-Bus signal"
1883
1971
        return self.need_approval()
1884
 
    
1885
 
    ## Methods
1886
 
    
 
1972
 
 
1973
    #  Methods
 
1974
 
1887
1975
    # Approve - method
1888
1976
    @dbus.service.method(_interface, in_signature="b")
1889
1977
    def Approve(self, value):
1890
1978
        self.approve(value)
1891
 
    
 
1979
 
1892
1980
    # CheckedOK - method
1893
1981
    @dbus.service.method(_interface)
1894
1982
    def CheckedOK(self):
1895
1983
        self.checked_ok()
1896
 
    
 
1984
 
1897
1985
    # Enable - method
1898
1986
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1899
1987
    @dbus.service.method(_interface)
1900
1988
    def Enable(self):
1901
1989
        "D-Bus method"
1902
1990
        self.enable()
1903
 
    
 
1991
 
1904
1992
    # StartChecker - method
1905
1993
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1906
1994
    @dbus.service.method(_interface)
1907
1995
    def StartChecker(self):
1908
1996
        "D-Bus method"
1909
1997
        self.start_checker()
1910
 
    
 
1998
 
1911
1999
    # Disable - method
1912
2000
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1913
2001
    @dbus.service.method(_interface)
1914
2002
    def Disable(self):
1915
2003
        "D-Bus method"
1916
2004
        self.disable()
1917
 
    
 
2005
 
1918
2006
    # StopChecker - method
1919
2007
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1920
2008
    @dbus.service.method(_interface)
1921
2009
    def StopChecker(self):
1922
2010
        self.stop_checker()
1923
 
    
1924
 
    ## Properties
1925
 
    
 
2011
 
 
2012
    #  Properties
 
2013
 
1926
2014
    # ApprovalPending - property
1927
2015
    @dbus_service_property(_interface, signature="b", access="read")
1928
2016
    def ApprovalPending_dbus_property(self):
1929
2017
        return dbus.Boolean(bool(self.approvals_pending))
1930
 
    
 
2018
 
1931
2019
    # ApprovedByDefault - property
1932
2020
    @dbus_service_property(_interface,
1933
2021
                           signature="b",
1936
2024
        if value is None:       # get
1937
2025
            return dbus.Boolean(self.approved_by_default)
1938
2026
        self.approved_by_default = bool(value)
1939
 
    
 
2027
 
1940
2028
    # ApprovalDelay - property
1941
2029
    @dbus_service_property(_interface,
1942
2030
                           signature="t",
1946
2034
            return dbus.UInt64(self.approval_delay.total_seconds()
1947
2035
                               * 1000)
1948
2036
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1949
 
    
 
2037
 
1950
2038
    # ApprovalDuration - property
1951
2039
    @dbus_service_property(_interface,
1952
2040
                           signature="t",
1956
2044
            return dbus.UInt64(self.approval_duration.total_seconds()
1957
2045
                               * 1000)
1958
2046
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1959
 
    
 
2047
 
1960
2048
    # Name - property
1961
2049
    @dbus_annotations(
1962
2050
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1963
2051
    @dbus_service_property(_interface, signature="s", access="read")
1964
2052
    def Name_dbus_property(self):
1965
2053
        return dbus.String(self.name)
1966
 
    
 
2054
 
 
2055
    # KeyID - property
 
2056
    @dbus_annotations(
 
2057
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
 
2058
    @dbus_service_property(_interface, signature="s", access="read")
 
2059
    def KeyID_dbus_property(self):
 
2060
        return dbus.String(self.key_id)
 
2061
 
1967
2062
    # Fingerprint - property
1968
2063
    @dbus_annotations(
1969
2064
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1970
2065
    @dbus_service_property(_interface, signature="s", access="read")
1971
2066
    def Fingerprint_dbus_property(self):
1972
2067
        return dbus.String(self.fingerprint)
1973
 
    
 
2068
 
1974
2069
    # Host - property
1975
2070
    @dbus_service_property(_interface,
1976
2071
                           signature="s",
1979
2074
        if value is None:       # get
1980
2075
            return dbus.String(self.host)
1981
2076
        self.host = str(value)
1982
 
    
 
2077
 
1983
2078
    # Created - property
1984
2079
    @dbus_annotations(
1985
2080
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1986
2081
    @dbus_service_property(_interface, signature="s", access="read")
1987
2082
    def Created_dbus_property(self):
1988
2083
        return datetime_to_dbus(self.created)
1989
 
    
 
2084
 
1990
2085
    # LastEnabled - property
1991
2086
    @dbus_service_property(_interface, signature="s", access="read")
1992
2087
    def LastEnabled_dbus_property(self):
1993
2088
        return datetime_to_dbus(self.last_enabled)
1994
 
    
 
2089
 
1995
2090
    # Enabled - property
1996
2091
    @dbus_service_property(_interface,
1997
2092
                           signature="b",
2003
2098
            self.enable()
2004
2099
        else:
2005
2100
            self.disable()
2006
 
    
 
2101
 
2007
2102
    # LastCheckedOK - property
2008
2103
    @dbus_service_property(_interface,
2009
2104
                           signature="s",
2013
2108
            self.checked_ok()
2014
2109
            return
2015
2110
        return datetime_to_dbus(self.last_checked_ok)
2016
 
    
 
2111
 
2017
2112
    # LastCheckerStatus - property
2018
2113
    @dbus_service_property(_interface, signature="n", access="read")
2019
2114
    def LastCheckerStatus_dbus_property(self):
2020
2115
        return dbus.Int16(self.last_checker_status)
2021
 
    
 
2116
 
2022
2117
    # Expires - property
2023
2118
    @dbus_service_property(_interface, signature="s", access="read")
2024
2119
    def Expires_dbus_property(self):
2025
2120
        return datetime_to_dbus(self.expires)
2026
 
    
 
2121
 
2027
2122
    # LastApprovalRequest - property
2028
2123
    @dbus_service_property(_interface, signature="s", access="read")
2029
2124
    def LastApprovalRequest_dbus_property(self):
2030
2125
        return datetime_to_dbus(self.last_approval_request)
2031
 
    
 
2126
 
2032
2127
    # Timeout - property
2033
2128
    @dbus_service_property(_interface,
2034
2129
                           signature="t",
2049
2144
                if (getattr(self, "disable_initiator_tag", None)
2050
2145
                    is None):
2051
2146
                    return
2052
 
                GObject.source_remove(self.disable_initiator_tag)
2053
 
                self.disable_initiator_tag = GObject.timeout_add(
 
2147
                GLib.source_remove(self.disable_initiator_tag)
 
2148
                self.disable_initiator_tag = GLib.timeout_add(
2054
2149
                    int((self.expires - now).total_seconds() * 1000),
2055
2150
                    self.disable)
2056
 
    
 
2151
 
2057
2152
    # ExtendedTimeout - property
2058
2153
    @dbus_service_property(_interface,
2059
2154
                           signature="t",
2063
2158
            return dbus.UInt64(self.extended_timeout.total_seconds()
2064
2159
                               * 1000)
2065
2160
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2066
 
    
 
2161
 
2067
2162
    # Interval - property
2068
2163
    @dbus_service_property(_interface,
2069
2164
                           signature="t",
2076
2171
            return
2077
2172
        if self.enabled:
2078
2173
            # Reschedule checker run
2079
 
            GObject.source_remove(self.checker_initiator_tag)
2080
 
            self.checker_initiator_tag = GObject.timeout_add(
 
2174
            GLib.source_remove(self.checker_initiator_tag)
 
2175
            self.checker_initiator_tag = GLib.timeout_add(
2081
2176
                value, self.start_checker)
2082
 
            self.start_checker() # Start one now, too
2083
 
    
 
2177
            self.start_checker()  # Start one now, too
 
2178
 
2084
2179
    # Checker - property
2085
2180
    @dbus_service_property(_interface,
2086
2181
                           signature="s",
2089
2184
        if value is None:       # get
2090
2185
            return dbus.String(self.checker_command)
2091
2186
        self.checker_command = str(value)
2092
 
    
 
2187
 
2093
2188
    # CheckerRunning - property
2094
2189
    @dbus_service_property(_interface,
2095
2190
                           signature="b",
2101
2196
            self.start_checker()
2102
2197
        else:
2103
2198
            self.stop_checker()
2104
 
    
 
2199
 
2105
2200
    # ObjectPath - property
2106
2201
    @dbus_annotations(
2107
2202
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2108
2203
         "org.freedesktop.DBus.Deprecated": "true"})
2109
2204
    @dbus_service_property(_interface, signature="o", access="read")
2110
2205
    def ObjectPath_dbus_property(self):
2111
 
        return self.dbus_object_path # is already a dbus.ObjectPath
2112
 
    
 
2206
        return self.dbus_object_path  # is already a dbus.ObjectPath
 
2207
 
2113
2208
    # Secret = property
2114
2209
    @dbus_annotations(
2115
2210
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
2120
2215
                           byte_arrays=True)
2121
2216
    def Secret_dbus_property(self, value):
2122
2217
        self.secret = bytes(value)
2123
 
    
 
2218
 
2124
2219
    del _interface
2125
2220
 
2126
2221
 
2127
2222
class ProxyClient(object):
2128
 
    def __init__(self, child_pipe, fpr, address):
 
2223
    def __init__(self, child_pipe, key_id, fpr, address):
2129
2224
        self._pipe = child_pipe
2130
 
        self._pipe.send(('init', fpr, address))
 
2225
        self._pipe.send(('init', key_id, fpr, address))
2131
2226
        if not self._pipe.recv():
2132
 
            raise KeyError(fpr)
2133
 
    
 
2227
            raise KeyError(key_id or fpr)
 
2228
 
2134
2229
    def __getattribute__(self, name):
2135
2230
        if name == '_pipe':
2136
2231
            return super(ProxyClient, self).__getattribute__(name)
2139
2234
        if data[0] == 'data':
2140
2235
            return data[1]
2141
2236
        if data[0] == 'function':
2142
 
            
 
2237
 
2143
2238
            def func(*args, **kwargs):
2144
2239
                self._pipe.send(('funcall', name, args, kwargs))
2145
2240
                return self._pipe.recv()[1]
2146
 
            
 
2241
 
2147
2242
            return func
2148
 
    
 
2243
 
2149
2244
    def __setattr__(self, name, value):
2150
2245
        if name == '_pipe':
2151
2246
            return super(ProxyClient, self).__setattr__(name, value)
2154
2249
 
2155
2250
class ClientHandler(socketserver.BaseRequestHandler, object):
2156
2251
    """A class to handle client connections.
2157
 
    
 
2252
 
2158
2253
    Instantiated once for each connection to handle it.
2159
2254
    Note: This will run in its own forked process."""
2160
 
    
 
2255
 
2161
2256
    def handle(self):
2162
2257
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2163
2258
            logger.info("TCP connection from: %s",
2164
2259
                        str(self.client_address))
2165
2260
            logger.debug("Pipe FD: %d",
2166
2261
                         self.server.child_pipe.fileno())
2167
 
            
 
2262
 
2168
2263
            session = gnutls.ClientSession(self.request)
2169
 
            
2170
 
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
2171
 
            #                      "+AES-256-CBC", "+SHA1",
2172
 
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
2173
 
            #                      "+DHE-DSS"))
 
2264
 
 
2265
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
2266
            #                       "+AES-256-CBC", "+SHA1",
 
2267
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
 
2268
            #                       "+DHE-DSS"))
2174
2269
            # Use a fallback default, since this MUST be set.
2175
2270
            priority = self.server.gnutls_priority
2176
2271
            if priority is None:
2177
2272
                priority = "NORMAL"
2178
 
            gnutls.priority_set_direct(session._c_object, priority,
 
2273
            gnutls.priority_set_direct(session._c_object,
 
2274
                                       priority.encode("utf-8"),
2179
2275
                                       None)
2180
 
            
 
2276
 
2181
2277
            # Start communication using the Mandos protocol
2182
2278
            # Get protocol number
2183
2279
            line = self.request.makefile().readline()
2188
2284
            except (ValueError, IndexError, RuntimeError) as error:
2189
2285
                logger.error("Unknown protocol version: %s", error)
2190
2286
                return
2191
 
            
 
2287
 
2192
2288
            # Start GnuTLS connection
2193
2289
            try:
2194
2290
                session.handshake()
2198
2294
                # established.  Just abandon the request.
2199
2295
                return
2200
2296
            logger.debug("Handshake succeeded")
2201
 
            
 
2297
 
2202
2298
            approval_required = False
2203
2299
            try:
2204
 
                try:
2205
 
                    fpr = self.fingerprint(
2206
 
                        self.peer_certificate(session))
2207
 
                except (TypeError, gnutls.Error) as error:
2208
 
                    logger.warning("Bad certificate: %s", error)
2209
 
                    return
2210
 
                logger.debug("Fingerprint: %s", fpr)
2211
 
                
2212
 
                try:
2213
 
                    client = ProxyClient(child_pipe, fpr,
 
2300
                if gnutls.has_rawpk:
 
2301
                    fpr = ""
 
2302
                    try:
 
2303
                        key_id = self.key_id(
 
2304
                            self.peer_certificate(session))
 
2305
                    except (TypeError, gnutls.Error) as error:
 
2306
                        logger.warning("Bad certificate: %s", error)
 
2307
                        return
 
2308
                    logger.debug("Key ID: %s", key_id)
 
2309
 
 
2310
                else:
 
2311
                    key_id = ""
 
2312
                    try:
 
2313
                        fpr = self.fingerprint(
 
2314
                            self.peer_certificate(session))
 
2315
                    except (TypeError, gnutls.Error) as error:
 
2316
                        logger.warning("Bad certificate: %s", error)
 
2317
                        return
 
2318
                    logger.debug("Fingerprint: %s", fpr)
 
2319
 
 
2320
                try:
 
2321
                    client = ProxyClient(child_pipe, key_id, fpr,
2214
2322
                                         self.client_address)
2215
2323
                except KeyError:
2216
2324
                    return
2217
 
                
 
2325
 
2218
2326
                if client.approval_delay:
2219
2327
                    delay = client.approval_delay
2220
2328
                    client.approvals_pending += 1
2221
2329
                    approval_required = True
2222
 
                
 
2330
 
2223
2331
                while True:
2224
2332
                    if not client.enabled:
2225
2333
                        logger.info("Client %s is disabled",
2228
2336
                            # Emit D-Bus signal
2229
2337
                            client.Rejected("Disabled")
2230
2338
                        return
2231
 
                    
 
2339
 
2232
2340
                    if client.approved or not client.approval_delay:
2233
 
                        #We are approved or approval is disabled
 
2341
                        # We are approved or approval is disabled
2234
2342
                        break
2235
2343
                    elif client.approved is None:
2236
2344
                        logger.info("Client %s needs approval",
2247
2355
                            # Emit D-Bus signal
2248
2356
                            client.Rejected("Denied")
2249
2357
                        return
2250
 
                    
2251
 
                    #wait until timeout or approved
 
2358
 
 
2359
                    # wait until timeout or approved
2252
2360
                    time = datetime.datetime.now()
2253
2361
                    client.changedstate.acquire()
2254
2362
                    client.changedstate.wait(delay.total_seconds())
2267
2375
                            break
2268
2376
                    else:
2269
2377
                        delay -= time2 - time
2270
 
                
 
2378
 
2271
2379
                try:
2272
2380
                    session.send(client.secret)
2273
2381
                except gnutls.Error as error:
2274
2382
                    logger.warning("gnutls send failed",
2275
 
                                   exc_info = error)
 
2383
                                   exc_info=error)
2276
2384
                    return
2277
 
                
 
2385
 
2278
2386
                logger.info("Sending secret to %s", client.name)
2279
2387
                # bump the timeout using extended_timeout
2280
2388
                client.bump_timeout(client.extended_timeout)
2281
2389
                if self.server.use_dbus:
2282
2390
                    # Emit D-Bus signal
2283
2391
                    client.GotSecret()
2284
 
            
 
2392
 
2285
2393
            finally:
2286
2394
                if approval_required:
2287
2395
                    client.approvals_pending -= 1
2290
2398
                except gnutls.Error as error:
2291
2399
                    logger.warning("GnuTLS bye failed",
2292
2400
                                   exc_info=error)
2293
 
    
 
2401
 
2294
2402
    @staticmethod
2295
2403
    def peer_certificate(session):
2296
 
        "Return the peer's OpenPGP certificate as a bytestring"
2297
 
        # If not an OpenPGP certificate...
2298
 
        if (gnutls.certificate_type_get(session._c_object)
2299
 
            != gnutls.CRT_OPENPGP):
 
2404
        "Return the peer's certificate as a bytestring"
 
2405
        try:
 
2406
            cert_type = gnutls.certificate_type_get2(session._c_object,
 
2407
                                                     gnutls.CTYPE_PEERS)
 
2408
        except AttributeError:
 
2409
            cert_type = gnutls.certificate_type_get(session._c_object)
 
2410
        if gnutls.has_rawpk:
 
2411
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
 
2412
        else:
 
2413
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
 
2414
        # If not a valid certificate type...
 
2415
        if cert_type not in valid_cert_types:
 
2416
            logger.info("Cert type %r not in %r", cert_type,
 
2417
                        valid_cert_types)
2300
2418
            # ...return invalid data
2301
2419
            return b""
2302
2420
        list_size = ctypes.c_uint(1)
2308
2426
            return None
2309
2427
        cert = cert_list[0]
2310
2428
        return ctypes.string_at(cert.data, cert.size)
2311
 
    
 
2429
 
 
2430
    @staticmethod
 
2431
    def key_id(certificate):
 
2432
        "Convert a certificate bytestring to a hexdigit key ID"
 
2433
        # New GnuTLS "datum" with the public key
 
2434
        datum = gnutls.datum_t(
 
2435
            ctypes.cast(ctypes.c_char_p(certificate),
 
2436
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2437
            ctypes.c_uint(len(certificate)))
 
2438
        # XXX all these need to be created in the gnutls "module"
 
2439
        # New empty GnuTLS certificate
 
2440
        pubkey = gnutls.pubkey_t()
 
2441
        gnutls.pubkey_init(ctypes.byref(pubkey))
 
2442
        # Import the raw public key into the certificate
 
2443
        gnutls.pubkey_import(pubkey,
 
2444
                             ctypes.byref(datum),
 
2445
                             gnutls.X509_FMT_DER)
 
2446
        # New buffer for the key ID
 
2447
        buf = ctypes.create_string_buffer(32)
 
2448
        buf_len = ctypes.c_size_t(len(buf))
 
2449
        # Get the key ID from the raw public key into the buffer
 
2450
        gnutls.pubkey_get_key_id(pubkey,
 
2451
                                 gnutls.KEYID_USE_SHA256,
 
2452
                                 ctypes.cast(ctypes.byref(buf),
 
2453
                                             ctypes.POINTER(ctypes.c_ubyte)),
 
2454
                                 ctypes.byref(buf_len))
 
2455
        # Deinit the certificate
 
2456
        gnutls.pubkey_deinit(pubkey)
 
2457
 
 
2458
        # Convert the buffer to a Python bytestring
 
2459
        key_id = ctypes.string_at(buf, buf_len.value)
 
2460
        # Convert the bytestring to hexadecimal notation
 
2461
        hex_key_id = binascii.hexlify(key_id).upper()
 
2462
        return hex_key_id
 
2463
 
2312
2464
    @staticmethod
2313
2465
    def fingerprint(openpgp):
2314
2466
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
2329
2481
                                       ctypes.byref(crtverify))
2330
2482
        if crtverify.value != 0:
2331
2483
            gnutls.openpgp_crt_deinit(crt)
2332
 
            raise gnutls.CertificateSecurityError("Verify failed")
 
2484
            raise gnutls.CertificateSecurityError(code
 
2485
                                                  =crtverify.value)
2333
2486
        # New buffer for the fingerprint
2334
2487
        buf = ctypes.create_string_buffer(20)
2335
2488
        buf_len = ctypes.c_size_t()
2347
2500
 
2348
2501
class MultiprocessingMixIn(object):
2349
2502
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2350
 
    
 
2503
 
2351
2504
    def sub_process_main(self, request, address):
2352
2505
        try:
2353
2506
            self.finish_request(request, address)
2354
2507
        except Exception:
2355
2508
            self.handle_error(request, address)
2356
2509
        self.close_request(request)
2357
 
    
 
2510
 
2358
2511
    def process_request(self, request, address):
2359
2512
        """Start a new process to process the request."""
2360
 
        proc = multiprocessing.Process(target = self.sub_process_main,
2361
 
                                       args = (request, address))
 
2513
        proc = multiprocessing.Process(target=self.sub_process_main,
 
2514
                                       args=(request, address))
2362
2515
        proc.start()
2363
2516
        return proc
2364
2517
 
2365
2518
 
2366
2519
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2367
2520
    """ adds a pipe to the MixIn """
2368
 
    
 
2521
 
2369
2522
    def process_request(self, request, client_address):
2370
2523
        """Overrides and wraps the original process_request().
2371
 
        
 
2524
 
2372
2525
        This function creates a new pipe in self.pipe
2373
2526
        """
2374
2527
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
2375
 
        
 
2528
 
2376
2529
        proc = MultiprocessingMixIn.process_request(self, request,
2377
2530
                                                    client_address)
2378
2531
        self.child_pipe.close()
2379
2532
        self.add_pipe(parent_pipe, proc)
2380
 
    
 
2533
 
2381
2534
    def add_pipe(self, parent_pipe, proc):
2382
2535
        """Dummy function; override as necessary"""
2383
2536
        raise NotImplementedError()
2386
2539
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2387
2540
                     socketserver.TCPServer, object):
2388
2541
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2389
 
    
 
2542
 
2390
2543
    Attributes:
2391
2544
        enabled:        Boolean; whether this server is activated yet
2392
2545
        interface:      None or a network interface name (string)
2393
2546
        use_ipv6:       Boolean; to use IPv6 or not
2394
2547
    """
2395
 
    
 
2548
 
2396
2549
    def __init__(self, server_address, RequestHandlerClass,
2397
2550
                 interface=None,
2398
2551
                 use_ipv6=True,
2408
2561
            self.socketfd = socketfd
2409
2562
            # Save the original socket.socket() function
2410
2563
            self.socket_socket = socket.socket
 
2564
 
2411
2565
            # To implement --socket, we monkey patch socket.socket.
2412
 
            # 
 
2566
            #
2413
2567
            # (When socketserver.TCPServer is a new-style class, we
2414
2568
            # could make self.socket into a property instead of monkey
2415
2569
            # patching socket.socket.)
2416
 
            # 
 
2570
            #
2417
2571
            # Create a one-time-only replacement for socket.socket()
2418
2572
            @functools.wraps(socket.socket)
2419
2573
            def socket_wrapper(*args, **kwargs):
2431
2585
        # socket_wrapper(), if socketfd was set.
2432
2586
        socketserver.TCPServer.__init__(self, server_address,
2433
2587
                                        RequestHandlerClass)
2434
 
    
 
2588
 
2435
2589
    def server_bind(self):
2436
2590
        """This overrides the normal server_bind() function
2437
2591
        to bind to an interface if one was specified, and also NOT to
2438
2592
        bind to an address or port if they were not specified."""
 
2593
        global SO_BINDTODEVICE
2439
2594
        if self.interface is not None:
2440
2595
            if SO_BINDTODEVICE is None:
2441
 
                logger.error("SO_BINDTODEVICE does not exist;"
2442
 
                             " cannot bind to interface %s",
2443
 
                             self.interface)
2444
 
            else:
2445
 
                try:
2446
 
                    self.socket.setsockopt(
2447
 
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
2448
 
                        (self.interface + "\0").encode("utf-8"))
2449
 
                except socket.error as error:
2450
 
                    if error.errno == errno.EPERM:
2451
 
                        logger.error("No permission to bind to"
2452
 
                                     " interface %s", self.interface)
2453
 
                    elif error.errno == errno.ENOPROTOOPT:
2454
 
                        logger.error("SO_BINDTODEVICE not available;"
2455
 
                                     " cannot bind to interface %s",
2456
 
                                     self.interface)
2457
 
                    elif error.errno == errno.ENODEV:
2458
 
                        logger.error("Interface %s does not exist,"
2459
 
                                     " cannot bind", self.interface)
2460
 
                    else:
2461
 
                        raise
 
2596
                # Fall back to a hard-coded value which seems to be
 
2597
                # common enough.
 
2598
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
2599
                SO_BINDTODEVICE = 25
 
2600
            try:
 
2601
                self.socket.setsockopt(
 
2602
                    socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2603
                    (self.interface + "\0").encode("utf-8"))
 
2604
            except socket.error as error:
 
2605
                if error.errno == errno.EPERM:
 
2606
                    logger.error("No permission to bind to"
 
2607
                                 " interface %s", self.interface)
 
2608
                elif error.errno == errno.ENOPROTOOPT:
 
2609
                    logger.error("SO_BINDTODEVICE not available;"
 
2610
                                 " cannot bind to interface %s",
 
2611
                                 self.interface)
 
2612
                elif error.errno == errno.ENODEV:
 
2613
                    logger.error("Interface %s does not exist,"
 
2614
                                 " cannot bind", self.interface)
 
2615
                else:
 
2616
                    raise
2462
2617
        # Only bind(2) the socket if we really need to.
2463
2618
        if self.server_address[0] or self.server_address[1]:
2464
2619
            if not self.server_address[0]:
2465
2620
                if self.address_family == socket.AF_INET6:
2466
 
                    any_address = "::" # in6addr_any
 
2621
                    any_address = "::"  # in6addr_any
2467
2622
                else:
2468
 
                    any_address = "0.0.0.0" # INADDR_ANY
 
2623
                    any_address = "0.0.0.0"  # INADDR_ANY
2469
2624
                self.server_address = (any_address,
2470
2625
                                       self.server_address[1])
2471
2626
            elif not self.server_address[1]:
2481
2636
 
2482
2637
class MandosServer(IPv6_TCPServer):
2483
2638
    """Mandos server.
2484
 
    
 
2639
 
2485
2640
    Attributes:
2486
2641
        clients:        set of Client objects
2487
2642
        gnutls_priority GnuTLS priority string
2488
2643
        use_dbus:       Boolean; to emit D-Bus signals or not
2489
 
    
2490
 
    Assumes a GObject.MainLoop event loop.
 
2644
 
 
2645
    Assumes a GLib.MainLoop event loop.
2491
2646
    """
2492
 
    
 
2647
 
2493
2648
    def __init__(self, server_address, RequestHandlerClass,
2494
2649
                 interface=None,
2495
2650
                 use_ipv6=True,
2505
2660
        self.gnutls_priority = gnutls_priority
2506
2661
        IPv6_TCPServer.__init__(self, server_address,
2507
2662
                                RequestHandlerClass,
2508
 
                                interface = interface,
2509
 
                                use_ipv6 = use_ipv6,
2510
 
                                socketfd = socketfd)
2511
 
    
 
2663
                                interface=interface,
 
2664
                                use_ipv6=use_ipv6,
 
2665
                                socketfd=socketfd)
 
2666
 
2512
2667
    def server_activate(self):
2513
2668
        if self.enabled:
2514
2669
            return socketserver.TCPServer.server_activate(self)
2515
 
    
 
2670
 
2516
2671
    def enable(self):
2517
2672
        self.enabled = True
2518
 
    
 
2673
 
2519
2674
    def add_pipe(self, parent_pipe, proc):
2520
2675
        # Call "handle_ipc" for both data and EOF events
2521
 
        GObject.io_add_watch(
 
2676
        GLib.io_add_watch(
2522
2677
            parent_pipe.fileno(),
2523
 
            GObject.IO_IN | GObject.IO_HUP,
 
2678
            GLib.IO_IN | GLib.IO_HUP,
2524
2679
            functools.partial(self.handle_ipc,
2525
 
                              parent_pipe = parent_pipe,
2526
 
                              proc = proc))
2527
 
    
 
2680
                              parent_pipe=parent_pipe,
 
2681
                              proc=proc))
 
2682
 
2528
2683
    def handle_ipc(self, source, condition,
2529
2684
                   parent_pipe=None,
2530
 
                   proc = None,
 
2685
                   proc=None,
2531
2686
                   client_object=None):
2532
2687
        # error, or the other end of multiprocessing.Pipe has closed
2533
 
        if condition & (GObject.IO_ERR | GObject.IO_HUP):
 
2688
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
2534
2689
            # Wait for other process to exit
2535
2690
            proc.join()
2536
2691
            return False
2537
 
        
 
2692
 
2538
2693
        # Read a request from the child
2539
2694
        request = parent_pipe.recv()
2540
2695
        command = request[0]
2541
 
        
 
2696
 
2542
2697
        if command == 'init':
2543
 
            fpr = request[1]
2544
 
            address = request[2]
2545
 
            
 
2698
            key_id = request[1].decode("ascii")
 
2699
            fpr = request[2].decode("ascii")
 
2700
            address = request[3]
 
2701
 
2546
2702
            for c in self.clients.values():
2547
 
                if c.fingerprint == fpr:
 
2703
                if key_id and c.key_id == key_id:
 
2704
                    client = c
 
2705
                    break
 
2706
                if fpr and c.fingerprint == fpr:
2548
2707
                    client = c
2549
2708
                    break
2550
2709
            else:
2551
 
                logger.info("Client not found for fingerprint: %s, ad"
2552
 
                            "dress: %s", fpr, address)
 
2710
                logger.info("Client not found for key ID: %s, address"
 
2711
                            ": %s", key_id or fpr, address)
2553
2712
                if self.use_dbus:
2554
2713
                    # Emit D-Bus signal
2555
 
                    mandos_dbus_service.ClientNotFound(fpr,
 
2714
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2556
2715
                                                       address[0])
2557
2716
                parent_pipe.send(False)
2558
2717
                return False
2559
 
            
2560
 
            GObject.io_add_watch(
 
2718
 
 
2719
            GLib.io_add_watch(
2561
2720
                parent_pipe.fileno(),
2562
 
                GObject.IO_IN | GObject.IO_HUP,
 
2721
                GLib.IO_IN | GLib.IO_HUP,
2563
2722
                functools.partial(self.handle_ipc,
2564
 
                                  parent_pipe = parent_pipe,
2565
 
                                  proc = proc,
2566
 
                                  client_object = client))
 
2723
                                  parent_pipe=parent_pipe,
 
2724
                                  proc=proc,
 
2725
                                  client_object=client))
2567
2726
            parent_pipe.send(True)
2568
2727
            # remove the old hook in favor of the new above hook on
2569
2728
            # same fileno
2572
2731
            funcname = request[1]
2573
2732
            args = request[2]
2574
2733
            kwargs = request[3]
2575
 
            
 
2734
 
2576
2735
            parent_pipe.send(('data', getattr(client_object,
2577
2736
                                              funcname)(*args,
2578
2737
                                                        **kwargs)))
2579
 
        
 
2738
 
2580
2739
        if command == 'getattr':
2581
2740
            attrname = request[1]
2582
2741
            if isinstance(client_object.__getattribute__(attrname),
2585
2744
            else:
2586
2745
                parent_pipe.send((
2587
2746
                    'data', client_object.__getattribute__(attrname)))
2588
 
        
 
2747
 
2589
2748
        if command == 'setattr':
2590
2749
            attrname = request[1]
2591
2750
            value = request[2]
2592
2751
            setattr(client_object, attrname, value)
2593
 
        
 
2752
 
2594
2753
        return True
2595
2754
 
2596
2755
 
2597
2756
def rfc3339_duration_to_delta(duration):
2598
2757
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2599
 
    
 
2758
 
2600
2759
    >>> rfc3339_duration_to_delta("P7D")
2601
2760
    datetime.timedelta(7)
2602
2761
    >>> rfc3339_duration_to_delta("PT60S")
2612
2771
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2613
2772
    datetime.timedelta(1, 200)
2614
2773
    """
2615
 
    
 
2774
 
2616
2775
    # Parsing an RFC 3339 duration with regular expressions is not
2617
2776
    # possible - there would have to be multiple places for the same
2618
2777
    # values, like seconds.  The current code, while more esoteric, is
2619
2778
    # cleaner without depending on a parsing library.  If Python had a
2620
2779
    # built-in library for parsing we would use it, but we'd like to
2621
2780
    # avoid excessive use of external libraries.
2622
 
    
 
2781
 
2623
2782
    # New type for defining tokens, syntax, and semantics all-in-one
2624
2783
    Token = collections.namedtuple("Token", (
2625
2784
        "regexp",  # To match token; if "value" is not None, must have
2658
2817
                           frozenset((token_year, token_month,
2659
2818
                                      token_day, token_time,
2660
2819
                                      token_week)))
2661
 
    # Define starting values
2662
 
    value = datetime.timedelta() # Value so far
 
2820
    # Define starting values:
 
2821
    # Value so far
 
2822
    value = datetime.timedelta()
2663
2823
    found_token = None
2664
 
    followers = frozenset((token_duration, )) # Following valid tokens
2665
 
    s = duration                # String left to parse
 
2824
    # Following valid tokens
 
2825
    followers = frozenset((token_duration, ))
 
2826
    # String left to parse
 
2827
    s = duration
2666
2828
    # Loop until end token is found
2667
2829
    while found_token is not token_end:
2668
2830
        # Search for any currently valid tokens
2692
2854
 
2693
2855
def string_to_delta(interval):
2694
2856
    """Parse a string and return a datetime.timedelta
2695
 
    
 
2857
 
2696
2858
    >>> string_to_delta('7d')
2697
2859
    datetime.timedelta(7)
2698
2860
    >>> string_to_delta('60s')
2706
2868
    >>> string_to_delta('5m 30s')
2707
2869
    datetime.timedelta(0, 330)
2708
2870
    """
2709
 
    
 
2871
 
2710
2872
    try:
2711
2873
        return rfc3339_duration_to_delta(interval)
2712
2874
    except ValueError:
2713
2875
        pass
2714
 
    
 
2876
 
2715
2877
    timevalue = datetime.timedelta(0)
2716
2878
    for s in interval.split():
2717
2879
        try:
2735
2897
    return timevalue
2736
2898
 
2737
2899
 
2738
 
def daemon(nochdir = False, noclose = False):
 
2900
def daemon(nochdir=False, noclose=False):
2739
2901
    """See daemon(3).  Standard BSD Unix function.
2740
 
    
 
2902
 
2741
2903
    This should really exist as os.daemon, but it doesn't (yet)."""
2742
2904
    if os.fork():
2743
2905
        sys.exit()
2761
2923
 
2762
2924
 
2763
2925
def main():
2764
 
    
 
2926
 
2765
2927
    ##################################################################
2766
2928
    # Parsing of options, both command line and config file
2767
 
    
 
2929
 
2768
2930
    parser = argparse.ArgumentParser()
2769
2931
    parser.add_argument("-v", "--version", action="version",
2770
 
                        version = "%(prog)s {}".format(version),
 
2932
                        version="%(prog)s {}".format(version),
2771
2933
                        help="show version number and exit")
2772
2934
    parser.add_argument("-i", "--interface", metavar="IF",
2773
2935
                        help="Bind to interface IF")
2809
2971
    parser.add_argument("--no-zeroconf", action="store_false",
2810
2972
                        dest="zeroconf", help="Do not use Zeroconf",
2811
2973
                        default=None)
2812
 
    
 
2974
 
2813
2975
    options = parser.parse_args()
2814
 
    
 
2976
 
2815
2977
    if options.check:
2816
2978
        import doctest
2817
2979
        fail_count, test_count = doctest.testmod()
2818
2980
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2819
 
    
 
2981
 
2820
2982
    # Default values for config file for server-global settings
2821
 
    server_defaults = { "interface": "",
2822
 
                        "address": "",
2823
 
                        "port": "",
2824
 
                        "debug": "False",
2825
 
                        "priority":
2826
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2827
 
                        ":+SIGN-DSA-SHA256",
2828
 
                        "servicename": "Mandos",
2829
 
                        "use_dbus": "True",
2830
 
                        "use_ipv6": "True",
2831
 
                        "debuglevel": "",
2832
 
                        "restore": "True",
2833
 
                        "socket": "",
2834
 
                        "statedir": "/var/lib/mandos",
2835
 
                        "foreground": "False",
2836
 
                        "zeroconf": "True",
2837
 
                    }
2838
 
    
 
2983
    if gnutls.has_rawpk:
 
2984
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
 
2985
                    ":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
 
2986
    else:
 
2987
        priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2988
                    ":+SIGN-DSA-SHA256")
 
2989
    server_defaults = {"interface": "",
 
2990
                       "address": "",
 
2991
                       "port": "",
 
2992
                       "debug": "False",
 
2993
                       "priority": priority,
 
2994
                       "servicename": "Mandos",
 
2995
                       "use_dbus": "True",
 
2996
                       "use_ipv6": "True",
 
2997
                       "debuglevel": "",
 
2998
                       "restore": "True",
 
2999
                       "socket": "",
 
3000
                       "statedir": "/var/lib/mandos",
 
3001
                       "foreground": "False",
 
3002
                       "zeroconf": "True",
 
3003
                       }
 
3004
    del priority
 
3005
 
2839
3006
    # Parse config file for server-global settings
2840
3007
    server_config = configparser.SafeConfigParser(server_defaults)
2841
3008
    del server_defaults
2843
3010
    # Convert the SafeConfigParser object to a dict
2844
3011
    server_settings = server_config.defaults()
2845
3012
    # Use the appropriate methods on the non-string config options
2846
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
3013
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
3014
                   "foreground", "zeroconf"):
2847
3015
        server_settings[option] = server_config.getboolean("DEFAULT",
2848
3016
                                                           option)
2849
3017
    if server_settings["port"]:
2859
3027
            server_settings["socket"] = os.dup(server_settings
2860
3028
                                               ["socket"])
2861
3029
    del server_config
2862
 
    
 
3030
 
2863
3031
    # Override the settings from the config file with command line
2864
3032
    # options, if set.
2865
3033
    for option in ("interface", "address", "port", "debug",
2883
3051
    if server_settings["debug"]:
2884
3052
        server_settings["foreground"] = True
2885
3053
    # Now we have our good server settings in "server_settings"
2886
 
    
 
3054
 
2887
3055
    ##################################################################
2888
 
    
 
3056
 
2889
3057
    if (not server_settings["zeroconf"]
2890
3058
        and not (server_settings["port"]
2891
3059
                 or server_settings["socket"] != "")):
2892
3060
        parser.error("Needs port or socket to work without Zeroconf")
2893
 
    
 
3061
 
2894
3062
    # For convenience
2895
3063
    debug = server_settings["debug"]
2896
3064
    debuglevel = server_settings["debuglevel"]
2900
3068
                                     stored_state_file)
2901
3069
    foreground = server_settings["foreground"]
2902
3070
    zeroconf = server_settings["zeroconf"]
2903
 
    
 
3071
 
2904
3072
    if debug:
2905
3073
        initlogger(debug, logging.DEBUG)
2906
3074
    else:
2909
3077
        else:
2910
3078
            level = getattr(logging, debuglevel.upper())
2911
3079
            initlogger(debug, level)
2912
 
    
 
3080
 
2913
3081
    if server_settings["servicename"] != "Mandos":
2914
3082
        syslogger.setFormatter(
2915
3083
            logging.Formatter('Mandos ({}) [%(process)d]:'
2916
3084
                              ' %(levelname)s: %(message)s'.format(
2917
3085
                                  server_settings["servicename"])))
2918
 
    
 
3086
 
2919
3087
    # Parse config file with clients
2920
3088
    client_config = configparser.SafeConfigParser(Client
2921
3089
                                                  .client_defaults)
2922
3090
    client_config.read(os.path.join(server_settings["configdir"],
2923
3091
                                    "clients.conf"))
2924
 
    
 
3092
 
2925
3093
    global mandos_dbus_service
2926
3094
    mandos_dbus_service = None
2927
 
    
 
3095
 
2928
3096
    socketfd = None
2929
3097
    if server_settings["socket"] != "":
2930
3098
        socketfd = server_settings["socket"]
2946
3114
        except IOError as e:
2947
3115
            logger.error("Could not open file %r", pidfilename,
2948
3116
                         exc_info=e)
2949
 
    
 
3117
 
2950
3118
    for name, group in (("_mandos", "_mandos"),
2951
3119
                        ("mandos", "mandos"),
2952
3120
                        ("nobody", "nogroup")):
2970
3138
                       .format(uid, gid, os.strerror(error.errno)))
2971
3139
        if error.errno != errno.EPERM:
2972
3140
            raise
2973
 
    
 
3141
 
2974
3142
    if debug:
2975
3143
        # Enable all possible GnuTLS debugging
2976
 
        
 
3144
 
2977
3145
        # "Use a log level over 10 to enable all debugging options."
2978
3146
        # - GnuTLS manual
2979
3147
        gnutls.global_set_log_level(11)
2980
 
        
 
3148
 
2981
3149
        @gnutls.log_func
2982
3150
        def debug_gnutls(level, string):
2983
3151
            logger.debug("GnuTLS: %s", string[:-1])
2984
 
        
 
3152
 
2985
3153
        gnutls.global_set_log_function(debug_gnutls)
2986
 
        
 
3154
 
2987
3155
        # Redirect stdin so all checkers get /dev/null
2988
3156
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2989
3157
        os.dup2(null, sys.stdin.fileno())
2990
3158
        if null > 2:
2991
3159
            os.close(null)
2992
 
    
 
3160
 
2993
3161
    # Need to fork before connecting to D-Bus
2994
3162
    if not foreground:
2995
3163
        # Close all input and output, do double fork, etc.
2996
3164
        daemon()
2997
 
    
2998
 
    # multiprocessing will use threads, so before we use GObject we
2999
 
    # need to inform GObject that threads will be used.
3000
 
    GObject.threads_init()
3001
 
    
 
3165
 
 
3166
    # multiprocessing will use threads, so before we use GLib we need
 
3167
    # to inform GLib that threads will be used.
 
3168
    GLib.threads_init()
 
3169
 
3002
3170
    global main_loop
3003
3171
    # From the Avahi example code
3004
3172
    DBusGMainLoop(set_as_default=True)
3005
 
    main_loop = GObject.MainLoop()
 
3173
    main_loop = GLib.MainLoop()
3006
3174
    bus = dbus.SystemBus()
3007
3175
    # End of Avahi example code
3008
3176
    if use_dbus:
3021
3189
    if zeroconf:
3022
3190
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3023
3191
        service = AvahiServiceToSyslog(
3024
 
            name = server_settings["servicename"],
3025
 
            servicetype = "_mandos._tcp",
3026
 
            protocol = protocol,
3027
 
            bus = bus)
 
3192
            name=server_settings["servicename"],
 
3193
            servicetype="_mandos._tcp",
 
3194
            protocol=protocol,
 
3195
            bus=bus)
3028
3196
        if server_settings["interface"]:
3029
3197
            service.interface = if_nametoindex(
3030
3198
                server_settings["interface"].encode("utf-8"))
3031
 
    
 
3199
 
3032
3200
    global multiprocessing_manager
3033
3201
    multiprocessing_manager = multiprocessing.Manager()
3034
 
    
 
3202
 
3035
3203
    client_class = Client
3036
3204
    if use_dbus:
3037
 
        client_class = functools.partial(ClientDBus, bus = bus)
3038
 
    
 
3205
        client_class = functools.partial(ClientDBus, bus=bus)
 
3206
 
3039
3207
    client_settings = Client.config_parser(client_config)
3040
3208
    old_client_settings = {}
3041
3209
    clients_data = {}
3042
 
    
 
3210
 
3043
3211
    # This is used to redirect stdout and stderr for checker processes
3044
3212
    global wnull
3045
 
    wnull = open(os.devnull, "w") # A writable /dev/null
 
3213
    wnull = open(os.devnull, "w")  # A writable /dev/null
3046
3214
    # Only used if server is running in foreground but not in debug
3047
3215
    # mode
3048
3216
    if debug or not foreground:
3049
3217
        wnull.close()
3050
 
    
 
3218
 
3051
3219
    # Get client data and settings from last running state.
3052
3220
    if server_settings["restore"]:
3053
3221
        try:
3054
3222
            with open(stored_state_path, "rb") as stored_state:
3055
 
                if sys.version_info.major == 2:                
 
3223
                if sys.version_info.major == 2:
3056
3224
                    clients_data, old_client_settings = pickle.load(
3057
3225
                        stored_state)
3058
3226
                else:
3059
3227
                    bytes_clients_data, bytes_old_client_settings = (
3060
 
                        pickle.load(stored_state, encoding = "bytes"))
3061
 
                    ### Fix bytes to strings
3062
 
                    ## clients_data
 
3228
                        pickle.load(stored_state, encoding="bytes"))
 
3229
                    #   Fix bytes to strings
 
3230
                    #  clients_data
3063
3231
                    # .keys()
3064
 
                    clients_data = { (key.decode("utf-8")
3065
 
                                      if isinstance(key, bytes)
3066
 
                                      else key): value
3067
 
                                     for key, value in
3068
 
                                     bytes_clients_data.items() }
 
3232
                    clients_data = {(key.decode("utf-8")
 
3233
                                     if isinstance(key, bytes)
 
3234
                                     else key): value
 
3235
                                    for key, value in
 
3236
                                    bytes_clients_data.items()}
3069
3237
                    del bytes_clients_data
3070
3238
                    for key in clients_data:
3071
 
                        value = { (k.decode("utf-8")
3072
 
                                   if isinstance(k, bytes) else k): v
3073
 
                                  for k, v in
3074
 
                                  clients_data[key].items() }
 
3239
                        value = {(k.decode("utf-8")
 
3240
                                  if isinstance(k, bytes) else k): v
 
3241
                                 for k, v in
 
3242
                                 clients_data[key].items()}
3075
3243
                        clients_data[key] = value
3076
3244
                        # .client_structure
3077
3245
                        value["client_structure"] = [
3078
3246
                            (s.decode("utf-8")
3079
3247
                             if isinstance(s, bytes)
3080
3248
                             else s) for s in
3081
 
                            value["client_structure"] ]
 
3249
                            value["client_structure"]]
3082
3250
                        # .name & .host
3083
3251
                        for k in ("name", "host"):
3084
3252
                            if isinstance(value[k], bytes):
3085
3253
                                value[k] = value[k].decode("utf-8")
3086
 
                    ## old_client_settings
 
3254
                        if not value.has_key("key_id"):
 
3255
                            value["key_id"] = ""
 
3256
                        elif not value.has_key("fingerprint"):
 
3257
                            value["fingerprint"] = ""
 
3258
                    #  old_client_settings
3087
3259
                    # .keys()
3088
3260
                    old_client_settings = {
3089
3261
                        (key.decode("utf-8")
3090
3262
                         if isinstance(key, bytes)
3091
3263
                         else key): value
3092
3264
                        for key, value in
3093
 
                        bytes_old_client_settings.items() }
 
3265
                        bytes_old_client_settings.items()}
3094
3266
                    del bytes_old_client_settings
3095
3267
                    # .host
3096
3268
                    for value in old_client_settings.values():
3110
3282
            logger.warning("Could not load persistent state: "
3111
3283
                           "EOFError:",
3112
3284
                           exc_info=e)
3113
 
    
 
3285
 
3114
3286
    with PGPEngine() as pgp:
3115
3287
        for client_name, client in clients_data.items():
3116
3288
            # Skip removed clients
3117
3289
            if client_name not in client_settings:
3118
3290
                continue
3119
 
            
 
3291
 
3120
3292
            # Decide which value to use after restoring saved state.
3121
3293
            # We have three different values: Old config file,
3122
3294
            # new config file, and saved state.
3133
3305
                        client[name] = value
3134
3306
                except KeyError:
3135
3307
                    pass
3136
 
            
 
3308
 
3137
3309
            # Clients who has passed its expire date can still be
3138
3310
            # enabled if its last checker was successful.  A Client
3139
3311
            # whose checker succeeded before we stored its state is
3172
3344
                    client_name))
3173
3345
                client["secret"] = (client_settings[client_name]
3174
3346
                                    ["secret"])
3175
 
    
 
3347
 
3176
3348
    # Add/remove clients based on new changes made to config
3177
3349
    for client_name in (set(old_client_settings)
3178
3350
                        - set(client_settings)):
3180
3352
    for client_name in (set(client_settings)
3181
3353
                        - set(old_client_settings)):
3182
3354
        clients_data[client_name] = client_settings[client_name]
3183
 
    
 
3355
 
3184
3356
    # Create all client objects
3185
3357
    for client_name, client in clients_data.items():
3186
3358
        tcp_server.clients[client_name] = client_class(
3187
 
            name = client_name,
3188
 
            settings = client,
3189
 
            server_settings = server_settings)
3190
 
    
 
3359
            name=client_name,
 
3360
            settings=client,
 
3361
            server_settings=server_settings)
 
3362
 
3191
3363
    if not tcp_server.clients:
3192
3364
        logger.warning("No clients defined")
3193
 
    
 
3365
 
3194
3366
    if not foreground:
3195
3367
        if pidfile is not None:
3196
3368
            pid = os.getpid()
3202
3374
                             pidfilename, pid)
3203
3375
        del pidfile
3204
3376
        del pidfilename
3205
 
    
3206
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
3207
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3208
 
    
 
3377
 
 
3378
    for termsig in (signal.SIGHUP, signal.SIGTERM):
 
3379
        GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
 
3380
                             lambda: main_loop.quit() and False)
 
3381
 
3209
3382
    if use_dbus:
3210
 
        
 
3383
 
3211
3384
        @alternate_dbus_interfaces(
3212
 
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
3385
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3213
3386
        class MandosDBusService(DBusObjectWithObjectManager):
3214
3387
            """A D-Bus proxy object"""
3215
 
            
 
3388
 
3216
3389
            def __init__(self):
3217
3390
                dbus.service.Object.__init__(self, bus, "/")
3218
 
            
 
3391
 
3219
3392
            _interface = "se.recompile.Mandos"
3220
 
            
 
3393
 
3221
3394
            @dbus.service.signal(_interface, signature="o")
3222
3395
            def ClientAdded(self, objpath):
3223
3396
                "D-Bus signal"
3224
3397
                pass
3225
 
            
 
3398
 
3226
3399
            @dbus.service.signal(_interface, signature="ss")
3227
 
            def ClientNotFound(self, fingerprint, address):
 
3400
            def ClientNotFound(self, key_id, address):
3228
3401
                "D-Bus signal"
3229
3402
                pass
3230
 
            
 
3403
 
3231
3404
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3232
3405
                               "true"})
3233
3406
            @dbus.service.signal(_interface, signature="os")
3234
3407
            def ClientRemoved(self, objpath, name):
3235
3408
                "D-Bus signal"
3236
3409
                pass
3237
 
            
 
3410
 
3238
3411
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3239
3412
                               "true"})
3240
3413
            @dbus.service.method(_interface, out_signature="ao")
3242
3415
                "D-Bus method"
3243
3416
                return dbus.Array(c.dbus_object_path for c in
3244
3417
                                  tcp_server.clients.values())
3245
 
            
 
3418
 
3246
3419
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3247
3420
                               "true"})
3248
3421
            @dbus.service.method(_interface,
3250
3423
            def GetAllClientsWithProperties(self):
3251
3424
                "D-Bus method"
3252
3425
                return dbus.Dictionary(
3253
 
                    { c.dbus_object_path: c.GetAll(
 
3426
                    {c.dbus_object_path: c.GetAll(
3254
3427
                        "se.recompile.Mandos.Client")
3255
 
                      for c in tcp_server.clients.values() },
 
3428
                     for c in tcp_server.clients.values()},
3256
3429
                    signature="oa{sv}")
3257
 
            
 
3430
 
3258
3431
            @dbus.service.method(_interface, in_signature="o")
3259
3432
            def RemoveClient(self, object_path):
3260
3433
                "D-Bus method"
3268
3441
                        self.client_removed_signal(c)
3269
3442
                        return
3270
3443
                raise KeyError(object_path)
3271
 
            
 
3444
 
3272
3445
            del _interface
3273
 
            
 
3446
 
3274
3447
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3275
 
                                 out_signature = "a{oa{sa{sv}}}")
 
3448
                                 out_signature="a{oa{sa{sv}}}")
3276
3449
            def GetManagedObjects(self):
3277
3450
                """D-Bus method"""
3278
3451
                return dbus.Dictionary(
3279
 
                    { client.dbus_object_path:
3280
 
                      dbus.Dictionary(
3281
 
                          { interface: client.GetAll(interface)
3282
 
                            for interface in
3283
 
                                 client._get_all_interface_names()})
3284
 
                      for client in tcp_server.clients.values()})
3285
 
            
 
3452
                    {client.dbus_object_path:
 
3453
                     dbus.Dictionary(
 
3454
                         {interface: client.GetAll(interface)
 
3455
                          for interface in
 
3456
                          client._get_all_interface_names()})
 
3457
                     for client in tcp_server.clients.values()})
 
3458
 
3286
3459
            def client_added_signal(self, client):
3287
3460
                """Send the new standard signal and the old signal"""
3288
3461
                if use_dbus:
3290
3463
                    self.InterfacesAdded(
3291
3464
                        client.dbus_object_path,
3292
3465
                        dbus.Dictionary(
3293
 
                            { interface: client.GetAll(interface)
3294
 
                              for interface in
3295
 
                              client._get_all_interface_names()}))
 
3466
                            {interface: client.GetAll(interface)
 
3467
                             for interface in
 
3468
                             client._get_all_interface_names()}))
3296
3469
                    # Old signal
3297
3470
                    self.ClientAdded(client.dbus_object_path)
3298
 
            
 
3471
 
3299
3472
            def client_removed_signal(self, client):
3300
3473
                """Send the new standard signal and the old signal"""
3301
3474
                if use_dbus:
3306
3479
                    # Old signal
3307
3480
                    self.ClientRemoved(client.dbus_object_path,
3308
3481
                                       client.name)
3309
 
        
 
3482
 
3310
3483
        mandos_dbus_service = MandosDBusService()
3311
 
    
 
3484
 
 
3485
    # Save modules to variables to exempt the modules from being
 
3486
    # unloaded before the function registered with atexit() is run.
 
3487
    mp = multiprocessing
 
3488
    wn = wnull
 
3489
 
3312
3490
    def cleanup():
3313
3491
        "Cleanup function; run on exit"
3314
3492
        if zeroconf:
3315
3493
            service.cleanup()
3316
 
        
3317
 
        multiprocessing.active_children()
3318
 
        wnull.close()
 
3494
 
 
3495
        mp.active_children()
 
3496
        wn.close()
3319
3497
        if not (tcp_server.clients or client_settings):
3320
3498
            return
3321
 
        
 
3499
 
3322
3500
        # Store client before exiting. Secrets are encrypted with key
3323
3501
        # based on what config file has. If config file is
3324
3502
        # removed/edited, old secret will thus be unrecovable.
3329
3507
                client.encrypted_secret = pgp.encrypt(client.secret,
3330
3508
                                                      key)
3331
3509
                client_dict = {}
3332
 
                
 
3510
 
3333
3511
                # A list of attributes that can not be pickled
3334
3512
                # + secret.
3335
 
                exclude = { "bus", "changedstate", "secret",
3336
 
                            "checker", "server_settings" }
 
3513
                exclude = {"bus", "changedstate", "secret",
 
3514
                           "checker", "server_settings"}
3337
3515
                for name, typ in inspect.getmembers(dbus.service
3338
3516
                                                    .Object):
3339
3517
                    exclude.add(name)
3340
 
                
 
3518
 
3341
3519
                client_dict["encrypted_secret"] = (client
3342
3520
                                                   .encrypted_secret)
3343
3521
                for attr in client.client_structure:
3344
3522
                    if attr not in exclude:
3345
3523
                        client_dict[attr] = getattr(client, attr)
3346
 
                
 
3524
 
3347
3525
                clients[client.name] = client_dict
3348
3526
                del client_settings[client.name]["secret"]
3349
 
        
 
3527
 
3350
3528
        try:
3351
3529
            with tempfile.NamedTemporaryFile(
3352
3530
                    mode='wb',
3355
3533
                    dir=os.path.dirname(stored_state_path),
3356
3534
                    delete=False) as stored_state:
3357
3535
                pickle.dump((clients, client_settings), stored_state,
3358
 
                            protocol = 2)
 
3536
                            protocol=2)
3359
3537
                tempname = stored_state.name
3360
3538
            os.rename(tempname, stored_state_path)
3361
3539
        except (IOError, OSError) as e:
3371
3549
                logger.warning("Could not save persistent state:",
3372
3550
                               exc_info=e)
3373
3551
                raise
3374
 
        
 
3552
 
3375
3553
        # Delete all clients, and settings from config
3376
3554
        while tcp_server.clients:
3377
3555
            name, client = tcp_server.clients.popitem()
3383
3561
            if use_dbus:
3384
3562
                mandos_dbus_service.client_removed_signal(client)
3385
3563
        client_settings.clear()
3386
 
    
 
3564
 
3387
3565
    atexit.register(cleanup)
3388
 
    
 
3566
 
3389
3567
    for client in tcp_server.clients.values():
3390
3568
        if use_dbus:
3391
3569
            # Emit D-Bus signal for adding
3393
3571
        # Need to initiate checking of clients
3394
3572
        if client.enabled:
3395
3573
            client.init_checker()
3396
 
    
 
3574
 
3397
3575
    tcp_server.enable()
3398
3576
    tcp_server.server_activate()
3399
 
    
 
3577
 
3400
3578
    # Find out what port we got
3401
3579
    if zeroconf:
3402
3580
        service.port = tcp_server.socket.getsockname()[1]
3407
3585
    else:                       # IPv4
3408
3586
        logger.info("Now listening on address %r, port %d",
3409
3587
                    *tcp_server.socket.getsockname())
3410
 
    
3411
 
    #service.interface = tcp_server.socket.getsockname()[3]
3412
 
    
 
3588
 
 
3589
    # service.interface = tcp_server.socket.getsockname()[3]
 
3590
 
3413
3591
    try:
3414
3592
        if zeroconf:
3415
3593
            # From the Avahi example code
3420
3598
                cleanup()
3421
3599
                sys.exit(1)
3422
3600
            # End of Avahi example code
3423
 
        
3424
 
        GObject.io_add_watch(tcp_server.fileno(), GObject.IO_IN,
3425
 
                             lambda *args, **kwargs:
3426
 
                             (tcp_server.handle_request
3427
 
                              (*args[2:], **kwargs) or True))
3428
 
        
 
3601
 
 
3602
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3603
                          lambda *args, **kwargs:
 
3604
                          (tcp_server.handle_request
 
3605
                           (*args[2:], **kwargs) or True))
 
3606
 
3429
3607
        logger.debug("Starting main loop")
3430
3608
        main_loop.run()
3431
3609
    except AvahiError as error: