/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: 2018-10-14 14:11:15 UTC
  • Revision ID: teddy@recompile.se-20181014141115-1oilce79snz1ackb
Depend on either old cryptsetup or new cryptsetup-initramfs

* debian/control (Package: mandos-client/Depends): Change "cryptsetup"
  to "cryptsetup (<< 2:2.0.3-1) | cryptsetup-initramfs".

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python3 -bI
2
 
# -*- coding: utf-8; lexical-binding: t -*-
 
1
#!/usr/bin/python
 
2
# -*- mode: python; coding: utf-8 -*-
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-2022 Teddy Hogeborn
15
 
# Copyright © 2008-2022 Björn Påhlsson
 
14
# Copyright © 2008-2018 Teddy Hogeborn
 
15
# Copyright © 2008-2018 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
 
34
35
from __future__ import (division, absolute_import, print_function,
35
36
                        unicode_literals)
36
37
 
39
40
except ImportError:
40
41
    pass
41
42
 
42
 
import sys
43
 
import unittest
44
 
import argparse
45
 
import logging
46
 
import os
47
43
try:
48
44
    import SocketServer as socketserver
49
45
except ImportError:
50
46
    import socketserver
51
47
import socket
 
48
import argparse
52
49
import datetime
53
50
import errno
54
51
try:
55
52
    import ConfigParser as configparser
56
53
except ImportError:
57
54
    import configparser
 
55
import sys
58
56
import re
 
57
import os
59
58
import signal
60
59
import subprocess
61
60
import atexit
62
61
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
82
80
 
83
81
import dbus
84
82
import dbus.service
85
 
import gi
86
83
from gi.repository import GLib
87
84
from dbus.mainloop.glib import DBusGMainLoop
88
85
import ctypes
90
87
import xml.dom.minidom
91
88
import inspect
92
89
 
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
 
# Show warnings by default
114
 
if not sys.warnoptions:
115
 
    import warnings
116
 
    warnings.simplefilter("default")
117
 
 
118
90
# Try to find the value of SO_BINDTODEVICE:
119
91
try:
120
92
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
140
112
            # No value found
141
113
            SO_BINDTODEVICE = None
142
114
 
143
 
if sys.version_info < (3, 2):
144
 
    configparser.Configparser = configparser.SafeConfigParser
 
115
if sys.version_info.major == 2:
 
116
    str = unicode
145
117
 
146
 
version = "1.8.16"
 
118
version = "1.7.20"
147
119
stored_state_file = "clients.pickle"
148
120
 
149
 
log = logging.getLogger(os.path.basename(sys.argv[0]))
150
 
logging.captureWarnings(True)   # Show warnings via the logging system
 
121
logger = logging.getLogger()
151
122
syslogger = None
152
123
 
153
124
try:
189
160
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
190
161
        address="/dev/log"))
191
162
    syslogger.setFormatter(logging.Formatter
192
 
                           ("Mandos [%(process)d]: %(levelname)s:"
193
 
                            " %(message)s"))
194
 
    log.addHandler(syslogger)
 
163
                           ('Mandos [%(process)d]: %(levelname)s:'
 
164
                            ' %(message)s'))
 
165
    logger.addHandler(syslogger)
195
166
 
196
167
    if debug:
197
168
        console = logging.StreamHandler()
198
 
        console.setFormatter(logging.Formatter("%(asctime)s %(name)s"
199
 
                                               " [%(process)d]:"
200
 
                                               " %(levelname)s:"
201
 
                                               " %(message)s"))
202
 
        log.addHandler(console)
203
 
    log.setLevel(level)
 
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)
204
175
 
205
176
 
206
177
class PGPError(Exception):
208
179
    pass
209
180
 
210
181
 
211
 
class PGPEngine:
 
182
class PGPEngine(object):
212
183
    """A simple class for OpenPGP symmetric encryption & decryption"""
213
184
 
214
185
    def __init__(self):
218
189
            output = subprocess.check_output(["gpgconf"])
219
190
            for line in output.splitlines():
220
191
                name, text, path = line.split(b":")
221
 
                if name == b"gpg":
 
192
                if name == "gpg":
222
193
                    self.gpg = path
223
194
                    break
224
195
        except OSError as e:
225
196
            if e.errno != errno.ENOENT:
226
197
                raise
227
 
        self.gnupgargs = ["--batch",
228
 
                          "--homedir", self.tempdir,
229
 
                          "--force-mdc",
230
 
                          "--quiet"]
 
198
        self.gnupgargs = ['--batch',
 
199
                          '--homedir', self.tempdir,
 
200
                          '--force-mdc',
 
201
                          '--quiet']
231
202
        # Only GPG version 1 has the --no-use-agent option.
232
 
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
 
203
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
233
204
            self.gnupgargs.append("--no-use-agent")
234
205
 
235
206
    def __enter__(self):
272
243
                dir=self.tempdir) as passfile:
273
244
            passfile.write(passphrase)
274
245
            passfile.flush()
