/mandos/trunk

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/trunk

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-03-05 21:39:15 UTC
  • Revision ID: teddy@recompile.se-20190305213915-xm1vw00jyy3a5tfn
mandos-ctl: Add more tests, including tests for all commands

* mandos-ctl (Test_string_to_delta.test_handles_basic_rfc3339): Add a
                                                  few more test cases.
  (TestCmd.setUp.MockClient.Set, TestCmd.setUp.MockClient.Get): Don't
  append to self.calls, since nobody should use it to check for Set()
  or Get() calls; instead, the return value of Get() should be
  inspected, and the MockClient.attributes dict should be inspected
  after (implicitly) calling Set().
  (Unique): New; stand-in for unittest.mock.sentinel.
  (TestPropertyCmd): New; abstract class testing PropertyCmd classes.
  (TestBumpTimeoutCmd, TestStartCheckerCmd, TestStopCheckerCmd,
  TestApproveByDefaultCmd, TestDenyByDefaultCmd): New.
  (TestValueArgumentPropertyCmd): New; abstract class for testing
                                  those PropertyCmd classes which also
                                  inherit from ValueArgumentMixIn.
  (TestSetCheckerCmd, TestSetHostCmd, TestSetSecretCmd,
  TestSetTimeoutCmd, TestSetExtendedTimeoutCmd, TestSetIntervalCmd,
  TestSetApprovalDelayCmd, TestSetApprovalDurationCmd): New.

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-2019 Teddy Hogeborn
 
15
# Copyright © 2008-2019 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
 
# Add os.set_inheritable if it does not exist
114
 
try:
115
 
    os.set_inheritable
116
 
except AttributeError:
117
 
    def set_inheritable(fd, inheritable):
118
 
        flags = fcntl.fcntl(fd, fcntl.F_GETFD)
119
 
        if inheritable and ((flags & fcntl.FD_CLOEXEC) != 0):
120
 
            fcntl.fcntl(fd, fcntl.F_SETFL, flags & ~fcntl.FD_CLOEXEC)
121
 
        elif (not inheritable) and ((flags & fcntl.FD_CLOEXEC) == 0):
122
 
            fcntl.fcntl(fd, fcntl.F_SETFL, flags | fcntl.FD_CLOEXEC)
123
 
    os.set_inheritable = set_inheritable
124
 
    del set_inheritable
125
 
 
126
 
# Show warnings by default
127
 
if not sys.warnoptions:
128
 
    import warnings
129
 
    warnings.simplefilter("default")
130
 
 
131
90
# Try to find the value of SO_BINDTODEVICE:
132
91
try:
133
92
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
153
112
            # No value found
154
113
            SO_BINDTODEVICE = None
155
114
 
156
 
if sys.version_info < (3, 2):
157
 
    configparser.Configparser = configparser.SafeConfigParser
 
115
if sys.version_info.major == 2:
 
116
    str = unicode
158
117
 
159
 
version = "1.8.17"
 
118
version = "1.8.3"
160
119
stored_state_file = "clients.pickle"
161
120
 
162
 
log = logging.getLogger(os.path.basename(sys.argv[0]))
163
 
logging.captureWarnings(True)   # Show warnings via the logging system
 
121
logger = logging.getLogger()
164
122
syslogger = None
165
123
 
166
124
try:
202
160
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
203
161
        address="/dev/log"))
204
162
    syslogger.setFormatter(logging.Formatter
205
 
                           ("Mandos [%(process)d]: %(levelname)s:"
206
 
                            " %(message)s"))
207
 
    log.addHandler(syslogger)
 
163
                           ('Mandos [%(process)d]: %(levelname)s:'
 
164
                            ' %(message)s'))
 
165
    logger.addHandler(syslogger)
208
166
 
209
167
    if debug:
210
168
        console = logging.StreamHandler()
211
 
        console.setFormatter(logging.Formatter("%(asctime)s %(name)s"
212
 
                                               " [%(process)d]:"
213
 
                                               " %(levelname)s:"
214
 
                                               " %(message)s"))
215
 
        log.addHandler(console)
216
 
    log.setLevel(level)
 
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)
217
175
 
218
176
 
219
177
class PGPError(Exception):
221
179
    pass
222
180
 
223
181
 
224
 
class PGPEngine:
 
182
class PGPEngine(object):
225
183
    """A simple class for OpenPGP symmetric encryption & decryption"""
226
184
 
227
185
    def __init__(self):
231
189
            output = subprocess.check_output(["gpgconf"])
232
190
            for line in output.splitlines():
233
191
                name, text, path = line.split(b":")
234
 
                if name == b"gpg":
 
192
                if name == "gpg":
235
193
                    self.gpg = path
236
194
                    break
237
195
        except OSError as e:
238
196
            if e.errno != errno.ENOENT:
239
197
                raise
240
 
        self.gnupgargs = ["--batch",
241
 
                          "--homedir", self.tempdir,
242
 
                          "--force-mdc",
243
 
                          "--quiet"]
 
198
        self.gnupgargs = ['--batch',
 
199
                          '--homedir', self.tempdir,
 
200
                          '--force-mdc',
 
201
                          '--quiet']
244
202
        # Only GPG version 1 has the --no-use-agent option.
245
 
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
 
203
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
246
204
            self.gnupgargs.append("--no-use-agent")
247
205
 
248
206
    def __enter__(self):
285
243
                dir=self.tempdir) as passfile:
286
244
            passfile.write(passphrase)
287
245
            passfile.flush()
