/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-16 04:38:35 UTC
  • Revision ID: teddy@recompile.se-20190316043835-xlmz9xse3bh1u5u6
mandos-ctl: Refactor tests

* mandos-ctl (Test_get_managed_objects): Remove some useless
                                         "@staticmethod"s.

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
 
# 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.8.3"
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
    _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))
543
525
 
544
526
    # Unless otherwise indicated, the constants and types below are
545
527
    # all from the gnutls/gnutls.h C header file.
562
544
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
563
545
 
564
546
    # Types
565
 
    class _session_int(ctypes.Structure):
 
547
    class session_int(ctypes.Structure):
566
548
        _fields_ = []
567
 
    session_t = ctypes.POINTER(_session_int)
 
549
    session_t = ctypes.POINTER(session_int)
568
550
 
569
551
    class certificate_credentials_st(ctypes.Structure):
570
552
        _fields_ = []
573
555
    certificate_type_t = ctypes.c_int
574
556
 
575
557
    class datum_t(ctypes.Structure):
576
 
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
577
 
                    ("size", ctypes.c_uint)]
 
558
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
559
                    ('size', ctypes.c_uint)]
578
560
 
579
 
    class _openpgp_crt_int(ctypes.Structure):
 
561
    class openpgp_crt_int(ctypes.Structure):
580
562
        _fields_ = []
581
 
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
 
563
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
582
564
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
583
565
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
584
566
    credentials_type_t = ctypes.c_int
587
569
 
588
570
    # Exceptions
589
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.
590
576
        def __init__(self, message=None, code=None, args=()):
591
577
            # Default usage is by a message string, but if a return
592
578
            # code is passed, convert it to a string with
593
579
            # gnutls.strerror()
594
580
            self.code = code
595
581
            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__(
 
582
                message = GnuTLS.strerror(code)
 
583
            return super(GnuTLS.Error, self).__init__(
599
584
                message, *args)
600
585
 
601
586
    class CertificateSecurityError(Error):
602
587
        pass
603
588
 
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
589
    # Classes
630
 
    class Credentials(With_from_param):
 
590
    class Credentials(object):
631
591
        def __init__(self):
632
 
            self._as_parameter_ = gnutls.certificate_credentials_t()
633
 
            gnutls.certificate_allocate_credentials(self)
 
592
            self._c_object = gnutls.certificate_credentials_t()
 
593
            gnutls.certificate_allocate_credentials(
 
594
                ctypes.byref(self._c_object))
634
595
            self.type = gnutls.CRD_CERTIFICATE
635
596
 
636
597
        def __del__(self):
637
 
            gnutls.certificate_free_credentials(self)
 
598
            gnutls.certificate_free_credentials(self._c_object)
638
599
 
639
 
    class ClientSession(With_from_param):
 
600
    class ClientSession(object):
640
601
        def __init__(self, socket, credentials=None):
641
 
            self._as_parameter_ = gnutls.session_t()
 
602
            self._c_object = gnutls.session_t()
642
603
            gnutls_flags = gnutls.CLIENT
643
 
            if gnutls.check_version(b"3.5.6"):
 
604
            if gnutls.check_version("3.5.6"):
644
605
                gnutls_flags |= gnutls.NO_TICKETS
645
606
            if gnutls.has_rawpk:
646
607
                gnutls_flags |= gnutls.ENABLE_RAWPK
647
 
            gnutls.init(self, gnutls_flags)
 
608
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
648
609
            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)
 
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)
652
614
            self.socket = socket
653
615
            if credentials is None:
654
616
                credentials = gnutls.Credentials()
655
 
            gnutls.credentials_set(self, credentials.type,
656
 
                                   credentials)
 
617
            gnutls.credentials_set(self._c_object, credentials.type,
 
618
                                   ctypes.cast(credentials._c_object,
 
619
                                               ctypes.c_void_p))
657
620
            self.credentials = credentials
658
621
 
659
622
        def __del__(self):
660
 
            gnutls.deinit(self)
 
623
            gnutls.deinit(self._c_object)
661
624
 
662
625
        def handshake(self):
663
 
            return gnutls.handshake(self)
 
626
            return gnutls.handshake(self._c_object)
664
627
 
665
628
        def send(self, data):
666
629
            data = bytes(data)
667
630
            data_len = len(data)
668
631
            while data_len > 0:
669
 
                data_len -= gnutls.record_send(self, data[-data_len:],
 
632
                data_len -= gnutls.record_send(self._c_object,
 
633
                                               data[-data_len:],
670
634
                                               data_len)
671
635
 
672
636
        def bye(self):
673
 
            return gnutls.bye(self, gnutls.SHUT_RDWR)
 
637
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
674
638
 
675
639
    # Error handling functions
676
640
    def _error_code(result):
677
641
        """A function to raise exceptions on errors, suitable
678
 
        for the "restype" attribute on ctypes functions"""
679
 
        if result >= gnutls.E_SUCCESS:
 
642
        for the 'restype' attribute on ctypes functions"""
 
643
        if result >= 0:
680
644
            return result
681
645
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
682
646
            raise gnutls.CertificateSecurityError(code=result)
683
647
        raise gnutls.Error(code=result)
684
648
 
685
 
    def _retry_on_error(result, func, arguments,
686
 
                        _error_code=_error_code):
 
649
    def _retry_on_error(result, func, arguments):
687
650
        """A function to retry on some errors, suitable
688
 
        for the "errcheck" attribute on ctypes functions"""
689
 
        while result < gnutls.E_SUCCESS:
 
651
        for the 'errcheck' attribute on ctypes functions"""
 
652
        while result < 0:
690
653
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
691
654
                return _error_code(result)
692
655
            result = func(*arguments)
697
660
 
698
661
    # Functions
699
662
    priority_set_direct = _library.gnutls_priority_set_direct
700
 
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
 
663
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
701
664
                                    ctypes.POINTER(ctypes.c_char_p)]
702
665
    priority_set_direct.restype = _error_code
703
666
 
704
667
    init = _library.gnutls_init
705
 
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
 
668
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
706
669
    init.restype = _error_code
707
670
 
708
671
    set_default_priority = _library.gnutls_set_default_priority
709
 
    set_default_priority.argtypes = [ClientSession]
 
672
    set_default_priority.argtypes = [session_t]
710
673
    set_default_priority.restype = _error_code
711
674
 
712
675
    record_send = _library.gnutls_record_send
713
 
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
 
676
    record_send.argtypes = [session_t, ctypes.c_void_p,
714
677
                            ctypes.c_size_t]
715
678
    record_send.restype = ctypes.c_ssize_t
716
679
    record_send.errcheck = _retry_on_error
718
681
    certificate_allocate_credentials = (
719
682
        _library.gnutls_certificate_allocate_credentials)
720
683
    certificate_allocate_credentials.argtypes = [
721
 
        PointerTo(Credentials)]
 
684
        ctypes.POINTER(certificate_credentials_t)]
722
685
    certificate_allocate_credentials.restype = _error_code
723
686
 
724
687
    certificate_free_credentials = (
725
688
        _library.gnutls_certificate_free_credentials)
726
 
    certificate_free_credentials.argtypes = [Credentials]
 
689
    certificate_free_credentials.argtypes = [
 
690
        certificate_credentials_t]
727
691
    certificate_free_credentials.restype = None
728
692
 