275
 
            proc = subprocess.Popen([self.gpg, "--symmetric",
276
 
                                     "--passphrase-file",
 
246
            proc = subprocess.Popen([self.gpg, '--symmetric',
 
247
                                     '--passphrase-file',
277
248
                                     passfile.name]
278
249
                                    + self.gnupgargs,
279
250
                                    stdin=subprocess.PIPE,
290
261
                dir=self.tempdir) as passfile:
291
262
            passfile.write(passphrase)
292
263
            passfile.flush()
293
 
            proc = subprocess.Popen([self.gpg, "--decrypt",
294
 
                                     "--passphrase-file",
 
264
            proc = subprocess.Popen([self.gpg, '--decrypt',
 
265
                                     '--passphrase-file',
295
266
                                     passfile.name]
296
267
                                    + self.gnupgargs,
297
268
                                    stdin=subprocess.PIPE,
304
275
 
305
276
 
306
277
# Pretend that we have an Avahi module
307
 
class avahi:
308
 
    """This isn't so much a class as it is a module-like namespace."""
 
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."""
309
281
    IF_UNSPEC = -1               # avahi-common/address.h
310
282
    PROTO_UNSPEC = -1            # avahi-common/address.h
311
283
    PROTO_INET = 0               # avahi-common/address.h
315
287
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
316
288
    DBUS_PATH_SERVER = "/"
317
289
 
318
 
    @staticmethod
319
 
    def string_array_to_txt_array(t):
 
290
    def string_array_to_txt_array(self, t):
320
291
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
321
292
                           for s in t), signature="ay")
322
293
    ENTRY_GROUP_ESTABLISHED = 2  # avahi-common/defs.h
327
298
    SERVER_RUNNING = 2           # avahi-common/defs.h
328
299
    SERVER_COLLISION = 3         # avahi-common/defs.h
329
300
    SERVER_FAILURE = 4           # avahi-common/defs.h
 
301
avahi = Avahi()
330
302
 
331
303
 
332
304
class AvahiError(Exception):
344
316
    pass
345
317
 
346
318
 
347
 
class AvahiService:
 
319
class AvahiService(object):
348
320
    """An Avahi (Zeroconf) service.
349
321
 
350
322
    Attributes:
351
323
    interface: integer; avahi.IF_UNSPEC or an interface index.
352
324
               Used to optionally bind to the specified interface.
353
 
    name: string; Example: "Mandos"
354
 
    type: string; Example: "_mandos._tcp".
 
325
    name: string; Example: 'Mandos'
 
326
    type: string; Example: '_mandos._tcp'.
355
327
     See <https://www.iana.org/assignments/service-names-port-numbers>
356
328
    port: integer; what port to announce
357
329
    TXT: list of strings; TXT record for the service
394
366
    def rename(self, remove=True):
395
367
        """Derived from the Avahi example code"""
396
368
        if self.rename_count >= self.max_renames:
397
 
            log.critical("No suitable Zeroconf service name found"
398
 
                         " after %i retries, exiting.",
399
 
                         self.rename_count)
 
369
            logger.critical("No suitable Zeroconf service name found"
 
370
                            " after %i retries, exiting.",
 
371
                            self.rename_count)
400
372
            raise AvahiServiceError("Too many renames")
401
373
        self.name = str(
402
374
            self.server.GetAlternativeServiceName(self.name))
403
375
        self.rename_count += 1
404
 
        log.info("Changing Zeroconf service name to %r ...",
405
 
                 self.name)
 
376
        logger.info("Changing Zeroconf service name to %r ...",
 
377
                    self.name)
406
378
        if remove:
407
379
            self.remove()
408
380
        try:
410
382
        except dbus.exceptions.DBusException as error:
411
383
            if (error.get_dbus_name()
412
384
                == "org.freedesktop.Avahi.CollisionError"):
413
 
                log.info("Local Zeroconf service name collision.")
 
385
                logger.info("Local Zeroconf service name collision.")
414
386
                return self.rename(remove=False)
415
387
            else:
416
 
                log.critical("D-Bus Exception", exc_info=error)
 
388
                logger.critical("D-Bus Exception", exc_info=error)
417
389
                self.cleanup()
418
390
                os._exit(1)
419
391
 
435
407
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
436
408
        self.entry_group_state_changed_match = (
437
409
            self.group.connect_to_signal(
438
 
                "StateChanged", self.entry_group_state_changed))
439
 
        log.debug("Adding Zeroconf service '%s' of type '%s' ...",
440
 
                  self.name, self.type)
 
410
                'StateChanged', self.entry_group_state_changed))
 
411
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
412
                     self.name, self.type)
441
413
        self.group.AddService(
442
414
            self.interface,
443
415
            self.protocol,
450
422
 
451
423
    def entry_group_state_changed(self, state, error):
452
424
        """Derived from the Avahi example code"""
453
 
        log.debug("Avahi entry group state change: %i", state)
 
425
        logger.debug("Avahi entry group state change: %i", state)
454
426
 
455
427
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
456
 
            log.debug("Zeroconf service established.")
 
428
            logger.debug("Zeroconf service established.")
457
429
        elif state == avahi.ENTRY_GROUP_COLLISION:
458
 
            log.info("Zeroconf service name collision.")
 
430
            logger.info("Zeroconf service name collision.")
459
431
            self.rename()
460
432
        elif state == avahi.ENTRY_GROUP_FAILURE:
461
 
            log.critical("Avahi: Error in group state changed %s",
462
 
                         str(error))
 
433
            logger.critical("Avahi: Error in group state changed %s",
 
434
                            str(error))
463
435
            raise AvahiGroupError("State changed: {!s}".format(error))
464
436
 
465
437
    def cleanup(self):
475
447
 
476
448
    def server_state_changed(self, state, error=None):
477
449
        """Derived from the Avahi example code"""
478
 
        log.debug("Avahi server state change: %i", state)
 
450
        logger.debug("Avahi server state change: %i", state)
479
451
        bad_states = {
480
452
            avahi.SERVER_INVALID: "Zeroconf server invalid",
481
453
            avahi.SERVER_REGISTERING: None,
485
457
        if state in bad_states:
486
458
            if bad_states[state] is not None:
487
459
                if error is None:
488
 
                    log.error(bad_states[state])
 
460
                    logger.error(bad_states[state])
489
461
                else:
490
 
                    log.error(bad_states[state] + ": %r", error)
 
462
                    logger.error(bad_states[state] + ": %r", error)
491
463
            self.cleanup()
492
464
        elif state == avahi.SERVER_RUNNING:
493
465
            try:
495
467
            except dbus.exceptions.DBusException as error:
496
468
                if (error.get_dbus_name()
497
469
                    == "org.freedesktop.Avahi.CollisionError"):
498
 
                    log.info("Local Zeroconf service name collision.")
 
470
                    logger.info("Local Zeroconf service name"
 
471
                                " collision.")
499
472
                    return self.rename(remove=False)
500
473
                else:
501
 
                    log.critical("D-Bus Exception", exc_info=error)
 
474
                    logger.critical("D-Bus Exception", exc_info=error)
502
475
                    self.cleanup()
503
476
                    os._exit(1)
504
477
        else:
505
478
            if error is None:
506
 
                log.debug("Unknown state: %r", state)
 
479
                logger.debug("Unknown state: %r", state)
507
480
            else:
508
 
                log.debug("Unknown state: %r: %r", state, error)
 
481
                logger.debug("Unknown state: %r: %r", state, error)
509
482
 
510
483
    def activate(self):
511
484
        """Derived from the Avahi example code"""
523
496
class AvahiServiceToSyslog(AvahiService):
524
497
    def rename(self, *args, **kwargs):
525
498
        """Add the new name to the syslog messages"""
526
 
        ret = super(AvahiServiceToSyslog, self).rename(*args,
527
 
                                                       **kwargs)
 
499
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
528
500
        syslogger.setFormatter(logging.Formatter(
529
 
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
 
501
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
530
502
            .format(self.name)))
531
503
        return ret
532
504
 
533
505
 
534
506
# Pretend that we have a GnuTLS module
535
 
class gnutls:
536
 
    """This isn't so much a class as it is a module-like namespace."""
 
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."""
537
510
 
538
511
    library = ctypes.util.find_library("gnutls")
539
512
    if library is None:
540
513
        library = ctypes.util.find_library("gnutls-deb0")
541
514
    _library = ctypes.cdll.LoadLibrary(library)
542
515
    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))
543
524
 
544
525
    # Unless otherwise indicated, the constants and types below are
545
526
    # all from the gnutls/gnutls.h C header file.
549
530
    E_INTERRUPTED = -52
550
531
    E_AGAIN = -28
551
532
    CRT_OPENPGP = 2
552
 
    CRT_RAWPK = 3
553
533
    CLIENT = 2
554
534
    SHUT_RDWR = 0
555
535
    CRD_CERTIFICATE = 1
556
536
    E_NO_CERTIFICATE_FOUND = -49
557
 
    X509_FMT_DER = 0
558
 
    NO_TICKETS = 1<<10
559
 
    ENABLE_RAWPK = 1<<18
560
 
    CTYPE_PEERS = 3
561
 
    KEYID_USE_SHA256 = 1        # gnutls/x509.h
562
537
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
563
538
 
564
539
    # Types
565
 
    class _session_int(ctypes.Structure):
 
540
    class session_int(ctypes.Structure):
566
541
        _fields_ = []
567
 
    session_t = ctypes.POINTER(_session_int)
 
542
    session_t = ctypes.POINTER(session_int)
568
543
 
569
544
    class certificate_credentials_st(ctypes.Structure):
570
545
        _fields_ = []
573
548
    certificate_type_t = ctypes.c_int
574
549
 
575
550
    class datum_t(ctypes.Structure):
576
 
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
577
 
                    ("size", ctypes.c_uint)]
 
551
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
552
                    ('size', ctypes.c_uint)]
578
553
 
579
 
    class _openpgp_crt_int(ctypes.Structure):
 
554
    class openpgp_crt_int(ctypes.Structure):
580
555
        _fields_ = []
581
 
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
 
556
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
582
557
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
583
558
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
584
559
    credentials_type_t = ctypes.c_int
587
562
 
588
563
    # Exceptions
589
564
    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.
590
569
        def __init__(self, message=None, code=None, args=()):
591
570
            # Default usage is by a message string, but if a return
592
571
            # code is passed, convert it to a string with
593
572
            # gnutls.strerror()
594
573
            self.code = code
595
574
            if message is None and code is not None:
596
 
                message = gnutls.strerror(code).decode(
597
 
                    "utf-8", errors="replace")
598
 
            return super(gnutls.Error, self).__init__(
 
575
                message = GnuTLS.strerror(code)
 
576
            return super(GnuTLS.Error, self).__init__(
599
577
                message, *args)
600
578
 
601
579
    class CertificateSecurityError(Error):
602
580
        pass
603
581
 
604
 
    class PointerTo:
605
 
        def __init__(self, cls):
606
 
            self.cls = cls
607
 
 
608
 
        def from_param(self, obj):
609
 
            if not isinstance(obj, self.cls):
610
 
                raise TypeError("Not of type {}: {!r}"
611
 
                                .format(self.cls.__name__, obj))
612
 
            return ctypes.byref(obj.from_param(obj))
613
 
 
614
 
    class CastToVoidPointer:
615
 
        def __init__(self, cls):
616
 
            self.cls = cls
617
 
 
618
 
        def from_param(self, obj):
619
 
            if not isinstance(obj, self.cls):
620
 
                raise TypeError("Not of type {}: {!r}"
621
 
                                .format(self.cls.__name__, obj))
622
 
            return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)
623
 
 
624
 
    class With_from_param:
625
 
        @classmethod
626
 
        def from_param(cls, obj):
627
 
            return obj._as_parameter_
628
 
 
629
582
    # Classes
630
 
    class Credentials(With_from_param):
 
583
    class Credentials(object):
631
584
        def __init__(self):
632
 
            self._as_parameter_ = gnutls.certificate_credentials_t()
633
 
            gnutls.certificate_allocate_credentials(self)
 
585
            self._c_object = gnutls.certificate_credentials_t()
 
586
            gnutls.certificate_allocate_credentials(
 
587
                ctypes.byref(self._c_object))
634
588
            self.type = gnutls.CRD_CERTIFICATE
635
589
 
636
590
        def __del__(self):
637
 
            gnutls.certificate_free_credentials(self)
 
591
            gnutls.certificate_free_credentials(self._c_object)
638
592
 
639
 
    class ClientSession(With_from_param):
 
593
    class ClientSession(object):
640
594
        def __init__(self, socket, credentials=None):
641
 
            self._as_parameter_ = gnutls.session_t()
642
 
            gnutls_flags = gnutls.CLIENT
643
 
            if gnutls.check_version(b"3.5.6"):
644
 
                gnutls_flags |= gnutls.NO_TICKETS
645
 
            if gnutls.has_rawpk:
646
 
                gnutls_flags |= gnutls.ENABLE_RAWPK
647
 
            gnutls.init(self, gnutls_flags)
648
 
            del gnutls_flags
649
 
            gnutls.set_default_priority(self)
650
 
            gnutls.transport_set_ptr(self, socket.fileno())
651
 
            gnutls.handshake_set_private_extensions(self, True)
 
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)
652
601
            self.socket = socket
653
602
            if credentials is None:
654
603
                credentials = gnutls.Credentials()
655
 
            gnutls.credentials_set(self, credentials.type,
656
 
                                   credentials)
 
604
            gnutls.credentials_set(self._c_object, credentials.type,
 
605
                                   ctypes.cast(credentials._c_object,
 
606
                                               ctypes.c_void_p))
657
607
            self.credentials = credentials
658
608
 
659
609
        def __del__(self):
660
 
            gnutls.deinit(self)
 
610
            gnutls.deinit(self._c_object)
661
611
 
662
612
        def handshake(self):
663
 
            return gnutls.handshake(self)
 
613
            return gnutls.handshake(self._c_object)
664
614
 
665
615
        def send(self, data):
666
616
            data = bytes(data)
667
617
            data_len = len(data)
668
618
            while data_len > 0:
669
 
                data_len -= gnutls.record_send(self, data[-data_len:],
 
619
                data_len -= gnutls.record_send(self._c_object,
 
620
                                               data[-data_len:],
670
621
                                               data_len)
671
622
 
672
623
        def bye(self):
673
 
            return gnutls.bye(self, gnutls.SHUT_RDWR)
 
624
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
674
625
 
675
626
    # Error handling functions
676
627
    def _error_code(result):
677
628
        """A function to raise exceptions on errors, suitable
678
 
        for the "restype" attribute on ctypes functions"""
679
 
        if result >= gnutls.E_SUCCESS:
 
629
        for the 'restype' attribute on ctypes functions"""
 
630
        if result >= 0:
680
631
            return result
681
632
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
682
633
            raise gnutls.CertificateSecurityError(code=result)
683
634
        raise gnutls.Error(code=result)
684
635
 
685
 
    def _retry_on_error(result, func, arguments,
686
 
                        _error_code=_error_code):
 
636
    def _retry_on_error(result, func, arguments):
687
637
        """A function to retry on some errors, suitable
688
 
        for the "errcheck" attribute on ctypes functions"""
689
 
        while result < gnutls.E_SUCCESS:
 
638
        for the 'errcheck' attribute on ctypes functions"""
 
639
        while result < 0:
690
640
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
691
641
                return _error_code(result)
692
642
            result = func(*arguments)
697
647
 
698
648
    # Functions
699
649
    priority_set_direct = _library.gnutls_priority_set_direct
700
 
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
 
650
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
701
651
                                    ctypes.POINTER(ctypes.c_char_p)]
702
652
    priority_set_direct.restype = _error_code
703
653
 
704
654
    init = _library.gnutls_init
705
 
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
 
655
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
706
656
    init.restype = _error_code
707
657
 
708
658
    set_default_priority = _library.gnutls_set_default_priority
709
 
    set_default_priority.argtypes = [ClientSession]
 
659
    set_default_priority.argtypes = [session_t]
710
660
    set_default_priority.restype = _error_code
711
661
 
712
662
    record_send = _library.gnutls_record_send
713
 
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
 
663
    record_send.argtypes = [session_t, ctypes.c_void_p,
714
664
                            ctypes.c_size_t]
715
665
    record_send.restype = ctypes.c_ssize_t
716
666
    record_send.errcheck = _retry_on_error
718
668
    certificate_allocate_credentials = (
719
669
        _library.gnutls_certificate_allocate_credentials)
720
670
    certificate_allocate_credentials.argtypes = [
721
 
        PointerTo(Credentials)]
 
671
        ctypes.POINTER(certificate_credentials_t)]
722
672
    certificate_allocate_credentials.restype = _error_code
723
673
 
724
674
    certificate_free_credentials = (
725
675
        _library.gnutls_certificate_free_credentials)
726
 
    certificate_free_credentials.argtypes = [Credentials]
 
676
    certificate_free_credentials.argtypes = [
 
677
        certificate_credentials_t]
727
678
    certificate_free_credentials.restype = None
728
679
 
729
680
    handshake_set_private_extensions = (
730
681
        _library.gnutls_handshake_set_private_extensions)
731
 
    handshake_set_private_extensions.argtypes = [ClientSession,
 
682
    handshake_set_private_extensions.argtypes = [session_t,
732
683
                                                 ctypes.c_int]
733
684
    handshake_set_private_extensions.restype = None
734
685
 
735
686
    credentials_set = _library.gnutls_credentials_set
736
 
    credentials_set.argtypes = [ClientSession, credentials_type_t,
737
 
                                CastToVoidPointer(Credentials)]
 
687
    credentials_set.argtypes = [session_t, credentials_type_t,
 
688
                                ctypes.c_void_p]
738
689
    credentials_set.restype = _error_code
739
690
 
740
691
    strerror = _library.gnutls_strerror
742
693
    strerror.restype = ctypes.c_char_p
743
694
 
744
695
    certificate_type_get = _library.gnutls_certificate_type_get
745
 
    certificate_type_get.argtypes = [ClientSession]
 
696
    certificate_type_get.argtypes = [session_t]
746
697
    certificate_type_get.restype = _error_code
747
698
 
748
699
    certificate_get_peers = _library.gnutls_certificate_get_peers
749
 
    certificate_get_peers.argtypes = [ClientSession,
 
700
    certificate_get_peers.argtypes = [session_t,
750
701
                                      ctypes.POINTER(ctypes.c_uint)]
751
702
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
752
703
 
759
710
    global_set_log_function.restype = None
760
711
 
761
712
    deinit = _library.gnutls_deinit
762
 
    deinit.argtypes = [ClientSession]
 
713
    deinit.argtypes = [session_t]
763
714
    deinit.restype = None
764
715
 
765
716
    handshake = _library.gnutls_handshake
766
 
    handshake.argtypes = [ClientSession]
767
 
    handshake.restype = ctypes.c_int
 
717
    handshake.argtypes = [session_t]
 
718
    handshake.restype = _error_code
768
719
    handshake.errcheck = _retry_on_error
769
720
 
770
721
    transport_set_ptr = _library.gnutls_transport_set_ptr
771
 
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
 
722
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
772
723
    transport_set_ptr.restype = None
773
724
 
774
725
    bye = _library.gnutls_bye
775
 
    bye.argtypes = [ClientSession, close_request_t]
776
 
    bye.restype = ctypes.c_int
 
726
    bye.argtypes = [session_t, close_request_t]
 
727
    bye.restype = _error_code
777
728
    bye.errcheck = _retry_on_error
778
729
 
779
730
    check_version = _library.gnutls_check_version
780
731
    check_version.argtypes = [ctypes.c_char_p]
781
732
    check_version.restype = ctypes.c_char_p
782
733
 
783
 
    _need_version = b"3.3.0"
784
 
    if check_version(_need_version) is None:
785
 
        raise self.Error("Needs GnuTLS {} or later"
786
 
                         .format(_need_version))
787
 
 
788
 
    _tls_rawpk_version = b"3.6.6"
789
 
    has_rawpk = bool(check_version(_tls_rawpk_version))
790
 
 
791
 
    if has_rawpk:
792
 
        # Types
793
 
        class pubkey_st(ctypes.Structure):
794
 
            _fields = []
795
 
        pubkey_t = ctypes.POINTER(pubkey_st)
796
 
 
797
 
        x509_crt_fmt_t = ctypes.c_int
798
 
 
799
 
        # All the function declarations below are from
800
 
        # gnutls/abstract.h
801
 
        pubkey_init = _library.gnutls_pubkey_init
802
 
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
803
 
        pubkey_init.restype = _error_code
804
 
 
805
 
        pubkey_import = _library.gnutls_pubkey_import
806
 
        pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
807
 
                                  x509_crt_fmt_t]
808
 
        pubkey_import.restype = _error_code
809
 
 
810
 
        pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
811
 
        pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
812
 
                                      ctypes.POINTER(ctypes.c_ubyte),
813
 
                                      ctypes.POINTER(ctypes.c_size_t)]
814
 
        pubkey_get_key_id.restype = _error_code
815
 
 
816
 
        pubkey_deinit = _library.gnutls_pubkey_deinit
817
 
        pubkey_deinit.argtypes = [pubkey_t]
818
 
        pubkey_deinit.restype = None
819
 
    else:
820
 
        # All the function declarations below are from
821
 
        # gnutls/openpgp.h
822
 
 
823
 
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
824
 
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
825
 
        openpgp_crt_init.restype = _error_code
826
 
 
827
 
        openpgp_crt_import = _library.gnutls_openpgp_crt_import
828
 
        openpgp_crt_import.argtypes = [openpgp_crt_t,
829
 
                                       ctypes.POINTER(datum_t),
830
 
                                       openpgp_crt_fmt_t]
831
 
        openpgp_crt_import.restype = _error_code
832
 
 
833
 
        openpgp_crt_verify_self = \
834
 
            _library.gnutls_openpgp_crt_verify_self
835
 
        openpgp_crt_verify_self.argtypes = [
836
 
            openpgp_crt_t,
837
 
            ctypes.c_uint,
838
 
            ctypes.POINTER(ctypes.c_uint),
839
 
        ]
840
 
        openpgp_crt_verify_self.restype = _error_code
841
 
 
842
 
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
843
 
        openpgp_crt_deinit.argtypes = [openpgp_crt_t]
844
 
        openpgp_crt_deinit.restype = None
845
 
 
846
 
        openpgp_crt_get_fingerprint = (
847
 
            _library.gnutls_openpgp_crt_get_fingerprint)
848
 
        openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
849
 
                                                ctypes.c_void_p,
850
 
                                                ctypes.POINTER(
851
 
                                                    ctypes.c_size_t)]
852
 
        openpgp_crt_get_fingerprint.restype = _error_code
853
 
 
854
 
    if check_version(b"3.6.4"):
855
 
        certificate_type_get2 = _library.gnutls_certificate_type_get2
856
 
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
857
 
        certificate_type_get2.restype = _error_code
 
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
858
762
 
859
763
    # Remove non-public functions
860
764
    del _error_code, _retry_on_error
 
765
# Create the global "gnutls" object, simulating a module
 
766
gnutls = GnuTLS()
861
767
 
862
768
 
863
769
def call_pipe(connection,       # : multiprocessing.Connection
871
777
    connection.close()
872
778
 
873
779
 
874
 
class Client:
 
780
class Client(object):
875
781
    """A representation of a client host served by this server.
876
782
 
877
783
    Attributes:
878
 
    approved:   bool(); None if not yet approved/disapproved
 
784
    approved:   bool(); 'None' if not yet approved/disapproved
879
785
    approval_delay: datetime.timedelta(); Time to wait for approval
880
786
    approval_duration: datetime.timedelta(); Duration of one approval
881
 
    checker: multiprocessing.Process(); a running checker process used
882
 
             to see if the client lives. None if no process is
883
 
             running.
 
787
    checker:    subprocess.Popen(); a running checker process used
 
788
                                    to see if the client lives.
 
789
                                    'None' if no process is running.
884
790
    checker_callback_tag: a GLib event source tag, or None
885
791
    checker_command: string; External command which is run to check
886
792
                     if client lives.  %() expansions are done at
894
800
    disable_initiator_tag: a GLib event source tag, or None
895
801
    enabled:    bool()
896
802
    fingerprint: string (40 or 32 hexadecimal digits); used to
897
 
                 uniquely identify an OpenPGP client
898
 
    key_id: string (64 hexadecimal digits); used to uniquely identify
899
 
            a client using raw public keys
 
803
                 uniquely identify the client
900
804
    host:       string; available for use by the checker command
901
805
    interval:   datetime.timedelta(); How often to start a new checker
902
806
    last_approval_request: datetime.datetime(); (UTC) or None
920
824
    """
921
825
 
922
826
    runtime_expansions = ("approval_delay", "approval_duration",
923
 
                          "created", "enabled", "expires", "key_id",
 
827
                          "created", "enabled", "expires",
924
828
                          "fingerprint", "host", "interval",
925
829
                          "last_approval_request", "last_checked_ok",
926
830
                          "last_enabled", "name", "timeout")
956
860
            client["enabled"] = config.getboolean(client_name,
957
861
                                                  "enabled")
958
862
 
959
 
            # Uppercase and remove spaces from key_id and fingerprint
960
 
            # for later comparison purposes with return value from the
961
 
            # key_id() and fingerprint() functions
962
 
            client["key_id"] = (section.get("key_id", "").upper()
963
 
                                .replace(" ", ""))
 
863
            # Uppercase and remove spaces from fingerprint for later
 
864
            # comparison purposes with return value from the
 
865
            # fingerprint() function
964
866
            client["fingerprint"] = (section["fingerprint"].upper()
965
867
                                     .replace(" ", ""))
966
868
            if "secret" in section:
1009
911
            self.last_enabled = None
1010
912
            self.expires = None
1011
913
 
1012
 
        log.debug("Creating client %r", self.name)
1013
 
        log.debug("  Key ID: %s", self.key_id)
1014
 
        log.debug("  Fingerprint: %s", self.fingerprint)
 
914
        logger.debug("Creating client %r", self.name)
 
915
        logger.debug("  Fingerprint: %s", self.fingerprint)
1015
916
        self.created = settings.get("created",
1016
917
                                    datetime.datetime.utcnow())
1017
918
 
1045
946
        if getattr(self, "enabled", False):
1046
947
            # Already enabled
1047
948
            return
 
949
        self.expires = datetime.datetime.utcnow() + self.timeout
1048
950
        self.enabled = True
1049
951
        self.last_enabled = datetime.datetime.utcnow()
1050
952
        self.init_checker()
1055
957
        if not getattr(self, "enabled", False):
1056
958
            return False
1057
959
        if not quiet:
1058
 
            log.info("Disabling client %s", self.name)
 
960
            logger.info("Disabling client %s", self.name)
1059
961
        if getattr(self, "disable_initiator_tag", None) is not None:
1060
962
            GLib.source_remove(self.disable_initiator_tag)
1061
963
            self.disable_initiator_tag = None
1073
975
    def __del__(self):
1074
976
        self.disable()
1075
977
 
1076
 
    def init_checker(self, randomize_start=False):
1077
 
        # Schedule a new checker to be started a randomly selected
1078
 
        # time (a fraction of 'interval') from now.  This spreads out
1079
 
        # the startup of checkers over time when the server is
1080
 
        # started.
 
978
    def init_checker(self):
 
979
        # Schedule a new checker to be started an 'interval' from now,
 
980
        # and every interval from then on.
1081
981
        if self.checker_initiator_tag is not None:
1082
982
            GLib.source_remove(self.checker_initiator_tag)
1083
 
        interval_milliseconds = int(self.interval.total_seconds()
1084
 
                                    * 1000)
1085
 
        if randomize_start:
1086
 
            delay_milliseconds = random.randrange(
1087
 
                interval_milliseconds + 1)
1088
 
        else:
1089
 
            delay_milliseconds = interval_milliseconds
1090
983
        self.checker_initiator_tag = GLib.timeout_add(
1091
 
            delay_milliseconds, self.start_checker, randomize_start)
1092
 
        delay = datetime.timedelta(0, 0, 0, delay_milliseconds)
1093
 
        # A checker might take up to an 'interval' of time, so we can
1094
 
        # expire at the soonest one interval after a checker was
1095
 
        # started.  Since the initial checker is delayed, the expire
1096
 
        # time might have to be extended.
1097
 
        now = datetime.datetime.utcnow()
1098
 
        self.expires = now + delay + self.interval
1099
 
        # Schedule a disable() at expire time
 
984
            int(self.interval.total_seconds() * 1000),
 
985
            self.start_checker)
 
986
        # Schedule a disable() when 'timeout' has passed
1100
987
        if self.disable_initiator_tag is not None:
1101
988
            GLib.source_remove(self.disable_initiator_tag)
1102
989
        self.disable_initiator_tag = GLib.timeout_add(
1103
 
            int((self.expires - now).total_seconds() * 1000),
1104
 
            self.disable)
 
990
            int(self.timeout.total_seconds() * 1000), self.disable)
 
991
        # Also start a new checker *right now*.
 
992
        self.start_checker()
1105
993
 
1106
994
    def checker_callback(self, source, condition, connection,
1107
995
                         command):
1108
996
        """The checker has completed, so take appropriate actions."""
 
997
        self.checker_callback_tag = None
 
998
        self.checker = None
1109
999
        # Read return code from connection (see call_pipe)
1110
1000
        returncode = connection.recv()
1111
1001
        connection.close()
1112
 
        if self.checker is not None:
1113
 
            self.checker.join()
1114
 
        self.checker_callback_tag = None
1115
 
        self.checker = None
1116
1002
 
1117
1003
        if returncode >= 0:
1118
1004
            self.last_checker_status = returncode
1119
1005
            self.last_checker_signal = None
1120
1006
            if self.last_checker_status == 0:
1121
 
                log.info("Checker for %(name)s succeeded", vars(self))
 
1007
                logger.info("Checker for %(name)s succeeded",
 
1008
                            vars(self))
1122
1009
                self.checked_ok()
1123
1010
            else:
1124
 
                log.info("Checker for %(name)s failed", vars(self))
 
1011
                logger.info("Checker for %(name)s failed", vars(self))
1125
1012
        else:
1126
1013
            self.last_checker_status = -1
1127
1014
            self.last_checker_signal = -returncode
1128
 
            log.warning("Checker for %(name)s crashed?", vars(self))
 
1015
            logger.warning("Checker for %(name)s crashed?",
 
1016
                           vars(self))
1129
1017
        return False
1130
1018
 
1131
1019
    def checked_ok(self):
1150
1038
    def need_approval(self):
1151
1039
        self.last_approval_request = datetime.datetime.utcnow()
1152
1040
 
1153
 
    def start_checker(self, start_was_randomized=False):
 
1041
    def start_checker(self):
1154
1042
        """Start a new checker subprocess if one is not running.
1155
1043
 
1156
1044
        If a checker already exists, leave it running and do
1165
1053
        # should be.
1166
1054
 
1167
1055
        if self.checker is not None and not self.checker.is_alive():
1168
 
            log.warning("Checker was not alive; joining")
 
1056
            logger.warning("Checker was not alive; joining")
1169
1057
            self.checker.join()
1170
1058
            self.checker = None
1171
1059
        # Start a new checker if needed
1172
1060
        if self.checker is None:
1173
1061
            # Escape attributes for the shell
1174
1062
            escaped_attrs = {
1175
 
                attr: shlex.quote(str(getattr(self, attr)))
 
1063
                attr: re.escape(str(getattr(self, attr)))
1176
1064
                for attr in self.runtime_expansions}
1177
1065
            try:
1178
1066
                command = self.checker_command % escaped_attrs
1179
1067
            except TypeError as error:
1180
 
                log.error('Could not format string "%s"',
1181
 
                          self.checker_command, exc_info=error)
 
1068
                logger.error('Could not format string "%s"',
 
1069
                             self.checker_command,
 
1070
                             exc_info=error)
1182
1071
                return True     # Try again later
1183
1072
            self.current_checker_command = command
1184
 
            log.info("Starting checker %r for %s", command, self.name)
 
1073
            logger.info("Starting checker %r for %s", command,
 
1074
                        self.name)
1185
1075
            # We don't need to redirect stdout and stderr, since
1186
1076
            # in normal mode, that is already done by daemon(),
1187
1077
            # and in debug mode we don't want to.  (Stdin is
1203
1093
                kwargs=popen_args)
1204
1094
            self.checker.start()
1205
1095
            self.checker_callback_tag = GLib.io_add_watch(
1206
 
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1207
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
1096
                pipe[0].fileno(), GLib.IO_IN,
1208
1097
                self.checker_callback, pipe[0], command)
1209
 
        if start_was_randomized:
1210
 
            # We were started after a random delay; Schedule a new
1211
 
            # checker to be started an 'interval' from now, and every
1212
 
            # interval from then on.
1213
 
            now = datetime.datetime.utcnow()
1214
 
            self.checker_initiator_tag = GLib.timeout_add(
1215
 
                int(self.interval.total_seconds() * 1000),
1216
 
                self.start_checker)
1217
 
            self.expires = max(self.expires, now + self.interval)
1218
 
            # Don't start a new checker again after same random delay
1219
 
            return False
1220
1098
        # Re-run this periodically if run by GLib.timeout_add
1221
1099
        return True
1222
1100
 
1227
1105
            self.checker_callback_tag = None
1228
1106
        if getattr(self, "checker", None) is None:
1229
1107
            return
1230
 
        log.debug("Stopping checker for %(name)s", vars(self))
 
1108
        logger.debug("Stopping checker for %(name)s", vars(self))
1231
1109
        self.checker.terminate()
1232
1110
        self.checker = None
1233
1111
 
1260
1138
        func._dbus_name = func.__name__
1261
1139
        if func._dbus_name.endswith("_dbus_property"):
1262
1140
            func._dbus_name = func._dbus_name[:-14]
1263
 
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
 
1141
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1264
1142
        return func
1265
1143
 
1266
1144
    return decorator
1355
1233
 
1356
1234
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1357
1235
                         out_signature="s",
1358
 
                         path_keyword="object_path",
1359
 
                         connection_keyword="connection")
 
1236
                         path_keyword='object_path',
 
1237
                         connection_keyword='connection')
1360
1238
    def Introspect(self, object_path, connection):
1361
1239
        """Overloading of standard D-Bus method.
1362
1240
 
1411
1289
            document.unlink()
1412
1290
        except (AttributeError, xml.dom.DOMException,
1413
1291
                xml.parsers.expat.ExpatError) as error:
1414
 
            log.error("Failed to override Introspection method",
1415
 
                      exc_info=error)
 
1292
            logger.error("Failed to override Introspection method",
 
1293
                         exc_info=error)
1416
1294
        return xmlstring
1417
1295
 
1418
1296
 
1476
1354
                raise ValueError("Byte arrays not supported for non-"
1477
1355
                                 "'ay' signature {!r}"
1478
1356
                                 .format(prop._dbus_signature))
1479
 
            value = dbus.ByteArray(bytes(value))
 
1357
            value = dbus.ByteArray(b''.join(chr(byte)
 
1358
                                            for byte in value))
1480
1359
        prop(value)
1481
1360
 
1482
1361
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1515
1394
 
1516
1395
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1517
1396
                         out_signature="s",
1518
 
                         path_keyword="object_path",
1519
 
                         connection_keyword="connection")
 
1397
                         path_keyword='object_path',
 
1398
                         connection_keyword='connection')
1520
1399
    def Introspect(self, object_path, connection):
1521
1400
        """Overloading of standard D-Bus method.
1522
1401
 
1578
1457
            document.unlink()
1579
1458
        except (AttributeError, xml.dom.DOMException,
1580
1459
                xml.parsers.expat.ExpatError) as error:
1581
 
            log.error("Failed to override Introspection method",
1582
 
                      exc_info=error)
 
1460
            logger.error("Failed to override Introspection method",
 
1461
                         exc_info=error)
1583
1462
        return xmlstring
1584
1463
 
1585
1464
 
1617
1496
 
1618
1497
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1619
1498
                         out_signature="s",
1620
 
                         path_keyword="object_path",
1621
 
                         connection_keyword="connection")
 