288
 
            proc = subprocess.Popen([self.gpg, "--symmetric",
289
 
                                     "--passphrase-file",
 
246
            proc = subprocess.Popen([self.gpg, '--symmetric',
 
247
                                     '--passphrase-file',
290
248
                                     passfile.name]
291
249
                                    + self.gnupgargs,
292
250
                                    stdin=subprocess.PIPE,
303
261
                dir=self.tempdir) as passfile:
304
262
            passfile.write(passphrase)
305
263
            passfile.flush()
306
 
            proc = subprocess.Popen([self.gpg, "--decrypt",
307
 
                                     "--passphrase-file",
 
264
            proc = subprocess.Popen([self.gpg, '--decrypt',
 
265
                                     '--passphrase-file',
308
266
                                     passfile.name]
309
267
                                    + self.gnupgargs,
310
268
                                    stdin=subprocess.PIPE,
317
275
 
318
276
 
319
277
# Pretend that we have an Avahi module
320
 
class avahi:
321
 
    """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."""
322
281
    IF_UNSPEC = -1               # avahi-common/address.h
323
282
    PROTO_UNSPEC = -1            # avahi-common/address.h
324
283
    PROTO_INET = 0               # avahi-common/address.h
328
287
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
329
288
    DBUS_PATH_SERVER = "/"
330
289
 
331
 
    @staticmethod
332
 
    def string_array_to_txt_array(t):
 
290
    def string_array_to_txt_array(self, t):
333
291
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
334
292
                           for s in t), signature="ay")
335
293
    ENTRY_GROUP_ESTABLISHED = 2  # avahi-common/defs.h
340
298
    SERVER_RUNNING = 2           # avahi-common/defs.h
341
299
    SERVER_COLLISION = 3         # avahi-common/defs.h
342
300
    SERVER_FAILURE = 4           # avahi-common/defs.h
 
301
avahi = Avahi()
343
302
 
344
303
 
345
304
class AvahiError(Exception):
357
316
    pass
358
317
 
359
318
 
360
 
class AvahiService:
 
319
class AvahiService(object):
361
320
    """An Avahi (Zeroconf) service.
362
321
 
363
322
    Attributes:
364
323
    interface: integer; avahi.IF_UNSPEC or an interface index.
365
324
               Used to optionally bind to the specified interface.
366
 
    name: string; Example: "Mandos"
367
 
    type: string; Example: "_mandos._tcp".
 
325
    name: string; Example: 'Mandos'
 
326
    type: string; Example: '_mandos._tcp'.
368
327
     See <https://www.iana.org/assignments/service-names-port-numbers>
369
328
    port: integer; what port to announce
370
329
    TXT: list of strings; TXT record for the service
407
366
    def rename(self, remove=True):
408
367
        """Derived from the Avahi example code"""
409
368
        if self.rename_count >= self.max_renames:
410
 
            log.critical("No suitable Zeroconf service name found"
411
 
                         " after %i retries, exiting.",
412
 
                         self.rename_count)
 
369
            logger.critical("No suitable Zeroconf service name found"
 
370
                            " after %i retries, exiting.",
 
371
                            self.rename_count)
413
372
            raise AvahiServiceError("Too many renames")
414
373
        self.name = str(
415
374
            self.server.GetAlternativeServiceName(self.name))
416
375
        self.rename_count += 1
417
 
        log.info("Changing Zeroconf service name to %r ...",
418
 
                 self.name)
 
376
        logger.info("Changing Zeroconf service name to %r ...",
 
377
                    self.name)
419
378
        if remove:
420
379
            self.remove()
421
380
        try:
423
382
        except dbus.exceptions.DBusException as error:
424
383
            if (error.get_dbus_name()
425
384
                == "org.freedesktop.Avahi.CollisionError"):
426
 
                log.info("Local Zeroconf service name collision.")
 
385
                logger.info("Local Zeroconf service name collision.")
427
386
                return self.rename(remove=False)
428
387
            else:
429
 
                log.critical("D-Bus Exception", exc_info=error)
 
388
                logger.critical("D-Bus Exception", exc_info=error)
430
389
                self.cleanup()
431
390
                os._exit(1)
432
391
 
448
407
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
449
408
        self.entry_group_state_changed_match = (
450
409
            self.group.connect_to_signal(
451
 
                "StateChanged", self.entry_group_state_changed))
452
 
        log.debug("Adding Zeroconf service '%s' of type '%s' ...",
453
 
                  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)
454
413
        self.group.AddService(
455
414
            self.interface,
456
415
            self.protocol,
463
422
 
464
423
    def entry_group_state_changed(self, state, error):
465
424
        """Derived from the Avahi example code"""
466
 
        log.debug("Avahi entry group state change: %i", state)
 
425
        logger.debug("Avahi entry group state change: %i", state)
467
426
 
468
427
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
469
 
            log.debug("Zeroconf service established.")
 
428
            logger.debug("Zeroconf service established.")
470
429
        elif state == avahi.ENTRY_GROUP_COLLISION:
471
 
            log.info("Zeroconf service name collision.")
 
430
            logger.info("Zeroconf service name collision.")
472
431
            self.rename()
473
432
        elif state == avahi.ENTRY_GROUP_FAILURE:
474
 
            log.critical("Avahi: Error in group state changed %s",
475
 
                         str(error))
 
433
            logger.critical("Avahi: Error in group state changed %s",
 
434
                            str(error))
476
435
            raise AvahiGroupError("State changed: {!s}".format(error))
477
436
 
478
437
    def cleanup(self):
488
447
 
489
448
    def server_state_changed(self, state, error=None):
490
449
        """Derived from the Avahi example code"""
491
 
        log.debug("Avahi server state change: %i", state)
 
450
        logger.debug("Avahi server state change: %i", state)
492
451
        bad_states = {
493
452
            avahi.SERVER_INVALID: "Zeroconf server invalid",
494
453
            avahi.SERVER_REGISTERING: None,
498
457
        if state in bad_states:
499
458
            if bad_states[state] is not None:
500
459
                if error is None:
501
 
                    log.error(bad_states[state])
 
460
                    logger.error(bad_states[state])
502
461
                else:
503
 
                    log.error(bad_states[state] + ": %r", error)
 
462
                    logger.error(bad_states[state] + ": %r", error)
504
463
            self.cleanup()
505
464
        elif state == avahi.SERVER_RUNNING:
506
465
            try:
508
467
            except dbus.exceptions.DBusException as error:
509
468
                if (error.get_dbus_name()
510
469
                    == "org.freedesktop.Avahi.CollisionError"):
511
 
                    log.info("Local Zeroconf service name collision.")
 
470
                    logger.info("Local Zeroconf service name"
 
471
                                " collision.")
512
472
                    return self.rename(remove=False)
513
473
                else:
514
 
                    log.critical("D-Bus Exception", exc_info=error)
 
474
                    logger.critical("D-Bus Exception", exc_info=error)
515
475
                    self.cleanup()
516
476
                    os._exit(1)
517
477
        else:
518
478
            if error is None:
519
 
                log.debug("Unknown state: %r", state)
 
479
                logger.debug("Unknown state: %r", state)
520
480
            else:
521
 
                log.debug("Unknown state: %r: %r", state, error)
 
481
                logger.debug("Unknown state: %r: %r", state, error)
522
482
 
523
483
    def activate(self):
524
484
        """Derived from the Avahi example code"""
536
496
class AvahiServiceToSyslog(AvahiService):
537
497
    def rename(self, *args, **kwargs):
538
498
        """Add the new name to the syslog messages"""
539
 
        ret = super(AvahiServiceToSyslog, self).rename(*args,
540
 
                                                       **kwargs)
 
499
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
541
500
        syslogger.setFormatter(logging.Formatter(
542
 
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
 
501
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
543
502
            .format(self.name)))
544
503
        return ret
545
504
 
546
505
 
547
506
# Pretend that we have a GnuTLS module
548
 
class gnutls:
549
 
    """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."""
550
510
 
551
511
    library = ctypes.util.find_library("gnutls")
552
512
    if library is None:
553
513
        library = ctypes.util.find_library("gnutls-deb0")
554
514
    _library = ctypes.cdll.LoadLibrary(library)
555
515
    del library
 
516
    _need_version = b"3.3.0"
 
517
    _tls_rawpk_version = b"3.6.6"
 
518
 
 
519
    def __init__(self):
 
520
        # Need to use "self" here, since this method is called before
 
521
        # the assignment to the "gnutls" global variable happens.
 
522
        if self.check_version(self._need_version) is None:
 
523
            raise self.Error("Needs GnuTLS {} or later"
 
524
                             .format(self._need_version))
556
525
 
557
526
    # Unless otherwise indicated, the constants and types below are
558
527
    # all from the gnutls/gnutls.h C header file.
575
544
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
576
545
 
577
546
    # Types
578
 
    class _session_int(ctypes.Structure):
 
547
    class session_int(ctypes.Structure):
579
548
        _fields_ = []
580
 
    session_t = ctypes.POINTER(_session_int)
 
549
    session_t = ctypes.POINTER(session_int)
581
550
 
582
551
    class certificate_credentials_st(ctypes.Structure):
583
552
        _fields_ = []
586
555
    certificate_type_t = ctypes.c_int
587
556
 
588
557
    class datum_t(ctypes.Structure):
589
 
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
590
 
                    ("size", ctypes.c_uint)]
 
558
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
559
                    ('size', ctypes.c_uint)]
591
560
 
592
 
    class _openpgp_crt_int(ctypes.Structure):
 
561
    class openpgp_crt_int(ctypes.Structure):
593
562
        _fields_ = []
594
 
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
 
563
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
595
564
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
596
565
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
597
566
    credentials_type_t = ctypes.c_int
600
569
 
601
570
    # Exceptions
602
571
    class Error(Exception):
 
572
        # We need to use the class name "GnuTLS" here, since this
 
573
        # exception might be raised from within GnuTLS.__init__,
 
574
        # which is called before the assignment to the "gnutls"
 
575
        # global variable has happened.
603
576
        def __init__(self, message=None, code=None, args=()):
604
577
            # Default usage is by a message string, but if a return
605
578
            # code is passed, convert it to a string with
606
579
            # gnutls.strerror()
607
580
            self.code = code
608
581
            if message is None and code is not None:
609
 
                message = gnutls.strerror(code).decode(
610
 
                    "utf-8", errors="replace")
611
 
            return super(gnutls.Error, self).__init__(
 
582
                message = GnuTLS.strerror(code)
 
583
            return super(GnuTLS.Error, self).__init__(
612
584
                message, *args)
613
585
 
614
586
    class CertificateSecurityError(Error):
615
587
        pass
616
588
 
617
 
    class PointerTo:
618
 
        def __init__(self, cls):
619
 
            self.cls = cls
620
 
 
621
 
        def from_param(self, obj):
622
 
            if not isinstance(obj, self.cls):
623
 
                raise TypeError("Not of type {}: {!r}"
624
 
                                .format(self.cls.__name__, obj))
625
 
            return ctypes.byref(obj.from_param(obj))
626
 
 
627
 
    class CastToVoidPointer:
628
 
        def __init__(self, cls):
629
 
            self.cls = cls
630
 
 
631
 
        def from_param(self, obj):
632
 
            if not isinstance(obj, self.cls):
633
 
                raise TypeError("Not of type {}: {!r}"
634
 
                                .format(self.cls.__name__, obj))
635
 
            return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)
636
 
 
637
 
    class With_from_param:
638
 
        @classmethod
639
 
        def from_param(cls, obj):
640
 
            return obj._as_parameter_
641
 
 
642
589
    # Classes
643
 
    class Credentials(With_from_param):
 
590
    class Credentials(object):
644
591
        def __init__(self):
645
 
            self._as_parameter_ = gnutls.certificate_credentials_t()
646
 
            gnutls.certificate_allocate_credentials(self)
 
592
            self._c_object = gnutls.certificate_credentials_t()
 
593
            gnutls.certificate_allocate_credentials(
 
594
                ctypes.byref(self._c_object))
647
595
            self.type = gnutls.CRD_CERTIFICATE
648
596
 
649
597
        def __del__(self):
650
 
            gnutls.certificate_free_credentials(self)
 
598
            gnutls.certificate_free_credentials(self._c_object)
651
599
 
652
 
    class ClientSession(With_from_param):
 
600
    class ClientSession(object):
653
601
        def __init__(self, socket, credentials=None):
654
 
            self._as_parameter_ = gnutls.session_t()
 
602
            self._c_object = gnutls.session_t()
655
603
            gnutls_flags = gnutls.CLIENT
656
 
            if gnutls.check_version(b"3.5.6"):
 
604
            if gnutls.check_version("3.5.6"):
657
605
                gnutls_flags |= gnutls.NO_TICKETS
658
606
            if gnutls.has_rawpk:
659
607
                gnutls_flags |= gnutls.ENABLE_RAWPK
660
 
            gnutls.init(self, gnutls_flags)
 
608
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
661
609
            del gnutls_flags
662
 
            gnutls.set_default_priority(self)
663
 
            gnutls.transport_set_ptr(self, socket.fileno())
664
 
            gnutls.handshake_set_private_extensions(self, True)
 
610
            gnutls.set_default_priority(self._c_object)
 
611
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
612
            gnutls.handshake_set_private_extensions(self._c_object,
 
613
                                                    True)
665
614
            self.socket = socket
666
615
            if credentials is None:
667
616
                credentials = gnutls.Credentials()
668
 
            gnutls.credentials_set(self, credentials.type,
669
 
                                   credentials)
 
617
            gnutls.credentials_set(self._c_object, credentials.type,
 
618
                                   ctypes.cast(credentials._c_object,
 
619
                                               ctypes.c_void_p))
670
620
            self.credentials = credentials
671
621
 
672
622
        def __del__(self):
673
 
            gnutls.deinit(self)
 
623
            gnutls.deinit(self._c_object)
674
624
 
675
625
        def handshake(self):
676
 
            return gnutls.handshake(self)
 
626
            return gnutls.handshake(self._c_object)
677
627
 
678
628
        def send(self, data):
679
629
            data = bytes(data)
680
630
            data_len = len(data)
681
631
            while data_len > 0:
682
 
                data_len -= gnutls.record_send(self, data[-data_len:],
 
632
                data_len -= gnutls.record_send(self._c_object,
 
633
                                               data[-data_len:],
683
634
                                               data_len)
684
635
 
685
636
        def bye(self):
686
 
            return gnutls.bye(self, gnutls.SHUT_RDWR)
 
637
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
687
638
 
688
639
    # Error handling functions
689
640
    def _error_code(result):
690
641
        """A function to raise exceptions on errors, suitable
691
 
        for the "restype" attribute on ctypes functions"""
692
 
        if result >= gnutls.E_SUCCESS:
 
642
        for the 'restype' attribute on ctypes functions"""
 
643
        if result >= 0:
693
644
            return result
694
645
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
695
646
            raise gnutls.CertificateSecurityError(code=result)
696
647
        raise gnutls.Error(code=result)
697
648
 
698
 
    def _retry_on_error(result, func, arguments,
699
 
                        _error_code=_error_code):
 
649
    def _retry_on_error(result, func, arguments):
700
650
        """A function to retry on some errors, suitable
701
 
        for the "errcheck" attribute on ctypes functions"""
702
 
        while result < gnutls.E_SUCCESS:
 
651
        for the 'errcheck' attribute on ctypes functions"""
 
652
        while result < 0:
703
653
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
704
654
                return _error_code(result)
705
655
            result = func(*arguments)
710
660
 
711
661
    # Functions
712
662
    priority_set_direct = _library.gnutls_priority_set_direct
713
 
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
 
663
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
714
664
                                    ctypes.POINTER(ctypes.c_char_p)]
715
665
    priority_set_direct.restype = _error_code
716
666
 
717
667
    init = _library.gnutls_init
718
 
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
 
668
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
719
669
    init.restype = _error_code
720
670
 
721
671
    set_default_priority = _library.gnutls_set_default_priority
722
 
    set_default_priority.argtypes = [ClientSession]
 
672
    set_default_priority.argtypes = [session_t]
723
673
    set_default_priority.restype = _error_code
724
674
 
725
675
    record_send = _library.gnutls_record_send
726
 
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
 
676
    record_send.argtypes = [session_t, ctypes.c_void_p,
727
677
                            ctypes.c_size_t]
728
678
    record_send.restype = ctypes.c_ssize_t
729
679
    record_send.errcheck = _retry_on_error
731
681
    certificate_allocate_credentials = (
732
682
        _library.gnutls_certificate_allocate_credentials)
733
683
    certificate_allocate_credentials.argtypes = [
734
 
        PointerTo(Credentials)]
 
684
        ctypes.POINTER(certificate_credentials_t)]
735
685
    certificate_allocate_credentials.restype = _error_code
736
686
 
737
687
    certificate_free_credentials = (
738
688
        _library.gnutls_certificate_free_credentials)
739
 
    certificate_free_credentials.argtypes = [Credentials]
 
689
    certificate_free_credentials.argtypes = [
 
690
        certificate_credentials_t]
740
691
    certificate_free_credentials.restype = None
741
692
 
742
693
    handshake_set_private_extensions = (
743
694
        _library.gnutls_handshake_set_private_extensions)
744
 
    handshake_set_private_extensions.argtypes = [ClientSession,
 
695
    handshake_set_private_extensions.argtypes = [session_t,
745
696
                                                 ctypes.c_int]
746
697
    handshake_set_private_extensions.restype = None
747
698
 
748
699
    credentials_set = _library.gnutls_credentials_set
749
 
    credentials_set.argtypes = [ClientSession, credentials_type_t,
750
 
                                CastToVoidPointer(Credentials)]
 
700
    credentials_set.argtypes = [session_t, credentials_type_t,
 
701
                                ctypes.c_void_p]
751
702
    credentials_set.restype = _error_code
752
703
 
753
704
    strerror = _library.gnutls_strerror
755
706
    strerror.restype = ctypes.c_char_p
756
707
 
757
708
    certificate_type_get = _library.gnutls_certificate_type_get
758
 
    certificate_type_get.argtypes = [ClientSession]
 
709
    certificate_type_get.argtypes = [session_t]
759
710
    certificate_type_get.restype = _error_code
760
711
 
761
712
    certificate_get_peers = _library.gnutls_certificate_get_peers
762
 
    certificate_get_peers.argtypes = [ClientSession,
 
713
    certificate_get_peers.argtypes = [session_t,
763
714
                                      ctypes.POINTER(ctypes.c_uint)]
764
715
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
765
716
 
772
723
    global_set_log_function.restype = None
773
724
 
774
725
    deinit = _library.gnutls_deinit
775
 
    deinit.argtypes = [ClientSession]
 
726
    deinit.argtypes = [session_t]
776
727
    deinit.restype = None
777
728
 
778
729
    handshake = _library.gnutls_handshake
779
 
    handshake.argtypes = [ClientSession]
780
 
    handshake.restype = ctypes.c_int
 
730
    handshake.argtypes = [session_t]
 
731
    handshake.restype = _error_code
781
732
    handshake.errcheck = _retry_on_error
782
733
 
783
734
    transport_set_ptr = _library.gnutls_transport_set_ptr
784
 
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
 
735
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
785
736
    transport_set_ptr.restype = None
786
737
 
787
738
    bye = _library.gnutls_bye
788
 
    bye.argtypes = [ClientSession, close_request_t]
789
 
    bye.restype = ctypes.c_int
 
739
    bye.argtypes = [session_t, close_request_t]
 
740
    bye.restype = _error_code
790
741
    bye.errcheck = _retry_on_error
791
742
 
792
743
    check_version = _library.gnutls_check_version
793
744
    check_version.argtypes = [ctypes.c_char_p]
794
745
    check_version.restype = ctypes.c_char_p
795
746
 
796
 
    _need_version = b"3.3.0"
797
 
    if check_version(_need_version) is None:
798
 
        raise self.Error("Needs GnuTLS {} or later"
799
 
                         .format(_need_version))
800
 
 
801
 
    _tls_rawpk_version = b"3.6.6"
802
747
    has_rawpk = bool(check_version(_tls_rawpk_version))
803
748
 
804
749
    if has_rawpk:
809
754
 
810
755
        x509_crt_fmt_t = ctypes.c_int
811
756
 
812
 
        # All the function declarations below are from
813
 
        # gnutls/abstract.h
 
757
        # All the function declarations below are from gnutls/abstract.h
814
758
        pubkey_init = _library.gnutls_pubkey_init
815
759
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
816
760
        pubkey_init.restype = _error_code
830
774
        pubkey_deinit.argtypes = [pubkey_t]
831
775
        pubkey_deinit.restype = None
832
776
    else:
833
 
        # All the function declarations below are from
834
 
        # gnutls/openpgp.h
 
777
        # All the function declarations below are from gnutls/openpgp.h
835
778
 
836
779
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
837
780
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
843
786
                                       openpgp_crt_fmt_t]
844
787
        openpgp_crt_import.restype = _error_code
845
788
 
846
 
        openpgp_crt_verify_self = \
847
 
            _library.gnutls_openpgp_crt_verify_self
848
 
        openpgp_crt_verify_self.argtypes = [
849
 
            openpgp_crt_t,
850
 
            ctypes.c_uint,
851
 
            ctypes.POINTER(ctypes.c_uint),
852
 
        ]
 
789
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
790
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
791
                                            ctypes.POINTER(ctypes.c_uint)]
853
792
        openpgp_crt_verify_self.restype = _error_code
854
793
 
855
794
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
864
803
                                                    ctypes.c_size_t)]
865
804
        openpgp_crt_get_fingerprint.restype = _error_code
866
805
 
867
 
    if check_version(b"3.6.4"):
 
806
    if check_version("3.6.4"):
868
807
        certificate_type_get2 = _library.gnutls_certificate_type_get2
869
 
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
 
808
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
870
809
        certificate_type_get2.restype = _error_code
871
810
 
872
811
    # Remove non-public functions
873
812
    del _error_code, _retry_on_error
 
813
# Create the global "gnutls" object, simulating a module
 
814
gnutls = GnuTLS()
874
815
 
875
816
 
876
817
def call_pipe(connection,       # : multiprocessing.Connection
884
825
    connection.close()
885
826
 
886
827
 
887
 
class Client:
 
828
class Client(object):
888
829
    """A representation of a client host served by this server.
889
830
 
890
831
    Attributes:
891
 
    approved:   bool(); None if not yet approved/disapproved
 
832
    approved:   bool(); 'None' if not yet approved/disapproved
892
833
    approval_delay: datetime.timedelta(); Time to wait for approval
893
834
    approval_duration: datetime.timedelta(); Duration of one approval
894
 
    checker: multiprocessing.Process(); a running checker process used
895
 
             to see if the client lives. None if no process is
896
 
             running.
 
835
    checker:    subprocess.Popen(); a running checker process used
 
836
                                    to see if the client lives.
 
837
                                    'None' if no process is running.
897
838
    checker_callback_tag: a GLib event source tag, or None
898
839
    checker_command: string; External command which is run to check
899
840
                     if client lives.  %() expansions are done at
974
915
            # key_id() and fingerprint() functions
975
916
            client["key_id"] = (section.get("key_id", "").upper()
976
917
                                .replace(" ", ""))
977
 
            client["fingerprint"] = (section.get("fingerprint",
978
 
                                                 "").upper()
 
918
            client["fingerprint"] = (section["fingerprint"].upper()
979
919
                                     .replace(" ", ""))
980
 
            if not (client["key_id"] or client["fingerprint"]):
981
 
                log.error("Skipping client %s without key_id or"
982
 
                          " fingerprint", client_name)
983
 
                del settings[client_name]
984
 
                continue
985
920
            if "secret" in section:
986
921
                client["secret"] = codecs.decode(section["secret"]
987
922
                                                 .encode("utf-8"),
1028
963
            self.last_enabled = None
1029
964
            self.expires = None
1030
965
 
1031
 
        log.debug("Creating client %r", self.name)
1032
 
        log.debug("  Key ID: %s", self.key_id)
1033
 
        log.debug("  Fingerprint: %s", self.fingerprint)
 
966
        logger.debug("Creating client %r", self.name)
 
967
        logger.debug("  Key ID: %s", self.key_id)
 
968
        logger.debug("  Fingerprint: %s", self.fingerprint)
1034
969
        self.created = settings.get("created",
1035
970
                                    datetime.datetime.utcnow())
1036
971
 
1064
999
        if getattr(self, "enabled", False):
1065
1000
            # Already enabled
1066
1001
            return
 
1002
        self.expires = datetime.datetime.utcnow() + self.timeout
1067
1003
        self.enabled = True
1068
1004
        self.last_enabled = datetime.datetime.utcnow()
1069
1005
        self.init_checker()
1074
1010
        if not getattr(self, "enabled", False):
1075
1011
            return False
1076
1012
        if not quiet:
1077
 
            log.info("Disabling client %s", self.name)
 
1013
            logger.info("Disabling client %s", self.name)
1078
1014
        if getattr(self, "disable_initiator_tag", None) is not None:
1079
1015
            GLib.source_remove(self.disable_initiator_tag)
1080
1016
            self.disable_initiator_tag = None
1092
1028
    def __del__(self):
1093
1029
        self.disable()
1094
1030
 
1095
 
    def init_checker(self, randomize_start=False):
1096
 
        # Schedule a new checker to be started a randomly selected
1097
 
        # time (a fraction of 'interval') from now.  This spreads out
1098
 
        # the startup of checkers over time when the server is
1099
 
        # started.
 
1031
    def init_checker(self):
 
1032
        # Schedule a new checker to be started an 'interval' from now,
 
1033
        # and every interval from then on.
1100
1034
        if self.checker_initiator_tag is not None:
1101
1035
            GLib.source_remove(self.checker_initiator_tag)
1102
 
        interval_milliseconds = int(self.interval.total_seconds()
1103
 
                                    * 1000)
1104
 
        if randomize_start:
1105
 
            delay_milliseconds = random.randrange(
1106
 
                interval_milliseconds + 1)
1107
 
        else:
1108
 
            delay_milliseconds = interval_milliseconds
1109
1036
        self.checker_initiator_tag = GLib.timeout_add(
1110
 
            delay_milliseconds, self.start_checker, randomize_start)
1111
 
        delay = datetime.timedelta(0, 0, 0, delay_milliseconds)
1112
 
        # A checker might take up to an 'interval' of time, so we can
1113
 
        # expire at the soonest one interval after a checker was
1114
 
        # started.  Since the initial checker is delayed, the expire
1115
 
        # time might have to be extended.
1116
 
        now = datetime.datetime.utcnow()
1117
 
        self.expires = now + delay + self.interval
1118
 
        # Schedule a disable() at expire time
 
1037
            int(self.interval.total_seconds() * 1000),
 
1038
            self.start_checker)
 
1039
        # Schedule a disable() when 'timeout' has passed
1119
1040
        if self.disable_initiator_tag is not None:
1120
1041
            GLib.source_remove(self.disable_initiator_tag)
1121
1042
        self.disable_initiator_tag = GLib.timeout_add(
1122
 
            int((self.expires - now).total_seconds() * 1000),
1123
 
            self.disable)
 
1043
            int(self.timeout.total_seconds() * 1000), self.disable)
 
1044
        # Also start a new checker *right now*.
 
1045
        self.start_checker()
1124
1046
 
1125
1047
    def checker_callback(self, source, condition, connection,
1126
1048
                         command):
1127
1049
        """The checker has completed, so take appropriate actions."""
 
1050
        self.checker_callback_tag = None
 
1051
        self.checker = None
1128
1052
        # Read return code from connection (see call_pipe)
1129
1053
        returncode = connection.recv()
1130
1054
        connection.close()
1131
 
        if self.checker is not None:
1132
 
            self.checker.join()
1133
 
        self.checker_callback_tag = None
1134
 
        self.checker = None
1135
1055
 
1136
1056
        if returncode >= 0:
1137
1057
            self.last_checker_status = returncode
1138
1058
            self.last_checker_signal = None
1139
1059
            if self.last_checker_status == 0:
1140
 
                log.info("Checker for %(name)s succeeded", vars(self))
 
1060
                logger.info("Checker for %(name)s succeeded",
 
1061
                            vars(self))
1141
1062
                self.checked_ok()
1142
1063
            else:
1143
 
                log.info("Checker for %(name)s failed", vars(self))
 
1064
                logger.info("Checker for %(name)s failed", vars(self))
1144
1065
        else:
1145
1066
            self.last_checker_status = -1
1146
1067
            self.last_checker_signal = -returncode
1147
 
            log.warning("Checker for %(name)s crashed?", vars(self))
 
1068
            logger.warning("Checker for %(name)s crashed?",
 
1069
                           vars(self))
1148
1070
        return False
1149
1071
 
1150
1072
    def checked_ok(self):
1169
1091
    def need_approval(self):
1170
1092
        self.last_approval_request = datetime.datetime.utcnow()
1171
1093
 
1172
 
    def start_checker(self, start_was_randomized=False):
 
1094
    def start_checker(self):
1173
1095
        """Start a new checker subprocess if one is not running.
1174
1096
 
1175
1097
        If a checker already exists, leave it running and do
1184
1106
        # should be.
1185
1107
 
1186
1108
        if self.checker is not None and not self.checker.is_alive():
1187
 
            log.warning("Checker was not alive; joining")
 
1109
            logger.warning("Checker was not alive; joining")
1188
1110
            self.checker.join()
1189
1111
            self.checker = None
1190
1112
        # Start a new checker if needed
1191
1113
        if self.checker is None:
1192
1114
            # Escape attributes for the shell
1193
1115
            escaped_attrs = {
1194
 
                attr: shlex.quote(str(getattr(self, attr)))
 
1116
                attr: re.escape(str(getattr(self, attr)))
1195
1117
                for attr in self.runtime_expansions}
1196
1118
            try:
1197
1119
                command = self.checker_command % escaped_attrs
1198
1120
            except TypeError as error:
1199
 
                log.error('Could not format string "%s"',
1200
 
                          self.checker_command, exc_info=error)
 
1121
                logger.error('Could not format string "%s"',
 
1122
                             self.checker_command,
 
1123
                             exc_info=error)
1201
1124
                return True     # Try again later
1202
1125
            self.current_checker_command = command
1203
 
            log.info("Starting checker %r for %s", command, self.name)
 
1126
            logger.info("Starting checker %r for %s", command,
 
1127
                        self.name)
1204
1128
            # We don't need to redirect stdout and stderr, since
1205
1129
            # in normal mode, that is already done by daemon(),
1206
1130
            # and in debug mode we don't want to.  (Stdin is
1222
1146
                kwargs=popen_args)
1223
1147
            self.checker.start()
1224
1148
            self.checker_callback_tag = GLib.io_add_watch(
1225
 
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1226
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
1149
                pipe[0].fileno(), GLib.IO_IN,
1227
1150
                self.checker_callback, pipe[0], command)
1228
 
        if start_was_randomized:
1229
 
            # We were started after a random delay; Schedule a new
1230
 
            # checker to be started an 'interval' from now, and every
1231
 
            # interval from then on.
1232
 
            now = datetime.datetime.utcnow()
1233
 
            self.checker_initiator_tag = GLib.timeout_add(
1234
 
                int(self.interval.total_seconds() * 1000),
1235
 
                self.start_checker)
1236
 
            self.expires = max(self.expires, now + self.interval)
1237
 
            # Don't start a new checker again after same random delay
1238
 
            return False
1239
1151
        # Re-run this periodically if run by GLib.timeout_add
1240
1152
        return True
1241
1153
 
1246
1158
            self.checker_callback_tag = None
1247
1159
        if getattr(self, "checker", None) is None:
1248
1160
            return
1249
 
        log.debug("Stopping checker for %(name)s", vars(self))
 
1161
        logger.debug("Stopping checker for %(name)s", vars(self))
1250
1162
        self.checker.terminate()
1251
1163
        self.checker = None
1252
1164
 
1279
1191
        func._dbus_name = func.__name__
1280
1192
        if func._dbus_name.endswith("_dbus_property"):
1281
1193
            func._dbus_name = func._dbus_name[:-14]
1282
 
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
 
1194
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1283
1195
        return func
1284
1196
 
1285
1197
    return decorator
1374
1286
 
1375
1287
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1376
1288
                         out_signature="s",
1377
 
                         path_keyword="object_path",
1378
 
                         connection_keyword="connection")
 
1289
                         path_keyword='object_path',
 
1290
                         connection_keyword='connection')
1379
1291
    def Introspect(self, object_path, connection):
1380
1292
        """Overloading of standard D-Bus method.
1381
1293
 
1430
1342
            document.unlink()
1431
1343
        except (AttributeError, xml.dom.DOMException,
1432
1344
                xml.parsers.expat.ExpatError) as error:
1433
 
            log.error("Failed to override Introspection method",
1434
 
                      exc_info=error)
 
1345
            logger.error("Failed to override Introspection method",
 
1346
                         exc_info=error)
1435
1347
        return xmlstring
1436
1348
 
1437
1349
 
1495
1407
                raise ValueError("Byte arrays not supported for non-"
1496
1408
                                 "'ay' signature {!r}"
1497
1409
                                 .format(prop._dbus_signature))
1498
 
            value = dbus.ByteArray(bytes(value))
 
1410
            value = dbus.ByteArray(b''.join(chr(byte)
 
1411
                                            for byte in value))
1499
1412
        prop(value)
1500
1413
 
1501
1414
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1534
1447
 
1535
1448
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1536
1449
                         out_signature="s",
1537
 
                         path_keyword="object_path",
1538
 
                         connection_keyword="connection")
 
1450
                         path_keyword='object_path',
 
1451
                         connection_keyword='connection')
1539
1452
    def Introspect(self, object_path, connection):
1540
1453
        """Overloading of standard D-Bus method.
1541
1454
 
1597
1510
            document.unlink()
1598
1511
        except (AttributeError, xml.dom.DOMException,
1599
1512
                xml.parsers.expat.ExpatError) as error:
1600
 
            log.error("Failed to override Introspection method",
1601
 
                      exc_info=error)
 
1513
            logger.error("Failed to override Introspection method",
 
1514
                         exc_info=error)
1602
1515
        return xmlstring
1603
1516
 
1604
1517
 
1636
1549
 
1637
1550
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1638
1551
                         out_signature="s",
1639
 
                         path_keyword="object_path",
1640
 
                         connection_keyword="connection")
 
1552
                         path_keyword='object_path',
 
1553
                         connection_keyword='connection')
1641
1554
    def Introspect(self, object_path, connection):
1642
1555
        """Overloading of standard D-Bus method.
1643
1556
 
1668
1581
            document.unlink()
1669
1582
        except (AttributeError, xml.dom.DOMException,
1670
1583
                xml.parsers.expat.ExpatError) as error:
1671
 
            log.error("Failed to override Introspection method",
1672
 
                      exc_info=error)
 
1584
            logger.error("Failed to override Introspection method",
 
1585
                         exc_info=error)
1673
1586
        return xmlstring
1674
1587
 
1675
1588
 
2306
2219
    del _interface
2307
2220
 
2308
2221
 
2309
 
class ProxyClient:
 
2222
class ProxyClient(object):
2310
2223
    def __init__(self, child_pipe, key_id, fpr, address):
2311
2224
        self._pipe = child_pipe
2312
 
        self._pipe.send(("init", key_id, fpr, address))
 
2225
        self._pipe.send(('init', key_id, fpr, address))
2313
2226
        if not self._pipe.recv():
2314
2227
            raise KeyError(key_id or fpr)
2315
2228
 
2316
2229
    def __getattribute__(self, name):
2317
 
        if name == "_pipe":
 
2230
        if name == '_pipe':
2318
2231
            return super(ProxyClient, self).__getattribute__(name)
2319
 
        self._pipe.send(("getattr", name))
 
2232
        self._pipe.send(('getattr', name))
2320
2233
        data = self._pipe.recv()
2321
 
        if data[0] == "data":
 
2234
        if data[0] == 'data':
2322
2235
            return data[1]
2323
 
        if data[0] == "function":
 
2236
        if data[0] == 'function':
2324
2237
 
2325
2238
            def func(*args, **kwargs):
2326
 
                self._pipe.send(("funcall", name, args, kwargs))
 
2239
                self._pipe.send(('funcall', name, args, kwargs))
2327
2240
                return self._pipe.recv()[1]
2328
2241
 
2329
2242
            return func
2330
2243
 
2331
2244
    def __setattr__(self, name, value):
2332
 
        if name == "_pipe":
 
2245
        if name == '_pipe':
2333
2246
            return super(ProxyClient, self).__setattr__(name, value)
2334
 
        self._pipe.send(("setattr", name, value))
 
2247
        self._pipe.send(('setattr', name, value))
2335
2248
 
2336
2249
 
2337
2250
class ClientHandler(socketserver.BaseRequestHandler, object):
2342
2255
 
2343
2256
    def handle(self):
2344
2257
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2345
 
            log.info("TCP connection from: %s",
2346
 
                     str(self.client_address))
2347
 
            log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
 
2258
            logger.info("TCP connection from: %s",
 
2259
                        str(self.client_address))
 
2260
            logger.debug("Pipe FD: %d",
 
2261
                         self.server.child_pipe.fileno())
2348
2262
 
2349
2263
            session = gnutls.ClientSession(self.request)
2350
2264
 
2351
 
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
 
2265
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
2352
2266
            #                       "+AES-256-CBC", "+SHA1",
2353
2267
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2354
2268
            #                       "+DHE-DSS"))
2356
2270
            priority = self.server.gnutls_priority
2357
2271
            if priority is None:
2358
2272
                priority = "NORMAL"
2359
 
            gnutls.priority_set_direct(session,
2360
 
                                       priority.encode("utf-8"), None)
 
2273
            gnutls.priority_set_direct(session._c_object,
 
2274
                                       priority.encode("utf-8"),
 
2275
                                       None)
2361
2276
 
2362
2277
            # Start communication using the Mandos protocol
2363
2278
            # Get protocol number
2364
2279
            line = self.request.makefile().readline()
2365
 
            log.debug("Protocol version: %r", line)
 
2280
            logger.debug("Protocol version: %r", line)
2366
2281
            try:
2367
2282
                if int(line.strip().split()[0]) > 1:
2368
2283
                    raise RuntimeError(line)
2369
2284
            except (ValueError, IndexError, RuntimeError) as error:
2370
 
                log.error("Unknown protocol version: %s", error)
 
2285
                logger.error("Unknown protocol version: %s", error)
2371
2286
                return
2372
2287
 
2373
2288
            # Start GnuTLS connection
2374
2289
            try:
2375
2290
                session.handshake()
2376
2291
            except gnutls.Error as error:
2377
 
                log.warning("Handshake failed: %s", error)
 
2292
                logger.warning("Handshake failed: %s", error)
2378
2293
                # Do not run session.bye() here: the session is not
2379
2294
                # established.  Just abandon the request.
2380
2295
                return
2381
 
            log.debug("Handshake succeeded")
 
2296
            logger.debug("Handshake succeeded")
2382
2297
 
2383
2298
            approval_required = False
2384
2299
            try:
2385
2300
                if gnutls.has_rawpk:
2386
 
                    fpr = b""
 
2301
                    fpr = ""
2387
2302
                    try:
2388
2303
                        key_id = self.key_id(
2389
2304
                            self.peer_certificate(session))
2390
2305
                    except (TypeError, gnutls.Error) as error:
2391
 
                        log.warning("Bad certificate: %s", error)
 
2306
                        logger.warning("Bad certificate: %s", error)
2392
2307
                        return
2393
 
                    log.debug("Key ID: %s",
2394
 
                              key_id.decode("utf-8",
2395
 
                                            errors="replace"))
 
2308
                    logger.debug("Key ID: %s", key_id)
2396
2309
 
2397
2310
                else:
2398
 
                    key_id = b""
 
2311
                    key_id = ""
2399
2312
                    try:
2400
2313
                        fpr = self.fingerprint(
2401
2314
                            self.peer_certificate(session))
2402
2315
                    except (TypeError, gnutls.Error) as error:
2403
 
                        log.warning("Bad certificate: %s", error)
 
2316
                        logger.warning("Bad certificate: %s", error)
2404
2317
                        return
2405
 
                    log.debug("Fingerprint: %s", fpr)
 
2318
                    logger.debug("Fingerprint: %s", fpr)
2406
2319
 
2407
2320
                try:
2408
2321
                    client = ProxyClient(child_pipe, key_id, fpr,
2417
2330
 
2418
2331
                while True:
2419
2332
                    if not client.enabled:
2420
 
                        log.info("Client %s is disabled", client.name)
 
2333
                        logger.info("Client %s is disabled",
 
2334
                                    client.name)
2421
2335
                        if self.server.use_dbus:
2422
2336
                            # Emit D-Bus signal
2423
2337
                            client.Rejected("Disabled")
2427
2341
                        # We are approved or approval is disabled
2428
2342
                        break
2429
2343
                    elif client.approved is None:
2430
 
                        log.info("Client %s needs approval",
2431
 
                                 client.name)
 
2344
                        logger.info("Client %s needs approval",
 
2345
                                    client.name)
2432
2346
                        if self.server.use_dbus:
2433
2347
                            # Emit D-Bus signal
2434
2348
                            client.NeedApproval(
2435
2349
                                client.approval_delay.total_seconds()
2436
2350
                                * 1000, client.approved_by_default)
2437
2351
                    else:
2438
 
                        log.warning("Client %s was not approved",
2439
 
                                    client.name)
 
2352
                        logger.warning("Client %s was not approved",
 
2353
                                       client.name)
2440
2354
                        if self.server.use_dbus:
2441
2355
                            # Emit D-Bus signal
2442
2356
                            client.Rejected("Denied")
2450
2364
                    time2 = datetime.datetime.now()
2451
2365
                    if (time2 - time) >= delay:
2452
2366
                        if not client.approved_by_default:
2453
 
                            log.warning("Client %s timed out while"
2454
 
                                        " waiting for approval",
2455
 
                                        client.name)
 
2367
                            logger.warning("Client %s timed out while"
 
2368
                                           " waiting for approval",
 
2369
                                           client.name)
2456
2370
                            if self.server.use_dbus:
2457
2371
                                # Emit D-Bus signal
2458
2372
                                client.Rejected("Approval timed out")
2465
2379
                try:
2466
2380
                    session.send(client.secret)
2467
2381
                except gnutls.Error as error:
2468
 
                    log.warning("gnutls send failed", exc_info=error)
 
2382
                    logger.warning("gnutls send failed",
 
2383
                                   exc_info=error)
2469
2384
                    return
2470
2385
 
2471
 
                log.info("Sending secret to %s", client.name)
 
2386
                logger.info("Sending secret to %s", client.name)
2472
2387
                # bump the timeout using extended_timeout
2473
2388
                client.bump_timeout(client.extended_timeout)
2474
2389
                if self.server.use_dbus:
2481
2396
                try:
2482
2397
                    session.bye()
2483
2398
                except gnutls.Error as error:
2484
 
                    log.warning("GnuTLS bye failed", exc_info=error)
 
2399
                    logger.warning("GnuTLS bye failed",
 
2400
                                   exc_info=error)
2485
2401
 
2486
2402
    @staticmethod
2487
2403
    def peer_certificate(session):
2488
2404
        "Return the peer's certificate as a bytestring"
2489
2405
        try:
2490
 
            cert_type = gnutls.certificate_type_get2(
2491
 
                session, gnutls.CTYPE_PEERS)
 
2406
            cert_type = gnutls.certificate_type_get2(session._c_object,
 
2407
                                                     gnutls.CTYPE_PEERS)
2492
2408
        except AttributeError:
2493
 
            cert_type = gnutls.certificate_type_get(session)
 
2409
            cert_type = gnutls.certificate_type_get(session._c_object)
2494
2410
        if gnutls.has_rawpk:
2495
2411
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2496
2412
        else:
2497
2413
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2498
2414
        # If not a valid certificate type...
2499
2415
        if cert_type not in valid_cert_types:
2500
 
            log.info("Cert type %r not in %r", cert_type,
2501
 
                     valid_cert_types)
 
2416
            logger.info("Cert type %r not in %r", cert_type,
 
2417
                        valid_cert_types)
2502
2418
            # ...return invalid data
2503
2419
            return b""
2504
2420
        list_size = ctypes.c_uint(1)
2505
2421
        cert_list = (gnutls.certificate_get_peers
2506
 
                     (session, ctypes.byref(list_size)))
 
2422
                     (session._c_object, ctypes.byref(list_size)))
2507
2423
        if not bool(cert_list) and list_size.value != 0:
2508
2424
            raise gnutls.Error("error getting peer certificate")
2509
2425
        if list_size.value == 0:
2531
2447
        buf = ctypes.create_string_buffer(32)
2532
2448
        buf_len = ctypes.c_size_t(len(buf))
2533
2449
        # Get the key ID from the raw public key into the buffer
2534
 
        gnutls.pubkey_get_key_id(
2535
 
            pubkey,
2536
 
            gnutls.KEYID_USE_SHA256,
2537
 
            ctypes.cast(ctypes.byref(buf),
2538
 
                        ctypes.POINTER(ctypes.c_ubyte)),
2539
 
            ctypes.byref(buf_len))
 
2450
        gnutls.pubkey_get_key_id(pubkey,
 
2451
                                 gnutls.KEYID_USE_SHA256,
 
2452
                                 ctypes.cast(ctypes.byref(buf),
 
2453
                                             ctypes.POINTER(ctypes.c_ubyte)),
 
2454
                                 ctypes.byref(buf_len))
2540
2455
        # Deinit the certificate
2541
2456
        gnutls.pubkey_deinit(pubkey)
2542
2457
 
2583
2498
        return hex_fpr
2584
2499
 
2585
2500
 
2586
 
class MultiprocessingMixIn:
 
2501
class MultiprocessingMixIn(object):
2587
2502
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2588
2503
 
2589
2504
    def sub_process_main(self, request, address):
2601
2516
        return proc
2602
2517
 
2603
2518
 
2604
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
2519
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2605
2520
    """ adds a pipe to the MixIn """
2606
2521
 
2607
2522
    def process_request(self, request, client_address):
2622
2537
 
2623
2538
 
2624
2539
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2625
 
                     socketserver.TCPServer):
