/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: 2025-06-14 15:37:45 UTC
  • Revision ID: teddy@recompile.se-20250614153745-1labvcqq11fuijy4
debian/control: Require cryptsetup support in systemd

* debian/control (Package: mandos-client/Depends): Add dependency on
  "systemd-cryptsetup" (for newer systemd), or "systemd (<< 256-2)"
  for when cryptsetup support was included in the systemd package
  itself, or "sysvinit-core" for installations without systemd.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python
2
 
# -*- mode: python; coding: utf-8 -*-
 
1
#!/usr/bin/python3 -bI
 
2
# -*- coding: utf-8; lexical-binding: t -*-
3
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
5
#
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
 
# Copyright © 2008-2018 Teddy Hogeborn
15
 
# Copyright © 2008-2018 Björn Påhlsson
 
14
# Copyright © 2008-2022 Teddy Hogeborn
 
15
# Copyright © 2008-2022 Björn Påhlsson
16
16
#
17
17
# This file is part of Mandos.
18
18
#
31
31
#
32
32
# Contact the authors at <mandos@recompile.se>.
33
33
#
34
 
 
35
34
from __future__ import (division, absolute_import, print_function,
36
35
                        unicode_literals)
37
36
 
40
39
except ImportError:
41
40
    pass
42
41
 
 
42
import sys
 
43
import unittest
 
44
import argparse
 
45
import logging
 
46
import os
43
47
try:
44
48
    import SocketServer as socketserver
45
49
except ImportError:
46
50
    import socketserver
47
51
import socket
48
 
import argparse
49
52
import datetime
50
53
import errno
51
54
try:
52
55
    import ConfigParser as configparser
53
56
except ImportError:
54
57
    import configparser
55
 
import sys
56
58
import re
57
 
import os
58
59
import signal
59
60
import subprocess
60
61
import atexit
61
62
import stat
62
 
import logging
63
63
import logging.handlers
64
64
import pwd
65
65
import contextlib
77
77
import itertools
78
78
import collections
79
79
import codecs
 
80
import random
 
81
import shlex
80
82
 
81
83
import dbus
82
84
import dbus.service
 
85
import gi
83
86
from gi.repository import GLib
84
87
from dbus.mainloop.glib import DBusGMainLoop
85
88
import ctypes
87
90
import xml.dom.minidom
88
91
import inspect
89
92
 
 
93
if sys.version_info.major == 2:
 
94
    __metaclass__ = type
 
95
    str = unicode
 
96
    input = raw_input
 
97
 
 
98
# Add collections.abc.Callable if it does not exist
 
99
try:
 
100
    collections.abc.Callable
 
101
except AttributeError:
 
102
    class abc:
 
103
        Callable = collections.Callable
 
104
    collections.abc = abc
 
105
    del abc
 
106
 
 
107
# Add shlex.quote if it does not exist
 
108
try:
 
109
    shlex.quote
 
110
except AttributeError:
 
111
    shlex.quote = re.escape
 
112
 
 
113
# Add os.set_inheritable if it does not exist
 
114
try:
 
115
    os.set_inheritable
 
116
except AttributeError:
 
117
    def set_inheritable(fd, inheritable):
 
118
        flags = fcntl.fcntl(fd, fcntl.F_GETFD)
 
119
        if inheritable and ((flags & fcntl.FD_CLOEXEC) != 0):
 
120
            fcntl.fcntl(fd, fcntl.F_SETFL, flags & ~fcntl.FD_CLOEXEC)
 
121
        elif (not inheritable) and ((flags & fcntl.FD_CLOEXEC) == 0):
 
122
            fcntl.fcntl(fd, fcntl.F_SETFL, flags | fcntl.FD_CLOEXEC)
 
123
    os.set_inheritable = set_inheritable
 
124
    del set_inheritable
 
125
 
 
126
# Show warnings by default
 
127
if not sys.warnoptions:
 
128
    import warnings
 
129
    warnings.simplefilter("default")
 
130
 
90
131
# Try to find the value of SO_BINDTODEVICE:
91
132
try:
92
133
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
112
153
            # No value found
113
154
            SO_BINDTODEVICE = None
114
155
 
115
 
if sys.version_info.major == 2:
116
 
    str = unicode
 
156
if sys.version_info < (3, 2):
 
157
    configparser.Configparser = configparser.SafeConfigParser
117
158
 
118
 
version = "1.7.19"
 
159
version = "1.8.18"
119
160
stored_state_file = "clients.pickle"
120
161
 
121
 
logger = logging.getLogger()
 
162
log = logging.getLogger(os.path.basename(sys.argv[0]))
 
163
logging.captureWarnings(True)   # Show warnings via the logging system
122
164
syslogger = None
123
165
 
124
166
try:
160
202
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
161
203
        address="/dev/log"))
162
204
    syslogger.setFormatter(logging.Formatter
163
 
                           ('Mandos [%(process)d]: %(levelname)s:'
164
 
                            ' %(message)s'))
165
 
    logger.addHandler(syslogger)
 
205
                           ("Mandos [%(process)d]: %(levelname)s:"
 
206
                            " %(message)s"))
 
207
    log.addHandler(syslogger)
166
208
 
167
209
    if debug:
168
210
        console = logging.StreamHandler()
169
 
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
170
 
                                               ' [%(process)d]:'
171
 
                                               ' %(levelname)s:'
172
 
                                               ' %(message)s'))
173
 
        logger.addHandler(console)
174
 
    logger.setLevel(level)
 
211
        console.setFormatter(logging.Formatter("%(asctime)s %(name)s"
 
212
                                               " [%(process)d]:"
 
213
                                               " %(levelname)s:"
 
214
                                               " %(message)s"))
 
215
        log.addHandler(console)
 
216
    log.setLevel(level)
175
217
 
176
218
 
177
219
class PGPError(Exception):
179
221
    pass
180
222
 
181
223
 
182
 
class PGPEngine(object):
 
224
class PGPEngine:
183
225
    """A simple class for OpenPGP symmetric encryption & decryption"""
184
226
 
185
227
    def __init__(self):
189
231
            output = subprocess.check_output(["gpgconf"])
190
232
            for line in output.splitlines():
191
233
                name, text, path = line.split(b":")
192
 
                if name == "gpg":
 
234
                if name == b"gpg":
193
235
                    self.gpg = path
194
236
                    break
195
237
        except OSError as e:
196
238
            if e.errno != errno.ENOENT:
197
239
                raise
198
 
        self.gnupgargs = ['--batch',
199
 
                          '--homedir', self.tempdir,
200
 
                          '--force-mdc',
201
 
                          '--quiet']
 
240
        self.gnupgargs = ["--batch",
 
241
                          "--homedir", self.tempdir,
 
242
                          "--force-mdc",
 
243
                          "--quiet"]
202
244
        # Only GPG version 1 has the --no-use-agent option.
203
 
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
 
245
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
204
246
            self.gnupgargs.append("--no-use-agent")
205
247
 
206
248
    def __enter__(self):
243
285
                dir=self.tempdir) as passfile:
244
286
            passfile.write(passphrase)
245
287
            passfile.flush()