1499
                         path_keyword='object_path',
 
1500
                         connection_keyword='connection')
1622
1501
    def Introspect(self, object_path, connection):
1623
1502
        """Overloading of standard D-Bus method.
1624
1503
 
1649
1528
            document.unlink()
1650
1529
        except (AttributeError, xml.dom.DOMException,
1651
1530
                xml.parsers.expat.ExpatError) as error:
1652
 
            log.error("Failed to override Introspection method",
1653
 
                      exc_info=error)
 
1531
            logger.error("Failed to override Introspection method",
 
1532
                         exc_info=error)
1654
1533
        return xmlstring
1655
1534
 
1656
1535
 
2120
1999
    def Name_dbus_property(self):
2121
2000
        return dbus.String(self.name)
2122
2001
 
2123
 
    # KeyID - property
2124
 
    @dbus_annotations(
2125
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2126
 
    @dbus_service_property(_interface, signature="s", access="read")
2127
 
    def KeyID_dbus_property(self):
2128
 
        return dbus.String(self.key_id)
2129
 
 
2130
2002
    # Fingerprint - property
2131
2003
    @dbus_annotations(
2132
2004
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2287
2159
    del _interface
2288
2160
 
2289
2161
 
2290
 
class ProxyClient:
2291
 
    def __init__(self, child_pipe, key_id, fpr, address):
 
2162
class ProxyClient(object):
 
2163
    def __init__(self, child_pipe, fpr, address):
2292
2164
        self._pipe = child_pipe
2293
 
        self._pipe.send(("init", key_id, fpr, address))
 
2165
        self._pipe.send(('init', fpr, address))
2294
2166
        if not self._pipe.recv():
2295
 
            raise KeyError(key_id or fpr)
 
2167
            raise KeyError(fpr)
2296
2168
 
2297
2169
    def __getattribute__(self, name):
2298
 
        if name == "_pipe":
 
2170
        if name == '_pipe':
2299
2171
            return super(ProxyClient, self).__getattribute__(name)
2300
 
        self._pipe.send(("getattr", name))
 
2172
        self._pipe.send(('getattr', name))
2301
2173
        data = self._pipe.recv()
2302
 
        if data[0] == "data":
 
2174
        if data[0] == 'data':
2303
2175
            return data[1]
2304
 
        if data[0] == "function":
 
2176
        if data[0] == 'function':
2305
2177
 
2306
2178
            def func(*args, **kwargs):
2307
 
                self._pipe.send(("funcall", name, args, kwargs))
 
2179
                self._pipe.send(('funcall', name, args, kwargs))
2308
2180
                return self._pipe.recv()[1]
2309
2181
 
2310
2182
            return func
2311
2183
 
2312
2184
    def __setattr__(self, name, value):
2313
 
        if name == "_pipe":
 
2185
        if name == '_pipe':
2314
2186
            return super(ProxyClient, self).__setattr__(name, value)
2315
 
        self._pipe.send(("setattr", name, value))
 
2187
        self._pipe.send(('setattr', name, value))
2316
2188
 
2317
2189
 
2318
2190
class ClientHandler(socketserver.BaseRequestHandler, object):
2323
2195
 
2324
2196
    def handle(self):
2325
2197
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2326
 
            log.info("TCP connection from: %s",
2327
 
                     str(self.client_address))
2328
 
            log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
 
2198
            logger.info("TCP connection from: %s",
 
2199
                        str(self.client_address))
 
2200
            logger.debug("Pipe FD: %d",
 
2201
                         self.server.child_pipe.fileno())
2329
2202
 
2330
2203
            session = gnutls.ClientSession(self.request)
2331
2204
 
2332
 
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
 
2205
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
2333
2206
            #                       "+AES-256-CBC", "+SHA1",
2334
2207
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2335
2208
            #                       "+DHE-DSS"))
2337
2210
            priority = self.server.gnutls_priority
2338
2211
            if priority is None:
2339
2212
                priority = "NORMAL"
2340
 
            gnutls.priority_set_direct(session,
2341
 
                                       priority.encode("utf-8"), None)
 
2213
            gnutls.priority_set_direct(session._c_object,
 
2214
                                       priority.encode("utf-8"),
 
2215
                                       None)
2342
2216
 
2343
2217
            # Start communication using the Mandos protocol
2344
2218
            # Get protocol number
2345
2219
            line = self.request.makefile().readline()
2346
 
            log.debug("Protocol version: %r", line)
 
2220
            logger.debug("Protocol version: %r", line)
2347
2221
            try:
2348
2222
                if int(line.strip().split()[0]) > 1:
2349
2223
                    raise RuntimeError(line)
2350
2224
            except (ValueError, IndexError, RuntimeError) as error:
2351
 
                log.error("Unknown protocol version: %s", error)
 
2225
                logger.error("Unknown protocol version: %s", error)
2352
2226
                return
2353
2227
 
2354
2228
            # Start GnuTLS connection
2355
2229
            try:
2356
2230
                session.handshake()
2357
2231
            except gnutls.Error as error:
2358
 
                log.warning("Handshake failed: %s", error)
 
2232
                logger.warning("Handshake failed: %s", error)
2359
2233
                # Do not run session.bye() here: the session is not
2360
2234
                # established.  Just abandon the request.
2361
2235
                return
2362
 
            log.debug("Handshake succeeded")
 
2236
            logger.debug("Handshake succeeded")
2363
2237
 
2364
2238
            approval_required = False
2365
2239
            try:
2366
 
                if gnutls.has_rawpk:
2367
 
                    fpr = b""
2368
 
                    try:
2369
 
                        key_id = self.key_id(
2370
 
                            self.peer_certificate(session))
2371
 
                    except (TypeError, gnutls.Error) as error:
2372
 
                        log.warning("Bad certificate: %s", error)
2373
 
                        return
2374
 
                    log.debug("Key ID: %s",
2375
 
                              key_id.decode("utf-8",
2376
 
                                            errors="replace"))
2377
 
 
2378
 
                else:
2379
 
                    key_id = b""
2380
 
                    try:
2381
 
                        fpr = self.fingerprint(
2382
 
                            self.peer_certificate(session))
2383
 
                    except (TypeError, gnutls.Error) as error:
2384
 
                        log.warning("Bad certificate: %s", error)
2385
 
                        return
2386
 
                    log.debug("Fingerprint: %s", fpr)
2387
 
 
2388
 
                try:
2389
 
                    client = ProxyClient(child_pipe, key_id, fpr,
 
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,
2390
2250
                                         self.client_address)
2391
2251
                except KeyError:
2392
2252
                    return
2398
2258
 
2399
2259
                while True:
2400
2260
                    if not client.enabled:
2401
 
                        log.info("Client %s is disabled", client.name)
 
2261
                        logger.info("Client %s is disabled",
 
2262
                                    client.name)
2402
2263
                        if self.server.use_dbus:
2403
2264
                            # Emit D-Bus signal
2404
2265
                            client.Rejected("Disabled")
2408
2269
                        # We are approved or approval is disabled
2409
2270
                        break
2410
2271
                    elif client.approved is None:
2411
 
                        log.info("Client %s needs approval",
2412
 
                                 client.name)
 
2272
                        logger.info("Client %s needs approval",
 
2273
                                    client.name)
2413
2274
                        if self.server.use_dbus:
2414
2275
                            # Emit D-Bus signal
2415
2276
                            client.NeedApproval(
2416
2277
                                client.approval_delay.total_seconds()
2417
2278
                                * 1000, client.approved_by_default)
2418
2279
                    else:
2419
 
                        log.warning("Client %s was not approved",
2420
 
                                    client.name)
 
2280
                        logger.warning("Client %s was not approved",
 
2281
                                       client.name)
2421
2282
                        if self.server.use_dbus:
2422
2283
                            # Emit D-Bus signal
2423
2284
                            client.Rejected("Denied")
2431
2292
                    time2 = datetime.datetime.now()
2432
2293
                    if (time2 - time) >= delay:
2433
2294
                        if not client.approved_by_default:
2434
 
                            log.warning("Client %s timed out while"
2435
 
                                        " waiting for approval",
2436
 
                                        client.name)
 
2295
                            logger.warning("Client %s timed out while"
 
2296
                                           " waiting for approval",
 
2297
                                           client.name)
2437
2298
                            if self.server.use_dbus:
2438
2299
                                # Emit D-Bus signal
2439
2300
                                client.Rejected("Approval timed out")
2446
2307
                try:
2447
2308
                    session.send(client.secret)
2448
2309
                except gnutls.Error as error:
2449
 
                    log.warning("gnutls send failed", exc_info=error)
 
2310
                    logger.warning("gnutls send failed",
 
2311
                                   exc_info=error)
2450
2312
                    return
2451
2313
 
2452
 
                log.info("Sending secret to %s", client.name)
 
2314
                logger.info("Sending secret to %s", client.name)
2453
2315
                # bump the timeout using extended_timeout
2454
2316
                client.bump_timeout(client.extended_timeout)
2455
2317
                if self.server.use_dbus:
2462
2324
                try:
2463
2325
                    session.bye()
2464
2326
                except gnutls.Error as error:
2465
 
                    log.warning("GnuTLS bye failed", exc_info=error)
 
2327
                    logger.warning("GnuTLS bye failed",
 
2328
                                   exc_info=error)
2466
2329
 
2467
2330
    @staticmethod
2468
2331
    def peer_certificate(session):
2469
 
        "Return the peer's certificate as a bytestring"
2470
 
        try:
2471
 
            cert_type = gnutls.certificate_type_get2(
2472
 
                session, gnutls.CTYPE_PEERS)
2473
 
        except AttributeError:
2474
 
            cert_type = gnutls.certificate_type_get(session)
2475
 
        if gnutls.has_rawpk:
2476
 
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2477
 
        else:
2478
 
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2479
 
        # If not a valid certificate type...
2480
 
        if cert_type not in valid_cert_types:
2481
 
            log.info("Cert type %r not in %r", cert_type,
2482
 
                     valid_cert_types)
 
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):
2483
2336
            # ...return invalid data
2484
2337
            return b""
2485
2338
        list_size = ctypes.c_uint(1)
2486
2339
        cert_list = (gnutls.certificate_get_peers
2487
 
                     (session, ctypes.byref(list_size)))
 
2340
                     (session._c_object, ctypes.byref(list_size)))
2488
2341
        if not bool(cert_list) and list_size.value != 0:
2489
2342
            raise gnutls.Error("error getting peer certificate")
2490
2343
        if list_size.value == 0:
2493
2346
        return ctypes.string_at(cert.data, cert.size)
2494
2347
 
2495
2348
    @staticmethod
2496
 
    def key_id(certificate):
2497
 
        "Convert a certificate bytestring to a hexdigit key ID"
2498
 
        # New GnuTLS "datum" with the public key
2499
 
        datum = gnutls.datum_t(
2500
 
            ctypes.cast(ctypes.c_char_p(certificate),
2501
 
                        ctypes.POINTER(ctypes.c_ubyte)),
2502
 
            ctypes.c_uint(len(certificate)))
2503
 
        # XXX all these need to be created in the gnutls "module"
2504
 
        # New empty GnuTLS certificate
2505
 
        pubkey = gnutls.pubkey_t()
2506
 
        gnutls.pubkey_init(ctypes.byref(pubkey))
2507
 
        # Import the raw public key into the certificate
2508
 
        gnutls.pubkey_import(pubkey,
2509
 
                             ctypes.byref(datum),
2510
 
                             gnutls.X509_FMT_DER)
2511
 
        # New buffer for the key ID
2512
 
        buf = ctypes.create_string_buffer(32)
2513
 
        buf_len = ctypes.c_size_t(len(buf))
2514
 
        # Get the key ID from the raw public key into the buffer
2515
 
        gnutls.pubkey_get_key_id(
2516
 
            pubkey,
2517
 
            gnutls.KEYID_USE_SHA256,
2518
 
            ctypes.cast(ctypes.byref(buf),
2519
 
                        ctypes.POINTER(ctypes.c_ubyte)),
2520
 
            ctypes.byref(buf_len))
2521
 
        # Deinit the certificate
2522
 
        gnutls.pubkey_deinit(pubkey)
2523
 
 
2524
 
        # Convert the buffer to a Python bytestring
2525
 
        key_id = ctypes.string_at(buf, buf_len.value)
2526
 
        # Convert the bytestring to hexadecimal notation
2527
 
        hex_key_id = binascii.hexlify(key_id).upper()
2528
 
        return hex_key_id
2529
 
 
2530
 
    @staticmethod
2531
2349
    def fingerprint(openpgp):
2532
2350
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
2533
2351
        # New GnuTLS "datum" with the OpenPGP public key
2564
2382
        return hex_fpr
2565
2383
 
2566
2384
 
2567
 
class MultiprocessingMixIn:
 
2385
class MultiprocessingMixIn(object):
2568
2386
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2569
2387
 
2570
2388
    def sub_process_main(self, request, address):
2582
2400
        return proc
2583
2401
 
2584
2402
 
2585
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
2403
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2586
2404
    """ adds a pipe to the MixIn """
2587
2405
 
2588
2406
    def process_request(self, request, client_address):
2603
2421
 
2604
2422
 
2605
2423
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2606
 
                     socketserver.TCPServer):
2607
 
    """IPv6-capable TCP server.  Accepts None as address and/or port
 