729
693
    handshake_set_private_extensions = (
730
694
        _library.gnutls_handshake_set_private_extensions)
731
 
    handshake_set_private_extensions.argtypes = [ClientSession,
 
695
    handshake_set_private_extensions.argtypes = [session_t,
732
696
                                                 ctypes.c_int]
733
697
    handshake_set_private_extensions.restype = None
734
698
 
735
699
    credentials_set = _library.gnutls_credentials_set
736
 
    credentials_set.argtypes = [ClientSession, credentials_type_t,
737
 
                                CastToVoidPointer(Credentials)]
 
700
    credentials_set.argtypes = [session_t, credentials_type_t,
 
701
                                ctypes.c_void_p]
738
702
    credentials_set.restype = _error_code
739
703
 
740
704
    strerror = _library.gnutls_strerror
742
706
    strerror.restype = ctypes.c_char_p
743
707
 
744
708
    certificate_type_get = _library.gnutls_certificate_type_get
745
 
    certificate_type_get.argtypes = [ClientSession]
 
709
    certificate_type_get.argtypes = [session_t]
746
710
    certificate_type_get.restype = _error_code
747
711
 
748
712
    certificate_get_peers = _library.gnutls_certificate_get_peers
749
 
    certificate_get_peers.argtypes = [ClientSession,
 
713
    certificate_get_peers.argtypes = [session_t,
750
714
                                      ctypes.POINTER(ctypes.c_uint)]
751
715
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
752
716
 
759
723
    global_set_log_function.restype = None
760
724
 
761
725
    deinit = _library.gnutls_deinit
762
 
    deinit.argtypes = [ClientSession]
 
726
    deinit.argtypes = [session_t]
763
727
    deinit.restype = None
764
728
 
765
729
    handshake = _library.gnutls_handshake
766
 
    handshake.argtypes = [ClientSession]
767
 
    handshake.restype = ctypes.c_int
 
730
    handshake.argtypes = [session_t]
 
731
    handshake.restype = _error_code
768
732
    handshake.errcheck = _retry_on_error
769
733
 
770
734
    transport_set_ptr = _library.gnutls_transport_set_ptr
771
 
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
 
735
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
772
736
    transport_set_ptr.restype = None
773
737
 
774
738
    bye = _library.gnutls_bye
775
 
    bye.argtypes = [ClientSession, close_request_t]
776
 
    bye.restype = ctypes.c_int
 
739
    bye.argtypes = [session_t, close_request_t]
 
740
    bye.restype = _error_code
777
741
    bye.errcheck = _retry_on_error
778
742
 
779
743
    check_version = _library.gnutls_check_version
780
744
    check_version.argtypes = [ctypes.c_char_p]
781
745
    check_version.restype = ctypes.c_char_p
782
746
 
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
747
    has_rawpk = bool(check_version(_tls_rawpk_version))
790
748
 
791
749
    if has_rawpk:
796
754
 
797
755
        x509_crt_fmt_t = ctypes.c_int
798
756
 
799
 
        # All the function declarations below are from
800
 
        # gnutls/abstract.h
 
757
        # All the function declarations below are from gnutls/abstract.h
801
758
        pubkey_init = _library.gnutls_pubkey_init
802
759
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
803
760
        pubkey_init.restype = _error_code
817
774
        pubkey_deinit.argtypes = [pubkey_t]
818
775
        pubkey_deinit.restype = None
819
776
    else:
820
 
        # All the function declarations below are from
821
 
        # gnutls/openpgp.h
 
777
        # All the function declarations below are from gnutls/openpgp.h
822
778
 
823
779
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
824
780
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
830
786
                                       openpgp_crt_fmt_t]
831
787
        openpgp_crt_import.restype = _error_code
832
788
 
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
 
        ]
 
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)]
840
792
        openpgp_crt_verify_self.restype = _error_code
841
793
 
842
794
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
851
803
                                                    ctypes.c_size_t)]
852
804
        openpgp_crt_get_fingerprint.restype = _error_code
853
805
 
854
 
    if check_version(b"3.6.4"):
 
806
    if check_version("3.6.4"):
855
807
        certificate_type_get2 = _library.gnutls_certificate_type_get2
856
 
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
 
808
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
857
809
        certificate_type_get2.restype = _error_code
858
810
 
859
811
    # Remove non-public functions
860
812
    del _error_code, _retry_on_error
 
813
# Create the global "gnutls" object, simulating a module
 
814
gnutls = GnuTLS()
861
815
 
862
816
 