246
 
            proc = subprocess.Popen([self.gpg, '--symmetric',
247
 
                                     '--passphrase-file',
 
288
            proc = subprocess.Popen([self.gpg, "--symmetric",
 
289
                                     "--passphrase-file",
248
290
                                     passfile.name]
249
291
                                    + self.gnupgargs,
250
292
                                    stdin=subprocess.PIPE,
261
303
                dir=self.tempdir) as passfile:
262
304
            passfile.write(passphrase)
263
305
            passfile.flush()
264
 
            proc = subprocess.Popen([self.gpg, '--decrypt',
265
 
                                     '--passphrase-file',
 
306
            proc = subprocess.Popen([self.gpg, "--decrypt",
 
307
                                     "--passphrase-file",
266
308
                                     passfile.name]
267
309
                                    + self.gnupgargs,
268
310
                                    stdin=subprocess.PIPE,
275
317
 
276
318
 
277
319
# Pretend that we have an Avahi module
278
 
class Avahi(object):
279
 
    """This isn't so much a class as it is a module-like namespace.
280
 
    It is instantiated once, and simulates having an Avahi module."""
 
320
class avahi:
 
321
    """This isn't so much a class as it is a module-like namespace."""
281
322
    IF_UNSPEC = -1               # avahi-common/address.h
282
323
    PROTO_UNSPEC = -1            # avahi-common/address.h
283
324
    PROTO_INET = 0               # avahi-common/address.h
287
328
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
288
329
    DBUS_PATH_SERVER = "/"
289
330
 
290
 
    def string_array_to_txt_array(self, t):
 
331
    @staticmethod
 
332
    def string_array_to_txt_array(t):
291
333
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
292
334
                           for s in t), signature="ay")
293
335
    ENTRY_GROUP_ESTABLISHED = 2  # avahi-common/defs.h
298
340
    SERVER_RUNNING = 2           # avahi-common/defs.h
299
341
    SERVER_COLLISION = 3         # avahi-common/defs.h
300
342
    SERVER_FAILURE = 4           # avahi-common/defs.h
301
 
avahi = Avahi()
302
343
 
303
344
 
304
345
class AvahiError(Exception):
316
357
    pass
317
358
 
318
359
 
319
 
class AvahiService(object):
 
360
class AvahiService:
320
361
    """An Avahi (Zeroconf) service.
321
362
 
322
363
    Attributes:
323
364
    interface: integer; avahi.IF_UNSPEC or an interface index.
324
365
               Used to optionally bind to the specified interface.
325
 
    name: string; Example: 'Mandos'
326
 
    type: string; Example: '_mandos._tcp'.
 
366
    name: string; Example: "Mandos"
 
367
    type: string; Example: "_mandos._tcp".
327
368
     See <https://www.iana.org/assignments/service-names-port-numbers>
328
369
    port: integer; what port to announce
329
370
    TXT: list of strings; TXT record for the service
366
407
    def rename(self, remove=True):
367
408
        """Derived from the Avahi example code"""
368
409
        if self.rename_count >= self.max_renames:
369
 
            logger.critical("No suitable Zeroconf service name found"
370
 
                            " after %i retries, exiting.",
371
 
                            self.rename_count)
 
410
            log.critical("No suitable Zeroconf service name found"
 
411
                         " after %i retries, exiting.",
 
412
                         self.rename_count)
372
413
            raise AvahiServiceError("Too many renames")
373
414
        self.name = str(
374
415
            self.server.GetAlternativeServiceName(self.name))
375
416
        self.rename_count += 1
376
 
        logger.info("Changing Zeroconf service name to %r ...",
377
 
                    self.name)
 
417
        log.info("Changing Zeroconf service name to %r ...",
 
418
                 self.name)
378
419
        if remove:
379
420
            self.remove()
380
421
        try:
382
423
        except dbus.exceptions.DBusException as error:
383
424
            if (error.get_dbus_name()
384
425
                == "org.freedesktop.Avahi.CollisionError"):
385
 
                logger.info("Local Zeroconf service name collision.")
 
426
                log.info("Local Zeroconf service name collision.")
386
427
                return self.rename(remove=False)
387
428
            else:
388
 
                logger.critical("D-Bus Exception", exc_info=error)
 
429
                log.critical("D-Bus Exception", exc_info=error)
389
430
                self.cleanup()
390
431
                os._exit(1)
391
432
 
407
448
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
408
449
        self.entry_group_state_changed_match = (
409
450
            self.group.connect_to_signal(
410
 
                'StateChanged', self.entry_group_state_changed))
411
 
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
412
 
                     self.name, self.type)
 
451
                "StateChanged", self.entry_group_state_changed))
 
452
        log.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
453
                  self.name, self.type)
413
454
        self.group.AddService(
414
455
            self.interface,
415
456
            self.protocol,
422
463
 
423
464
    def entry_group_state_changed(self, state, error):
424
465
        """Derived from the Avahi example code"""
425
 
        logger.debug("Avahi entry group state change: %i", state)
 
466
        log.debug("Avahi entry group state change: %i", state)
426
467
 
427
468
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
428
 
            logger.debug("Zeroconf service established.")
 
469
            log.debug("Zeroconf service established.")
429
470
        elif state == avahi.ENTRY_GROUP_COLLISION:
430
 
            logger.info("Zeroconf service name collision.")
 
471
            log.info("Zeroconf service name collision.")
431
472
            self.rename()
432
473
        elif state == avahi.ENTRY_GROUP_FAILURE:
433
 
            logger.critical("Avahi: Error in group state changed %s",
434
 
                            str(error))
 
474
            log.critical("Avahi: Error in group state changed %s",
 
475
                         str(error))
435
476
            raise AvahiGroupError("State changed: {!s}".format(error))
436
477
 
437
478
    def cleanup(self):
447
488
 
448
489
    def server_state_changed(self, state, error=None):
449
490
        """Derived from the Avahi example code"""
450
 
        logger.debug("Avahi server state change: %i", state)
 
491
        log.debug("Avahi server state change: %i", state)
451
492
        bad_states = {
452
493
            avahi.SERVER_INVALID: "Zeroconf server invalid",
453
494
            avahi.SERVER_REGISTERING: None,
457
498
        if state in bad_states:
458
499
            if bad_states[state] is not None:
459
500
                if error is None:
460
 
                    logger.error(bad_states[state])
 
501
                    log.error(bad_states[state])
461
502
                else:
462
 
                    logger.error(bad_states[state] + ": %r", error)
 
503
                    log.error(bad_states[state] + ": %r", error)
463
504
            self.cleanup()
464
505
        elif state == avahi.SERVER_RUNNING:
465
506
            try:
467
508
            except dbus.exceptions.DBusException as error:
468
509
                if (error.get_dbus_name()
469
510
                    == "org.freedesktop.Avahi.CollisionError"):
470
 
                    logger.info("Local Zeroconf service name"
471
 
                                " collision.")
 
511
                    log.info("Local Zeroconf service name collision.")
472
512
                    return self.rename(remove=False)
473
513
                else:
474
 
                    logger.critical("D-Bus Exception", exc_info=error)
 
514
                    log.critical("D-Bus Exception", exc_info=error)
475
515
                    self.cleanup()
476
516
                    os._exit(1)
477
517
        else:
478
518
            if error is None:
479
 
                logger.debug("Unknown state: %r", state)
 
519
                log.debug("Unknown state: %r", state)
480
520
            else:
481
 
                logger.debug("Unknown state: %r: %r", state, error)
 
521
                log.debug("Unknown state: %r: %r", state, error)
482
522
 
483
523
    def activate(self):
484
524
        """Derived from the Avahi example code"""
496
536
class AvahiServiceToSyslog(AvahiService):
497
537
    def rename(self, *args, **kwargs):
498
538
        """Add the new name to the syslog messages"""
499
 
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
 
539
        ret = super(AvahiServiceToSyslog, self).rename(*args,
 
540
                                                       **kwargs)
500
541
        syslogger.setFormatter(logging.Formatter(
501
 
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
542
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
502
543
            .format(self.name)))
503
544
        return ret
504
545
 
505
546
 
506
547
# Pretend that we have a GnuTLS module
507
 
class GnuTLS(object):
508
 
    """This isn't so much a class as it is a module-like namespace.
509
 
    It is instantiated once, and simulates having a GnuTLS module."""
 
548
class gnutls:
 
549
    """This isn't so much a class as it is a module-like namespace."""
510
550
 
511
551
    library = ctypes.util.find_library("gnutls")
512
552
    if library is None:
513
553
        library = ctypes.util.find_library("gnutls-deb0")
514
554
    _library = ctypes.cdll.LoadLibrary(library)
515
555
    del library
516
 
    _need_version = b"3.3.0"
517
 
 
518
 
    def __init__(self):
519
 
        # Need to use "self" here, since this method is called before
520
 
        # the assignment to the "gnutls" global variable happens.
521
 
        if self.check_version(self._need_version) is None:
522
 
            raise self.Error("Needs GnuTLS {} or later"
523
 
                             .format(self._need_version))
524
556
 
525
557
    # Unless otherwise indicated, the constants and types below are
526
558
    # all from the gnutls/gnutls.h C header file.
530
562
    E_INTERRUPTED = -52
531
563
    E_AGAIN = -28
532
564
    CRT_OPENPGP = 2
 
565
    CRT_RAWPK = 3
533
566
    CLIENT = 2
534
567
    SHUT_RDWR = 0
535
568
    CRD_CERTIFICATE = 1
536
569
    E_NO_CERTIFICATE_FOUND = -49
 
570
    X509_FMT_DER = 0
 
571
    NO_TICKETS = 1<<10
 
572
    ENABLE_RAWPK = 1<<18
 
573
    CTYPE_PEERS = 3
 
574
    KEYID_USE_SHA256 = 1        # gnutls/x509.h
537
575
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
538
576
 
539
577
    # Types
540
 
    class session_int(ctypes.Structure):
 
578
    class _session_int(ctypes.Structure):
541
579
        _fields_ = []
542
 
    session_t = ctypes.POINTER(session_int)
 
580
    session_t = ctypes.POINTER(_session_int)
543
581
 
544
582
    class certificate_credentials_st(ctypes.Structure):
545
583
        _fields_ = []
548
586
    certificate_type_t = ctypes.c_int
549
587
 
550
588
    class datum_t(ctypes.Structure):
551
 
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
552
 
                    ('size', ctypes.c_uint)]
 
589
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
 
590
                    ("size", ctypes.c_uint)]
553
591
 
554
 
    class openpgp_crt_int(ctypes.Structure):
 
592
    class _openpgp_crt_int(ctypes.Structure):
555
593
        _fields_ = []
556
 
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
594
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
557
595
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
558
596
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
559
597
    credentials_type_t = ctypes.c_int
562
600
 
563
601
    # Exceptions
564
602
    class Error(Exception):
565
 
        # We need to use the class name "GnuTLS" here, since this
566
 
        # exception might be raised from within GnuTLS.__init__,
567
 
        # which is called before the assignment to the "gnutls"
568
 
        # global variable has happened.
569
603
        def __init__(self, message=None, code=None, args=()):
570
604
            # Default usage is by a message string, but if a return
571
605
            # code is passed, convert it to a string with
572
606
            # gnutls.strerror()
573
607
            self.code = code
574
608
            if message is None and code is not None:
575
 
                message = GnuTLS.strerror(code)
576
 
            return super(GnuTLS.Error, self).__init__(
 
609
                message = gnutls.strerror(code).decode(
 
610
                    "utf-8", errors="replace")
 
611
            return super(gnutls.Error, self).__init__(
577
612
                message, *args)
578
613
 
579
614
    class CertificateSecurityError(Error):
580
615
        pass
581
616
 
 
617
    class PointerTo:
 
618
        def __init__(self, cls):
 
619
            self.cls = cls
 
620
 
 
621
        def from_param(self, obj):
 
622
            if not isinstance(obj, self.cls):
 
623
                raise TypeError("Not of type {}: {!r}"
 
624
                                .format(self.cls.__name__, obj))
 
625
            return ctypes.byref(obj.from_param(obj))
 
626
 
 
627
    class CastToVoidPointer:
 
628
        def __init__(self, cls):
 
629
            self.cls = cls
 
630
 
 
631
        def from_param(self, obj):
 
632
            if not isinstance(obj, self.cls):
 
633
                raise TypeError("Not of type {}: {!r}"
 
634
                                .format(self.cls.__name__, obj))
 
635
            return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)
 
636
 
 
637
    class With_from_param:
 
638
        @classmethod
 
639
        def from_param(cls, obj):
 
640
            return obj._as_parameter_
 
641
 
582
642
    # Classes
583
 
    class Credentials(object):
 
643
    class Credentials(With_from_param):
584
644
        def __init__(self):
585
 
            self._c_object = gnutls.certificate_credentials_t()
586
 
            gnutls.certificate_allocate_credentials(
587
 
                ctypes.byref(self._c_object))
 
645
            self._as_parameter_ = gnutls.certificate_credentials_t()
 
646
            gnutls.certificate_allocate_credentials(self)
588
647
            self.type = gnutls.CRD_CERTIFICATE
589
648
 
590
649
        def __del__(self):
591
 
            gnutls.certificate_free_credentials(self._c_object)
 
650
            gnutls.certificate_free_credentials(self)
592
651
 
593
 
    class ClientSession(object):
 
652
    class ClientSession(With_from_param):
594
653
        def __init__(self, socket, credentials=None):
595
 
            self._c_object = gnutls.session_t()
596
 
            gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
597
 
            gnutls.set_default_priority(self._c_object)
598
 
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
599
 
            gnutls.handshake_set_private_extensions(self._c_object,
600
 
                                                    True)
 
654
            self._as_parameter_ = gnutls.session_t()
 
655
            gnutls_flags = gnutls.CLIENT
 
656
            if gnutls.check_version(b"3.5.6"):
 
657
                gnutls_flags |= gnutls.NO_TICKETS
 
658
            if gnutls.has_rawpk:
 
659
                gnutls_flags |= gnutls.ENABLE_RAWPK
 
660
            gnutls.init(self, gnutls_flags)
 
661
            del gnutls_flags
 
662
            gnutls.set_default_priority(self)
 
663
            gnutls.transport_set_ptr(self, socket.fileno())
 
664
            gnutls.handshake_set_private_extensions(self, True)
601
665
            self.socket = socket
602
666
            if credentials is None:
603
667
                credentials = gnutls.Credentials()
604
 
            gnutls.credentials_set(self._c_object, credentials.type,
605
 
                                   ctypes.cast(credentials._c_object,
606
 
                                               ctypes.c_void_p))
 
668
            gnutls.credentials_set(self, credentials.type,
 
669
                                   credentials)
607
670
            self.credentials = credentials
608
671
 
609
672
        def __del__(self):
610
 
            gnutls.deinit(self._c_object)
 
673
            gnutls.deinit(self)
611
674
 
612
675
        def handshake(self):
613
 
            return gnutls.handshake(self._c_object)
 
676
            return gnutls.handshake(self)
614
677
 
615
678
        def send(self, data):
616
679
            data = bytes(data)
617
680
            data_len = len(data)
618
681
            while data_len > 0:
619
 
                data_len -= gnutls.record_send(self._c_object,
620
 
                                               data[-data_len:],
 
682
                data_len -= gnutls.record_send(self, data[-data_len:],
621
683
                                               data_len)
622
684
 
623
685
        def bye(self):
624
 
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
686
            return gnutls.bye(self, gnutls.SHUT_RDWR)
625
687
 
626
688
    # Error handling functions
627
689
    def _error_code(result):
628
690
        """A function to raise exceptions on errors, suitable
629
 
        for the 'restype' attribute on ctypes functions"""
630
 
        if result >= 0:
 
691
        for the "restype" attribute on ctypes functions"""
 
692
        if result >= gnutls.E_SUCCESS:
631
693
            return result
632
694
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
633
695
            raise gnutls.CertificateSecurityError(code=result)
634
696
        raise gnutls.Error(code=result)
635
697
 
636
 
    def _retry_on_error(result, func, arguments):
 
698
    def _retry_on_error(result, func, arguments,
 
699
                        _error_code=_error_code):
637
700
        """A function to retry on some errors, suitable
638
 
        for the 'errcheck' attribute on ctypes functions"""
639
 
        while result < 0:
 
701
        for the "errcheck" attribute on ctypes functions"""
 
702
        while result < gnutls.E_SUCCESS:
640
703
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
641
704
                return _error_code(result)
642
705
            result = func(*arguments)
647
710
 
648
711
    # Functions
649
712
    priority_set_direct = _library.gnutls_priority_set_direct
650
 
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
713
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
651
714
                                    ctypes.POINTER(ctypes.c_char_p)]
652
715
    priority_set_direct.restype = _error_code
653
716
 
654
717
    init = _library.gnutls_init
655
 
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
718
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
656
719
    init.restype = _error_code
657
720
 
658
721
    set_default_priority = _library.gnutls_set_default_priority
659
 
    set_default_priority.argtypes = [session_t]
 
722
    set_default_priority.argtypes = [ClientSession]
660
723
    set_default_priority.restype = _error_code
661
724
 
662
725
    record_send = _library.gnutls_record_send
663
 
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
726
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
664
727
                            ctypes.c_size_t]