2424
                     socketserver.TCPServer, object):
 
2425
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2608
2426
 
2609
2427
    Attributes:
2610
2428
        enabled:        Boolean; whether this server is activated yet
2661
2479
            if SO_BINDTODEVICE is None:
2662
2480
                # Fall back to a hard-coded value which seems to be
2663
2481
                # common enough.
2664
 
                log.warning("SO_BINDTODEVICE not found, trying 25")
 
2482
                logger.warning("SO_BINDTODEVICE not found, trying 25")
2665
2483
                SO_BINDTODEVICE = 25
2666
2484
            try:
2667
2485
                self.socket.setsockopt(
2669
2487
                    (self.interface + "\0").encode("utf-8"))
2670
2488
            except socket.error as error:
2671
2489
                if error.errno == errno.EPERM:
2672
 
                    log.error("No permission to bind to interface %s",
2673
 
                              self.interface)
 
2490
                    logger.error("No permission to bind to"
 
2491
                                 " interface %s", self.interface)
2674
2492
                elif error.errno == errno.ENOPROTOOPT:
2675
 
                    log.error("SO_BINDTODEVICE not available; cannot"
2676
 
                              " bind to interface %s", self.interface)
 
2493
                    logger.error("SO_BINDTODEVICE not available;"
 
2494
                                 " cannot bind to interface %s",
 
2495
                                 self.interface)