863
817
def call_pipe(connection,       # : multiprocessing.Connection
871
825
    connection.close()
872
826
 
873
827
 
874
 
class Client:
 
828
class Client(object):
875
829
    """A representation of a client host served by this server.
876
830
 
877
831
    Attributes:
878
 
    approved:   bool(); None if not yet approved/disapproved
 
832
    approved:   bool(); 'None' if not yet approved/disapproved
879
833
    approval_delay: datetime.timedelta(); Time to wait for approval
880
834
    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.
 
835
    checker:    subprocess.Popen(); a running checker process used
 
836
                                    to see if the client lives.
 
837
                                    'None' if no process is running.
884
838
    checker_callback_tag: a GLib event source tag, or None
885
839
    checker_command: string; External command which is run to check
886
840
                     if client lives.  %() expansions are done at
961
915
            # key_id() and fingerprint() functions
962
916
            client["key_id"] = (section.get("key_id", "").upper()
963
917
                                .replace(" ", ""))
964
 
            client["fingerprint"] = (section.get("fingerprint",
965
 
                                                 "").upper()
 
918
            client["fingerprint"] = (section["fingerprint"].upper()
966
919
                                     .replace(" ", ""))
967
 
            if not (client["key_id"] or client["fingerprint"]):
968
 
                log.error("Skipping client %s without key_id or"
969
 
                          " fingerprint", client_name)
970
 
                del settings[client_name]
971
 
                continue
972
920
            if "secret" in section:
973
921
                client["secret"] = codecs.decode(section["secret"]
974
922
                                                 .encode("utf-8"),
1015
963
            self.last_enabled = None
1016
964
            self.expires = None
1017
965
 
1018
 
        log.debug("Creating client %r", self.name)
1019
 
        log.debug("  Key ID: %s", self.key_id)
1020
 
        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)
1021
969
        self.created = settings.get("created",
1022
970
                                    datetime.datetime.utcnow())
1023
971
 
1051
999
        if getattr(self, "enabled", False):
1052
1000
            # Already enabled
1053
1001
            return
 
1002
        self.expires = datetime.datetime.utcnow() + self.timeout
1054
1003
        self.enabled = True
1055
1004
        self.last_enabled = datetime.datetime.utcnow()
1056
1005
        self.init_checker()
1061
1010
        if not getattr(self, "enabled", False):
1062
1011
            return False
1063
1012
        if not quiet:
1064
 
            log.info("Disabling client %s", self.name)
 
1013
            logger.info("Disabling client %s", self.name)
1065
1014
        if getattr(self, "disable_initiator_tag", None) is not None:
1066
1015
            GLib.source_remove(self.disable_initiator_tag)
1067
1016
            self.disable_initiator_tag = None
1079
1028
    def __del__(self):
1080
1029
        self.disable()
1081
1030
 
1082
 
    def init_checker(self, randomize_start=False):
1083
 
        # Schedule a new checker to be started a randomly selected
1084
 
        # time (a fraction of 'interval') from now.  This spreads out
1085
 
        # the startup of checkers over time when the server is
1086
 
        # 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.
1087
1034
        if self.checker_initiator_tag is not None:
1088
1035
            GLib.source_remove(self.checker_initiator_tag)
1089
 
        interval_milliseconds = int(self.interval.total_seconds()
1090
 
                                    * 1000)
1091
 
        if randomize_start:
1092
 
            delay_milliseconds = random.randrange(
1093
 
                interval_milliseconds + 1)
1094
 
        else:
1095
 
            delay_milliseconds = interval_milliseconds
1096
1036
        self.checker_initiator_tag = GLib.timeout_add(
1097
 
            delay_milliseconds, self.start_checker, randomize_start)
1098
 
        delay = datetime.timedelta(0, 0, 0, delay_milliseconds)
1099
 
        # A checker might take up to an 'interval' of time, so we can
1100
 
        # expire at the soonest one interval after a checker was
1101
 
        # started.  Since the initial checker is delayed, the expire
1102
 
        # time might have to be extended.
1103
 
        now = datetime.datetime.utcnow()
1104
 
        self.expires = now + delay + self.interval
1105
 
        # 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
1106
1040
        if self.disable_initiator_tag is not None:
1107
1041
            GLib.source_remove(self.disable_initiator_tag)
1108
1042
        self.disable_initiator_tag = GLib.timeout_add(
1109
 
            int((self.expires - now).total_seconds() * 1000),
1110
 
            self.disable)
 
1043
            int(self.timeout.total_seconds() * 1000), self.disable)
 
1044
        # Also start a new checker *right now*.
 
1045
        self.start_checker()
1111
1046
 
1112
1047
    def checker_callback(self, source, condition, connection,
1113
1048
                         command):
1114
1049
        """The checker has completed, so take appropriate actions."""
 
1050
        self.checker_callback_tag = None
 
1051
        self.checker = None
1115
1052
        # Read return code from connection (see call_pipe)
1116
1053
        returncode = connection.recv()
1117
1054
        connection.close()
1118
 
        if self.checker is not None:
1119
 
            self.checker.join()
1120
 
        self.checker_callback_tag = None
1121
 
        self.checker = None
1122
1055
 
1123
1056
        if returncode >= 0:
1124
1057
            self.last_checker_status = returncode
1125
1058
            self.last_checker_signal = None
1126
1059
            if self.last_checker_status == 0:
1127
 
                log.info("Checker for %(name)s succeeded", vars(self))
 
1060
                logger.info("Checker for %(name)s succeeded",
 
1061
                            vars(self))
1128
1062
                self.checked_ok()
1129
1063
            else:
1130
 
                log.info("Checker for %(name)s failed", vars(self))
 
1064
                logger.info("Checker for %(name)s failed", vars(self))
1131
1065
        else:
1132
1066
            self.last_checker_status = -1
1133
1067
            self.last_checker_signal = -returncode
1134
 
            log.warning("Checker for %(name)s crashed?", vars(self))
 
1068
            logger.warning("Checker for %(name)s crashed?",
 
1069
                           vars(self))
1135
1070
        return False
1136
1071
 
1137
1072
    def checked_ok(self):
1156
1091
    def need_approval(self):
1157
1092
        self.last_approval_request = datetime.datetime.utcnow()
1158
1093
 
1159
 
    def start_checker(self, start_was_randomized=False):
 
1094
    def start_checker(self):
1160
1095
        """Start a new checker subprocess if one is not running.
1161
1096
 
1162
1097
        If a checker already exists, leave it running and do
1171
1106
        # should be.
1172
1107
 
1173
1108
        if self.checker is not None and not self.checker.is_alive():
1174
 
            log.warning("Checker was not alive; joining")
 
1109
            logger.warning("Checker was not alive; joining")
1175
1110
            self.checker.join()
1176
1111
            self.checker = None
1177
1112
        # Start a new checker if needed
1178
1113
        if self.checker is None:
1179
1114
            # Escape attributes for the shell
1180
1115
            escaped_attrs = {
1181
 
                attr: shlex.quote(str(getattr(self, attr)))
 
1116
                attr: re.escape(str(getattr(self, attr)))
1182
1117
                for attr in self.runtime_expansions}
1183
1118
            try:
1184
1119
                command = self.checker_command % escaped_attrs
1185
1120
            except TypeError as error:
1186
 
                log.error('Could not format string "%s"',
1187
 
                          self.checker_command, exc_info=error)
 
1121
                logger.error('Could not format string "%s"',
 
1122
                             self.checker_command,
 
1123
                             exc_info=error)
1188
1124
                return True     # Try again later
1189
1125
            self.current_checker_command = command
1190
 
            log.info("Starting checker %r for %s", command, self.name)
 
1126
            logger.info("Starting checker %r for %s", command,
 
1127
                        self.name)
1191
1128
            # We don't need to redirect stdout and stderr, since
1192
1129
            # in normal mode, that is already done by daemon(),
1193
1130
            # and in debug mode we don't want to.  (Stdin is
1209
1146
                kwargs=popen_args)
1210
1147
            self.checker.start()
1211
1148
            self.checker_callback_tag = GLib.io_add_watch(
1212
 
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1213
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
1149
                pipe[0].fileno(), GLib.IO_IN,
1214
1150
                self.checker_callback, pipe[0], command)
1215
 
        if start_was_randomized:
1216
 
            # We were started after a random delay; Schedule a new
1217
 
            # checker to be started an 'interval' from now, and every
1218
 
            # interval from then on.
1219
 
            now = datetime.datetime.utcnow()
1220
 
            self.checker_initiator_tag = GLib.timeout_add(
1221
 
                int(self.interval.total_seconds() * 1000),
1222
 
                self.start_checker)
1223
 
            self.expires = max(self.expires, now + self.interval)
1224
 
            # Don't start a new checker again after same random delay
1225
 
            return False
1226
1151
        # Re-run this periodically if run by GLib.timeout_add
1227
1152
        return True
1228
1153
 
1233
1158
            self.checker_callback_tag = None
1234
1159
        if getattr(self, "checker", None) is None:
1235
1160
            return
1236
 
        log.debug("Stopping checker for %(name)s", vars(self))
 
1161
        logger.debug("Stopping checker for %(name)s", vars(self))
1237
1162
        self.checker.terminate()
1238
1163
        self.checker = None
1239
1164
 
1266
1191
        func._dbus_name = func.__name__
1267
1192
        if func._dbus_name.endswith("_dbus_property"):
1268
1193
            func._dbus_name = func._dbus_name[:-14]
1269
 
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
 
1194
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1270
1195
        return func
1271
1196
 
1272
1197
    return decorator
1361
1286
 
1362
1287
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1363
1288
                         out_signature="s",
1364
 
                         path_keyword="object_path",
1365
 
                         connection_keyword="connection")
 
1289
                         path_keyword='object_path',
 
1290
                         connection_keyword='connection')
1366
1291
    def Introspect(self, object_path, connection):