665
728
    record_send.restype = ctypes.c_ssize_t
666
729
    record_send.errcheck = _retry_on_error
668
731
    certificate_allocate_credentials = (
669
732
        _library.gnutls_certificate_allocate_credentials)
670
733
    certificate_allocate_credentials.argtypes = [
671
 
        ctypes.POINTER(certificate_credentials_t)]
 
734
        PointerTo(Credentials)]
672
735
    certificate_allocate_credentials.restype = _error_code
673
736
 
674
737
    certificate_free_credentials = (
675
738
        _library.gnutls_certificate_free_credentials)
676
 
    certificate_free_credentials.argtypes = [
677
 
        certificate_credentials_t]
 
739
    certificate_free_credentials.argtypes = [Credentials]
678
740
    certificate_free_credentials.restype = None
679
741
 
680
742
    handshake_set_private_extensions = (
681
743
        _library.gnutls_handshake_set_private_extensions)
682
 
    handshake_set_private_extensions.argtypes = [session_t,
 
744
    handshake_set_private_extensions.argtypes = [ClientSession,
683
745
                                                 ctypes.c_int]
684
746
    handshake_set_private_extensions.restype = None
685
747
 
686
748
    credentials_set = _library.gnutls_credentials_set
687
 
    credentials_set.argtypes = [session_t, credentials_type_t,
688
 
                                ctypes.c_void_p]
 
749
    credentials_set.argtypes = [ClientSession, credentials_type_t,
 
750
                                CastToVoidPointer(Credentials)]
689
751
    credentials_set.restype = _error_code
690
752
 
691
753
    strerror = _library.gnutls_strerror
693
755
    strerror.restype = ctypes.c_char_p
694
756
 
695
757
    certificate_type_get = _library.gnutls_certificate_type_get
696
 
    certificate_type_get.argtypes = [session_t]
 
758
    certificate_type_get.argtypes = [ClientSession]
697
759
    certificate_type_get.restype = _error_code
698
760
 
699
761
    certificate_get_peers = _library.gnutls_certificate_get_peers
700
 
    certificate_get_peers.argtypes = [session_t,
 
762
    certificate_get_peers.argtypes = [ClientSession,
701
763
                                      ctypes.POINTER(ctypes.c_uint)]
702
764
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
703
765
 
710
772
    global_set_log_function.restype = None
711
773
 
712
774
    deinit = _library.gnutls_deinit
713
 
    deinit.argtypes = [session_t]
 
775
    deinit.argtypes = [ClientSession]
714
776
    deinit.restype = None
715
777
 
716
778
    handshake = _library.gnutls_handshake
717
 
    handshake.argtypes = [session_t]
718
 
    handshake.restype = _error_code
 
779
    handshake.argtypes = [ClientSession]
 
780
    handshake.restype = ctypes.c_int
719
781
    handshake.errcheck = _retry_on_error
720
782
 
721
783
    transport_set_ptr = _library.gnutls_transport_set_ptr
722
 
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
784
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
723
785
    transport_set_ptr.restype = None
724
786
 
725
787
    bye = _library.gnutls_bye
726
 
    bye.argtypes = [session_t, close_request_t]
727
 
    bye.restype = _error_code
 
788
    bye.argtypes = [ClientSession, close_request_t]
 
789
    bye.restype = ctypes.c_int
728
790
    bye.errcheck = _retry_on_error
729
791
 
730
792
    check_version = _library.gnutls_check_version
731
793
    check_version.argtypes = [ctypes.c_char_p]
732
794
    check_version.restype = ctypes.c_char_p
733
795
 
734
 
    # All the function declarations below are from gnutls/openpgp.h
735
 
 
736
 
    openpgp_crt_init = _library.gnutls_openpgp_crt_init
737
 
    openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
738
 
    openpgp_crt_init.restype = _error_code
739
 
 
740
 
    openpgp_crt_import = _library.gnutls_openpgp_crt_import
741
 
    openpgp_crt_import.argtypes = [openpgp_crt_t,
742
 
                                   ctypes.POINTER(datum_t),
743
 
                                   openpgp_crt_fmt_t]
744
 
    openpgp_crt_import.restype = _error_code
745
 
 
746
 
    openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
747
 
    openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
748
 
                                        ctypes.POINTER(ctypes.c_uint)]
749
 
    openpgp_crt_verify_self.restype = _error_code
750
 
 
751
 
    openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
752
 
    openpgp_crt_deinit.argtypes = [openpgp_crt_t]
753
 
    openpgp_crt_deinit.restype = None
754
 
 
755
 
    openpgp_crt_get_fingerprint = (
756
 
        _library.gnutls_openpgp_crt_get_fingerprint)
757
 
    openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
758
 
                                            ctypes.c_void_p,
759
 
                                            ctypes.POINTER(
760
 
                                                ctypes.c_size_t)]
761
 
    openpgp_crt_get_fingerprint.restype = _error_code
 
796
    _need_version = b"3.3.0"
 
797
    if check_version(_need_version) is None:
 
798
        raise self.Error("Needs GnuTLS {} or later"
 
799
                         .format(_need_version))
 
800
 
 
801
    _tls_rawpk_version = b"3.6.6"
 
802
    has_rawpk = bool(check_version(_tls_rawpk_version))
 
803
 
 
804
    if has_rawpk:
 
805
        # Types
 
806
        class pubkey_st(ctypes.Structure):
 
807
            _fields = []
 
808
        pubkey_t = ctypes.POINTER(pubkey_st)
 
809
 
 
810
        x509_crt_fmt_t = ctypes.c_int
 
811
 
 
812
        # All the function declarations below are from
 
813
        # gnutls/abstract.h
 
814
        pubkey_init = _library.gnutls_pubkey_init
 
815
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
 
816
        pubkey_init.restype = _error_code
 
817
 
 
818
        pubkey_import = _library.gnutls_pubkey_import
 
819
        pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
 
820
                                  x509_crt_fmt_t]
 
821
        pubkey_import.restype = _error_code
 
822
 
 
823
        pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
 
824
        pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
 
825
                                      ctypes.POINTER(ctypes.c_ubyte),
 
826
                                      ctypes.POINTER(ctypes.c_size_t)]
 
827
        pubkey_get_key_id.restype = _error_code
 
828
 
 
829
        pubkey_deinit = _library.gnutls_pubkey_deinit
 
830
        pubkey_deinit.argtypes = [pubkey_t]
 
831
        pubkey_deinit.restype = None
 
832
    else:
 
833
        # All the function declarations below are from
 
834
        # gnutls/openpgp.h
 
835
 
 
836
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
837
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
838
        openpgp_crt_init.restype = _error_code
 
839
 
 
840
        openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
841
        openpgp_crt_import.argtypes = [openpgp_crt_t,
 
842
                                       ctypes.POINTER(datum_t),
 
843
                                       openpgp_crt_fmt_t]
 
844
        openpgp_crt_import.restype = _error_code
 
845
 
 
846
        openpgp_crt_verify_self = \
 
847
            _library.gnutls_openpgp_crt_verify_self
 
848
        openpgp_crt_verify_self.argtypes = [
 
849
            openpgp_crt_t,
 
850
            ctypes.c_uint,
 
851
            ctypes.POINTER(ctypes.c_uint),
 
852
        ]
 
853
        openpgp_crt_verify_self.restype = _error_code
 
854
 
 
855
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
856
        openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
857
        openpgp_crt_deinit.restype = None
 
858
 
 
859
        openpgp_crt_get_fingerprint = (
 
860
            _library.gnutls_openpgp_crt_get_fingerprint)
 
861
        openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
862
                                                ctypes.c_void_p,
 
863
                                                ctypes.POINTER(
 
864
                                                    ctypes.c_size_t)]
 
865
        openpgp_crt_get_fingerprint.restype = _error_code
 
866
 
 
867
    if check_version(b"3.6.4"):
 
868
        certificate_type_get2 = _library.gnutls_certificate_type_get2
 
869
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
 
870
        certificate_type_get2.restype = _error_code
762
871
 
763
872
    # Remove non-public functions
764
873
    del _error_code, _retry_on_error
765
 
# Create the global "gnutls" object, simulating a module
766
 
gnutls = GnuTLS()
767
874
 
768
875
 