2677
2496
                elif error.errno == errno.ENODEV:
2678
 
                    log.error("Interface %s does not exist, cannot"
2679
 
                              " bind", self.interface)
 
2497
                    logger.error("Interface %s does not exist,"
 
2498
                                 " cannot bind", self.interface)
2680
2499
                else:
2681
2500
                    raise
2682
2501
        # Only bind(2) the socket if we really need to.
2683
2502
        if self.server_address[0] or self.server_address[1]:
2684
 
            if self.server_address[1]:
2685
 
                self.allow_reuse_address = True
2686
2503
            if not self.server_address[0]:
2687
2504
                if self.address_family == socket.AF_INET6:
2688
2505
                    any_address = "::"  # in6addr_any
2741
2558
    def add_pipe(self, parent_pipe, proc):
2742
2559
        # Call "handle_ipc" for both data and EOF events
2743
2560
        GLib.io_add_watch(
2744
 
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
2745
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2561
            parent_pipe.fileno(),
 
2562
            GLib.IO_IN | GLib.IO_HUP,
2746
2563
            functools.partial(self.handle_ipc,
2747
2564
                              parent_pipe=parent_pipe,
2748
2565
                              proc=proc))
2761
2578
        request = parent_pipe.recv()
2762
2579
        command = request[0]