2626
 
    """IPv6-capable TCP server.  Accepts None as address and/or port
 
2540
                     socketserver.TCPServer, object):
 
2541
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2627
2542
 
2628
2543
    Attributes:
2629
2544
        enabled:        Boolean; whether this server is activated yet
2680
2595
            if SO_BINDTODEVICE is None:
2681
2596
                # Fall back to a hard-coded value which seems to be
2682
2597
                # common enough.
2683
 
                log.warning("SO_BINDTODEVICE not found, trying 25")
 
2598
                logger.warning("SO_BINDTODEVICE not found, trying 25")
2684
2599
                SO_BINDTODEVICE = 25
2685
2600
            try:
2686
2601
                self.socket.setsockopt(
2688
2603
                    (self.interface + "\0").encode("utf-8"))
2689
2604
            except socket.error as error:
2690
2605
                if error.errno == errno.EPERM:
2691
 
                    log.error("No permission to bind to interface %s",
2692
 
                              self.interface)
 
2606
                    logger.error("No permission to bind to"
 
2607
                                 " interface %s", self.interface)
2693
2608
                elif error.errno == errno.ENOPROTOOPT:
2694
 
                    log.error("SO_BINDTODEVICE not available; cannot"
2695
 
                              " bind to interface %s", self.interface)
 
2609
                    logger.error("SO_BINDTODEVICE not available;"
 
2610
                                 " cannot bind to interface %s",
 
2611
                                 self.interface)
2696
2612
                elif error.errno == errno.ENODEV:
2697
 
                    log.error("Interface %s does not exist, cannot"
2698
 
                              " bind", self.interface)
 
2613
                    logger.error("Interface %s does not exist,"
 
2614
                                 " cannot bind", self.interface)
2699
2615
                else:
2700
2616
                    raise
2701
2617
        # Only bind(2) the socket if we really need to.
2702
2618
        if self.server_address[0] or self.server_address[1]:
2703
 
            if self.server_address[1]:
2704
 
                self.allow_reuse_address = True
2705
2619
            if not self.server_address[0]:
2706
2620
                if self.address_family == socket.AF_INET6:
2707
2621
                    any_address = "::"  # in6addr_any
2760
2674
    def add_pipe(self, parent_pipe, proc):
2761
2675
        # Call "handle_ipc" for both data and EOF events
2762
2676
        GLib.io_add_watch(
2763
 
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
2764
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2677
            parent_pipe.fileno(),
 
2678
            GLib.IO_IN | GLib.IO_HUP,
2765
2679
            functools.partial(self.handle_ipc,
2766
2680
                              parent_pipe=parent_pipe,
2767
2681
                              proc=proc))
2780
2694
        request = parent_pipe.recv()
2781
2695
        command = request[0]
2782
2696
 
2783
 
        if command == "init":
 
2697
        if command == 'init':
2784
2698
            key_id = request[1].decode("ascii")
2785
2699
            fpr = request[2].decode("ascii")
2786
2700
            address = request[3]
2787
2701
 
2788
2702
            for c in self.clients.values():
2789
 
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2790
 
                              "27AE41E4649B934CA495991B7852B855"):
 
2703
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2791
2704
                    continue
2792
2705
                if key_id and c.key_id == key_id:
2793
2706
                    client = c
2796
2709
                    client = c
2797
2710
                    break
2798
2711
            else:
2799
 
                log.info("Client not found for key ID: %s, address:"
2800
 
                         " %s", key_id or fpr, address)
 
2712
                logger.info("Client not found for key ID: %s, address"
 
2713
                            ": %s", key_id or fpr, address)
2801
2714
                if self.use_dbus:
2802
2715
                    # Emit D-Bus signal
2803
2716
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2806
2719
                return False
2807
2720
 
2808
2721
            GLib.io_add_watch(
2809
 
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
2810
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2722
                parent_pipe.fileno(),
 
2723
                GLib.IO_IN | GLib.IO_HUP,
2811
2724
                functools.partial(self.handle_ipc,
2812
2725
                                  parent_pipe=parent_pipe,
2813
2726
                                  proc=proc,
2816
2729
            # remove the old hook in favor of the new above hook on
2817
2730
            # same fileno
2818
2731
            return False
2819
 
        if command == "funcall":
 
2732
        if command == 'funcall':
2820
2733
            funcname = request[1]
2821
2734
            args = request[2]
2822
2735
            kwargs = request[3]
2823
2736
 
2824
 
            parent_pipe.send(("data", getattr(client_object,
 
2737
            parent_pipe.send(('data', getattr(client_object,
2825
2738
                                              funcname)(*args,
2826
2739
                                                        **kwargs)))
2827
2740
 
2828
 
        if command == "getattr":
 
2741
        if command == 'getattr':
2829
2742
            attrname = request[1]
2830
2743
            if isinstance(client_object.__getattribute__(attrname),
2831
 
                          collections.abc.Callable):
2832
 
                parent_pipe.send(("function", ))
 
2744
                          collections.Callable):
 
2745
                parent_pipe.send(('function', ))
2833
2746
            else:
2834
2747
                parent_pipe.send((
2835
 
                    "data", client_object.__getattribute__(attrname)))
 
2748
                    'data', client_object.__getattribute__(attrname)))
2836
2749
 
2837
 
        if command == "setattr":
 
2750
        if command == 'setattr':
2838
2751
            attrname = request[1]
2839
2752
            value = request[2]
2840
2753
            setattr(client_object, attrname, value)
2845
2758
def rfc3339_duration_to_delta(duration):
2846
2759
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2847
2760
 
2848
 
    >>> timedelta = datetime.timedelta
2849
 
    >>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2850
 
    True
2851
 
    >>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2852
 
    True
2853
 
    >>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2854
 
    True
2855
 
    >>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2856
 
    True
2857
 
    >>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2858
 
    True
2859
 
    >>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2860
 
    True
2861
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2862
 
    True
2863
 
    >>> del timedelta
 
2761
    >>> rfc3339_duration_to_delta("P7D")
 
2762
    datetime.timedelta(7)
 
2763
    >>> rfc3339_duration_to_delta("PT60S")
 
2764
    datetime.timedelta(0, 60)
 
2765
    >>> rfc3339_duration_to_delta("PT60M")
 
2766
    datetime.timedelta(0, 3600)
 
2767
    >>> rfc3339_duration_to_delta("PT24H")
 
2768
    datetime.timedelta(1)
 
2769
    >>> rfc3339_duration_to_delta("P1W")
 
2770
    datetime.timedelta(7)
 
2771
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2772
    datetime.timedelta(0, 330)
 
2773
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2774
    datetime.timedelta(1, 200)
2864
2775
    """