769
876
def call_pipe(connection,       # : multiprocessing.Connection
777
884
    connection.close()
778
885
 
779
886
 
780
 
class Client(object):
 
887
class Client:
781
888
    """A representation of a client host served by this server.
782
889
 
783
890
    Attributes:
784
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
891
    approved:   bool(); None if not yet approved/disapproved
785
892
    approval_delay: datetime.timedelta(); Time to wait for approval
786
893
    approval_duration: datetime.timedelta(); Duration of one approval
787
 
    checker:    subprocess.Popen(); a running checker process used
788
 
                                    to see if the client lives.
789
 
                                    'None' if no process is running.
 
894
    checker: multiprocessing.Process(); a running checker process used
 
895
             to see if the client lives. None if no process is
 
896
             running.
790
897
    checker_callback_tag: a GLib event source tag, or None
791
898
    checker_command: string; External command which is run to check
792
899
                     if client lives.  %() expansions are done at
800
907
    disable_initiator_tag: a GLib event source tag, or None
801
908
    enabled:    bool()
802
909
    fingerprint: string (40 or 32 hexadecimal digits); used to
803
 
                 uniquely identify the client
 
910
                 uniquely identify an OpenPGP client
 
911
    key_id: string (64 hexadecimal digits); used to uniquely identify
 
912
            a client using raw public keys
804
913
    host:       string; available for use by the checker command
805
914
    interval:   datetime.timedelta(); How often to start a new checker
806
915
    last_approval_request: datetime.datetime(); (UTC) or None
824
933
    """
825
934
 
826
935
    runtime_expansions = ("approval_delay", "approval_duration",
827
 
                          "created", "enabled", "expires",
 
936
                          "created", "enabled", "expires", "key_id",
828
937
                          "fingerprint", "host", "interval",
829
938
                          "last_approval_request", "last_checked_ok",
830
939
                          "last_enabled", "name", "timeout")
860
969
            client["enabled"] = config.getboolean(client_name,
861
970
                                                  "enabled")
862
971
 
863
 
            # Uppercase and remove spaces from fingerprint for later
864
 
            # comparison purposes with return value from the
865
 
            # fingerprint() function
866
 
            client["fingerprint"] = (section["fingerprint"].upper()
 
972
            # Uppercase and remove spaces from key_id and fingerprint
 
973
            # for later comparison purposes with return value from the
 
974
            # key_id() and fingerprint() functions
 
975
            client["key_id"] = (section.get("key_id", "").upper()
 
976
                                .replace(" ", ""))
 
977
            client["fingerprint"] = (section.get("fingerprint",
 
978
                                                 "").upper()
867
979
                                     .replace(" ", ""))
 
980
            if not (client["key_id"] or client["fingerprint"]):
 
981
                log.error("Skipping client %s without key_id or"
 
982
                          " fingerprint", client_name)
 
983
                del settings[client_name]
 
984
                continue
868
985
            if "secret" in section:
869
986
                client["secret"] = codecs.decode(section["secret"]
870
987
                                                 .encode("utf-8"),
911
1028
            self.last_enabled = None
912
1029
            self.expires = None
913
1030
 
914
 
        logger.debug("Creating client %r", self.name)
915
 
        logger.debug("  Fingerprint: %s", self.fingerprint)
 
1031
        log.debug("Creating client %r", self.name)
 
1032
        log.debug("  Key ID: %s", self.key_id)
 
1033
        log.debug("  Fingerprint: %s", self.fingerprint)
916
1034
        self.created = settings.get("created",
917
1035
                                    datetime.datetime.utcnow())
918
1036
 
946
1064
        if getattr(self, "enabled", False):
947
1065
            # Already enabled
948
1066
            return
949
 
        self.expires = datetime.datetime.utcnow() + self.timeout
950
1067
        self.enabled = True
951
1068
        self.last_enabled = datetime.datetime.utcnow()
952
1069
        self.init_checker()
957
1074
        if not getattr(self, "enabled", False):
958
1075
            return False
959
1076
        if not quiet:
960
 
            logger.info("Disabling client %s", self.name)
 
1077
            log.info("Disabling client %s", self.name)
961
1078
        if getattr(self, "disable_initiator_tag", None) is not None:
962
1079
            GLib.source_remove(self.disable_initiator_tag)
963
1080
            self.disable_initiator_tag = None
975
1092
    def __del__(self):
976
1093
        self.disable()
977
1094
 
978
 
    def init_checker(self):
979
 
        # Schedule a new checker to be started an 'interval' from now,
980
 
        # and every interval from then on.
 
1095
    def init_checker(self, randomize_start=False):
 
1096
        # Schedule a new checker to be started a randomly selected
 
1097
        # time (a fraction of 'interval') from now.  This spreads out
 
1098
        # the startup of checkers over time when the server is
 
1099
        # started.
981
1100
        if self.checker_initiator_tag is not None:
982
1101
            GLib.source_remove(self.checker_initiator_tag)
 
1102
        interval_milliseconds = int(self.interval.total_seconds()
 
1103
                                    * 1000)
 
1104
        if randomize_start:
 
1105
            delay_milliseconds = random.randrange(
 
1106
                interval_milliseconds + 1)
 
1107
        else:
 
1108
            delay_milliseconds = interval_milliseconds
983
1109
        self.checker_initiator_tag = GLib.timeout_add(
984
 
            int(self.interval.total_seconds() * 1000),
985
 
            self.start_checker)
986
 
        # Schedule a disable() when 'timeout' has passed
 
1110
            delay_milliseconds, self.start_checker, randomize_start)
 
1111
        delay = datetime.timedelta(0, 0, 0, delay_milliseconds)
 
1112
        # A checker might take up to an 'interval' of time, so we can
 
1113
        # expire at the soonest one interval after a checker was
 
1114
        # started.  Since the initial checker is delayed, the expire
 
1115
        # time might have to be extended.
 
1116
        now = datetime.datetime.utcnow()
 
1117
        self.expires = now + delay + self.interval
 
1118
        # Schedule a disable() at expire time
987
1119
        if self.disable_initiator_tag is not None:
988
1120
            GLib.source_remove(self.disable_initiator_tag)
989
1121
        self.disable_initiator_tag = GLib.timeout_add(
990
 
            int(self.timeout.total_seconds() * 1000), self.disable)
991
 
        # Also start a new checker *right now*.
992
 
        self.start_checker()
 
1122
            int((self.expires - now).total_seconds() * 1000),
 
1123
            self.disable)
993
1124
 
994
1125
    def checker_callback(self, source, condition, connection,
995
1126
                         command):
996
1127
        """The checker has completed, so take appropriate actions."""
997
 
        self.checker_callback_tag = None
998
 
        self.checker = None
999
1128
        # Read return code from connection (see call_pipe)
1000
1129
        returncode = connection.recv()
1001
1130
        connection.close()
 
1131
        if self.checker is not None:
 
1132
            self.checker.join()
 
1133
        self.checker_callback_tag = None
 
1134
        self.checker = None
1002
1135
 
1003
1136
        if returncode >= 0:
1004
1137
            self.last_checker_status = returncode
1005
1138
            self.last_checker_signal = None
1006
1139
            if self.last_checker_status == 0:
1007
 
                logger.info("Checker for %(name)s succeeded",
1008
 
                            vars(self))
 
1140
                log.info("Checker for %(name)s succeeded", vars(self))
1009
1141
                self.checked_ok()
1010
1142
            else:
1011
 
                logger.info("Checker for %(name)s failed", vars(self))
 
1143
                log.info("Checker for %(name)s failed", vars(self))
1012
1144
        else:
1013
1145
            self.last_checker_status = -1
1014
1146
            self.last_checker_signal = -returncode
1015
 
            logger.warning("Checker for %(name)s crashed?",
1016
 
                           vars(self))
 
1147
            log.warning("Checker for %(name)s crashed?", vars(self))
1017
1148
        return False
1018
1149
 
1019
1150
    def checked_ok(self):
1038
1169
    def need_approval(self):
1039
1170
        self.last_approval_request = datetime.datetime.utcnow()
1040
1171
 
1041
 
    def start_checker(self):
 
1172
    def start_checker(self, start_was_randomized=False):
1042
1173
        """Start a new checker subprocess if one is not running.
1043
1174
 
1044
1175
        If a checker already exists, leave it running and do
1053
1184
        # should be.
1054
1185
 
1055
1186
        if self.checker is not None and not self.checker.is_alive():
1056
 
            logger.warning("Checker was not alive; joining")
 
1187
            log.warning("Checker was not alive; joining")
1057
1188
            self.checker.join()
1058
1189
            self.checker = None
1059
1190
        # Start a new checker if needed
1060
1191
        if self.checker is None:
1061
1192
            # Escape attributes for the shell
1062
1193
            escaped_attrs = {
1063
 
                attr: re.escape(str(getattr(self, attr)))
 
1194
                attr: shlex.quote(str(getattr(self, attr)))
1064
1195
                for attr in self.runtime_expansions}
1065
1196
            try:
1066
1197
                command = self.checker_command % escaped_attrs
1067
1198
            except TypeError as error:
1068
 
                logger.error('Could not format string "%s"',
1069
 
                             self.checker_command,
1070
 
                             exc_info=error)
 
1199
                log.error('Could not format string "%s"',
 
1200
                          self.checker_command, exc_info=error)
1071
1201
                return True     # Try again later
1072
1202
            self.current_checker_command = command
1073
 
            logger.info("Starting checker %r for %s", command,
1074
 
                        self.name)
 
1203
            log.info("Starting checker %r for %s", command, self.name)
1075
1204
            # We don't need to redirect stdout and stderr, since
1076
1205
            # in normal mode, that is already done by daemon(),
1077
1206
            # and in debug mode we don't want to.  (Stdin is
1093
1222
                kwargs=popen_args)
1094
1223
            self.checker.start()
1095
1224
            self.checker_callback_tag = GLib.io_add_watch(
1096
 
                pipe[0].fileno(), GLib.IO_IN,
 
1225
                GLib.IOChannel.unix_new(pipe[0].fileno()),
 
1226
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1097
1227
                self.checker_callback, pipe[0], command)
 
1228
        if start_was_randomized:
 
1229
            # We were started after a random delay; Schedule a new
 
1230
            # checker to be started an 'interval' from now, and every
 
1231
            # interval from then on.
 
1232
            now = datetime.datetime.utcnow()
 
1233
            self.checker_initiator_tag = GLib.timeout_add(
 
1234
                int(self.interval.total_seconds() * 1000),
 
1235
                self.start_checker)
 
1236
            self.expires = max(self.expires, now + self.interval)
 
1237
            # Don't start a new checker again after same random delay
 
1238
            return False
1098
1239
        # Re-run this periodically if run by GLib.timeout_add
1099
1240
        return True
1100
1241
 
1105
1246
            self.checker_callback_tag = None
1106
1247
        if getattr(self, "checker", None) is None:
1107
1248
            return
1108
 
        logger.debug("Stopping checker for %(name)s", vars(self))
 
1249
        log.debug("Stopping checker for %(name)s", vars(self))
1109
1250
        self.checker.terminate()
1110
1251
        self.checker = None
1111
1252
 
1138
1279
        func._dbus_name = func.__name__
1139
1280
        if func._dbus_name.endswith("_dbus_property"):
1140
1281
            func._dbus_name = func._dbus_name[:-14]
1141
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
 
1282
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
1142
1283
        return func
1143
1284
 
1144
1285
    return decorator
1233
1374
 
1234
1375
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1235
1376
                         out_signature="s",
1236
 
                         path_keyword='object_path',
1237
 
                         connection_keyword='connection')
 
1377
                         path_keyword="object_path",
 
1378
                         connection_keyword="connection")
1238
1379
    def Introspect(self, object_path, connection):
1239
1380
        """Overloading of standard D-Bus method.
1240
1381
 
1289
1430
            document.unlink()
1290
1431
        except (AttributeError, xml.dom.DOMException,
1291
1432
                xml.parsers.expat.ExpatError) as error:
1292
 
            logger.error("Failed to override Introspection method",
1293
 
                         exc_info=error)
 
1433
            log.error("Failed to override Introspection method",
 
1434
                      exc_info=error)
1294
1435
        return xmlstring
1295
1436
 
1296
1437
 
1354
1495
                raise ValueError("Byte arrays not supported for non-"
1355
1496
                                 "'ay' signature {!r}"
1356
1497
                                 .format(prop._dbus_signature))
1357
 
            value = dbus.ByteArray(b''.join(chr(byte)
1358
 
                                            for byte in value))
 
1498
            value = dbus.ByteArray(bytes(value))
1359
1499
        prop(value)
1360
1500
 
1361
1501
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1394
1534
 
1395
1535
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1396
1536
                         out_signature="s",
1397
 
                         path_keyword='object_path',
1398
 
                         connection_keyword='connection')
 