2763
2580
 
2764
 
        if command == "init":
2765
 
            key_id = request[1].decode("ascii")
2766
 
            fpr = request[2].decode("ascii")
2767
 
            address = request[3]
 
2581
        if command == 'init':
 
2582
            fpr = request[1].decode("ascii")
 
2583
            address = request[2]
2768
2584
 
2769
2585
            for c in self.clients.values():
2770
 
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2771
 
                              "27AE41E4649B934CA495991B7852B855"):
2772
 
                    continue
2773
 
                if key_id and c.key_id == key_id:
2774
 
                    client = c
2775
 
                    break
2776
 
                if fpr and c.fingerprint == fpr:
 
2586
                if c.fingerprint == fpr:
2777
2587
                    client = c
2778
2588
                    break
2779
2589
            else:
2780
 
                log.info("Client not found for key ID: %s, address:"
2781
 
                         " %s", key_id or fpr, address)
 
2590
                logger.info("Client not found for fingerprint: %s, ad"
 
2591
                            "dress: %s", fpr, address)
2782
2592
                if self.use_dbus:
2783
2593
                    # Emit D-Bus signal
2784
 
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
 
2594
                    mandos_dbus_service.ClientNotFound(fpr,
2785
2595
                                                       address[0])
2786
2596
                parent_pipe.send(False)
2787
2597
                return False
2788
2598
 