1367
1292
        """Overloading of standard D-Bus method.
1368
1293
 
1417
1342
            document.unlink()
1418
1343
        except (AttributeError, xml.dom.DOMException,
1419
1344
                xml.parsers.expat.ExpatError) as error:
1420
 
            log.error("Failed to override Introspection method",
1421
 
                      exc_info=error)
 
1345
            logger.error("Failed to override Introspection method",
 
1346
                         exc_info=error)
1422
1347
        return xmlstring
1423
1348
 
1424
1349
 
1482
1407
                raise ValueError("Byte arrays not supported for non-"
1483
1408
                                 "'ay' signature {!r}"
1484
1409
                                 .format(prop._dbus_signature))
1485
 
            value = dbus.ByteArray(bytes(value))
 
1410
            value = dbus.ByteArray(b''.join(chr(byte)
 
1411
                                            for byte in value))
1486
1412
        prop(value)
1487
1413
 
1488
1414
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1521
1447
 
1522
1448
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1523
1449
                         out_signature="s",
1524
 
                         path_keyword="object_path",
1525
 
                         connection_keyword="connection")
 
1450
                         path_keyword='object_path',
 
1451
                         connection_keyword='connection')
1526
1452
    def Introspect(self, object_path, connection):
1527
1453
        """Overloading of standard D-Bus method.
1528
1454
 
1584
1510
            document.unlink()
1585
1511
        except (AttributeError, xml.dom.DOMException,
1586
1512
                xml.parsers.expat.ExpatError) as error:
1587
 
            log.error("Failed to override Introspection method",
1588
 
                      exc_info=error)
 
1513
            logger.error("Failed to override Introspection method",
 
1514
                         exc_info=error)
1589
1515
        return xmlstring
1590
1516
 
1591
1517
 
1623
1549
 
1624
1550
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1625
1551
                         out_signature="s",
1626
 
                         path_keyword="object_path",
1627
 
                         connection_keyword="connection")
 
1552
                         path_keyword='object_path',
 
1553
                         connection_keyword='connection')
1628
1554
    def Introspect(self, object_path, connection):