1537
                         path_keyword="object_path",
 
1538
                         connection_keyword="connection")
1399
1539
    def Introspect(self, object_path, connection):
1400
1540
        """Overloading of standard D-Bus method.
1401
1541
 
1457
1597
            document.unlink()
1458
1598
        except (AttributeError, xml.dom.DOMException,
1459
1599
                xml.parsers.expat.ExpatError) as error:
1460
 
            logger.error("Failed to override Introspection method",
1461
 
                         exc_info=error)
 
1600
            log.error("Failed to override Introspection method",
 
1601
                      exc_info=error)
1462
1602
        return xmlstring
1463
1603
 
1464
1604
 
1496
1636
 
1497
1637
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1498
1638
                         out_signature="s",
1499
 
                         path_keyword='object_path',
1500
 
                         connection_keyword='connection')
 
1639
                         path_keyword="object_path",
 
1640
                         connection_keyword="connection")
1501
1641
    def Introspect(self, object_path, connection):
1502
1642
        """Overloading of standard D-Bus method.
1503
1643
 
1528
1668
            document.unlink()
1529
1669
        except (AttributeError, xml.dom.DOMException,
1530
1670
                xml.parsers.expat.ExpatError) as error:
1531
 
            logger.error("Failed to override Introspection method",
1532
 
                         exc_info=error)
 
1671
            log.error("Failed to override Introspection method",
 
1672
                      exc_info=error)
1533
1673
        return xmlstring
1534
1674
 
1535
1675
 
1999
2139
    def Name_dbus_property(self):
2000
2140
        return dbus.String(self.name)
2001
2141
 
 
2142
    # KeyID - property
 