2865
2776
 
2866
2777
    # Parsing an RFC 3339 duration with regular expressions is not
2946
2857
def string_to_delta(interval):
2947
2858
    """Parse a string and return a datetime.timedelta
2948
2859
 
2949
 
    >>> string_to_delta("7d") == datetime.timedelta(7)
2950
 
    True
2951
 
    >>> string_to_delta("60s") == datetime.timedelta(0, 60)
2952
 
    True
2953
 
    >>> string_to_delta("60m") == datetime.timedelta(0, 3600)
2954
 
    True
2955
 
    >>> string_to_delta("24h") == datetime.timedelta(1)
2956
 
    True
2957
 
    >>> string_to_delta("1w") == datetime.timedelta(7)
2958
 
    True
2959
 
    >>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
2960
 
    True
 
2860
    >>> string_to_delta('7d')
 
2861
    datetime.timedelta(7)
 
2862
    >>> string_to_delta('60s')
 
2863
    datetime.timedelta(0, 60)
 
2864
    >>> string_to_delta('60m')
 
2865
    datetime.timedelta(0, 3600)
 
2866
    >>> string_to_delta('24h')
 
2867
    datetime.timedelta(1)
 
2868
    >>> string_to_delta('1w')
 
2869
    datetime.timedelta(7)
 
2870
    >>> string_to_delta('5m 30s')
 
2871
    datetime.timedelta(0, 330)
2961
2872
    """