1629
1555
        """Overloading of standard D-Bus method.
1630
1556
 
1655
1581
            document.unlink()
1656
1582
        except (AttributeError, xml.dom.DOMException,
1657
1583
                xml.parsers.expat.ExpatError) as error:
1658
 
            log.error("Failed to override Introspection method",
1659
 
                      exc_info=error)
 
1584
            logger.error("Failed to override Introspection method",
 
1585
                         exc_info=error)
1660
1586
        return xmlstring
1661
1587
 
1662
1588
 
2293
2219
    del _interface
2294
2220
 
2295
2221
 
2296
 
class ProxyClient:
 
2222
class ProxyClient(object):
2297
2223
    def __init__(self, child_pipe, key_id, fpr, address):
2298
2224
        self._pipe = child_pipe
2299
 
        self._pipe.send(("init", key_id, fpr, address))
 
2225
        self._pipe.send(('init', key_id, fpr, address))
2300
2226
        if not self._pipe.recv():
2301
2227
            raise KeyError(key_id or fpr)
2302
2228
 
2303
2229
    def __getattribute__(self, name):
2304
 
        if name == "_pipe":
 
2230
        if name == '_pipe':
2305
2231
            return super(ProxyClient, self).__getattribute__(name)
2306
 
        self._pipe.send(("getattr", name))
 
2232
        self._pipe.send(('getattr', name))
2307
2233
        data = self._pipe.recv()
2308
 
        if data[0] == "data":
 
2234
        if data[0] == 'data':
2309
2235
            return data[1]
2310
 
        if data[0] == "function":
 
2236
        if data[0] == 'function':
2311
2237
 
2312
2238
            def func(*args, **kwargs):
2313
 
                self._pipe.send(("funcall", name, args, kwargs))
 
2239
                self._pipe.send(('funcall', name, args, kwargs))
2314
2240
                return self._pipe.recv()[1]
2315
2241
 
2316
2242
            return func
2317
2243
 
2318
2244
    def __setattr__(self, name, value):
2319
 
        if name == "_pipe":
 
2245
        if name == '_pipe':
2320
2246
            return super(ProxyClient, self).__setattr__(name, value)
2321
 
        self._pipe.send(("setattr", name, value))
 
2247
        self._pipe.send(('setattr', name, value))
2322
2248
 
2323
2249
 
2324
2250
class ClientHandler(socketserver.BaseRequestHandler, object):
2329
2255
 
2330
2256
    def handle(self):
2331
2257
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2332
 
            log.info("TCP connection from: %s",
2333
 
                     str(self.client_address))
2334
 
            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())
2335
2262
 
2336
2263
            session = gnutls.ClientSession(self.request)
2337
2264
 
2338
 
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
 
2265
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
2339
2266
            #                       "+AES-256-CBC", "+SHA1",
2340
2267
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2341
2268
            #                       "+DHE-DSS"))
2343
2270
            priority = self.server.gnutls_priority
2344
2271
            if priority is None:
2345
2272
                priority = "NORMAL"
2346
 
            gnutls.priority_set_direct(session,
2347
 
                                       priority.encode("utf-8"), None)
 
2273
            gnutls.priority_set_direct(session._c_object,
 
2274
                                       priority.encode("utf-8"),
 
2275
                                       None)
2348
2276
 
2349
2277
            # Start communication using the Mandos protocol
2350
2278
            # Get protocol number
2351
2279
            line = self.request.makefile().readline()
2352
 
            log.debug("Protocol version: %r", line)
 
2280
            logger.debug("Protocol version: %r", line)
2353
2281
            try:
2354
2282
                if int(line.strip().split()[0]) > 1:
2355
2283
                    raise RuntimeError(line)
2356
2284
            except (ValueError, IndexError, RuntimeError) as error:
2357
 
                log.error("Unknown protocol version: %s", error)
 
2285
                logger.error("Unknown protocol version: %s", error)
2358
2286
                return
2359
2287
 
2360
2288
            # Start GnuTLS connection
2361
2289
            try:
2362
2290
                session.handshake()
2363
2291
            except gnutls.Error as error:
2364
 
                log.warning("Handshake failed: %s", error)
 
2292
                logger.warning("Handshake failed: %s", error)
2365
2293
                # Do not run session.bye() here: the session is not
2366
2294
                # established.  Just abandon the request.
2367
2295
                return
2368
 
            log.debug("Handshake succeeded")
 
2296
            logger.debug("Handshake succeeded")
2369
2297
 
2370
2298
            approval_required = False
2371
2299
            try:
2372
2300
                if gnutls.has_rawpk:
2373
 
                    fpr = b""
 
2301
                    fpr = ""
2374
2302
                    try:
2375
2303
                        key_id = self.key_id(
2376
2304
                            self.peer_certificate(session))
2377
2305
                    except (TypeError, gnutls.Error) as error:
2378
 
                        log.warning("Bad certificate: %s", error)
 
2306
                        logger.warning("Bad certificate: %s", error)
2379
2307
                        return
2380
 
                    log.debug("Key ID: %s",
2381
 
                              key_id.decode("utf-8",
2382
 
                                            errors="replace"))
 
2308
                    logger.debug("Key ID: %s", key_id)
2383
2309
 
2384
2310
                else:
2385
 
                    key_id = b""
 
2311
                    key_id = ""
2386
2312
                    try:
2387
2313
                        fpr = self.fingerprint(
2388
2314
                            self.peer_certificate(session))
2389
2315
                    except (TypeError, gnutls.Error) as error:
2390
 
                        log.warning("Bad certificate: %s", error)
 
2316
                        logger.warning("Bad certificate: %s", error)
2391
2317
                        return
2392
 
                    log.debug("Fingerprint: %s", fpr)
 
2318
                    logger.debug("Fingerprint: %s", fpr)
2393
2319
 
2394
2320
                try:
2395
2321
                    client = ProxyClient(child_pipe, key_id, fpr,
2404
2330
 
2405
2331
                while True:
2406
2332
                    if not client.enabled:
2407
 
                        log.info("Client %s is disabled", client.name)
 
2333
                        logger.info("Client %s is disabled",
 
2334
                                    client.name)
2408
2335
                        if self.server.use_dbus:
2409
2336
                            # Emit D-Bus signal
2410
2337
                            client.Rejected("Disabled")
2414
2341
                        # We are approved or approval is disabled
2415
2342
                        break
2416
2343
                    elif client.approved is None:
2417
 
                        log.info("Client %s needs approval",
2418
 
                                 client.name)
 
2344
                        logger.info("Client %s needs approval",
 
2345
                                    client.name)
2419
2346
                        if self.server.use_dbus:
2420
2347
                            # Emit D-Bus signal
2421
2348
                            client.NeedApproval(
2422
2349
                                client.approval_delay.total_seconds()
2423
2350
                                * 1000, client.approved_by_default)
2424
2351
                    else:
2425
 
                        log.warning("Client %s was not approved",
2426
 
                                    client.name)
 
2352
                        logger.warning("Client %s was not approved",
 
2353
                                       client.name)
2427
2354
                        if self.server.use_dbus:
2428
2355
                            # Emit D-Bus signal
2429
2356
                            client.Rejected("Denied")
2437
2364
                    time2 = datetime.datetime.now()
2438
2365
                    if (time2 - time) >= delay:
2439
2366
                        if not client.approved_by_default:
2440
 
                            log.warning("Client %s timed out while"
2441
 
                                        " waiting for approval",
2442
 
                                        client.name)
 
2367
                            logger.warning("Client %s timed out while"
 
2368
                                           " waiting for approval",
 
2369
                                           client.name)
2443
2370
                            if self.server.use_dbus:
2444
2371
                                # Emit D-Bus signal
2445
2372
                                client.Rejected("Approval timed out")
2452
2379
                try:
2453
2380
                    session.send(client.secret)
2454
2381
                except gnutls.Error as error:
2455
 
                    log.warning("gnutls send failed", exc_info=error)
 
2382
                    logger.warning("gnutls send failed",
 
2383
                                   exc_info=error)
2456
2384
                    return
2457
2385
 
2458
 
                log.info("Sending secret to %s", client.name)
 
2386
                logger.info("Sending secret to %s", client.name)
2459
2387
                # bump the timeout using extended_timeout
2460
2388
                client.bump_timeout(client.extended_timeout)
2461
2389
                if self.server.use_dbus:
2468
2396
                try:
2469
2397
                    session.bye()
2470
2398
                except gnutls.Error as error:
2471
 
                    log.warning("GnuTLS bye failed", exc_info=error)
 
2399
                    logger.warning("GnuTLS bye failed",
 
2400
                                   exc_info=error)
2472
2401
 
2473
2402
    @staticmethod
2474
2403
    def peer_certificate(session):
2475
2404
        "Return the peer's certificate as a bytestring"
2476
2405
        try:
2477
 
            cert_type = gnutls.certificate_type_get2(
2478
 
                session, gnutls.CTYPE_PEERS)
 
2406
            cert_type = gnutls.certificate_type_get2(session._c_object,
 
2407
                                                     gnutls.CTYPE_PEERS)
2479
2408
        except AttributeError:
2480
 
            cert_type = gnutls.certificate_type_get(session)
 
2409
            cert_type = gnutls.certificate_type_get(session._c_object)
2481
2410
        if gnutls.has_rawpk:
2482
2411
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2483
2412
        else:
2484
2413
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2485
2414
        # If not a valid certificate type...
2486
2415
        if cert_type not in valid_cert_types:
2487
 
            log.info("Cert type %r not in %r", cert_type,
2488
 
                     valid_cert_types)
 
2416
            logger.info("Cert type %r not in %r", cert_type,
 
2417
                        valid_cert_types)
2489
2418
            # ...return invalid data
2490
2419
            return b""
2491
2420
        list_size = ctypes.c_uint(1)
2492
2421
        cert_list = (gnutls.certificate_get_peers
2493
 
                     (session, ctypes.byref(list_size)))
 
2422
                     (session._c_object, ctypes.byref(list_size)))
2494
2423
        if not bool(cert_list) and list_size.value != 0:
2495
2424
            raise gnutls.Error("error getting peer certificate")
2496
2425
        if list_size.value == 0:
2518
2447
        buf = ctypes.create_string_buffer(32)
2519
2448
        buf_len = ctypes.c_size_t(len(buf))
2520
2449
        # Get the key ID from the raw public key into the buffer
2521
 
        gnutls.pubkey_get_key_id(
2522
 
            pubkey,
2523
 
            gnutls.KEYID_USE_SHA256,
2524
 
            ctypes.cast(ctypes.byref(buf),
2525
 
                        ctypes.POINTER(ctypes.c_ubyte)),
2526
 
            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))
2527
2455
        # Deinit the certificate
2528
2456
        gnutls.pubkey_deinit(pubkey)
2529
2457
 
2570
2498
        return hex_fpr
2571
2499
 
2572
2500
 
2573
 
class MultiprocessingMixIn:
 
2501
class MultiprocessingMixIn(object):
2574
2502
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2575
2503
 
2576
2504
    def sub_process_main(self, request, address):
2588
2516
        return proc
2589
2517
 
2590
2518
 
2591
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
2519
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2592
2520
    """ adds a pipe to the MixIn """
2593
2521
 
2594
2522
    def process_request(self, request, client_address):
2609
2537
 
2610
2538
 
2611
2539
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2612
 
                     socketserver.TCPServer):
2613
 
    """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
2614
2542
 
2615
2543
    Attributes:
2616
2544
        enabled:        Boolean; whether this server is activated yet
2667
2595
            if SO_BINDTODEVICE is None:
2668
2596
                # Fall back to a hard-coded value which seems to be
2669
2597
                # common enough.
2670
 
                log.warning("SO_BINDTODEVICE not found, trying 25")
 
2598
                logger.warning("SO_BINDTODEVICE not found, trying 25")
2671
2599
                SO_BINDTODEVICE = 25
2672
2600
            try:
2673
2601
                self.socket.setsockopt(
2675
2603
                    (self.interface + "\0").encode("utf-8"))
2676
2604
            except socket.error as error:
2677
2605
                if error.errno == errno.EPERM:
2678
 
                    log.error("No permission to bind to interface %s",
2679
 
                              self.interface)
 
2606
                    logger.error("No permission to bind to"
 
2607
                                 " interface %s", self.interface)
2680
2608
                elif error.errno == errno.ENOPROTOOPT:
2681
 
                    log.error("SO_BINDTODEVICE not available; cannot"
2682
 
                              " bind to interface %s", self.interface)
 
2609
                    logger.error("SO_BINDTODEVICE not available;"
 
2610
                                 " cannot bind to interface %s",
 
2611
                                 self.interface)
2683
2612
                elif error.errno == errno.ENODEV:
2684
 
                    log.error("Interface %s does not exist, cannot"
2685
 
                              " bind", self.interface)
 
2613
                    logger.error("Interface %s does not exist,"
 
2614
                                 " cannot bind", self.interface)
2686
2615
                else:
2687
2616
                    raise
2688
2617
        # Only bind(2) the socket if we really need to.
2689
2618
        if self.server_address[0] or self.server_address[1]:
2690
 
            if self.server_address[1]:
2691
 
                self.allow_reuse_address = True
2692
2619
            if not self.server_address[0]:
2693
2620
                if self.address_family == socket.AF_INET6:
2694
2621
                    any_address = "::"  # in6addr_any
2747
2674
    def add_pipe(self, parent_pipe, proc):
2748
2675
        # Call "handle_ipc" for both data and EOF events
2749
2676
        GLib.io_add_watch(
2750
 
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
2751
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2677
            parent_pipe.fileno(),
 
2678
            GLib.IO_IN | GLib.IO_HUP,
2752
2679
            functools.partial(self.handle_ipc,
2753
2680
                              parent_pipe=parent_pipe,
2754
2681
                              proc=proc))
2767
2694
        request = parent_pipe.recv()
2768
2695
        command = request[0]
2769
2696
 
2770
 
        if command == "init":
 
2697
        if command == 'init':
2771
2698
            key_id = request[1].decode("ascii")
2772
2699
            fpr = request[2].decode("ascii")
2773
2700
            address = request[3]
2774
2701
 
2775
2702
            for c in self.clients.values():
2776
 
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2777
 
                              "27AE41E4649B934CA495991B7852B855"):
 
2703
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2778
2704
                    continue
2779
2705
                if key_id and c.key_id == key_id:
2780
2706
                    client = c
2783
2709
                    client = c
2784
2710
                    break
2785
2711
            else:
2786
 
                log.info("Client not found for key ID: %s, address:"
2787
 
                         " %s", key_id or fpr, address)
 
2712
                logger.info("Client not found for key ID: %s, address"
 
2713
                            ": %s", key_id or fpr, address)
2788
2714
                if self.use_dbus:
2789
2715
                    # Emit D-Bus signal
2790
2716
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2793
2719
                return False
2794
2720
 
2795
2721
            GLib.io_add_watch(
2796
 
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
2797
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2722
                parent_pipe.fileno(),
 
2723
                GLib.IO_IN | GLib.IO_HUP,
2798
2724
                functools.partial(self.handle_ipc,
2799
2725
                                  parent_pipe=parent_pipe,
2800
2726
                                  proc=proc,
2803
2729
            # remove the old hook in favor of the new above hook on
2804
2730
            # same fileno
2805
2731
            return False
2806
 
        if command == "funcall":
 
2732
        if command == 'funcall':
2807
2733
            funcname = request[1]
2808
2734
            args = request[2]
2809
2735
            kwargs = request[3]
2810
2736
 
2811
 
            parent_pipe.send(("data", getattr(client_object,
 
2737
            parent_pipe.send(('data', getattr(client_object,
2812
2738
                                              funcname)(*args,
2813
2739
                                                        **kwargs)))
2814
2740
 
2815
 
        if command == "getattr":
 
2741
        if command == 'getattr':
2816
2742
            attrname = request[1]
2817
2743
            if isinstance(client_object.__getattribute__(attrname),
2818
 
                          collections.abc.Callable):
2819
 
                parent_pipe.send(("function", ))
 
2744
                          collections.Callable):
 
2745
                parent_pipe.send(('function', ))
2820
2746
            else:
2821
2747
                parent_pipe.send((
2822
 
                    "data", client_object.__getattribute__(attrname)))
 
2748
                    'data', client_object.__getattribute__(attrname)))
2823
2749
 
2824
 
        if command == "setattr":
 
2750
        if command == 'setattr':
2825
2751
            attrname = request[1]
2826
2752
            value = request[2]
2827
2753
            setattr(client_object, attrname, value)
2832
2758
def rfc3339_duration_to_delta(duration):
2833
2759
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2834
2760
 
2835
 
    >>> timedelta = datetime.timedelta
2836
 
    >>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2837
 
    True
2838
 
    >>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2839
 
    True
2840
 
    >>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2841
 
    True
2842
 
    >>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2843
 
    True
2844
 
    >>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2845
 
    True
2846
 
    >>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2847
 
    True
2848
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2849
 
    True
2850
 
    >>> 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)
2851
2775
    """
2852
2776
 
2853
2777
    # Parsing an RFC 3339 duration with regular expressions is not
2933
2857
def string_to_delta(interval):
2934
2858
    """Parse a string and return a datetime.timedelta
2935
2859
 
2936
 
    >>> string_to_delta("7d") == datetime.timedelta(7)
2937
 
    True
2938
 
    >>> string_to_delta("60s") == datetime.timedelta(0, 60)
2939
 
    True
2940
 
    >>> string_to_delta("60m") == datetime.timedelta(0, 3600)
2941
 
    True
2942
 
    >>> string_to_delta("24h") == datetime.timedelta(1)
2943
 
    True
2944
 
    >>> string_to_delta("1w") == datetime.timedelta(7)
2945
 
    True
2946
 
    >>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
2947
 
    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)
2948
2872
    """
2949
2873
 
2950
2874
    try:
3052
2976
 
3053
2977
    options = parser.parse_args()
3054
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
 
3055
2984
    # Default values for config file for server-global settings
3056
2985
    if gnutls.has_rawpk:
3057
2986
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3077
3006
    del priority
3078
3007
 
3079
3008
    # Parse config file for server-global settings
3080
 
    server_config = configparser.ConfigParser(server_defaults)
 
3009
    server_config = configparser.SafeConfigParser(server_defaults)
3081
3010
    del server_defaults
3082
3011
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
3083
 
    # Convert the ConfigParser object to a dict
 
3012
    # Convert the SafeConfigParser object to a dict
3084
3013
    server_settings = server_config.defaults()
3085
3014
    # Use the appropriate methods on the non-string config options
3086
3015
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3153
3082
 
3154
3083
    if server_settings["servicename"] != "Mandos":
3155
3084
        syslogger.setFormatter(
3156
 
            logging.Formatter("Mandos ({}) [%(process)d]:"
3157
 
                              " %(levelname)s: %(message)s".format(
 
3085
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
3086
                              ' %(levelname)s: %(message)s'.format(
3158
3087
                                  server_settings["servicename"])))
3159
3088
 
3160
3089
    # Parse config file with clients
3161
 
    client_config = configparser.ConfigParser(Client.client_defaults)
 
3090
    client_config = configparser.SafeConfigParser(Client
 
3091
                                                  .client_defaults)
3162
3092
    client_config.read(os.path.join(server_settings["configdir"],
3163
3093
                                    "clients.conf"))
3164
3094
 
3184
3114
        try:
3185
3115
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3186
3116
        except IOError as e:
3187
 
            log.error("Could not open file %r", pidfilename,
3188
 
                      exc_info=e)
 
3117
            logger.error("Could not open file %r", pidfilename,
 
3118
                         exc_info=e)
3189
3119
 
3190
3120
    for name, group in (("_mandos", "_mandos"),
3191
3121
                        ("mandos", "mandos"),
3202
3132
    try:
3203
3133
        os.setgid(gid)
3204
3134
        os.setuid(uid)
3205
 
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
 
3135
        if debug:
 
3136
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3137
                                                             gid))
3206
3138
    except OSError as error:
3207
 
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3208
 
                    os.strerror(error.errno))
 
3139
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3140
                       .format(uid, gid, os.strerror(error.errno)))
3209
3141
        if error.errno != errno.EPERM:
3210
3142
            raise
3211
3143
 
3218
3150
 
3219
3151
        @gnutls.log_func
3220
3152
        def debug_gnutls(level, string):
3221
 
            log.debug("GnuTLS: %s",
3222
 
                      string[:-1].decode("utf-8", errors="replace"))
 
3153
            logger.debug("GnuTLS: %s", string[:-1])
3223
3154
 
3224
3155
        gnutls.global_set_log_function(debug_gnutls)
3225
3156
 
3234
3165
        # Close all input and output, do double fork, etc.
3235
3166
        daemon()
3236
3167
 
3237
 
    if gi.version_info < (3, 10, 2):
3238
 
        # multiprocessing will use threads, so before we use GLib we
3239
 
        # need to inform GLib that threads will be used.
3240
 
        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()
3241
3171
 
3242
3172
    global main_loop
3243
3173
    # From the Avahi example code
3254
3184
                "se.bsnet.fukt.Mandos", bus,
3255
3185
                do_not_queue=True)
3256
3186
        except dbus.exceptions.DBusException as e:
3257
 
            log.error("Disabling D-Bus:", exc_info=e)
 
3187
            logger.error("Disabling D-Bus:", exc_info=e)
3258
3188
            use_dbus = False
3259
3189
            server_settings["use_dbus"] = False
3260
3190
            tcp_server.use_dbus = False
3319
3249
                             if isinstance(s, bytes)
3320
3250
                             else s) for s in
3321
3251
                            value["client_structure"]]
3322
 
                        # .name, .host, and .checker_command
3323
 
                        for k in ("name", "host", "checker_command"):
 
3252
                        # .name & .host
 
3253
                        for k in ("name", "host"):
3324
3254
                            if isinstance(value[k], bytes):
3325
3255
                                value[k] = value[k].decode("utf-8")
3326
 
                        if "key_id" not in value:
 
3256
                        if not value.has_key("key_id"):
3327
3257
                            value["key_id"] = ""
3328
 
                        elif "fingerprint" not in value:
 
3258
                        elif not value.has_key("fingerprint"):
3329
3259
                            value["fingerprint"] = ""
3330
3260
                    #  old_client_settings
3331
3261
                    # .keys()
3336
3266
                        for key, value in
3337
3267
                        bytes_old_client_settings.items()}
3338
3268
                    del bytes_old_client_settings
3339
 
                    # .host and .checker_command
 
3269
                    # .host
3340
3270
                    for value in old_client_settings.values():
3341
 
                        for attribute in ("host", "checker_command"):
3342
 
                            if isinstance(value[attribute], bytes):
3343
 
                                value[attribute] = (value[attribute]
3344
 
                                                    .decode("utf-8"))
 
3271
                        if isinstance(value["host"], bytes):
 
3272
                            value["host"] = (value["host"]
 
3273
                                             .decode("utf-8"))
3345
3274
            os.remove(stored_state_path)
3346
3275
        except IOError as e:
3347
3276
            if e.errno == errno.ENOENT:
3348
 
                log.warning("Could not load persistent state:"
3349
 
                            " %s", os.strerror(e.errno))
 
3277
                logger.warning("Could not load persistent state:"
 
3278
                               " {}".format(os.strerror(e.errno)))
3350
3279
            else:
3351
 
                log.critical("Could not load persistent state:",
3352
 
                             exc_info=e)
 
3280
                logger.critical("Could not load persistent state:",
 
3281
                                exc_info=e)
3353
3282
                raise
3354
3283
        except EOFError as e:
3355
 
            log.warning("Could not load persistent state: EOFError:",
3356
 
                        exc_info=e)
 
3284
            logger.warning("Could not load persistent state: "
 
3285
                           "EOFError:",
 
3286
                           exc_info=e)
3357
3287
 
3358
3288
    with PGPEngine() as pgp:
3359
3289
        for client_name, client in clients_data.items():
3386
3316
            if client["enabled"]:
3387
3317
                if datetime.datetime.utcnow() >= client["expires"]:
3388
3318
                    if not client["last_checked_ok"]:
3389
 
                        log.warning("disabling client %s - Client"
3390
 
                                    " never performed a successful"
3391
 
                                    " checker", client_name)
 
3319
                        logger.warning(
 
3320
                            "disabling client {} - Client never "
 
3321
                            "performed a successful checker".format(
 
3322
                                client_name))
3392
3323
                        client["enabled"] = False
3393
3324
                    elif client["last_checker_status"] != 0:
3394
 
                        log.warning("disabling client %s - Client"
3395
 
                                    " last checker failed with error"
3396
 
                                    " code %s", client_name,
3397
 
                                    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"]))
3398
3331
                        client["enabled"] = False
3399
3332
                    else:
3400
3333
                        client["expires"] = (
3401
3334
                            datetime.datetime.utcnow()
3402
3335
                            + client["timeout"])
3403
 
                        log.debug("Last checker succeeded, keeping %s"
3404
 
                                  " enabled", client_name)
 
3336
                        logger.debug("Last checker succeeded,"
 
3337
                                     " keeping {} enabled".format(
 
3338
                                         client_name))
3405
3339
            try:
3406
3340
                client["secret"] = pgp.decrypt(
3407
3341
                    client["encrypted_secret"],
3408
3342
                    client_settings[client_name]["secret"])
3409
3343
            except PGPError:
3410
3344
                # If decryption fails, we use secret from new settings
3411
 
                log.debug("Failed to decrypt %s old secret",
3412
 
                          client_name)
 
3345
                logger.debug("Failed to decrypt {} old secret".format(
 
3346
                    client_name))
3413
3347
                client["secret"] = (client_settings[client_name]
3414
3348
                                    ["secret"])
3415
3349
 
3429
3363
            server_settings=server_settings)
3430
3364
 
3431
3365
    if not tcp_server.clients:
3432
 
        log.warning("No clients defined")
 
3366
        logger.warning("No clients defined")
3433
3367
 
3434
3368
    if not foreground:
3435
3369
        if pidfile is not None:
3438
3372
                with pidfile:
3439
3373
                    print(pid, file=pidfile)
3440
3374
            except IOError:
3441
 
                log.error("Could not write to file %r with PID %d",
3442
 
                          pidfilename, pid)
 
3375
                logger.error("Could not write to file %r with PID %d",
 
3376
                             pidfilename, pid)
3443
3377
        del pidfile
3444
3378
        del pidfilename
3445
3379
 
3595
3529
 
3596
3530
        try:
3597
3531
            with tempfile.NamedTemporaryFile(
3598
 
                    mode="wb",
 
3532
                    mode='wb',
3599
3533
                    suffix=".pickle",
3600
 
                    prefix="clients-",
 
3534
                    prefix='clients-',
3601
3535
                    dir=os.path.dirname(stored_state_path),
3602
3536
                    delete=False) as stored_state:
3603
3537
                pickle.dump((clients, client_settings), stored_state,
3611
3545
                except NameError:
3612
3546
                    pass
3613
3547
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3614
 
                log.warning("Could not save persistent state: %s",
3615
 
                            os.strerror(e.errno))
 
3548
                logger.warning("Could not save persistent state: {}"
 
3549
                               .format(os.strerror(e.errno)))
3616
3550
            else:
3617
 
                log.warning("Could not save persistent state:",
3618
 
                            exc_info=e)
 
3551
                logger.warning("Could not save persistent state:",
 
3552
                               exc_info=e)
3619
3553
                raise
3620
3554
 
3621
3555
        # Delete all clients, and settings from config
3638
3572
            mandos_dbus_service.client_added_signal(client)
3639
3573
        # Need to initiate checking of clients
3640
3574
        if client.enabled:
3641
 
            client.init_checker(randomize_start=True)
 
3575
            client.init_checker()
3642
3576
 
3643
3577
    tcp_server.enable()
3644
3578
    tcp_server.server_activate()
3647
3581
    if zeroconf:
3648
3582
        service.port = tcp_server.socket.getsockname()[1]
3649
3583
    if use_ipv6:
3650
 
        log.info("Now listening on address %r, port %d, flowinfo %d,"
3651
 
                 " 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())
3652
3587
    else:                       # IPv4
3653
 
        log.info("Now listening on address %r, port %d",
3654
 
                 *tcp_server.socket.getsockname())
 
3588
        logger.info("Now listening on address %r, port %d",
 
3589
                    *tcp_server.socket.getsockname())
3655
3590
 
3656
3591
    # service.interface = tcp_server.socket.getsockname()[3]
3657
3592
 
3661
3596
            try:
3662
3597
                service.activate()
3663
3598
            except dbus.exceptions.DBusException as error:
3664
 
                log.critical("D-Bus Exception", exc_info=error)
 
3599
                logger.critical("D-Bus Exception", exc_info=error)
3665
3600
                cleanup()
3666
3601
                sys.exit(1)
3667
3602
            # End of Avahi example code
3668
3603
 
3669
 
        GLib.io_add_watch(
3670
 
            GLib.IOChannel.unix_new(tcp_server.fileno()),
3671
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3672
 
            lambda *args, **kwargs: (tcp_server.handle_request
3673
 
                                     (*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))
3674
3608
 
3675
 
        log.debug("Starting main loop")
 
3609
        logger.debug("Starting main loop")
3676
3610
        main_loop.run()
3677
3611
    except AvahiError as error:
3678
 
        log.critical("Avahi Error", exc_info=error)
 
3612
        logger.critical("Avahi Error", exc_info=error)
3679
3613
        cleanup()
3680
3614
        sys.exit(1)
3681
3615
    except KeyboardInterrupt:
3682
3616
        if debug:
3683
3617
            print("", file=sys.stderr)
3684
 
        log.debug("Server received KeyboardInterrupt")
3685
 
    log.debug("Server exiting")
 
3618
        logger.debug("Server received KeyboardInterrupt")
 
3619
    logger.debug("Server exiting")
3686
3620
    # Must run before the D-Bus bus name gets deregistered
3687
3621
    cleanup()
3688
3622
 
3689
 
 
3690
 
def parse_test_args():
3691
 
    # type: () -> argparse.Namespace
3692
 
    parser = argparse.ArgumentParser(add_help=False)
3693
 
    parser.add_argument("--check", action="store_true")
3694
 
    parser.add_argument("--prefix", )
3695
 
    args, unknown_args = parser.parse_known_args()
3696
 
    if args.check:
3697
 
        # Remove test options from sys.argv
3698
 
        sys.argv[1:] = unknown_args
3699
 
    return args
3700
 
 
3701
 
# Add all tests from doctest strings
3702
 
def load_tests(loader, tests, none):
3703
 
    import doctest
3704
 
    tests.addTests(doctest.DocTestSuite())
3705
 
    return tests
3706
 
 
3707
 
if __name__ == "__main__":
3708
 
    options = parse_test_args()
3709
 
    try:
3710
 
        if options.check:
3711
 
            extra_test_prefix = options.prefix
3712
 
            if extra_test_prefix is not None:
3713
 
                if not (unittest.main(argv=[""], exit=False)
3714
 
                        .result.wasSuccessful()):
3715
 
                    sys.exit(1)
3716
 
                class ExtraTestLoader(unittest.TestLoader):
3717
 
                    testMethodPrefix = extra_test_prefix
3718
 
                # Call using ./scriptname --test [--verbose]
3719
 
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
3720
 
            else:
3721
 
                unittest.main(argv=[""])
3722
 
        else:
3723
 
            main()
3724
 
    finally:
3725
 
        logging.shutdown()
3726
 
 
3727
 
# Local Variables:
3728
 
# run-tests:
3729
 
# (lambda (&optional extra)
3730
 
#   (if (not (funcall run-tests-in-test-buffer default-directory
3731
 
#             extra))
3732
 
#       (funcall show-test-buffer-in-test-window)
3733
 
#     (funcall remove-test-window)
3734
 
#     (if extra (message "Extra tests run successfully!"))))
3735
 
# run-tests-in-test-buffer:
3736
 
# (lambda (dir &optional extra)
3737
 
#   (with-current-buffer (get-buffer-create "*Test*")
3738
 
#     (setq buffer-read-only nil
3739
 
#           default-directory dir)
3740
 
#     (erase-buffer)
3741
 
#     (compilation-mode))
3742
 
#   (let ((process-result
3743
 
#          (let ((inhibit-read-only t))
3744
 
#            (process-file-shell-command
3745
 
#             (funcall get-command-line extra) nil "*Test*"))))
3746
 
#     (and (numberp process-result)
3747
 
#          (= process-result 0))))
3748
 
# get-command-line:
3749
 
# (lambda (&optional extra)
3750
 
#   (let ((quoted-script
3751
 
#          (shell-quote-argument (funcall get-script-name))))
3752
 
#     (format
3753
 
#      (concat "%s --check" (if extra " --prefix=atest" ""))
3754
 
#      quoted-script)))
3755
 
# get-script-name:
3756
 
# (lambda ()
3757
 
#   (if (fboundp 'file-local-name)
3758
 
#       (file-local-name (buffer-file-name))
3759
 
#     (or (file-remote-p (buffer-file-name) 'localname)
3760
 
#         (buffer-file-name))))
3761
 
# remove-test-window:
3762
 
# (lambda ()
3763
 
#   (let ((test-window (get-buffer-window "*Test*")))
3764
 
#     (if test-window (delete-window test-window))))
3765
 
# show-test-buffer-in-test-window:
3766
 
# (lambda ()
3767
 
#   (when (not (get-buffer-window-list "*Test*"))
3768
 
#     (setq next-error-last-buffer (get-buffer "*Test*"))
3769
 
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3770
 
#            (display-buffer-overriding-action
3771
 
#             `((display-buffer-in-side-window) (side . ,side)
3772
 
#               (window-height . fit-window-to-buffer)
3773
 
#               (window-width . fit-window-to-buffer))))
3774
 
#       (display-buffer "*Test*"))))
3775
 
# eval:
3776
 
# (progn
3777
 
#   (let* ((run-extra-tests (lambda () (interactive)
3778
 
#                             (funcall run-tests t)))
3779
 
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3780
 
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
3781
 
#     (setq minor-mode-overriding-map-alist
3782
 
#           (cons `(run-tests . ,outer-keymap)
3783
 
#                 minor-mode-overriding-map-alist)))
3784
 
#   (add-hook 'after-save-hook run-tests 90 t))
3785
 
# End:
 
3623
 
 
3624
if __name__ == '__main__':
 
3625
    main()