2143
    @dbus_annotations(
 
2144
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
 
2145
    @dbus_service_property(_interface, signature="s", access="read")
 
2146
    def KeyID_dbus_property(self):
 
2147
        return dbus.String(self.key_id)
 
2148
 
2002
2149
    # Fingerprint - property
2003
2150
    @dbus_annotations(
2004
2151
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2159
2306
    del _interface
2160
2307
 
2161
2308
 
2162
 
class ProxyClient(object):
2163
 
    def __init__(self, child_pipe, fpr, address):
 
2309
class ProxyClient:
 
2310
    def __init__(self, child_pipe, key_id, fpr, address):
2164
2311
        self._pipe = child_pipe
2165
 
        self._pipe.send(('init', fpr, address))
 
2312
        self._pipe.send(("init", key_id, fpr, address))
2166
2313
        if not self._pipe.recv():
2167
 
            raise KeyError(fpr)
 
2314
            raise KeyError(key_id or fpr)
2168
2315
 
2169
2316
    def __getattribute__(self, name):
2170
 
        if name == '_pipe':
 
2317
        if name == "_pipe":
2171
2318
            return super(ProxyClient, self).__getattribute__(name)
2172
 
        self._pipe.send(('getattr', name))
 
2319
        self._pipe.send(("getattr", name))
2173
2320
        data = self._pipe.recv()
2174
 
        if data[0] == 'data':
 
2321
        if data[0] == "data":
2175
2322
            return data[1]
2176
 
        if data[0] == 'function':
 
2323
        if data[0] == "function":
2177
2324
 
2178
2325
            def func(*args, **kwargs):
2179
 
                self._pipe.send(('funcall', name, args, kwargs))
 
2326
                self._pipe.send(("funcall", name, args, kwargs))
2180
2327
                return self._pipe.recv()[1]
2181
2328
 
2182
2329
            return func
2183
2330
 
2184
2331
    def __setattr__(self, name, value):
2185
 
        if name == '_pipe':
 
2332
        if name == "_pipe":
2186
2333
            return super(ProxyClient, self).__setattr__(name, value)
2187
 
        self._pipe.send(('setattr', name, value))
 
2334
        self._pipe.send(("setattr", name, value))
2188
2335
 
2189
2336
 
2190
2337
class ClientHandler(socketserver.BaseRequestHandler, object):
2195
2342
 
2196
2343
    def handle(self):
2197
2344
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2198
 
            logger.info("TCP connection from: %s",
2199
 
                        str(self.client_address))
2200
 
            logger.debug("Pipe FD: %d",
2201
 
                         self.server.child_pipe.fileno())
 
2345
            log.info("TCP connection from: %s",
 
2346
                     str(self.client_address))
 
2347
            log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
2202
2348
 
2203
2349
            session = gnutls.ClientSession(self.request)
2204
2350
 
2205
 
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
2351
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
2206
2352
            #                       "+AES-256-CBC", "+SHA1",
2207
2353
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2208
2354
            #                       "+DHE-DSS"))
2210
2356
            priority = self.server.gnutls_priority
2211
2357
            if priority is None:
2212
2358
                priority = "NORMAL"
2213
 
            gnutls.priority_set_direct(session._c_object,
2214
 
                                       priority.encode("utf-8"),
2215
 
                                       None)
 
2359
            gnutls.priority_set_direct(session,
 
2360
                                       priority.encode("utf-8"), None)
2216
2361
 
2217
2362
            # Start communication using the Mandos protocol
2218
2363
            # Get protocol number
2219
2364
            line = self.request.makefile().readline()
2220
 
            logger.debug("Protocol version: %r", line)
 
2365
            log.debug("Protocol version: %r", line)
2221
2366
            try:
2222
2367
                if int(line.strip().split()[0]) > 1:
2223
2368
                    raise RuntimeError(line)
2224
2369
            except (ValueError, IndexError, RuntimeError) as error:
2225
 
                logger.error("Unknown protocol version: %s", error)
 
2370
                log.error("Unknown protocol version: %s", error)
2226
2371
                return
2227
2372
 
2228
2373
            # Start GnuTLS connection
2229
2374
            try:
2230
2375
                session.handshake()
2231
2376
            except gnutls.Error as error:
2232
 
                logger.warning("Handshake failed: %s", error)
 
2377
                log.warning("Handshake failed: %s", error)
2233
2378
                # Do not run session.bye() here: the session is not
2234
2379
                # established.  Just abandon the request.
2235
2380
                return
2236
 
            logger.debug("Handshake succeeded")
 
2381
            log.debug("Handshake succeeded")
2237
2382
 
2238
2383
            approval_required = False
2239
2384
            try:
2240
 
                try:
2241
 
                    fpr = self.fingerprint(
2242
 
                        self.peer_certificate(session))
2243
 
                except (TypeError, gnutls.Error) as error:
2244
 
                    logger.warning("Bad certificate: %s", error)
2245
 
                    return
2246
 
                logger.debug("Fingerprint: %s", fpr)
2247
 
 
2248
 
                try:
2249
 
                    client = ProxyClient(child_pipe, fpr,
 
2385
                if gnutls.has_rawpk:
 
2386
                    fpr = b""
 
2387
                    try:
 
2388
                        key_id = self.key_id(
 
2389
                            self.peer_certificate(session))
 
2390
                    except (TypeError, gnutls.Error) as error:
 
2391
                        log.warning("Bad certificate: %s", error)
 
2392
                        return
 
2393
                    log.debug("Key ID: %s",
 
2394
                              key_id.decode("utf-8",
 
2395
                                            errors="replace"))
 
2396
 
 
2397
                else:
 
2398
                    key_id = b""
 
2399
                    try:
 
2400
                        fpr = self.fingerprint(
 
2401
                            self.peer_certificate(session))
 
2402
                    except (TypeError, gnutls.Error) as error:
 
2403
                        log.warning("Bad certificate: %s", error)
 
2404
                        return
 
2405
                    log.debug("Fingerprint: %s", fpr)
 
2406
 
 
2407
                try:
 
2408
                    client = ProxyClient(child_pipe, key_id, fpr,
2250
2409
                                         self.client_address)
2251
2410
                except KeyError:
2252
2411
                    return
2258
2417
 
2259
2418
                while True:
2260
2419
                    if not client.enabled:
2261
 
                        logger.info("Client %s is disabled",
2262
 
                                    client.name)
 
2420
                        log.info("Client %s is disabled", client.name)
2263
2421
                        if self.server.use_dbus:
2264
2422
                            # Emit D-Bus signal
2265
2423
                            client.Rejected("Disabled")
2269
2427
                        # We are approved or approval is disabled
2270
2428
                        break
2271
2429
                    elif client.approved is None:
2272
 
                        logger.info("Client %s needs approval",
2273
 
                                    client.name)
 
2430
                        log.info("Client %s needs approval",
 
2431
                                 client.name)
2274
2432
                        if self.server.use_dbus:
2275
2433
                            # Emit D-Bus signal
2276
2434
                            client.NeedApproval(
2277
2435
                                client.approval_delay.total_seconds()
2278
2436
                                * 1000, client.approved_by_default)
2279
2437
                    else:
2280
 
                        logger.warning("Client %s was not approved",
2281
 
                                       client.name)
 
2438
                        log.warning("Client %s was not approved",
 
2439
                                    client.name)
2282
2440
                        if self.server.use_dbus:
2283
2441
                            # Emit D-Bus signal
2284
2442
                            client.Rejected("Denied")
2292
2450
                    time2 = datetime.datetime.now()
2293
2451
                    if (time2 - time) >= delay:
2294
2452
                        if not client.approved_by_default:
2295
 
                            logger.warning("Client %s timed out while"
2296
 
                                           " waiting for approval",
2297
 
                                           client.name)
 
2453
                            log.warning("Client %s timed out while"
 
2454
                                        " waiting for approval",
 
2455
                                        client.name)
2298
2456
                            if self.server.use_dbus:
2299
2457
                                # Emit D-Bus signal
2300
2458
                                client.Rejected("Approval timed out")
2307
2465
                try:
2308
2466
                    session.send(client.secret)
2309
2467
                except gnutls.Error as error:
2310
 
                    logger.warning("gnutls send failed",
2311
 
                                   exc_info=error)
 
2468
                    log.warning("gnutls send failed", exc_info=error)
2312
2469
                    return
2313
2470
 
2314
 
                logger.info("Sending secret to %s", client.name)
 
2471
                log.info("Sending secret to %s", client.name)
2315
2472
                # bump the timeout using extended_timeout
2316
2473
                client.bump_timeout(client.extended_timeout)
2317
2474
                if self.server.use_dbus:
2324
2481
                try:
2325
2482
                    session.bye()
2326
2483
                except gnutls.Error as error:
2327
 
                    logger.warning("GnuTLS bye failed",
2328
 
                                   exc_info=error)
 
2484
                    log.warning("GnuTLS bye failed", exc_info=error)
2329
2485
 
2330
2486
    @staticmethod
2331
2487
    def peer_certificate(session):
2332
 
        "Return the peer's OpenPGP certificate as a bytestring"
2333
 
        # If not an OpenPGP certificate...
2334
 
        if (gnutls.certificate_type_get(session._c_object)
2335
 
            != gnutls.CRT_OPENPGP):
 
2488
        "Return the peer's certificate as a bytestring"
 
2489
        try:
 
2490
            cert_type = gnutls.certificate_type_get2(
 
2491
                session, gnutls.CTYPE_PEERS)
 
2492
        except AttributeError:
 
2493
            cert_type = gnutls.certificate_type_get(session)
 
2494
        if gnutls.has_rawpk:
 
2495
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
 
2496
        else:
 
2497
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
 
2498
        # If not a valid certificate type...
 
2499
        if cert_type not in valid_cert_types:
 
2500
            log.info("Cert type %r not in %r", cert_type,
 
2501
                     valid_cert_types)
2336
2502
            # ...return invalid data
2337
2503
            return b""
2338
2504
        list_size = ctypes.c_uint(1)
2339
2505
        cert_list = (gnutls.certificate_get_peers
2340
 
                     (session._c_object, ctypes.byref(list_size)))
 
2506
                     (session, ctypes.byref(list_size)))
2341
2507
        if not bool(cert_list) and list_size.value != 0:
2342
2508
            raise gnutls.Error("error getting peer certificate")
2343
2509
        if list_size.value == 0:
2346
2512
        return ctypes.string_at(cert.data, cert.size)
2347
2513
 
2348
2514
    @staticmethod
 
2515
    def key_id(certificate):
 
2516
        "Convert a certificate bytestring to a hexdigit key ID"
 
2517
        # New GnuTLS "datum" with the public key
 
2518
        datum = gnutls.datum_t(
 
2519
            ctypes.cast(ctypes.c_char_p(certificate),
 
2520
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2521
            ctypes.c_uint(len(certificate)))
 
2522
        # XXX all these need to be created in the gnutls "module"
 
2523
        # New empty GnuTLS certificate
 
2524
        pubkey = gnutls.pubkey_t()
 
2525
        gnutls.pubkey_init(ctypes.byref(pubkey))
 
2526
        # Import the raw public key into the certificate
 
2527
        gnutls.pubkey_import(pubkey,
 
2528
                             ctypes.byref(datum),
 
2529
                             gnutls.X509_FMT_DER)
 
2530
        # New buffer for the key ID
 
2531
        buf = ctypes.create_string_buffer(32)
 
2532
        buf_len = ctypes.c_size_t(len(buf))
 
2533
        # Get the key ID from the raw public key into the buffer
 
2534
        gnutls.pubkey_get_key_id(
 
2535
            pubkey,
 
2536
            gnutls.KEYID_USE_SHA256,
 
2537
            ctypes.cast(ctypes.byref(buf),
 
2538
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2539
            ctypes.byref(buf_len))
 
2540
        # Deinit the certificate
 
2541
        gnutls.pubkey_deinit(pubkey)
 
2542
 
 
2543
        # Convert the buffer to a Python bytestring
 
2544
        key_id = ctypes.string_at(buf, buf_len.value)
 
2545
        # Convert the bytestring to hexadecimal notation
 
2546
        hex_key_id = binascii.hexlify(key_id).upper()
 
2547
        return hex_key_id
 
2548
 
 
2549
    @staticmethod
2349
2550
    def fingerprint(openpgp):
2350
2551
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
2351
2552
        # New GnuTLS "datum" with the OpenPGP public key
2382
2583
        return hex_fpr
2383
2584
 
2384
2585
 
2385
 
class MultiprocessingMixIn(object):
 
2586
class MultiprocessingMixIn:
2386
2587
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2387
2588
 
2388
2589
    def sub_process_main(self, request, address):
2400
2601
        return proc
2401
2602
 
2402
2603
 
2403
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
 
2604
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
2404
2605
    """ adds a pipe to the MixIn """
2405
2606
 
2406
2607
    def process_request(self, request, client_address):
2421
2622
 
2422
2623
 
2423
2624
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2424
 
                     socketserver.TCPServer, object):
2425
 
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
 
2625
                     socketserver.TCPServer):
 
2626
    """IPv6-capable TCP server.  Accepts None as address and/or port
2426
2627
 
2427
2628
    Attributes:
2428
2629
        enabled:        Boolean; whether this server is activated yet
2479
2680
            if SO_BINDTODEVICE is None:
2480
2681
                # Fall back to a hard-coded value which seems to be
2481
2682
                # common enough.
2482
 
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
2683
                log.warning("SO_BINDTODEVICE not found, trying 25")
2483
2684
                SO_BINDTODEVICE = 25
2484
2685
            try:
2485
2686
                self.socket.setsockopt(
2487
2688
                    (self.interface + "\0").encode("utf-8"))
2488
2689
            except socket.error as error:
2489
2690
                if error.errno == errno.EPERM:
2490
 
                    logger.error("No permission to bind to"
2491
 
                                 " interface %s", self.interface)
 
2691
                    log.error("No permission to bind to interface %s",
 
2692
                              self.interface)
2492
2693
                elif error.errno == errno.ENOPROTOOPT:
2493
 
                    logger.error("SO_BINDTODEVICE not available;"
2494
 
                                 " cannot bind to interface %s",
2495
 
                                 self.interface)
 
2694
                    log.error("SO_BINDTODEVICE not available; cannot"
 
2695
                              " bind to interface %s", self.interface)
2496
2696
                elif error.errno == errno.ENODEV:
2497
 
                    logger.error("Interface %s does not exist,"
2498
 
                                 " cannot bind", self.interface)
 
2697
                    log.error("Interface %s does not exist, cannot"
 
2698
                              " bind", self.interface)
2499
2699
                else:
2500
2700
                    raise
2501
2701
        # Only bind(2) the socket if we really need to.
2502
2702
        if self.server_address[0] or self.server_address[1]:
 
2703
            if self.server_address[1]:
 
2704
                self.allow_reuse_address = True
2503
2705
            if not self.server_address[0]:
2504
2706
                if self.address_family == socket.AF_INET6:
2505
2707
                    any_address = "::"  # in6addr_any
2558
2760
    def add_pipe(self, parent_pipe, proc):
2559
2761
        # Call "handle_ipc" for both data and EOF events
2560
2762
        GLib.io_add_watch(
2561
 
            parent_pipe.fileno(),
2562
 
            GLib.IO_IN | GLib.IO_HUP,
 
2763
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
 
2764
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2563
2765
            functools.partial(self.handle_ipc,
2564
2766
                              parent_pipe=parent_pipe,
2565
2767
                              proc=proc))
2578
2780
        request = parent_pipe.recv()
2579
2781
        command = request[0]
2580
2782
 
2581
 
        if command == 'init':
2582
 
            fpr = request[1].decode("ascii")
2583
 
            address = request[2]
 
2783
        if command == "init":
 
2784
            key_id = request[1].decode("ascii")
 
2785
            fpr = request[2].decode("ascii")
 
2786
            address = request[3]
2584
2787
 
2585
2788
            for c in self.clients.values():
2586
 
                if c.fingerprint == fpr:
 
2789
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
 
2790
                              "27AE41E4649B934CA495991B7852B855"):
 
2791
                    continue
 
2792
                if key_id and c.key_id == key_id:
 
2793
                    client = c
 
2794
                    break
 
2795
                if fpr and c.fingerprint == fpr:
2587
2796
                    client = c
2588
2797
                    break
2589
2798
            else:
2590
 
                logger.info("Client not found for fingerprint: %s, ad"
2591
 
                            "dress: %s", fpr, address)
 
2799
                log.info("Client not found for key ID: %s, address:"
 
2800
                         " %s", key_id or fpr, address)
2592
2801
                if self.use_dbus:
2593
2802
                    # Emit D-Bus signal
2594
 
                    mandos_dbus_service.ClientNotFound(fpr,
 
2803
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2595
2804
                                                       address[0])
2596
2805
                parent_pipe.send(False)
2597
2806
                return False
2598
2807
 
2599
2808
            GLib.io_add_watch(
2600
 
                parent_pipe.fileno(),
2601
 
                GLib.IO_IN | GLib.IO_HUP,
 
2809
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
 
2810
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2602
2811
                functools.partial(self.handle_ipc,
2603
2812
                                  parent_pipe=parent_pipe,
2604
2813
                                  proc=proc,
2607
2816
            # remove the old hook in favor of the new above hook on
2608
2817
            # same fileno
2609
2818
            return False
2610
 
        if command == 'funcall':
 
2819
        if command == "funcall":
2611
2820
            funcname = request[1]
2612
2821
            args = request[2]
2613
2822
            kwargs = request[3]
2614
2823
 
2615
 
            parent_pipe.send(('data', getattr(client_object,
 
2824
            parent_pipe.send(("data", getattr(client_object,
2616
2825
                                              funcname)(*args,
2617
2826
                                                        **kwargs)))
2618
2827
 
2619
 
        if command == 'getattr':
 
2828
        if command == "getattr":
2620
2829
            attrname = request[1]
2621
2830
            if isinstance(client_object.__getattribute__(attrname),
2622
 
                          collections.Callable):
2623
 
                parent_pipe.send(('function', ))
 
2831
                          collections.abc.Callable):
 
2832
                parent_pipe.send(("function", ))
2624
2833
            else:
2625
2834
                parent_pipe.send((
2626
 
                    'data', client_object.__getattribute__(attrname)))
 
2835
                    "data", client_object.__getattribute__(attrname)))
2627
2836
 
2628
 
        if command == 'setattr':
 
2837
        if command == "setattr":
2629
2838
            attrname = request[1]
2630
2839
            value = request[2]
2631
2840
            setattr(client_object, attrname, value)
2636
2845
def rfc3339_duration_to_delta(duration):
2637
2846
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2638
2847
 
2639
 
    >>> rfc3339_duration_to_delta("P7D")
2640
 
    datetime.timedelta(7)
2641
 
    >>> rfc3339_duration_to_delta("PT60S")
2642
 
    datetime.timedelta(0, 60)
2643
 
    >>> rfc3339_duration_to_delta("PT60M")
2644
 
    datetime.timedelta(0, 3600)
2645
 
    >>> rfc3339_duration_to_delta("PT24H")
2646
 
    datetime.timedelta(1)
2647
 
    >>> rfc3339_duration_to_delta("P1W")
2648
 
    datetime.timedelta(7)
2649
 
    >>> rfc3339_duration_to_delta("PT5M30S")
2650
 
    datetime.timedelta(0, 330)
2651
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2652
 
    datetime.timedelta(1, 200)
 
2848
    >>> timedelta = datetime.timedelta
 
2849
    >>> rfc3339_duration_to_delta("P7D") == timedelta(7)
 
2850
    True
 
2851
    >>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
 
2852
    True
 
2853
    >>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
 
2854
    True
 
2855
    >>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
 
2856
    True
 
2857
    >>> rfc3339_duration_to_delta("P1W") == timedelta(7)
 
2858
    True
 
2859
    >>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
 
2860
    True
 
2861
    >>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
 
2862
    True
 
2863
    >>> del timedelta
2653
2864
    """
2654
2865
 
2655
2866
    # Parsing an RFC 3339 duration with regular expressions is not
2735
2946
def string_to_delta(interval):
2736
2947
    """Parse a string and return a datetime.timedelta
2737
2948
 
2738
 
    >>> string_to_delta('7d')
2739
 
    datetime.timedelta(7)
2740
 
    >>> string_to_delta('60s')
2741
 
    datetime.timedelta(0, 60)
2742
 
    >>> string_to_delta('60m')
2743
 
    datetime.timedelta(0, 3600)
2744
 
    >>> string_to_delta('24h')
2745
 
    datetime.timedelta(1)
2746
 
    >>> string_to_delta('1w')
2747
 
    datetime.timedelta(7)
2748
 
    >>> string_to_delta('5m 30s')
2749
 
    datetime.timedelta(0, 330)
 
2949
    >>> string_to_delta("7d") == datetime.timedelta(7)
 
2950
    True
 
2951
    >>> string_to_delta("60s") == datetime.timedelta(0, 60)
 
2952
    True
 
2953
    >>> string_to_delta("60m") == datetime.timedelta(0, 3600)
 
2954
    True
 
2955
    >>> string_to_delta("24h") == datetime.timedelta(1)
 
2956
    True
 
2957
    >>> string_to_delta("1w") == datetime.timedelta(7)
 
2958
    True
 
2959
    >>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
 
2960
    True
2750
2961
    """
2751
2962
 
2752
2963
    try:
2854
3065
 
2855
3066
    options = parser.parse_args()
2856
3067
 
2857
 
    if options.check:
2858
 
        import doctest
2859
 
        fail_count, test_count = doctest.testmod()
2860
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2861
 
 
2862
3068
    # Default values for config file for server-global settings
 
3069
    if gnutls.has_rawpk:
 
3070
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
 
3071
                    ":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
 
3072
    else:
 
3073
        priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
3074
                    ":+SIGN-DSA-SHA256")
2863
3075
    server_defaults = {"interface": "",
2864
3076
                       "address": "",
2865
3077
                       "port": "",
2866
3078
                       "debug": "False",
2867
 
                       "priority":
2868
 
                       "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2869
 
                       ":+SIGN-DSA-SHA256",
 
3079
                       "priority": priority,
2870
3080
                       "servicename": "Mandos",
2871
3081
                       "use_dbus": "True",
2872
3082
                       "use_ipv6": "True",
2877
3087
                       "foreground": "False",
2878
3088
                       "zeroconf": "True",
2879
3089
                       }
 
3090
    del priority
2880
3091
 
2881
3092
    # Parse config file for server-global settings
2882
 
    server_config = configparser.SafeConfigParser(server_defaults)
 
3093
    server_config = configparser.ConfigParser(server_defaults)
2883
3094
    del server_defaults
2884
3095
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
2885
 
    # Convert the SafeConfigParser object to a dict
 
3096
    # Convert the ConfigParser object to a dict
2886
3097
    server_settings = server_config.defaults()
2887
3098
    # Use the appropriate methods on the non-string config options
2888
3099
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
2898
3109
        # Later, stdin will, and stdout and stderr might, be dup'ed
2899
3110
        # over with an opened os.devnull.  But we don't want this to
2900
3111
        # happen with a supplied network socket.
2901
 
        if 0 <= server_settings["socket"] <= 2:
 
3112
        while 0 <= server_settings["socket"] <= 2:
2902
3113
            server_settings["socket"] = os.dup(server_settings
2903
3114
                                               ["socket"])
 
3115
        os.set_inheritable(server_settings["socket"], False)
2904
3116
    del server_config
2905
3117
 
2906
3118
    # Override the settings from the config file with command line
2955
3167
 
2956
3168
    if server_settings["servicename"] != "Mandos":
2957
3169
        syslogger.setFormatter(
2958
 
            logging.Formatter('Mandos ({}) [%(process)d]:'
2959
 
                              ' %(levelname)s: %(message)s'.format(
 
3170
            logging.Formatter("Mandos ({}) [%(process)d]:"
 
3171
                              " %(levelname)s: %(message)s".format(
2960
3172
                                  server_settings["servicename"])))
2961
3173
 
2962
3174
    # Parse config file with clients
2963
 
    client_config = configparser.SafeConfigParser(Client
2964
 
                                                  .client_defaults)
 
3175
    client_config = configparser.ConfigParser(Client.client_defaults)
2965
3176
    client_config.read(os.path.join(server_settings["configdir"],
2966
3177
                                    "clients.conf"))
2967
3178
 
2987
3198
        try:
2988
3199
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2989
3200
        except IOError as e:
2990
 
            logger.error("Could not open file %r", pidfilename,
2991
 
                         exc_info=e)
 
3201
            log.error("Could not open file %r", pidfilename,
 
3202
                      exc_info=e)
2992
3203
 
2993
3204
    for name, group in (("_mandos", "_mandos"),
2994
3205
                        ("mandos", "mandos"),
3005
3216
    try:
3006
3217
        os.setgid(gid)
3007
3218
        os.setuid(uid)
3008
 
        if debug:
3009
 
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
3010
 
                                                             gid))
 
3219
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
3011
3220
    except OSError as error:
3012
 
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
3013
 
                       .format(uid, gid, os.strerror(error.errno)))
 
3221
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
 
3222
                    os.strerror(error.errno))