2789
2599
            GLib.io_add_watch(
2790
 
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
2791
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2600
                parent_pipe.fileno(),
 
2601
                GLib.IO_IN | GLib.IO_HUP,
2792
2602
                functools.partial(self.handle_ipc,
2793
2603
                                  parent_pipe=parent_pipe,
2794
2604
                                  proc=proc,
2797
2607
            # remove the old hook in favor of the new above hook on
2798
2608
            # same fileno
2799
2609
            return False
2800
 
        if command == "funcall":
 
2610
        if command == 'funcall':
2801
2611
            funcname = request[1]
2802
2612
            args = request[2]
2803
2613
            kwargs = request[3]
2804
2614
 
2805
 
            parent_pipe.send(("data", getattr(client_object,
 
2615
            parent_pipe.send(('data', getattr(client_object,
2806
2616
                                              funcname)(*args,
2807
2617
                                                        **kwargs)))
2808
2618
 
2809
 
        if command == "getattr":
 
2619
        if command == 'getattr':
2810
2620
            attrname = request[1]
2811
2621
            if isinstance(client_object.__getattribute__(attrname),
2812
 
                          collections.abc.Callable):
2813
 
                parent_pipe.send(("function", ))
 
2622
                          collections.Callable):
 
2623
                parent_pipe.send(('function', ))
2814
2624
            else:
2815
2625
                parent_pipe.send((
2816
 
                    "data", client_object.__getattribute__(attrname)))
 
2626
                    'data', client_object.__getattribute__(attrname)))
2817
2627
 
2818
 
        if command == "setattr":
 
2628
        if command == 'setattr':
2819
2629
            attrname = request[1]
2820
2630
            value = request[2]
2821
2631
            setattr(client_object, attrname, value)
2826
2636
def rfc3339_duration_to_delta(duration):
2827
2637
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2828
2638
 
2829
 
    >>> timedelta = datetime.timedelta
2830
 
    >>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2831
 
    True
2832
 
    >>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2833
 
    True
2834
 
    >>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2835
 
    True
2836
 
    >>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2837
 
    True
2838
 
    >>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2839
 
    True
2840
 
    >>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2841
 
    True
2842
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2843
 
    True
2844
 
    >>> del timedelta
 
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)
2845
2653
    """
2846
2654
 
2847
2655
    # Parsing an RFC 3339 duration with regular expressions is not
2927
2735
def string_to_delta(interval):
2928
2736
    """Parse a string and return a datetime.timedelta
2929
2737
 
2930
 
    >>> string_to_delta("7d") == datetime.timedelta(7)
2931
 
    True
2932
 
    >>> string_to_delta("60s") == datetime.timedelta(0, 60)
2933
 
    True
2934
 
    >>> string_to_delta("60m") == datetime.timedelta(0, 3600)
2935
 
    True
2936
 
    >>> string_to_delta("24h") == datetime.timedelta(1)
2937
 
    True
2938
 
    >>> string_to_delta("1w") == datetime.timedelta(7)
2939
 
    True
2940
 
    >>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
2941
 
    True
 
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)
2942
2750
    """
2943
2751
 
2944
2752
    try:
3046
2854
 
3047
2855
    options = parser.parse_args()
3048
2856
 
 
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
 
3049
2862
    # Default values for config file for server-global settings
3050
 
    if gnutls.has_rawpk:
3051
 
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3052
 
                    ":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3053
 
    else:
3054
 
        priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3055
 
                    ":+SIGN-DSA-SHA256")
3056
2863
    server_defaults = {"interface": "",
3057
2864
                       "address": "",
3058
2865
                       "port": "",
3059
2866
                       "debug": "False",
3060
 
                       "priority": priority,
 
2867
                       "priority":
 
2868
                       "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2869
                       ":+SIGN-DSA-SHA256",
3061
2870
                       "servicename": "Mandos",
3062
2871
                       "use_dbus": "True",
3063
2872
                       "use_ipv6": "True",
3068
2877
                       "foreground": "False",
3069
2878
                       "zeroconf": "True",
3070
2879
                       }
3071
 
    del priority
3072
2880
 
3073
2881
    # Parse config file for server-global settings
3074
 
    server_config = configparser.ConfigParser(server_defaults)
 
2882
    server_config = configparser.SafeConfigParser(server_defaults)
3075
2883
    del server_defaults
3076
2884
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
3077
 
    # Convert the ConfigParser object to a dict
 
2885
    # Convert the SafeConfigParser object to a dict
3078
2886
    server_settings = server_config.defaults()
3079
2887
    # Use the appropriate methods on the non-string config options
3080
2888
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3147
2955
 
3148
2956
    if server_settings["servicename"] != "Mandos":
3149
2957
        syslogger.setFormatter(
3150
 
            logging.Formatter("Mandos ({}) [%(process)d]:"
3151
 
                              " %(levelname)s: %(message)s".format(
 
2958
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2959
                              ' %(levelname)s: %(message)s'.format(
3152
2960
                                  server_settings["servicename"])))
3153
2961
 
3154
2962
    # Parse config file with clients
3155
 
    client_config = configparser.ConfigParser(Client.client_defaults)
 
2963
    client_config = configparser.SafeConfigParser(Client
 
2964
                                                  .client_defaults)
3156
2965
    client_config.read(os.path.join(server_settings["configdir"],
3157
2966
                                    "clients.conf"))
3158
2967
 
3178
2987
        try:
3179
2988
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3180
2989
        except IOError as e:
3181
 
            log.error("Could not open file %r", pidfilename,
3182
 
                      exc_info=e)
 
2990
            logger.error("Could not open file %r", pidfilename,
 
2991
                         exc_info=e)
3183
2992
 
3184
2993
    for name, group in (("_mandos", "_mandos"),
3185
2994
                        ("mandos", "mandos"),
3196
3005
    try:
3197
3006
        os.setgid(gid)
3198
3007
        os.setuid(uid)
3199
 
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
 
3008
        if debug:
 
3009
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3010
                                                             gid))
3200
3011
    except OSError as error:
3201
 
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3202
 
                    os.strerror(error.errno))
 
3012
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3013
                       .format(uid, gid, os.strerror(error.errno)))
3203
3014
        if error.errno != errno.EPERM:
3204
3015
            raise
3205
3016
 
3212
3023
 
3213
3024
        @gnutls.log_func
3214
3025
        def debug_gnutls(level, string):
3215
 
            log.debug("GnuTLS: %s",
3216
 
                      string[:-1].decode("utf-8", errors="replace"))
 
3026
            logger.debug("GnuTLS: %s", string[:-1])
3217
3027
 
3218
3028
        gnutls.global_set_log_function(debug_gnutls)
3219
3029
 
3228
3038
        # Close all input and output, do double fork, etc.
3229
3039
        daemon()
3230
3040
 
3231
 
    if gi.version_info < (3, 10, 2):
3232
 
        # multiprocessing will use threads, so before we use GLib we
3233
 
        # need to inform GLib that threads will be used.
3234
 
        GLib.threads_init()
 
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()
3235
3044
 
3236
3045
    global main_loop
3237
3046
    # From the Avahi example code
3248
3057
                "se.bsnet.fukt.Mandos", bus,
3249
3058
                do_not_queue=True)
3250
3059
        except dbus.exceptions.DBusException as e:
3251
 
            log.error("Disabling D-Bus:", exc_info=e)
 
3060
            logger.error("Disabling D-Bus:", exc_info=e)
3252
3061
            use_dbus = False
3253
3062
            server_settings["use_dbus"] = False
3254
3063
            tcp_server.use_dbus = False
3313
3122
                             if isinstance(s, bytes)
3314
3123
                             else s) for s in
3315
3124
                            value["client_structure"]]
3316
 
                        # .name, .host, and .checker_command
3317
 
                        for k in ("name", "host", "checker_command"):
 
3125
                        # .name & .host
 
3126
                        for k in ("name", "host"):
3318
3127
                            if isinstance(value[k], bytes):
3319
3128
                                value[k] = value[k].decode("utf-8")
3320
 
                        if "key_id" not in value:
3321
 
                            value["key_id"] = ""
3322
 
                        elif "fingerprint" not in value:
3323
 
                            value["fingerprint"] = ""
3324
3129
                    #  old_client_settings
3325
3130
                    # .keys()
3326
3131
                    old_client_settings = {
3330
3135
                        for key, value in
3331
3136
                        bytes_old_client_settings.items()}
3332
3137
                    del bytes_old_client_settings
3333
 
                    # .host and .checker_command
 
3138
                    # .host
3334
3139
                    for value in old_client_settings.values():
3335
 
                        for attribute in ("host", "checker_command"):
3336
 
                            if isinstance(value[attribute], bytes):
3337
 
                                value[attribute] = (value[attribute]
3338
 
                                                    .decode("utf-8"))
 
3140
                        if isinstance(value["host"], bytes):
 
3141
                            value["host"] = (value["host"]
 
3142
                                             .decode("utf-8"))
3339
3143
            os.remove(stored_state_path)
3340
3144
        except IOError as e:
3341
3145
            if e.errno == errno.ENOENT:
3342
 
                log.warning("Could not load persistent state:"
3343
 
                            " %s", os.strerror(e.errno))
 
3146
                logger.warning("Could not load persistent state:"
 
3147
                               " {}".format(os.strerror(e.errno)))
3344
3148
            else:
3345
 
                log.critical("Could not load persistent state:",
3346
 
                             exc_info=e)
 
3149
                logger.critical("Could not load persistent state:",
 
3150
                                exc_info=e)
3347
3151
                raise
3348
3152
        except EOFError as e:
3349
 
            log.warning("Could not load persistent state: EOFError:",
3350
 
                        exc_info=e)
 
3153
            logger.warning("Could not load persistent state: "
 
3154
                           "EOFError:",
 
3155
                           exc_info=e)
3351
3156
 
3352
3157
    with PGPEngine() as pgp:
3353
3158
        for client_name, client in clients_data.items():
3380
3185
            if client["enabled"]:
3381
3186
                if datetime.datetime.utcnow() >= client["expires"]:
3382
3187
                    if not client["last_checked_ok"]:
3383
 
                        log.warning("disabling client %s - Client"
3384
 
                                    " never performed a successful"
3385
 
                                    " checker", client_name)
 
3188
                        logger.warning(
 
3189
                            "disabling client {} - Client never "
 
3190
                            "performed a successful checker".format(
 
3191
                                client_name))
3386
3192
                        client["enabled"] = False
3387
3193
                    elif client["last_checker_status"] != 0:
3388
 
                        log.warning("disabling client %s - Client"
3389
 
                                    " last checker failed with error"
3390
 
                                    " code %s", client_name,
3391
 
                                    client["last_checker_status"])
 
3194
                        logger.warning(
 
3195
                            "disabling client {} - Client last"
 
3196
                            " checker failed with error code"
 
3197
                            " {}".format(
 
3198
                                client_name,
 
3199
                                client["last_checker_status"]))
3392
3200
                        client["enabled"] = False
3393
3201
                    else:
3394
3202
                        client["expires"] = (
3395
3203
                            datetime.datetime.utcnow()
3396
3204
                            + client["timeout"])
3397
 
                        log.debug("Last checker succeeded, keeping %s"
3398
 
                                  " enabled", client_name)
 
3205
                        logger.debug("Last checker succeeded,"
 
3206
                                     " keeping {} enabled".format(
 
3207
                                         client_name))
3399
3208
            try:
3400
3209
                client["secret"] = pgp.decrypt(
3401
3210
                    client["encrypted_secret"],
3402
3211
                    client_settings[client_name]["secret"])
3403
3212
            except PGPError:
3404
3213
                # If decryption fails, we use secret from new settings
3405
 
                log.debug("Failed to decrypt %s old secret",
3406
 
                          client_name)
 
3214
                logger.debug("Failed to decrypt {} old secret".format(
 
3215
                    client_name))
3407
3216
                client["secret"] = (client_settings[client_name]
3408
3217
                                    ["secret"])
3409
3218
 
3423
3232
            server_settings=server_settings)
3424
3233
 
3425
3234
    if not tcp_server.clients:
3426
 
        log.warning("No clients defined")
 
3235
        logger.warning("No clients defined")
3427
3236
 
3428
3237
    if not foreground:
3429
3238
        if pidfile is not None:
3432
3241
                with pidfile:
3433
3242
                    print(pid, file=pidfile)
3434
3243
            except IOError:
3435
 
                log.error("Could not write to file %r with PID %d",
3436
 
                          pidfilename, pid)
 
3244
                logger.error("Could not write to file %r with PID %d",
 
3245
                             pidfilename, pid)
3437
3246
        del pidfile
3438
3247
        del pidfilename
3439
3248
 
3459
3268
                pass
3460
3269
 
3461
3270
            @dbus.service.signal(_interface, signature="ss")
3462
 
            def ClientNotFound(self, key_id, address):
 
3271
            def ClientNotFound(self, fingerprint, address):
3463
3272
                "D-Bus signal"
3464
3273
                pass
3465
3274
 
3589
3398
 
3590
3399
        try:
3591
3400
            with tempfile.NamedTemporaryFile(
3592
 
                    mode="wb",
 
3401
                    mode='wb',
3593
3402
                    suffix=".pickle",
3594
 
                    prefix="clients-",
 
3403
                    prefix='clients-',
3595
3404
                    dir=os.path.dirname(stored_state_path),
3596
3405
                    delete=False) as stored_state:
3597
3406
                pickle.dump((clients, client_settings), stored_state,
3605
3414
                except NameError:
3606
3415
                    pass
3607
3416
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3608
 
                log.warning("Could not save persistent state: %s",
3609
 
                            os.strerror(e.errno))
 
3417
                logger.warning("Could not save persistent state: {}"
 
3418
                               .format(os.strerror(e.errno)))
3610
3419
            else:
3611
 
                log.warning("Could not save persistent state:",
3612
 
                            exc_info=e)
 
3420
                logger.warning("Could not save persistent state:",
 
3421
                               exc_info=e)
3613
3422
                raise
3614
3423
 
3615
3424
        # Delete all clients, and settings from config
3632
3441
            mandos_dbus_service.client_added_signal(client)
3633
3442
        # Need to initiate checking of clients
3634
3443
        if client.enabled:
3635
 
            client.init_checker(randomize_start=True)
 
3444
            client.init_checker()
3636
3445
 
3637
3446
    tcp_server.enable()
3638
3447
    tcp_server.server_activate()
3641
3450
    if zeroconf:
3642
3451
        service.port = tcp_server.socket.getsockname()[1]
3643
3452
    if use_ipv6:
3644
 
        log.info("Now listening on address %r, port %d, flowinfo %d,"
3645
 
                 " scope_id %d", *tcp_server.socket.getsockname())
 
3453
        logger.info("Now listening on address %r, port %d,"
 
3454
                    " flowinfo %d, scope_id %d",
 
3455
                    *tcp_server.socket.getsockname())
3646
3456
    else:                       # IPv4
3647
 
        log.info("Now listening on address %r, port %d",
3648
 
                 *tcp_server.socket.getsockname())
 
3457
        logger.info("Now listening on address %r, port %d",
 
3458
                    *tcp_server.socket.getsockname())
3649
3459
 
3650
3460
    # service.interface = tcp_server.socket.getsockname()[3]
3651
3461
 
3655
3465
            try:
3656
3466
                service.activate()
3657
3467
            except dbus.exceptions.DBusException as error:
3658
 
                log.critical("D-Bus Exception", exc_info=error)
 
3468
                logger.critical("D-Bus Exception", exc_info=error)
3659
3469
                cleanup()
3660
3470
                sys.exit(1)
3661
3471
            # End of Avahi example code
3662
3472
 
3663
 
        GLib.io_add_watch(
3664
 
            GLib.IOChannel.unix_new(tcp_server.fileno()),
3665
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3666
 
            lambda *args, **kwargs: (tcp_server.handle_request
3667
 
                                     (*args[2:], **kwargs) or True))
 
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))
3668
3477
 
3669
 
        log.debug("Starting main loop")
 
3478
        logger.debug("Starting main loop")
3670
3479
        main_loop.run()
3671
3480
    except AvahiError as error:
3672
 
        log.critical("Avahi Error", exc_info=error)
 
3481
        logger.critical("Avahi Error", exc_info=error)
3673
3482
        cleanup()
3674
3483
        sys.exit(1)
3675
3484
    except KeyboardInterrupt:
3676
3485
        if debug:
3677
3486
            print("", file=sys.stderr)
3678
 
        log.debug("Server received KeyboardInterrupt")
3679
 
    log.debug("Server exiting")
 
3487
        logger.debug("Server received KeyboardInterrupt")
 
3488
    logger.debug("Server exiting")
3680
3489
    # Must run before the D-Bus bus name gets deregistered
3681
3490
    cleanup()
3682
3491
 
3683
 
 
3684
 
def parse_test_args():
3685
 
    # type: () -> argparse.Namespace
3686
 
    parser = argparse.ArgumentParser(add_help=False)
3687
 
    parser.add_argument("--check", action="store_true")
3688
 
    parser.add_argument("--prefix", )
3689
 
    args, unknown_args = parser.parse_known_args()
3690
 
    if args.check:
3691
 
        # Remove test options from sys.argv
3692
 
        sys.argv[1:] = unknown_args
3693
 
    return args
3694
 
 
3695
 
# Add all tests from doctest strings
3696
 
def load_tests(loader, tests, none):
3697
 
    import doctest
3698
 
    tests.addTests(doctest.DocTestSuite())
3699
 
    return tests
3700
 
 
3701
 
if __name__ == "__main__":
3702
 
    options = parse_test_args()
3703
 
    try:
3704
 
        if options.check:
3705
 
            extra_test_prefix = options.prefix
3706
 
            if extra_test_prefix is not None:
3707
 
                if not (unittest.main(argv=[""], exit=False)
3708
 
                        .result.wasSuccessful()):
3709
 
                    sys.exit(1)
3710
 
                class ExtraTestLoader(unittest.TestLoader):
3711
 
                    testMethodPrefix = extra_test_prefix
3712
 
                # Call using ./scriptname --test [--verbose]
3713
 
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
3714
 
            else:
3715
 
                unittest.main(argv=[""])
3716
 
        else:
3717
 
            main()
3718
 
    finally:
3719
 
        logging.shutdown()
3720
 
 
3721
 
# Local Variables:
3722
 
# run-tests:
3723
 
# (lambda (&optional extra)
3724
 
#   (if (not (funcall run-tests-in-test-buffer default-directory
3725
 
#             extra))
3726
 
#       (funcall show-test-buffer-in-test-window)
3727
 
#     (funcall remove-test-window)
3728
 
#     (if extra (message "Extra tests run successfully!"))))
3729
 
# run-tests-in-test-buffer:
3730
 
# (lambda (dir &optional extra)
3731
 
#   (with-current-buffer (get-buffer-create "*Test*")
3732
 
#     (setq buffer-read-only nil
3733
 
#           default-directory dir)
3734
 
#     (erase-buffer)
3735
 
#     (compilation-mode))
3736
 
#   (let ((process-result
3737
 
#          (let ((inhibit-read-only t))
3738
 
#            (process-file-shell-command
3739
 
#             (funcall get-command-line extra) nil "*Test*"))))
3740
 
#     (and (numberp process-result)
3741
 
#          (= process-result 0))))
3742
 
# get-command-line:
3743
 
# (lambda (&optional extra)
3744
 
#   (let ((quoted-script
3745
 
#          (shell-quote-argument (funcall get-script-name))))
3746
 
#     (format
3747
 
#      (concat "%s --check" (if extra " --prefix=atest" ""))
3748
 
#      quoted-script)))
3749
 
# get-script-name:
3750
 
# (lambda ()
3751
 
#   (if (fboundp 'file-local-name)
3752
 
#       (file-local-name (buffer-file-name))
3753
 
#     (or (file-remote-p (buffer-file-name) 'localname)
3754
 
#         (buffer-file-name))))
3755
 
# remove-test-window:
3756
 
# (lambda ()
3757
 
#   (let ((test-window (get-buffer-window "*Test*")))
3758
 
#     (if test-window (delete-window test-window))))
3759
 
# show-test-buffer-in-test-window:
3760
 
# (lambda ()
3761
 
#   (when (not (get-buffer-window-list "*Test*"))
3762
 
#     (setq next-error-last-buffer (get-buffer "*Test*"))
3763
 
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3764
 
#            (display-buffer-overriding-action
3765
 
#             `((display-buffer-in-side-window) (side . ,side)
3766
 
#               (window-height . fit-window-to-buffer)
3767
 
#               (window-width . fit-window-to-buffer))))
3768
 
#       (display-buffer "*Test*"))))
3769
 
# eval:
3770
 
# (progn
3771
 
#   (let* ((run-extra-tests (lambda () (interactive)
3772
 
#                             (funcall run-tests t)))
3773
 
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3774
 
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
3775
 
#     (setq minor-mode-overriding-map-alist
3776
 
#           (cons `(run-tests . ,outer-keymap)
3777
 
#                 minor-mode-overriding-map-alist)))
3778
 
#   (add-hook 'after-save-hook run-tests 90 t))
3779
 
# End:
 
3492
 
 
3493
if __name__ == '__main__':
 
3494
    main()