2962
2873
 
2963
2874
    try:
3065
2976
 
3066
2977
    options = parser.parse_args()
3067
2978
 
 
2979
    if options.check:
 
2980
        import doctest
 
2981
        fail_count, test_count = doctest.testmod()
 
2982
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2983
 
3068
2984
    # Default values for config file for server-global settings
3069
2985
    if gnutls.has_rawpk:
3070
2986
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3090
3006
    del priority
3091
3007
 
3092
3008
    # Parse config file for server-global settings
3093
 
    server_config = configparser.ConfigParser(server_defaults)
 
3009
    server_config = configparser.SafeConfigParser(server_defaults)
3094
3010
    del server_defaults
3095
3011
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
3096
 
    # Convert the ConfigParser object to a dict
 
3012
    # Convert the SafeConfigParser object to a dict
3097
3013
    server_settings = server_config.defaults()
3098
3014
    # Use the appropriate methods on the non-string config options
3099
3015
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3109
3025
        # Later, stdin will, and stdout and stderr might, be dup'ed
3110
3026
        # over with an opened os.devnull.  But we don't want this to
3111
3027
        # happen with a supplied network socket.
3112
 
        while 0 <= server_settings["socket"] <= 2:
 
3028
        if 0 <= server_settings["socket"] <= 2:
3113
3029
            server_settings["socket"] = os.dup(server_settings
3114
3030
                                               ["socket"])
3115
 
        os.set_inheritable(server_settings["socket"], False)
3116
3031
    del server_config
3117
3032
 
3118
3033
    # Override the settings from the config file with command line
3167
3082
 
3168
3083
    if server_settings["servicename"] != "Mandos":
3169
3084
        syslogger.setFormatter(
3170
 
            logging.Formatter("Mandos ({}) [%(process)d]:"
3171
 
                              " %(levelname)s: %(message)s".format(
 
3085
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
3086
                              ' %(levelname)s: %(message)s'.format(
3172
3087
                                  server_settings["servicename"])))
3173
3088
 
3174
3089
    # Parse config file with clients
3175
 
    client_config = configparser.ConfigParser(Client.client_defaults)
 
3090
    client_config = configparser.SafeConfigParser(Client
 
3091
                                                  .client_defaults)
3176
3092
    client_config.read(os.path.join(server_settings["configdir"],
3177
3093
                                    "clients.conf"))
3178
3094
 
3198
3114
        try:
3199
3115
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3200
3116
        except IOError as e:
3201
 
            log.error("Could not open file %r", pidfilename,
3202
 
                      exc_info=e)
 
3117
            logger.error("Could not open file %r", pidfilename,
 
3118
                         exc_info=e)
3203
3119
 
3204
3120
    for name, group in (("_mandos", "_mandos"),
3205
3121
                        ("mandos", "mandos"),
3216
3132
    try:
3217
3133
        os.setgid(gid)
3218
3134
        os.setuid(uid)
3219
 
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
 
3135
        if debug:
 
3136
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3137
                                                             gid))
3220
3138
    except OSError as error:
3221
 
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3222
 
                    os.strerror(error.errno))
 
3139
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3140
                       .format(uid, gid, os.strerror(error.errno)))
3223
3141
        if error.errno != errno.EPERM:
3224
3142
            raise
3225
3143
 
3232
3150
 
3233
3151
        @gnutls.log_func
3234
3152
        def debug_gnutls(level, string):
3235
 
            log.debug("GnuTLS: %s",
3236
 
                      string[:-1].decode("utf-8", errors="replace"))
 
3153
            logger.debug("GnuTLS: %s", string[:-1])
3237
3154
 
3238
3155
        gnutls.global_set_log_function(debug_gnutls)
3239
3156
 
3248
3165
        # Close all input and output, do double fork, etc.
3249
3166
        daemon()
3250
3167
 
3251
 
    if gi.version_info < (3, 10, 2):
3252
 
        # multiprocessing will use threads, so before we use GLib we
3253
 
        # need to inform GLib that threads will be used.
3254
 
        GLib.threads_init()
 
3168
    # multiprocessing will use threads, so before we use GLib we need
 
3169
    # to inform GLib that threads will be used.
 
3170
    GLib.threads_init()
3255
3171
 
3256
3172
    global main_loop
3257
3173
    # From the Avahi example code
3258
3174
    DBusGMainLoop(set_as_default=True)
3259
3175
    main_loop = GLib.MainLoop()
3260
 
    if use_dbus or zeroconf:
3261
 
        bus = dbus.SystemBus()
 
3176
    bus = dbus.SystemBus()
3262
3177
    # End of Avahi example code
3263
3178
    if use_dbus:
3264
3179
        try:
3269
3184
                "se.bsnet.fukt.Mandos", bus,
3270
3185
                do_not_queue=True)
3271
3186
        except dbus.exceptions.DBusException as e:
3272
 
            log.error("Disabling D-Bus:", exc_info=e)
 
3187
            logger.error("Disabling D-Bus:", exc_info=e)
3273
3188
            use_dbus = False
3274
3189
            server_settings["use_dbus"] = False
3275
3190
            tcp_server.use_dbus = False
3334
3249
                             if isinstance(s, bytes)
3335
3250
                             else s) for s in
3336
3251
                            value["client_structure"]]
3337
 
                        # .name, .host, and .checker_command
3338
 
                        for k in ("name", "host", "checker_command"):
 
3252
                        # .name & .host
 
3253
                        for k in ("name", "host"):
3339
3254
                            if isinstance(value[k], bytes):
3340
3255
                                value[k] = value[k].decode("utf-8")
3341
 
                        if "key_id" not in value:
 
3256
                        if not value.has_key("key_id"):
3342
3257
                            value["key_id"] = ""
3343
 
                        elif "fingerprint" not in value:
 
3258
                        elif not value.has_key("fingerprint"):
3344
3259
                            value["fingerprint"] = ""
3345
3260
                    #  old_client_settings
3346
3261
                    # .keys()
3351
3266
                        for key, value in
3352
3267
                        bytes_old_client_settings.items()}
3353
3268
                    del bytes_old_client_settings
3354
 
                    # .host and .checker_command
 
3269
                    # .host
3355
3270
                    for value in old_client_settings.values():
3356
 
                        for attribute in ("host", "checker_command"):
3357
 
                            if isinstance(value[attribute], bytes):
3358
 
                                value[attribute] = (value[attribute]
3359
 
                                                    .decode("utf-8"))
 
3271
                        if isinstance(value["host"], bytes):
 
3272
                            value["host"] = (value["host"]
 
3273
                                             .decode("utf-8"))
3360
3274
            os.remove(stored_state_path)
3361
3275
        except IOError as e:
3362
3276
            if e.errno == errno.ENOENT:
3363
 
                log.warning("Could not load persistent state:"
3364
 
                            " %s", os.strerror(e.errno))
 
3277
                logger.warning("Could not load persistent state:"
 
3278
                               " {}".format(os.strerror(e.errno)))
3365
3279
            else:
3366
 
                log.critical("Could not load persistent state:",
3367
 
                             exc_info=e)
 
3280
                logger.critical("Could not load persistent state:",
 
3281
                                exc_info=e)
3368
3282
                raise
3369
3283
        except EOFError as e:
3370
 
            log.warning("Could not load persistent state: EOFError:",
3371
 
                        exc_info=e)
 
3284
            logger.warning("Could not load persistent state: "
 
3285
                           "EOFError:",
 
3286
                           exc_info=e)
3372
3287
 
3373
3288
    with PGPEngine() as pgp:
3374
3289
        for client_name, client in clients_data.items():
3401
3316
            if client["enabled"]:
3402
3317
                if datetime.datetime.utcnow() >= client["expires"]:
3403
3318
                    if not client["last_checked_ok"]:
3404
 
                        log.warning("disabling client %s - Client"
3405
 
                                    " never performed a successful"
3406
 
                                    " checker", client_name)
 
3319
                        logger.warning(
 
3320
                            "disabling client {} - Client never "
 
3321
                            "performed a successful checker".format(
 
3322
                                client_name))
3407
3323
                        client["enabled"] = False
3408
3324
                    elif client["last_checker_status"] != 0:
3409
 
                        log.warning("disabling client %s - Client"
3410
 
                                    " last checker failed with error"
3411
 
                                    " code %s", client_name,
3412
 
                                    client["last_checker_status"])
 
3325
                        logger.warning(
 
3326
                            "disabling client {} - Client last"
 
3327
                            " checker failed with error code"
 
3328
                            " {}".format(
 
3329
                                client_name,
 
3330
                                client["last_checker_status"]))
3413
3331
                        client["enabled"] = False
3414
3332
                    else:
3415
3333
                        client["expires"] = (
3416
3334
                            datetime.datetime.utcnow()
3417
3335
                            + client["timeout"])
3418
 
                        log.debug("Last checker succeeded, keeping %s"
3419
 
                                  " enabled", client_name)
 
3336
                        logger.debug("Last checker succeeded,"
 
3337
                                     " keeping {} enabled".format(
 
3338
                                         client_name))
3420
3339
            try:
3421
3340
                client["secret"] = pgp.decrypt(
3422
3341
                    client["encrypted_secret"],
3423
3342
                    client_settings[client_name]["secret"])
3424
3343
            except PGPError:
3425
3344
                # If decryption fails, we use secret from new settings
3426
 
                log.debug("Failed to decrypt %s old secret",
3427
 
                          client_name)
 
3345
                logger.debug("Failed to decrypt {} old secret".format(
 
3346
                    client_name))
3428
3347
                client["secret"] = (client_settings[client_name]
3429
3348
                                    ["secret"])
3430
3349
 
3444
3363
            server_settings=server_settings)
3445
3364
 
3446
3365
    if not tcp_server.clients:
3447
 
        log.warning("No clients defined")
 
3366
        logger.warning("No clients defined")
3448
3367
 
3449
3368
    if not foreground:
3450
3369
        if pidfile is not None:
3453
3372
                with pidfile:
3454
3373
                    print(pid, file=pidfile)
3455
3374
            except IOError:
3456
 
                log.error("Could not write to file %r with PID %d",
3457
 
                          pidfilename, pid)
 
3375
                logger.error("Could not write to file %r with PID %d",
 
3376
                             pidfilename, pid)
3458
3377
        del pidfile
3459
3378
        del pidfilename
3460
3379
 
3610
3529
 
3611
3530
        try:
3612
3531
            with tempfile.NamedTemporaryFile(
3613
 
                    mode="wb",
 
3532
                    mode='wb',
3614
3533
                    suffix=".pickle",
3615
 
                    prefix="clients-",
 
3534
                    prefix='clients-',
3616
3535
                    dir=os.path.dirname(stored_state_path),
3617
3536
                    delete=False) as stored_state:
3618
3537
                pickle.dump((clients, client_settings), stored_state,
3626
3545
                except NameError:
3627
3546
                    pass
3628
3547
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3629
 
                log.warning("Could not save persistent state: %s",
3630
 
                            os.strerror(e.errno))
 
3548
                logger.warning("Could not save persistent state: {}"
 
3549
                               .format(os.strerror(e.errno)))
3631
3550
            else:
3632
 
                log.warning("Could not save persistent state:",
3633
 
                            exc_info=e)
 
3551
                logger.warning("Could not save persistent state:",
 
3552
                               exc_info=e)
3634
3553
                raise
3635
3554
 
3636
3555
        # Delete all clients, and settings from config
3653
3572
            mandos_dbus_service.client_added_signal(client)
3654
3573
        # Need to initiate checking of clients
3655
3574
        if client.enabled:
3656
 
            client.init_checker(randomize_start=True)
 
3575
            client.init_checker()
3657
3576
 
3658
3577
    tcp_server.enable()
3659
3578
    tcp_server.server_activate()
3662
3581
    if zeroconf:
3663
3582
        service.port = tcp_server.socket.getsockname()[1]
3664
3583
    if use_ipv6:
3665
 
        log.info("Now listening on address %r, port %d, flowinfo %d,"
3666
 
                 " scope_id %d", *tcp_server.socket.getsockname())
 
3584
        logger.info("Now listening on address %r, port %d,"
 
3585
                    " flowinfo %d, scope_id %d",
 
3586
                    *tcp_server.socket.getsockname())
3667
3587
    else:                       # IPv4
3668
 
        log.info("Now listening on address %r, port %d",
3669
 
                 *tcp_server.socket.getsockname())
 
3588
        logger.info("Now listening on address %r, port %d",
 
3589
                    *tcp_server.socket.getsockname())
3670
3590
 
3671
3591
    # service.interface = tcp_server.socket.getsockname()[3]
3672
3592
 
3676
3596
            try:
3677
3597
                service.activate()
3678
3598
            except dbus.exceptions.DBusException as error:
3679
 
                log.critical("D-Bus Exception", exc_info=error)
 
3599
                logger.critical("D-Bus Exception", exc_info=error)
3680
3600
                cleanup()
3681
3601
                sys.exit(1)
3682
3602
            # End of Avahi example code
3683
3603
 
3684
 
        GLib.io_add_watch(
3685
 
            GLib.IOChannel.unix_new(tcp_server.fileno()),
3686
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3687
 
            lambda *args, **kwargs: (tcp_server.handle_request
3688
 
                                     (*args[2:], **kwargs) or True))
 
3604
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3605
                          lambda *args, **kwargs:
 
3606
                          (tcp_server.handle_request
 
3607
                           (*args[2:], **kwargs) or True))
3689
3608
 
3690
 
        log.debug("Starting main loop")
 
3609
        logger.debug("Starting main loop")
3691
3610
        main_loop.run()
3692
3611
    except AvahiError as error:
3693
 
        log.critical("Avahi Error", exc_info=error)
 
3612
        logger.critical("Avahi Error", exc_info=error)
3694
3613
        cleanup()
3695
3614
        sys.exit(1)
3696
3615
    except KeyboardInterrupt:
3697
3616
        if debug:
3698
3617
            print("", file=sys.stderr)
3699
 
        log.debug("Server received KeyboardInterrupt")
3700
 
    log.debug("Server exiting")
 
3618
        logger.debug("Server received KeyboardInterrupt")
 
3619
    logger.debug("Server exiting")
3701
3620
    # Must run before the D-Bus bus name gets deregistered
3702
3621
    cleanup()
3703
3622
 
3704
 
 
3705
 
def parse_test_args():
3706
 
    # type: () -> argparse.Namespace
3707
 
    parser = argparse.ArgumentParser(add_help=False)
3708
 
    parser.add_argument("--check", action="store_true")
3709
 
    parser.add_argument("--prefix", )
3710
 
    args, unknown_args = parser.parse_known_args()
3711
 
    if args.check:
3712
 
        # Remove test options from sys.argv
3713
 
        sys.argv[1:] = unknown_args
3714
 
    return args
3715
 
 
3716
 
# Add all tests from doctest strings
3717
 
def load_tests(loader, tests, none):
3718
 
    import doctest
3719
 
    tests.addTests(doctest.DocTestSuite())
3720
 
    return tests
3721
 
 
3722
 
if __name__ == "__main__":
3723
 
    options = parse_test_args()
3724
 
    try:
3725
 
        if options.check:
3726
 
            extra_test_prefix = options.prefix
3727
 
            if extra_test_prefix is not None:
3728
 
                if not (unittest.main(argv=[""], exit=False)
3729
 
                        .result.wasSuccessful()):
3730
 
                    sys.exit(1)
3731
 
                class ExtraTestLoader(unittest.TestLoader):
3732
 
                    testMethodPrefix = extra_test_prefix
3733
 
                # Call using ./scriptname --test [--verbose]
3734
 
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
3735
 
            else:
3736
 
                unittest.main(argv=[""])
3737
 
        else:
3738
 
            main()
3739
 
    finally:
3740
 
        logging.shutdown()
3741
 
 
3742
 
# Local Variables:
3743
 
# run-tests:
3744
 
# (lambda (&optional extra)
3745
 
#   (if (not (funcall run-tests-in-test-buffer default-directory
3746
 
#             extra))
3747
 
#       (funcall show-test-buffer-in-test-window)
3748
 
#     (funcall remove-test-window)
3749
 
#     (if extra (message "Extra tests run successfully!"))))
3750
 
# run-tests-in-test-buffer:
3751
 
# (lambda (dir &optional extra)
3752
 
#   (with-current-buffer (get-buffer-create "*Test*")
3753
 
#     (setq buffer-read-only nil
3754
 
#           default-directory dir)
3755
 
#     (erase-buffer)
3756
 
#     (compilation-mode))
3757
 
#   (let ((process-result
3758
 
#          (let ((inhibit-read-only t))
3759
 
#            (process-file-shell-command
3760
 
#             (funcall get-command-line extra) nil "*Test*"))))
3761
 
#     (and (numberp process-result)
3762
 
#          (= process-result 0))))
3763
 
# get-command-line:
3764
 
# (lambda (&optional extra)
3765
 
#   (let ((quoted-script
3766
 
#          (shell-quote-argument (funcall get-script-name))))
3767
 
#     (format
3768
 
#      (concat "%s --check" (if extra " --prefix=atest" ""))
3769
 
#      quoted-script)))
3770
 
# get-script-name:
3771
 
# (lambda ()
3772
 
#   (if (fboundp 'file-local-name)
3773
 
#       (file-local-name (buffer-file-name))
3774
 
#     (or (file-remote-p (buffer-file-name) 'localname)
3775
 
#         (buffer-file-name))))
3776
 
# remove-test-window:
3777
 
# (lambda ()
3778
 
#   (let ((test-window (get-buffer-window "*Test*")))
3779
 
#     (if test-window (delete-window test-window))))
3780
 
# show-test-buffer-in-test-window:
3781
 
# (lambda ()
3782
 
#   (when (not (get-buffer-window-list "*Test*"))
3783
 
#     (setq next-error-last-buffer (get-buffer "*Test*"))
3784
 
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3785
 
#            (display-buffer-overriding-action
3786
 
#             `((display-buffer-in-side-window) (side . ,side)
3787
 
#               (window-height . fit-window-to-buffer)
3788
 
#               (window-width . fit-window-to-buffer))))
3789
 
#       (display-buffer "*Test*"))))
3790
 
# eval:
3791
 
# (progn
3792
 
#   (let* ((run-extra-tests (lambda () (interactive)
3793
 
#                             (funcall run-tests t)))
3794
 
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3795
 
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
3796
 
#     (setq minor-mode-overriding-map-alist
3797
 
#           (cons `(run-tests . ,outer-keymap)
3798
 
#                 minor-mode-overriding-map-alist)))
3799
 
#   (add-hook 'after-save-hook run-tests 90 t))
3800
 
# End:
 
3623
 
 
3624
if __name__ == '__main__':
 
3625
    main()