3014
3223
        if error.errno != errno.EPERM:
3015
3224
            raise
3016
3225
 
3023
3232
 
3024
3233
        @gnutls.log_func
3025
3234
        def debug_gnutls(level, string):
3026
 
            logger.debug("GnuTLS: %s", string[:-1])
 
3235
            log.debug("GnuTLS: %s",
 
3236
                      string[:-1].decode("utf-8", errors="replace"))
3027
3237
 
3028
3238
        gnutls.global_set_log_function(debug_gnutls)
3029
3239
 
3038
3248
        # Close all input and output, do double fork, etc.
3039
3249
        daemon()
3040
3250
 
3041
 
    # multiprocessing will use threads, so before we use GLib we need
3042
 
    # to inform GLib that threads will be used.
3043
 
    GLib.threads_init()
 
3251
    if gi.version_info < (3, 10, 2):
 
3252
        # multiprocessing will use threads, so before we use GLib we
 
3253
        # need to inform GLib that threads will be used.
 
3254
        GLib.threads_init()
3044
3255
 
3045
3256
    global main_loop
3046
3257
    # From the Avahi example code
3047
3258
    DBusGMainLoop(set_as_default=True)
3048
3259
    main_loop = GLib.MainLoop()
3049
 
    bus = dbus.SystemBus()
 
3260
    if use_dbus or zeroconf:
 
3261
        bus = dbus.SystemBus()
3050
3262
    # End of Avahi example code
3051
3263
    if use_dbus:
3052
3264
        try:
3057
3269
                "se.bsnet.fukt.Mandos", bus,
3058
3270
                do_not_queue=True)
3059
3271
        except dbus.exceptions.DBusException as e:
3060
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
3272
            log.error("Disabling D-Bus:", exc_info=e)
3061
3273
            use_dbus = False
3062
3274
            server_settings["use_dbus"] = False
3063
3275
            tcp_server.use_dbus = False
3122
3334
                             if isinstance(s, bytes)
3123
3335
                             else s) for s in
3124
3336
                            value["client_structure"]]
3125
 
                        # .name & .host
3126
 
                        for k in ("name", "host"):
 
3337
                        # .name, .host, and .checker_command
 
3338
                        for k in ("name", "host", "checker_command"):
3127
3339
                            if isinstance(value[k], bytes):
3128
3340
                                value[k] = value[k].decode("utf-8")
 
3341
                        if "key_id" not in value:
 
3342
                            value["key_id"] = ""
 
3343
                        elif "fingerprint" not in value:
 
3344
                            value["fingerprint"] = ""
3129
3345
                    #  old_client_settings
3130
3346
                    # .keys()
3131
3347
                    old_client_settings = {
3135
3351
                        for key, value in
3136
3352
                        bytes_old_client_settings.items()}
3137
3353
                    del bytes_old_client_settings
3138
 
                    # .host
 
3354
                    # .host and .checker_command
3139
3355
                    for value in old_client_settings.values():
3140
 
                        if isinstance(value["host"], bytes):
3141
 
                            value["host"] = (value["host"]
3142
 
                                             .decode("utf-8"))
 
3356
                        for attribute in ("host", "checker_command"):
 
3357
                            if isinstance(value[attribute], bytes):
 
3358
                                value[attribute] = (value[attribute]
 
3359
                                                    .decode("utf-8"))
3143
3360
            os.remove(stored_state_path)
3144
3361
        except IOError as e:
3145
3362
            if e.errno == errno.ENOENT:
3146
 
                logger.warning("Could not load persistent state:"
3147
 
                               " {}".format(os.strerror(e.errno)))
 
3363
                log.warning("Could not load persistent state:"
 
3364
                            " %s", os.strerror(e.errno))
3148
3365
            else:
3149
 
                logger.critical("Could not load persistent state:",
3150
 
                                exc_info=e)
 
3366
                log.critical("Could not load persistent state:",
 
3367
                             exc_info=e)
3151
3368
                raise
3152
3369
        except EOFError as e:
3153
 
            logger.warning("Could not load persistent state: "
3154
 
                           "EOFError:",
3155
 
                           exc_info=e)
 
3370
            log.warning("Could not load persistent state: EOFError:",
 
3371
                        exc_info=e)
3156
3372
 
3157
3373
    with PGPEngine() as pgp:
3158
3374
        for client_name, client in clients_data.items():
3185
3401
            if client["enabled"]:
3186
3402
                if datetime.datetime.utcnow() >= client["expires"]:
3187
3403
                    if not client["last_checked_ok"]:
3188
 
                        logger.warning(
3189
 
                            "disabling client {} - Client never "
3190
 
                            "performed a successful checker".format(
3191
 
                                client_name))
 
3404
                        log.warning("disabling client %s - Client"
 
3405
                                    " never performed a successful"
 
3406
                                    " checker", client_name)
3192
3407
                        client["enabled"] = False
3193
3408
                    elif client["last_checker_status"] != 0:
3194
 
                        logger.warning(
3195
 
                            "disabling client {} - Client last"
3196
 
                            " checker failed with error code"
3197
 
                            " {}".format(
3198
 
                                client_name,
3199
 
                                client["last_checker_status"]))
 
3409
                        log.warning("disabling client %s - Client"
 
3410
                                    " last checker failed with error"
 
3411
                                    " code %s", client_name,
 
3412
                                    client["last_checker_status"])
3200
3413
                        client["enabled"] = False
3201
3414
                    else:
3202
3415
                        client["expires"] = (
3203
3416
                            datetime.datetime.utcnow()
3204
3417
                            + client["timeout"])
3205
 
                        logger.debug("Last checker succeeded,"
3206
 
                                     " keeping {} enabled".format(
3207
 
                                         client_name))
 
3418
                        log.debug("Last checker succeeded, keeping %s"
 
3419
                                  " enabled", client_name)
3208
3420
            try:
3209
3421
                client["secret"] = pgp.decrypt(
3210
3422
                    client["encrypted_secret"],
3211
3423
                    client_settings[client_name]["secret"])
3212
3424
            except PGPError:
3213
3425
                # If decryption fails, we use secret from new settings
3214
 
                logger.debug("Failed to decrypt {} old secret".format(
3215
 
                    client_name))
 
3426
                log.debug("Failed to decrypt %s old secret",
 
3427
                          client_name)
3216
3428
                client["secret"] = (client_settings[client_name]
3217
3429
                                    ["secret"])
3218
3430
 
3232
3444
            server_settings=server_settings)
3233
3445
 
3234
3446
    if not tcp_server.clients:
3235
 
        logger.warning("No clients defined")
 
3447
        log.warning("No clients defined")
3236
3448
 
3237
3449
    if not foreground:
3238
3450
        if pidfile is not None:
3241
3453
                with pidfile:
3242
3454
                    print(pid, file=pidfile)
3243
3455
            except IOError:
3244
 
                logger.error("Could not write to file %r with PID %d",
3245
 
                             pidfilename, pid)
 
3456
                log.error("Could not write to file %r with PID %d",
 
3457
                          pidfilename, pid)
3246
3458
        del pidfile
3247
3459
        del pidfilename
3248
3460
 
3268
3480
                pass
3269
3481
 
3270
3482
            @dbus.service.signal(_interface, signature="ss")
3271
 
            def ClientNotFound(self, fingerprint, address):
 
3483
            def ClientNotFound(self, key_id, address):
3272
3484
                "D-Bus signal"
3273
3485
                pass
3274
3486
 
3398
3610
 
3399
3611
        try:
3400
3612
            with tempfile.NamedTemporaryFile(
3401
 
                    mode='wb',
 
3613
                    mode="wb",
3402
3614
                    suffix=".pickle",
3403
 
                    prefix='clients-',
 
3615
                    prefix="clients-",
3404
3616
                    dir=os.path.dirname(stored_state_path),
3405
3617
                    delete=False) as stored_state:
3406
3618
                pickle.dump((clients, client_settings), stored_state,
3414
3626
                except NameError:
3415
3627
                    pass
3416
3628
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3417
 
                logger.warning("Could not save persistent state: {}"
3418
 
                               .format(os.strerror(e.errno)))
 
3629
                log.warning("Could not save persistent state: %s",
 
3630
                            os.strerror(e.errno))
3419
3631
            else:
3420
 
                logger.warning("Could not save persistent state:",
3421
 
                               exc_info=e)
 
3632
                log.warning("Could not save persistent state:",
 
3633
                            exc_info=e)
3422
3634
                raise
3423
3635
 
3424
3636
        # Delete all clients, and settings from config
3441
3653
            mandos_dbus_service.client_added_signal(client)
3442
3654
        # Need to initiate checking of clients
3443
3655
        if client.enabled:
3444
 
            client.init_checker()
 
3656
            client.init_checker(randomize_start=True)
3445
3657
 
3446
3658
    tcp_server.enable()
3447
3659
    tcp_server.server_activate()
3450
3662
    if zeroconf:
3451
3663
        service.port = tcp_server.socket.getsockname()[1]
3452
3664
    if use_ipv6:
3453
 
        logger.info("Now listening on address %r, port %d,"
3454
 
                    " flowinfo %d, scope_id %d",
3455
 
                    *tcp_server.socket.getsockname())
 
3665
        log.info("Now listening on address %r, port %d, flowinfo %d,"
 
3666
                 " scope_id %d", *tcp_server.socket.getsockname())
3456
3667
    else:                       # IPv4
3457
 
        logger.info("Now listening on address %r, port %d",
3458
 
                    *tcp_server.socket.getsockname())
 
3668
        log.info("Now listening on address %r, port %d",
 
3669
                 *tcp_server.socket.getsockname())
3459
3670
 
3460
3671
    # service.interface = tcp_server.socket.getsockname()[3]
3461
3672
 
3465
3676
            try:
3466
3677
                service.activate()
3467
3678
            except dbus.exceptions.DBusException as error:
3468
 
                logger.critical("D-Bus Exception", exc_info=error)
 
3679
                log.critical("D-Bus Exception", exc_info=error)
3469
3680
                cleanup()
3470
3681
                sys.exit(1)
3471
3682
            # End of Avahi example code
3472
3683
 
3473
 
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3474
 
                          lambda *args, **kwargs:
3475
 
                          (tcp_server.handle_request
3476
 
                           (*args[2:], **kwargs) or True))
 
3684
        GLib.io_add_watch(
 
3685
            GLib.IOChannel.unix_new(tcp_server.fileno()),
 
3686
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
3687
            lambda *args, **kwargs: (tcp_server.handle_request
 
3688
                                     (*args[2:], **kwargs) or True))
3477
3689
 
3478
 
        logger.debug("Starting main loop")
 
3690
        log.debug("Starting main loop")
3479
3691
        main_loop.run()
3480
3692
    except AvahiError as error:
3481
 
        logger.critical("Avahi Error", exc_info=error)
 
3693
        log.critical("Avahi Error", exc_info=error)
3482
3694
        cleanup()
3483
3695
        sys.exit(1)
3484
3696
    except KeyboardInterrupt:
3485
3697
        if debug:
3486
3698
            print("", file=sys.stderr)
3487
 
        logger.debug("Server received KeyboardInterrupt")
3488
 
    logger.debug("Server exiting")
 
3699
        log.debug("Server received KeyboardInterrupt")
 
3700
    log.debug("Server exiting")
3489
3701
    # Must run before the D-Bus bus name gets deregistered
3490
3702
    cleanup()
3491
3703
 
3492
 
 
3493
 
if __name__ == '__main__':
3494
 
    main()
 
3704
 
 
3705
def parse_test_args():
 
3706
    # type: () -> argparse.Namespace
 
3707
    parser = argparse.ArgumentParser(add_help=False)
 
3708
    parser.add_argument("--check", action="store_true")
 
3709
    parser.add_argument("--prefix", )
 
3710
    args, unknown_args = parser.parse_known_args()
 
3711
    if args.check:
 
3712
        # Remove test options from sys.argv
 
3713
        sys.argv[1:] = unknown_args
 
3714
    return args
 
3715
 
 
3716
# Add all tests from doctest strings
 
3717
def load_tests(loader, tests, none):
 
3718
    import doctest
 
3719
    tests.addTests(doctest.DocTestSuite())
 
3720
    return tests
 
3721
 
 
3722
if __name__ == "__main__":
 
3723
    options = parse_test_args()
 
3724
    try:
 
3725
        if options.check:
 
3726
            extra_test_prefix = options.prefix
 
3727
            if extra_test_prefix is not None:
 
3728
                if not (unittest.main(argv=[""], exit=False)
 
3729
                        .result.wasSuccessful()):
 
3730
                    sys.exit(1)
 
3731
                class ExtraTestLoader(unittest.TestLoader):
 
3732
                    testMethodPrefix = extra_test_prefix
 
3733
                # Call using ./scriptname --test [--verbose]
 
3734
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
 
3735
            else:
 
3736
                unittest.main(argv=[""])
 
3737
        else:
 
3738
            main()
 
3739
    finally:
 
3740
        logging.shutdown()
 
3741
 
 
3742
# Local Variables:
 
3743
# run-tests:
 
3744
# (lambda (&optional extra)
 
3745
#   (if (not (funcall run-tests-in-test-buffer default-directory
 
3746
#             extra))
 
3747
#       (funcall show-test-buffer-in-test-window)
 
3748
#     (funcall remove-test-window)
 
3749
#     (if extra (message "Extra tests run successfully!"))))
 
3750
# run-tests-in-test-buffer:
 
3751
# (lambda (dir &optional extra)
 
3752
#   (with-current-buffer (get-buffer-create "*Test*")
 
3753
#     (setq buffer-read-only nil
 
3754
#           default-directory dir)
 
3755
#     (erase-buffer)
 
3756
#     (compilation-mode))
 
3757
#   (let ((process-result
 
3758
#          (let ((inhibit-read-only t))
 
3759
#            (process-file-shell-command
 
3760
#             (funcall get-command-line extra) nil "*Test*"))))
 
3761
#     (and (numberp process-result)
 
3762
#          (= process-result 0))))
 
3763
# get-command-line:
 
3764
# (lambda (&optional extra)
 
3765
#   (let ((quoted-script
 
3766
#          (shell-quote-argument (funcall get-script-name))))
 
3767
#     (format
 
3768
#      (concat "%s --check" (if extra " --prefix=atest" ""))
 
3769
#      quoted-script)))
 
3770
# get-script-name:
 
3771
# (lambda ()
 
3772
#   (if (fboundp 'file-local-name)
 
3773
#       (file-local-name (buffer-file-name))
 
3774
#     (or (file-remote-p (buffer-file-name) 'localname)
 
3775
#         (buffer-file-name))))
 
3776
# remove-test-window:
 
3777
# (lambda ()
 
3778
#   (let ((test-window (get-buffer-window "*Test*")))
 
3779
#     (if test-window (delete-window test-window))))
 
3780
# show-test-buffer-in-test-window:
 
3781
# (lambda ()
 
3782
#   (when (not (get-buffer-window-list "*Test*"))
 
3783
#     (setq next-error-last-buffer (get-buffer "*Test*"))
 
3784
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
 
3785
#            (display-buffer-overriding-action
 
3786
#             `((display-buffer-in-side-window) (side . ,side)
 
3787
#               (window-height . fit-window-to-buffer)
 
3788
#               (window-width . fit-window-to-buffer))))
 
3789
#       (display-buffer "*Test*"))))
 
3790
# eval:
 
3791
# (progn
 
3792
#   (let* ((run-extra-tests (lambda () (interactive)
 
3793
#                             (funcall run-tests t)))
 
3794
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
 
3795
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
 
3796
#     (setq minor-mode-overriding-map-alist
 
3797
#           (cons `(run-tests . ,outer-keymap)
 
3798
#                 minor-mode-overriding-map-alist)))
 
3799
#   (add-hook 'after-save-hook run-tests 90 t))
 
3800
# End: