/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: 2020-11-30 18:08:38 UTC
  • mfrom: (1227 trunk)
  • mto: This revision was merged to the branch mainline in revision 1228.
  • Revision ID: teddy@recompile.se-20201130180838-g7c6mhbvenlitnce
Merge from trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
#!/usr/bin/python3 -bI
2
 
# -*- coding: utf-8; lexical-binding: t -*-
 
2
# -*- mode: python; after-save-hook: (lambda () (let ((command (if (fboundp 'file-local-name) (file-local-name (buffer-file-name)) (or (file-remote-p (buffer-file-name) 'localname) (buffer-file-name))))) (if (= (progn (if (get-buffer "*Test*") (kill-buffer "*Test*")) (process-file-shell-command (format "%s --check" (shell-quote-argument command)) nil "*Test*")) 0) (let ((w (get-buffer-window "*Test*"))) (if w (delete-window w))) (progn (with-current-buffer "*Test*" (compilation-mode)) (display-buffer "*Test*" '(display-buffer-in-side-window)))))); 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-2020 Teddy Hogeborn
 
15
# Copyright © 2008-2020 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 unittest
80
81
import random
81
82
import shlex
82
83
 
93
94
if sys.version_info.major == 2:
94
95
    __metaclass__ = type
95
96
    str = unicode
96
 
    input = raw_input
97
97
 
98
98
# Add collections.abc.Callable if it does not exist
99
99
try:
143
143
if sys.version_info < (3, 2):
144
144
    configparser.Configparser = configparser.SafeConfigParser
145
145
 
146
 
version = "1.8.15"
 
146
version = "1.8.12"
147
147
stored_state_file = "clients.pickle"
148
148
 
149
 
log = logging.getLogger(os.path.basename(sys.argv[0]))
 
149
logger = logging.getLogger()
150
150
logging.captureWarnings(True)   # Show warnings via the logging system
151
151
syslogger = None
152
152
 
189
189
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
190
190
        address="/dev/log"))
191
191
    syslogger.setFormatter(logging.Formatter
192
 
                           ("Mandos [%(process)d]: %(levelname)s:"
193
 
                            " %(message)s"))
194
 
    log.addHandler(syslogger)
 
192
                           ('Mandos [%(process)d]: %(levelname)s:'
 
193
                            ' %(message)s'))
 
194
    logger.addHandler(syslogger)
195
195
 
196
196
    if debug:
197
197
        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)
 
198
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
199
                                               ' [%(process)d]:'
 
200
                                               ' %(levelname)s:'
 
201
                                               ' %(message)s'))
 
202
        logger.addHandler(console)
 
203
    logger.setLevel(level)
204
204
 
205
205
 
206
206
class PGPError(Exception):
224
224
        except OSError as e:
225
225
            if e.errno != errno.ENOENT:
226
226
                raise
227
 
        self.gnupgargs = ["--batch",
228
 
                          "--homedir", self.tempdir,
229
 
                          "--force-mdc",
230
 
                          "--quiet"]
 
227
        self.gnupgargs = ['--batch',
 
228
                          '--homedir', self.tempdir,
 
229
                          '--force-mdc',
 
230
                          '--quiet']
231
231
        # Only GPG version 1 has the --no-use-agent option.
232
232
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
233
233
            self.gnupgargs.append("--no-use-agent")
272
272
                dir=self.tempdir) as passfile:
273
273
            passfile.write(passphrase)
274
274
            passfile.flush()
275
 
            proc = subprocess.Popen([self.gpg, "--symmetric",
276
 
                                     "--passphrase-file",
 
275
            proc = subprocess.Popen([self.gpg, '--symmetric',
 
276
                                     '--passphrase-file',
277
277
                                     passfile.name]
278
278
                                    + self.gnupgargs,
279
279
                                    stdin=subprocess.PIPE,
290
290
                dir=self.tempdir) as passfile:
291
291
            passfile.write(passphrase)
292
292
            passfile.flush()
293
 
            proc = subprocess.Popen([self.gpg, "--decrypt",
294
 
                                     "--passphrase-file",
 
293
            proc = subprocess.Popen([self.gpg, '--decrypt',
 
294
                                     '--passphrase-file',
295
295
                                     passfile.name]
296
296
                                    + self.gnupgargs,
297
297
                                    stdin=subprocess.PIPE,
350
350
    Attributes:
351
351
    interface: integer; avahi.IF_UNSPEC or an interface index.
352
352
               Used to optionally bind to the specified interface.
353
 
    name: string; Example: "Mandos"
354
 
    type: string; Example: "_mandos._tcp".
 
353
    name: string; Example: 'Mandos'
 
354
    type: string; Example: '_mandos._tcp'.
355
355
     See <https://www.iana.org/assignments/service-names-port-numbers>
356
356
    port: integer; what port to announce
357
357
    TXT: list of strings; TXT record for the service
394
394
    def rename(self, remove=True):
395
395
        """Derived from the Avahi example code"""
396
396
        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)
 
397
            logger.critical("No suitable Zeroconf service name found"
 
398
                            " after %i retries, exiting.",
 
399
                            self.rename_count)
400
400
            raise AvahiServiceError("Too many renames")
401
401
        self.name = str(
402
402
            self.server.GetAlternativeServiceName(self.name))
403
403
        self.rename_count += 1
404
 
        log.info("Changing Zeroconf service name to %r ...",
405
 
                 self.name)
 
404
        logger.info("Changing Zeroconf service name to %r ...",
 
405
                    self.name)
406
406
        if remove:
407
407
            self.remove()
408
408
        try:
410
410
        except dbus.exceptions.DBusException as error:
411
411
            if (error.get_dbus_name()
412
412
                == "org.freedesktop.Avahi.CollisionError"):
413
 
                log.info("Local Zeroconf service name collision.")
 
413
                logger.info("Local Zeroconf service name collision.")
414
414
                return self.rename(remove=False)
415
415
            else:
416
 
                log.critical("D-Bus Exception", exc_info=error)
 
416
                logger.critical("D-Bus Exception", exc_info=error)
417
417
                self.cleanup()
418
418
                os._exit(1)
419
419
 
435
435
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
436
436
        self.entry_group_state_changed_match = (
437
437
            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)
 
438
                'StateChanged', self.entry_group_state_changed))
 
439
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
440
                     self.name, self.type)
441
441
        self.group.AddService(
442
442
            self.interface,
443
443
            self.protocol,
450
450
 
451
451
    def entry_group_state_changed(self, state, error):
452
452
        """Derived from the Avahi example code"""
453
 
        log.debug("Avahi entry group state change: %i", state)
 
453
        logger.debug("Avahi entry group state change: %i", state)
454
454
 
455
455
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
456
 
            log.debug("Zeroconf service established.")
 
456
            logger.debug("Zeroconf service established.")
457
457
        elif state == avahi.ENTRY_GROUP_COLLISION:
458
 
            log.info("Zeroconf service name collision.")
 
458
            logger.info("Zeroconf service name collision.")
459
459
            self.rename()
460
460
        elif state == avahi.ENTRY_GROUP_FAILURE:
461
 
            log.critical("Avahi: Error in group state changed %s",
462
 
                         str(error))
 
461
            logger.critical("Avahi: Error in group state changed %s",
 
462
                            str(error))
463
463
            raise AvahiGroupError("State changed: {!s}".format(error))
464
464
 
465
465
    def cleanup(self):
475
475
 
476
476
    def server_state_changed(self, state, error=None):
477
477
        """Derived from the Avahi example code"""
478
 
        log.debug("Avahi server state change: %i", state)
 
478
        logger.debug("Avahi server state change: %i", state)
479
479
        bad_states = {
480
480
            avahi.SERVER_INVALID: "Zeroconf server invalid",
481
481
            avahi.SERVER_REGISTERING: None,
485
485
        if state in bad_states:
486
486
            if bad_states[state] is not None:
487
487
                if error is None:
488
 
                    log.error(bad_states[state])
 
488
                    logger.error(bad_states[state])
489
489
                else:
490
 
                    log.error(bad_states[state] + ": %r", error)
 
490
                    logger.error(bad_states[state] + ": %r", error)
491
491
            self.cleanup()
492
492
        elif state == avahi.SERVER_RUNNING:
493
493
            try:
495
495
            except dbus.exceptions.DBusException as error:
496
496
                if (error.get_dbus_name()
497
497
                    == "org.freedesktop.Avahi.CollisionError"):
498
 
                    log.info("Local Zeroconf service name collision.")
 
498
                    logger.info("Local Zeroconf service name"
 
499
                                " collision.")
499
500
                    return self.rename(remove=False)
500
501
                else:
501
 
                    log.critical("D-Bus Exception", exc_info=error)
 
502
                    logger.critical("D-Bus Exception", exc_info=error)
502
503
                    self.cleanup()
503
504
                    os._exit(1)
504
505
        else:
505
506
            if error is None:
506
 
                log.debug("Unknown state: %r", state)
 
507
                logger.debug("Unknown state: %r", state)
507
508
            else:
508
 
                log.debug("Unknown state: %r: %r", state, error)
 
509
                logger.debug("Unknown state: %r: %r", state, error)
509
510
 
510
511
    def activate(self):
511
512
        """Derived from the Avahi example code"""
526
527
        ret = super(AvahiServiceToSyslog, self).rename(*args,
527
528
                                                       **kwargs)
528
529
        syslogger.setFormatter(logging.Formatter(
529
 
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
 
530
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
530
531
            .format(self.name)))
531
532
        return ret
532
533
 
562
563
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
563
564
 
564
565
    # Types
565
 
    class _session_int(ctypes.Structure):
 
566
    class session_int(ctypes.Structure):
566
567
        _fields_ = []
567
 
    session_t = ctypes.POINTER(_session_int)
 
568
    session_t = ctypes.POINTER(session_int)
568
569
 
569
570
    class certificate_credentials_st(ctypes.Structure):
570
571
        _fields_ = []
573
574
    certificate_type_t = ctypes.c_int
574
575
 
575
576
    class datum_t(ctypes.Structure):
576
 
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
577
 
                    ("size", ctypes.c_uint)]
 
577
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
578
                    ('size', ctypes.c_uint)]
578
579
 
579
 
    class _openpgp_crt_int(ctypes.Structure):
 
580
    class openpgp_crt_int(ctypes.Structure):
580
581
        _fields_ = []
581
 
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
 
582
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
582
583
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
583
584
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
584
585
    credentials_type_t = ctypes.c_int
593
594
            # gnutls.strerror()
594
595
            self.code = code
595
596
            if message is None and code is not None:
596
 
                message = gnutls.strerror(code).decode(
597
 
                    "utf-8", errors="replace")
 
597
                message = gnutls.strerror(code)
598
598
            return super(gnutls.Error, self).__init__(
599
599
                message, *args)
600
600
 
601
601
    class CertificateSecurityError(Error):
602
602
        pass
603
603
 
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
604
    # Classes
630
 
    class Credentials(With_from_param):
 
605
    class Credentials:
631
606
        def __init__(self):
632
 
            self._as_parameter_ = gnutls.certificate_credentials_t()
633
 
            gnutls.certificate_allocate_credentials(self)
 
607
            self._c_object = gnutls.certificate_credentials_t()
 
608
            gnutls.certificate_allocate_credentials(
 
609
                ctypes.byref(self._c_object))
634
610
            self.type = gnutls.CRD_CERTIFICATE
635
611
 
636
612
        def __del__(self):
637
 
            gnutls.certificate_free_credentials(self)
 
613
            gnutls.certificate_free_credentials(self._c_object)
638
614
 
639
 
    class ClientSession(With_from_param):
 
615
    class ClientSession:
640
616
        def __init__(self, socket, credentials=None):
641
 
            self._as_parameter_ = gnutls.session_t()
 
617
            self._c_object = gnutls.session_t()
642
618
            gnutls_flags = gnutls.CLIENT
643
619
            if gnutls.check_version(b"3.5.6"):
644
620
                gnutls_flags |= gnutls.NO_TICKETS
645
621
            if gnutls.has_rawpk:
646
622
                gnutls_flags |= gnutls.ENABLE_RAWPK
647
 
            gnutls.init(self, gnutls_flags)
 
623
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
648
624
            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)
 
625
            gnutls.set_default_priority(self._c_object)
 
626
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
627
            gnutls.handshake_set_private_extensions(self._c_object,
 
628
                                                    True)
652
629
            self.socket = socket
653
630
            if credentials is None:
654
631
                credentials = gnutls.Credentials()
655
 
            gnutls.credentials_set(self, credentials.type,
656
 
                                   credentials)
 
632
            gnutls.credentials_set(self._c_object, credentials.type,
 
633
                                   ctypes.cast(credentials._c_object,
 
634
                                               ctypes.c_void_p))
657
635
            self.credentials = credentials
658
636
 
659
637
        def __del__(self):
660
 
            gnutls.deinit(self)
 
638
            gnutls.deinit(self._c_object)
661
639
 
662
640
        def handshake(self):
663
 
            return gnutls.handshake(self)
 
641
            return gnutls.handshake(self._c_object)
664
642
 
665
643
        def send(self, data):
666
644
            data = bytes(data)
667
645
            data_len = len(data)
668
646
            while data_len > 0:
669
 
                data_len -= gnutls.record_send(self, data[-data_len:],
 
647
                data_len -= gnutls.record_send(self._c_object,
 
648
                                               data[-data_len:],
670
649
                                               data_len)
671
650
 
672
651
        def bye(self):
673
 
            return gnutls.bye(self, gnutls.SHUT_RDWR)
 
652
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
674
653
 
675
654
    # Error handling functions
676
655
    def _error_code(result):
677
656
        """A function to raise exceptions on errors, suitable
678
 
        for the "restype" attribute on ctypes functions"""
679
 
        if result >= gnutls.E_SUCCESS:
 
657
        for the 'restype' attribute on ctypes functions"""
 
658
        if result >= 0:
680
659
            return result
681
660
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
682
661
            raise gnutls.CertificateSecurityError(code=result)
683
662
        raise gnutls.Error(code=result)
684
663
 
685
 
    def _retry_on_error(result, func, arguments,
686
 
                        _error_code=_error_code):
 
664
    def _retry_on_error(result, func, arguments):
687
665
        """A function to retry on some errors, suitable
688
 
        for the "errcheck" attribute on ctypes functions"""
689
 
        while result < gnutls.E_SUCCESS:
 
666
        for the 'errcheck' attribute on ctypes functions"""
 
667
        while result < 0:
690
668
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
691
669
                return _error_code(result)
692
670
            result = func(*arguments)
697
675
 
698
676
    # Functions
699
677
    priority_set_direct = _library.gnutls_priority_set_direct
700
 
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
 
678
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
701
679
                                    ctypes.POINTER(ctypes.c_char_p)]
702
680
    priority_set_direct.restype = _error_code
703
681
 
704
682
    init = _library.gnutls_init
705
 
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
 
683
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
706
684
    init.restype = _error_code
707
685
 
708
686
    set_default_priority = _library.gnutls_set_default_priority
709
 
    set_default_priority.argtypes = [ClientSession]
 
687
    set_default_priority.argtypes = [session_t]
710
688
    set_default_priority.restype = _error_code
711
689
 
712
690
    record_send = _library.gnutls_record_send
713
 
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
 
691
    record_send.argtypes = [session_t, ctypes.c_void_p,
714
692
                            ctypes.c_size_t]
715
693
    record_send.restype = ctypes.c_ssize_t
716
694
    record_send.errcheck = _retry_on_error
718
696
    certificate_allocate_credentials = (
719
697
        _library.gnutls_certificate_allocate_credentials)
720
698
    certificate_allocate_credentials.argtypes = [
721
 
        PointerTo(Credentials)]
 
699
        ctypes.POINTER(certificate_credentials_t)]
722
700
    certificate_allocate_credentials.restype = _error_code
723
701
 
724
702
    certificate_free_credentials = (
725
703
        _library.gnutls_certificate_free_credentials)
726
 
    certificate_free_credentials.argtypes = [Credentials]
 
704
    certificate_free_credentials.argtypes = [
 
705
        certificate_credentials_t]
727
706
    certificate_free_credentials.restype = None
728
707
 
729
708
    handshake_set_private_extensions = (
730
709
        _library.gnutls_handshake_set_private_extensions)
731
 
    handshake_set_private_extensions.argtypes = [ClientSession,
 
710
    handshake_set_private_extensions.argtypes = [session_t,
732
711
                                                 ctypes.c_int]
733
712
    handshake_set_private_extensions.restype = None
734
713
 
735
714
    credentials_set = _library.gnutls_credentials_set
736
 
    credentials_set.argtypes = [ClientSession, credentials_type_t,
737
 
                                CastToVoidPointer(Credentials)]
 
715
    credentials_set.argtypes = [session_t, credentials_type_t,
 
716
                                ctypes.c_void_p]
738
717
    credentials_set.restype = _error_code
739
718
 
740
719
    strerror = _library.gnutls_strerror
742
721
    strerror.restype = ctypes.c_char_p
743
722
 
744
723
    certificate_type_get = _library.gnutls_certificate_type_get
745
 
    certificate_type_get.argtypes = [ClientSession]
 
724
    certificate_type_get.argtypes = [session_t]
746
725
    certificate_type_get.restype = _error_code
747
726
 
748
727
    certificate_get_peers = _library.gnutls_certificate_get_peers
749
 
    certificate_get_peers.argtypes = [ClientSession,
 
728
    certificate_get_peers.argtypes = [session_t,
750
729
                                      ctypes.POINTER(ctypes.c_uint)]
751
730
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
752
731
 
759
738
    global_set_log_function.restype = None
760
739
 
761
740
    deinit = _library.gnutls_deinit
762
 
    deinit.argtypes = [ClientSession]
 
741
    deinit.argtypes = [session_t]
763
742
    deinit.restype = None
764
743
 
765
744
    handshake = _library.gnutls_handshake
766
 
    handshake.argtypes = [ClientSession]
767
 
    handshake.restype = ctypes.c_int
 
745
    handshake.argtypes = [session_t]
 
746
    handshake.restype = _error_code
768
747
    handshake.errcheck = _retry_on_error
769
748
 
770
749
    transport_set_ptr = _library.gnutls_transport_set_ptr
771
 
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
 
750
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
772
751
    transport_set_ptr.restype = None
773
752
 
774
753
    bye = _library.gnutls_bye
775
 
    bye.argtypes = [ClientSession, close_request_t]
776
 
    bye.restype = ctypes.c_int
 
754
    bye.argtypes = [session_t, close_request_t]
 
755
    bye.restype = _error_code
777
756
    bye.errcheck = _retry_on_error
778
757
 
779
758
    check_version = _library.gnutls_check_version
853
832
 
854
833
    if check_version(b"3.6.4"):
855
834
        certificate_type_get2 = _library.gnutls_certificate_type_get2
856
 
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
 
835
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
857
836
        certificate_type_get2.restype = _error_code
858
837
 
859
838
    # Remove non-public functions
875
854
    """A representation of a client host served by this server.
876
855
 
877
856
    Attributes:
878
 
    approved:   bool(); None if not yet approved/disapproved
 
857
    approved:   bool(); 'None' if not yet approved/disapproved
879
858
    approval_delay: datetime.timedelta(); Time to wait for approval
880
859
    approval_duration: datetime.timedelta(); Duration of one approval
881
860
    checker: multiprocessing.Process(); a running checker process used
882
 
             to see if the client lives. None if no process is
 
861
             to see if the client lives. 'None' if no process is
883
862
             running.
884
863
    checker_callback_tag: a GLib event source tag, or None
885
864
    checker_command: string; External command which is run to check
1009
988
            self.last_enabled = None
1010
989
            self.expires = None
1011
990
 
1012
 
        log.debug("Creating client %r", self.name)
1013
 
        log.debug("  Key ID: %s", self.key_id)
1014
 
        log.debug("  Fingerprint: %s", self.fingerprint)
 
991
        logger.debug("Creating client %r", self.name)
 
992
        logger.debug("  Key ID: %s", self.key_id)
 
993
        logger.debug("  Fingerprint: %s", self.fingerprint)
1015
994
        self.created = settings.get("created",
1016
995
                                    datetime.datetime.utcnow())
1017
996
 
1045
1024
        if getattr(self, "enabled", False):
1046
1025
            # Already enabled
1047
1026
            return
 
1027
        self.expires = datetime.datetime.utcnow() + self.timeout
1048
1028
        self.enabled = True
1049
1029
        self.last_enabled = datetime.datetime.utcnow()
1050
1030
        self.init_checker()
1055
1035
        if not getattr(self, "enabled", False):
1056
1036
            return False
1057
1037
        if not quiet:
1058
 
            log.info("Disabling client %s", self.name)
 
1038
            logger.info("Disabling client %s", self.name)
1059
1039
        if getattr(self, "disable_initiator_tag", None) is not None:
1060
1040
            GLib.source_remove(self.disable_initiator_tag)
1061
1041
            self.disable_initiator_tag = None
1073
1053
    def __del__(self):
1074
1054
        self.disable()
1075
1055
 
1076
 
    def init_checker(self, randomize_start=False):
1077
 
        # Schedule a new checker to be started a randomly selected
1078
 
        # time (a fraction of 'interval') from now.  This spreads out
1079
 
        # the startup of checkers over time when the server is
1080
 
        # started.
 
1056
    def init_checker(self):
 
1057
        # Schedule a new checker to be started an 'interval' from now,
 
1058
        # and every interval from then on.
1081
1059
        if self.checker_initiator_tag is not None:
1082
1060
            GLib.source_remove(self.checker_initiator_tag)
1083
 
        interval_milliseconds = int(self.interval.total_seconds()
1084
 
                                    * 1000)
1085
 
        if randomize_start:
1086
 
            delay_milliseconds = random.randrange(
1087
 
                interval_milliseconds + 1)
1088
 
        else:
1089
 
            delay_milliseconds = interval_milliseconds
1090
1061
        self.checker_initiator_tag = GLib.timeout_add(
1091
 
            delay_milliseconds, self.start_checker, randomize_start)
1092
 
        delay = datetime.timedelta(0, 0, 0, delay_milliseconds)
1093
 
        # A checker might take up to an 'interval' of time, so we can
1094
 
        # expire at the soonest one interval after a checker was
1095
 
        # started.  Since the initial checker is delayed, the expire
1096
 
        # time might have to be extended.
1097
 
        now = datetime.datetime.utcnow()
1098
 
        self.expires = now + delay + self.interval
1099
 
        # Schedule a disable() at expire time
 
1062
            random.randrange(int(self.interval.total_seconds() * 1000
 
1063
                                 + 1)),
 
1064
            self.start_checker)
 
1065
        # Schedule a disable() when 'timeout' has passed
1100
1066
        if self.disable_initiator_tag is not None:
1101
1067
            GLib.source_remove(self.disable_initiator_tag)
1102
1068
        self.disable_initiator_tag = GLib.timeout_add(
1103
 
            int((self.expires - now).total_seconds() * 1000),
1104
 
            self.disable)
 
1069
            int(self.timeout.total_seconds() * 1000), self.disable)
 
1070
        # Also start a new checker *right now*.
 
1071
        self.start_checker()
1105
1072
 
1106
1073
    def checker_callback(self, source, condition, connection,
1107
1074
                         command):
1118
1085
            self.last_checker_status = returncode
1119
1086
            self.last_checker_signal = None
1120
1087
            if self.last_checker_status == 0:
1121
 
                log.info("Checker for %(name)s succeeded", vars(self))
 
1088
                logger.info("Checker for %(name)s succeeded",
 
1089
                            vars(self))
1122
1090
                self.checked_ok()
1123
1091
            else:
1124
 
                log.info("Checker for %(name)s failed", vars(self))
 
1092
                logger.info("Checker for %(name)s failed", vars(self))
1125
1093
        else:
1126
1094
            self.last_checker_status = -1
1127
1095
            self.last_checker_signal = -returncode
1128
 
            log.warning("Checker for %(name)s crashed?", vars(self))
 
1096
            logger.warning("Checker for %(name)s crashed?",
 
1097
                           vars(self))
1129
1098
        return False
1130
1099
 
1131
1100
    def checked_ok(self):
1150
1119
    def need_approval(self):
1151
1120
        self.last_approval_request = datetime.datetime.utcnow()
1152
1121
 
1153
 
    def start_checker(self, start_was_randomized=False):
 
1122
    def start_checker(self):
1154
1123
        """Start a new checker subprocess if one is not running.
1155
1124
 
1156
1125
        If a checker already exists, leave it running and do
1165
1134
        # should be.
1166
1135
 
1167
1136
        if self.checker is not None and not self.checker.is_alive():
1168
 
            log.warning("Checker was not alive; joining")
 
1137
            logger.warning("Checker was not alive; joining")
1169
1138
            self.checker.join()
1170
1139
            self.checker = None
1171
1140
        # Start a new checker if needed
1177
1146
            try:
1178
1147
                command = self.checker_command % escaped_attrs
1179
1148
            except TypeError as error:
1180
 
                log.error('Could not format string "%s"',
1181
 
                          self.checker_command, exc_info=error)
 
1149
                logger.error('Could not format string "%s"',
 
1150
                             self.checker_command,
 
1151
                             exc_info=error)
1182
1152
                return True     # Try again later
1183
1153
            self.current_checker_command = command
1184
 
            log.info("Starting checker %r for %s", command, self.name)
 
1154
            logger.info("Starting checker %r for %s", command,
 
1155
                        self.name)
1185
1156
            # We don't need to redirect stdout and stderr, since
1186
1157
            # in normal mode, that is already done by daemon(),
1187
1158
            # and in debug mode we don't want to.  (Stdin is
1206
1177
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1207
1178
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1208
1179
                self.checker_callback, pipe[0], command)
1209
 
        if start_was_randomized:
1210
 
            # We were started after a random delay; Schedule a new
1211
 
            # checker to be started an 'interval' from now, and every
1212
 
            # interval from then on.
1213
 
            now = datetime.datetime.utcnow()
1214
 
            self.checker_initiator_tag = GLib.timeout_add(
1215
 
                int(self.interval.total_seconds() * 1000),
1216
 
                self.start_checker)
1217
 
            self.expires = max(self.expires, now + self.interval)
1218
 
            # Don't start a new checker again after same random delay
1219
 
            return False
1220
1180
        # Re-run this periodically if run by GLib.timeout_add
1221
1181
        return True
1222
1182
 
1227
1187
            self.checker_callback_tag = None
1228
1188
        if getattr(self, "checker", None) is None:
1229
1189
            return
1230
 
        log.debug("Stopping checker for %(name)s", vars(self))
 
1190
        logger.debug("Stopping checker for %(name)s", vars(self))
1231
1191
        self.checker.terminate()
1232
1192
        self.checker = None
1233
1193
 
1260
1220
        func._dbus_name = func.__name__
1261
1221
        if func._dbus_name.endswith("_dbus_property"):
1262
1222
            func._dbus_name = func._dbus_name[:-14]
1263
 
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
 
1223
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1264
1224
        return func
1265
1225
 
1266
1226
    return decorator
1355
1315
 
1356
1316
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1357
1317
                         out_signature="s",
1358
 
                         path_keyword="object_path",
1359
 
                         connection_keyword="connection")
 
1318
                         path_keyword='object_path',
 
1319
                         connection_keyword='connection')
1360
1320
    def Introspect(self, object_path, connection):
1361
1321
        """Overloading of standard D-Bus method.
1362
1322
 
1411
1371
            document.unlink()
1412
1372
        except (AttributeError, xml.dom.DOMException,
1413
1373
                xml.parsers.expat.ExpatError) as error:
1414
 
            log.error("Failed to override Introspection method",
1415
 
                      exc_info=error)
 
1374
            logger.error("Failed to override Introspection method",
 
1375
                         exc_info=error)
1416
1376
        return xmlstring
1417
1377
 
1418
1378
 
1515
1475
 
1516
1476
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1517
1477
                         out_signature="s",
1518
 
                         path_keyword="object_path",
1519
 
                         connection_keyword="connection")
 
1478
                         path_keyword='object_path',
 
1479
                         connection_keyword='connection')
1520
1480
    def Introspect(self, object_path, connection):
1521
1481
        """Overloading of standard D-Bus method.
1522
1482
 
1578
1538
            document.unlink()
1579
1539
        except (AttributeError, xml.dom.DOMException,
1580
1540
                xml.parsers.expat.ExpatError) as error:
1581
 
            log.error("Failed to override Introspection method",
1582
 
                      exc_info=error)
 
1541
            logger.error("Failed to override Introspection method",
 
1542
                         exc_info=error)
1583
1543
        return xmlstring
1584
1544
 
1585
1545
 
1617
1577
 
1618
1578
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1619
1579
                         out_signature="s",
1620
 
                         path_keyword="object_path",
1621
 
                         connection_keyword="connection")
 
1580
                         path_keyword='object_path',
 
1581
                         connection_keyword='connection')
1622
1582
    def Introspect(self, object_path, connection):
1623
1583
        """Overloading of standard D-Bus method.
1624
1584
 
1649
1609
            document.unlink()
1650
1610
        except (AttributeError, xml.dom.DOMException,
1651
1611
                xml.parsers.expat.ExpatError) as error:
1652
 
            log.error("Failed to override Introspection method",
1653
 
                      exc_info=error)
 
1612
            logger.error("Failed to override Introspection method",
 
1613
                         exc_info=error)
1654
1614
        return xmlstring
1655
1615
 
1656
1616
 
2290
2250
class ProxyClient:
2291
2251
    def __init__(self, child_pipe, key_id, fpr, address):
2292
2252
        self._pipe = child_pipe
2293
 
        self._pipe.send(("init", key_id, fpr, address))
 
2253
        self._pipe.send(('init', key_id, fpr, address))
2294
2254
        if not self._pipe.recv():
2295
2255
            raise KeyError(key_id or fpr)
2296
2256
 
2297
2257
    def __getattribute__(self, name):
2298
 
        if name == "_pipe":
 
2258
        if name == '_pipe':
2299
2259
            return super(ProxyClient, self).__getattribute__(name)
2300
 
        self._pipe.send(("getattr", name))
 
2260
        self._pipe.send(('getattr', name))
2301
2261
        data = self._pipe.recv()
2302
 
        if data[0] == "data":
 
2262
        if data[0] == 'data':
2303
2263
            return data[1]
2304
 
        if data[0] == "function":
 
2264
        if data[0] == 'function':
2305
2265
 
2306
2266
            def func(*args, **kwargs):
2307
 
                self._pipe.send(("funcall", name, args, kwargs))
 
2267
                self._pipe.send(('funcall', name, args, kwargs))
2308
2268
                return self._pipe.recv()[1]
2309
2269
 
2310
2270
            return func
2311
2271
 
2312
2272
    def __setattr__(self, name, value):
2313
 
        if name == "_pipe":
 
2273
        if name == '_pipe':
2314
2274
            return super(ProxyClient, self).__setattr__(name, value)
2315
 
        self._pipe.send(("setattr", name, value))
 
2275
        self._pipe.send(('setattr', name, value))
2316
2276
 
2317
2277
 
2318
2278
class ClientHandler(socketserver.BaseRequestHandler, object):
2323
2283
 
2324
2284
    def handle(self):
2325
2285
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2326
 
            log.info("TCP connection from: %s",
2327
 
                     str(self.client_address))
2328
 
            log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
 
2286
            logger.info("TCP connection from: %s",
 
2287
                        str(self.client_address))
 
2288
            logger.debug("Pipe FD: %d",
 
2289
                         self.server.child_pipe.fileno())
2329
2290
 
2330
2291
            session = gnutls.ClientSession(self.request)
2331
2292
 
2332
 
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
 
2293
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
2333
2294
            #                       "+AES-256-CBC", "+SHA1",
2334
2295
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2335
2296
            #                       "+DHE-DSS"))
2337
2298
            priority = self.server.gnutls_priority
2338
2299
            if priority is None:
2339
2300
                priority = "NORMAL"
2340
 
            gnutls.priority_set_direct(session,
2341
 
                                       priority.encode("utf-8"), None)
 
2301
            gnutls.priority_set_direct(session._c_object,
 
2302
                                       priority.encode("utf-8"),
 
2303
                                       None)
2342
2304
 
2343
2305
            # Start communication using the Mandos protocol
2344
2306
            # Get protocol number
2345
2307
            line = self.request.makefile().readline()
2346
 
            log.debug("Protocol version: %r", line)
 
2308
            logger.debug("Protocol version: %r", line)
2347
2309
            try:
2348
2310
                if int(line.strip().split()[0]) > 1:
2349
2311
                    raise RuntimeError(line)
2350
2312
            except (ValueError, IndexError, RuntimeError) as error:
2351
 
                log.error("Unknown protocol version: %s", error)
 
2313
                logger.error("Unknown protocol version: %s", error)
2352
2314
                return
2353
2315
 
2354
2316
            # Start GnuTLS connection
2355
2317
            try:
2356
2318
                session.handshake()
2357
2319
            except gnutls.Error as error:
2358
 
                log.warning("Handshake failed: %s", error)
 
2320
                logger.warning("Handshake failed: %s", error)
2359
2321
                # Do not run session.bye() here: the session is not
2360
2322
                # established.  Just abandon the request.
2361
2323
                return
2362
 
            log.debug("Handshake succeeded")
 
2324
            logger.debug("Handshake succeeded")
2363
2325
 
2364
2326
            approval_required = False
2365
2327
            try:
2369
2331
                        key_id = self.key_id(
2370
2332
                            self.peer_certificate(session))
2371
2333
                    except (TypeError, gnutls.Error) as error:
2372
 
                        log.warning("Bad certificate: %s", error)
 
2334
                        logger.warning("Bad certificate: %s", error)
2373
2335
                        return
2374
 
                    log.debug("Key ID: %s",
2375
 
                              key_id.decode("utf-8",
2376
 
                                            errors="replace"))
 
2336
                    logger.debug("Key ID: %s", key_id)
2377
2337
 
2378
2338
                else:
2379
2339
                    key_id = b""
2381
2341
                        fpr = self.fingerprint(
2382
2342
                            self.peer_certificate(session))
2383
2343
                    except (TypeError, gnutls.Error) as error:
2384
 
                        log.warning("Bad certificate: %s", error)
 
2344
                        logger.warning("Bad certificate: %s", error)
2385
2345
                        return
2386
 
                    log.debug("Fingerprint: %s", fpr)
 
2346
                    logger.debug("Fingerprint: %s", fpr)
2387
2347
 
2388
2348
                try:
2389
2349
                    client = ProxyClient(child_pipe, key_id, fpr,
2398
2358
 
2399
2359
                while True:
2400
2360
                    if not client.enabled:
2401
 
                        log.info("Client %s is disabled", client.name)
 
2361
                        logger.info("Client %s is disabled",
 
2362
                                    client.name)
2402
2363
                        if self.server.use_dbus:
2403
2364
                            # Emit D-Bus signal
2404
2365
                            client.Rejected("Disabled")
2408
2369
                        # We are approved or approval is disabled
2409
2370
                        break
2410
2371
                    elif client.approved is None:
2411
 
                        log.info("Client %s needs approval",
2412
 
                                 client.name)
 
2372
                        logger.info("Client %s needs approval",
 
2373
                                    client.name)
2413
2374
                        if self.server.use_dbus:
2414
2375
                            # Emit D-Bus signal
2415
2376
                            client.NeedApproval(
2416
2377
                                client.approval_delay.total_seconds()
2417
2378
                                * 1000, client.approved_by_default)
2418
2379
                    else:
2419
 
                        log.warning("Client %s was not approved",
2420
 
                                    client.name)
 
2380
                        logger.warning("Client %s was not approved",
 
2381
                                       client.name)
2421
2382
                        if self.server.use_dbus:
2422
2383
                            # Emit D-Bus signal
2423
2384
                            client.Rejected("Denied")
2431
2392
                    time2 = datetime.datetime.now()
2432
2393
                    if (time2 - time) >= delay:
2433
2394
                        if not client.approved_by_default:
2434
 
                            log.warning("Client %s timed out while"
2435
 
                                        " waiting for approval",
2436
 
                                        client.name)
 
2395
                            logger.warning("Client %s timed out while"
 
2396
                                           " waiting for approval",
 
2397
                                           client.name)
2437
2398
                            if self.server.use_dbus:
2438
2399
                                # Emit D-Bus signal
2439
2400
                                client.Rejected("Approval timed out")
2446
2407
                try:
2447
2408
                    session.send(client.secret)
2448
2409
                except gnutls.Error as error:
2449
 
                    log.warning("gnutls send failed", exc_info=error)
 
2410
                    logger.warning("gnutls send failed",
 
2411
                                   exc_info=error)
2450
2412
                    return
2451
2413
 
2452
 
                log.info("Sending secret to %s", client.name)
 
2414
                logger.info("Sending secret to %s", client.name)
2453
2415
                # bump the timeout using extended_timeout
2454
2416
                client.bump_timeout(client.extended_timeout)
2455
2417
                if self.server.use_dbus:
2462
2424
                try:
2463
2425
                    session.bye()
2464
2426
                except gnutls.Error as error:
2465
 
                    log.warning("GnuTLS bye failed", exc_info=error)
 
2427
                    logger.warning("GnuTLS bye failed",
 
2428
                                   exc_info=error)
2466
2429
 
2467
2430
    @staticmethod
2468
2431
    def peer_certificate(session):
2469
2432
        "Return the peer's certificate as a bytestring"
2470
2433
        try:
2471
 
            cert_type = gnutls.certificate_type_get2(
2472
 
                session, gnutls.CTYPE_PEERS)
 
2434
            cert_type = gnutls.certificate_type_get2(session._c_object,
 
2435
                                                     gnutls.CTYPE_PEERS)
2473
2436
        except AttributeError:
2474
 
            cert_type = gnutls.certificate_type_get(session)
 
2437
            cert_type = gnutls.certificate_type_get(session._c_object)
2475
2438
        if gnutls.has_rawpk:
2476
2439
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2477
2440
        else:
2478
2441
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2479
2442
        # If not a valid certificate type...
2480
2443
        if cert_type not in valid_cert_types:
2481
 
            log.info("Cert type %r not in %r", cert_type,
2482
 
                     valid_cert_types)
 
2444
            logger.info("Cert type %r not in %r", cert_type,
 
2445
                        valid_cert_types)
2483
2446
            # ...return invalid data
2484
2447
            return b""
2485
2448
        list_size = ctypes.c_uint(1)
2486
2449
        cert_list = (gnutls.certificate_get_peers
2487
 
                     (session, ctypes.byref(list_size)))
 
2450
                     (session._c_object, ctypes.byref(list_size)))
2488
2451
        if not bool(cert_list) and list_size.value != 0:
2489
2452
            raise gnutls.Error("error getting peer certificate")
2490
2453
        if list_size.value == 0:
2604
2567
 
2605
2568
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2606
2569
                     socketserver.TCPServer):
2607
 
    """IPv6-capable TCP server.  Accepts None as address and/or port
 
2570
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2608
2571
 
2609
2572
    Attributes:
2610
2573
        enabled:        Boolean; whether this server is activated yet
2661
2624
            if SO_BINDTODEVICE is None:
2662
2625
                # Fall back to a hard-coded value which seems to be
2663
2626
                # common enough.
2664
 
                log.warning("SO_BINDTODEVICE not found, trying 25")
 
2627
                logger.warning("SO_BINDTODEVICE not found, trying 25")
2665
2628
                SO_BINDTODEVICE = 25
2666
2629
            try:
2667
2630
                self.socket.setsockopt(
2669
2632
                    (self.interface + "\0").encode("utf-8"))
2670
2633
            except socket.error as error:
2671
2634
                if error.errno == errno.EPERM:
2672
 
                    log.error("No permission to bind to interface %s",
2673
 
                              self.interface)
 
2635
                    logger.error("No permission to bind to"
 
2636
                                 " interface %s", self.interface)
2674
2637
                elif error.errno == errno.ENOPROTOOPT:
2675
 
                    log.error("SO_BINDTODEVICE not available; cannot"
2676
 
                              " bind to interface %s", self.interface)
 
2638
                    logger.error("SO_BINDTODEVICE not available;"
 
2639
                                 " cannot bind to interface %s",
 
2640
                                 self.interface)
2677
2641
                elif error.errno == errno.ENODEV:
2678
 
                    log.error("Interface %s does not exist, cannot"
2679
 
                              " bind", self.interface)
 
2642
                    logger.error("Interface %s does not exist,"
 
2643
                                 " cannot bind", self.interface)
2680
2644
                else:
2681
2645
                    raise
2682
2646
        # Only bind(2) the socket if we really need to.
2761
2725
        request = parent_pipe.recv()
2762
2726
        command = request[0]
2763
2727
 
2764
 
        if command == "init":
 
2728
        if command == 'init':
2765
2729
            key_id = request[1].decode("ascii")
2766
2730
            fpr = request[2].decode("ascii")
2767
2731
            address = request[3]
2777
2741
                    client = c
2778
2742
                    break
2779
2743
            else:
2780
 
                log.info("Client not found for key ID: %s, address:"
2781
 
                         " %s", key_id or fpr, address)
 
2744
                logger.info("Client not found for key ID: %s, address"
 
2745
                            ": %s", key_id or fpr, address)
2782
2746
                if self.use_dbus:
2783
2747
                    # Emit D-Bus signal
2784
2748
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2797
2761
            # remove the old hook in favor of the new above hook on
2798
2762
            # same fileno
2799
2763
            return False
2800
 
        if command == "funcall":
 
2764
        if command == 'funcall':
2801
2765
            funcname = request[1]
2802
2766
            args = request[2]
2803
2767
            kwargs = request[3]
2804
2768
 
2805
 
            parent_pipe.send(("data", getattr(client_object,
 
2769
            parent_pipe.send(('data', getattr(client_object,
2806
2770
                                              funcname)(*args,
2807
2771
                                                        **kwargs)))
2808
2772
 
2809
 
        if command == "getattr":
 
2773
        if command == 'getattr':
2810
2774
            attrname = request[1]
2811
2775
            if isinstance(client_object.__getattribute__(attrname),
2812
2776
                          collections.abc.Callable):
2813
 
                parent_pipe.send(("function", ))
 
2777
                parent_pipe.send(('function', ))
2814
2778
            else:
2815
2779
                parent_pipe.send((
2816
 
                    "data", client_object.__getattribute__(attrname)))
 
2780
                    'data', client_object.__getattribute__(attrname)))
2817
2781
 
2818
 
        if command == "setattr":
 
2782
        if command == 'setattr':
2819
2783
            attrname = request[1]
2820
2784
            value = request[2]
2821
2785
            setattr(client_object, attrname, value)
2927
2891
def string_to_delta(interval):
2928
2892
    """Parse a string and return a datetime.timedelta
2929
2893
 
2930
 
    >>> string_to_delta("7d") == datetime.timedelta(7)
2931
 
    True
2932
 
    >>> string_to_delta("60s") == datetime.timedelta(0, 60)
2933
 
    True
2934
 
    >>> string_to_delta("60m") == datetime.timedelta(0, 3600)
2935
 
    True
2936
 
    >>> string_to_delta("24h") == datetime.timedelta(1)
2937
 
    True
2938
 
    >>> string_to_delta("1w") == datetime.timedelta(7)
2939
 
    True
2940
 
    >>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
 
2894
    >>> string_to_delta('7d') == datetime.timedelta(7)
 
2895
    True
 
2896
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
 
2897
    True
 
2898
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
 
2899
    True
 
2900
    >>> string_to_delta('24h') == datetime.timedelta(1)
 
2901
    True
 
2902
    >>> string_to_delta('1w') == datetime.timedelta(7)
 
2903
    True
 
2904
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2941
2905
    True
2942
2906
    """
2943
2907
 
3147
3111
 
3148
3112
    if server_settings["servicename"] != "Mandos":
3149
3113
        syslogger.setFormatter(
3150
 
            logging.Formatter("Mandos ({}) [%(process)d]:"
3151
 
                              " %(levelname)s: %(message)s".format(
 
3114
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
3115
                              ' %(levelname)s: %(message)s'.format(
3152
3116
                                  server_settings["servicename"])))
3153
3117
 
3154
3118
    # Parse config file with clients
3178
3142
        try:
3179
3143
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3180
3144
        except IOError as e:
3181
 
            log.error("Could not open file %r", pidfilename,
3182
 
                      exc_info=e)
 
3145
            logger.error("Could not open file %r", pidfilename,
 
3146
                         exc_info=e)
3183
3147
 
3184
3148
    for name, group in (("_mandos", "_mandos"),
3185
3149
                        ("mandos", "mandos"),
3196
3160
    try:
3197
3161
        os.setgid(gid)
3198
3162
        os.setuid(uid)
3199
 
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
 
3163
        if debug:
 
3164
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3165
                                                             gid))
3200
3166
    except OSError as error:
3201
 
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3202
 
                    os.strerror(error.errno))
 
3167
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3168
                       .format(uid, gid, os.strerror(error.errno)))
3203
3169
        if error.errno != errno.EPERM:
3204
3170
            raise
3205
3171
 
3212
3178
 
3213
3179
        @gnutls.log_func
3214
3180
        def debug_gnutls(level, string):
3215
 
            log.debug("GnuTLS: %s",
3216
 
                      string[:-1].decode("utf-8", errors="replace"))
 
3181
            logger.debug("GnuTLS: %s", string[:-1])
3217
3182
 
3218
3183
        gnutls.global_set_log_function(debug_gnutls)
3219
3184
 
3248
3213
                "se.bsnet.fukt.Mandos", bus,
3249
3214
                do_not_queue=True)
3250
3215
        except dbus.exceptions.DBusException as e:
3251
 
            log.error("Disabling D-Bus:", exc_info=e)
 
3216
            logger.error("Disabling D-Bus:", exc_info=e)
3252
3217
            use_dbus = False
3253
3218
            server_settings["use_dbus"] = False
3254
3219
            tcp_server.use_dbus = False
3339
3304
            os.remove(stored_state_path)
3340
3305
        except IOError as e:
3341
3306
            if e.errno == errno.ENOENT:
3342
 
                log.warning("Could not load persistent state:"
3343
 
                            " %s", os.strerror(e.errno))
 
3307
                logger.warning("Could not load persistent state:"
 
3308
                               " {}".format(os.strerror(e.errno)))
3344
3309
            else:
3345
 
                log.critical("Could not load persistent state:",
3346
 
                             exc_info=e)
 
3310
                logger.critical("Could not load persistent state:",
 
3311
                                exc_info=e)
3347
3312
                raise
3348
3313
        except EOFError as e:
3349
 
            log.warning("Could not load persistent state: EOFError:",
3350
 
                        exc_info=e)
 
3314
            logger.warning("Could not load persistent state: "
 
3315
                           "EOFError:",
 
3316
                           exc_info=e)
3351
3317
 
3352
3318
    with PGPEngine() as pgp:
3353
3319
        for client_name, client in clients_data.items():
3380
3346
            if client["enabled"]:
3381
3347
                if datetime.datetime.utcnow() >= client["expires"]:
3382
3348
                    if not client["last_checked_ok"]:
3383
 
                        log.warning("disabling client %s - Client"
3384
 
                                    " never performed a successful"
3385
 
                                    " checker", client_name)
 
3349
                        logger.warning(
 
3350
                            "disabling client {} - Client never "
 
3351
                            "performed a successful checker".format(
 
3352
                                client_name))
3386
3353
                        client["enabled"] = False
3387
3354
                    elif client["last_checker_status"] != 0:
3388
 
                        log.warning("disabling client %s - Client"
3389
 
                                    " last checker failed with error"
3390
 
                                    " code %s", client_name,
3391
 
                                    client["last_checker_status"])
 
3355
                        logger.warning(
 
3356
                            "disabling client {} - Client last"
 
3357
                            " checker failed with error code"
 
3358
                            " {}".format(
 
3359
                                client_name,
 
3360
                                client["last_checker_status"]))
3392
3361
                        client["enabled"] = False
3393
3362
                    else:
3394
3363
                        client["expires"] = (
3395
3364
                            datetime.datetime.utcnow()
3396
3365
                            + client["timeout"])
3397
 
                        log.debug("Last checker succeeded, keeping %s"
3398
 
                                  " enabled", client_name)
 
3366
                        logger.debug("Last checker succeeded,"
 
3367
                                     " keeping {} enabled".format(
 
3368
                                         client_name))
3399
3369
            try:
3400
3370
                client["secret"] = pgp.decrypt(
3401
3371
                    client["encrypted_secret"],
3402
3372
                    client_settings[client_name]["secret"])
3403
3373
            except PGPError:
3404
3374
                # If decryption fails, we use secret from new settings
3405
 
                log.debug("Failed to decrypt %s old secret",
3406
 
                          client_name)
 
3375
                logger.debug("Failed to decrypt {} old secret".format(
 
3376
                    client_name))
3407
3377
                client["secret"] = (client_settings[client_name]
3408
3378
                                    ["secret"])
3409
3379
 
3423
3393
            server_settings=server_settings)
3424
3394
 
3425
3395
    if not tcp_server.clients:
3426
 
        log.warning("No clients defined")
 
3396
        logger.warning("No clients defined")
3427
3397
 
3428
3398
    if not foreground:
3429
3399
        if pidfile is not None:
3432
3402
                with pidfile:
3433
3403
                    print(pid, file=pidfile)
3434
3404
            except IOError:
3435
 
                log.error("Could not write to file %r with PID %d",
3436
 
                          pidfilename, pid)
 
3405
                logger.error("Could not write to file %r with PID %d",
 
3406
                             pidfilename, pid)
3437
3407
        del pidfile
3438
3408
        del pidfilename
3439
3409
 
3589
3559
 
3590
3560
        try:
3591
3561
            with tempfile.NamedTemporaryFile(
3592
 
                    mode="wb",
 
3562
                    mode='wb',
3593
3563
                    suffix=".pickle",
3594
 
                    prefix="clients-",
 
3564
                    prefix='clients-',
3595
3565
                    dir=os.path.dirname(stored_state_path),
3596
3566
                    delete=False) as stored_state:
3597
3567
                pickle.dump((clients, client_settings), stored_state,
3605
3575
                except NameError:
3606
3576
                    pass
3607
3577
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3608
 
                log.warning("Could not save persistent state: %s",
3609
 
                            os.strerror(e.errno))
 
3578
                logger.warning("Could not save persistent state: {}"
 
3579
                               .format(os.strerror(e.errno)))
3610
3580
            else:
3611
 
                log.warning("Could not save persistent state:",
3612
 
                            exc_info=e)
 
3581
                logger.warning("Could not save persistent state:",
 
3582
                               exc_info=e)
3613
3583
                raise
3614
3584
 
3615
3585
        # Delete all clients, and settings from config
3632
3602
            mandos_dbus_service.client_added_signal(client)
3633
3603
        # Need to initiate checking of clients
3634
3604
        if client.enabled:
3635
 
            client.init_checker(randomize_start=True)
 
3605
            client.init_checker()
3636
3606
 
3637
3607
    tcp_server.enable()
3638
3608
    tcp_server.server_activate()
3641
3611
    if zeroconf:
3642
3612
        service.port = tcp_server.socket.getsockname()[1]
3643
3613
    if use_ipv6:
3644
 
        log.info("Now listening on address %r, port %d, flowinfo %d,"
3645
 
                 " scope_id %d", *tcp_server.socket.getsockname())
 
3614
        logger.info("Now listening on address %r, port %d,"
 
3615
                    " flowinfo %d, scope_id %d",
 
3616
                    *tcp_server.socket.getsockname())
3646
3617
    else:                       # IPv4
3647
 
        log.info("Now listening on address %r, port %d",
3648
 
                 *tcp_server.socket.getsockname())
 
3618
        logger.info("Now listening on address %r, port %d",
 
3619
                    *tcp_server.socket.getsockname())
3649
3620
 
3650
3621
    # service.interface = tcp_server.socket.getsockname()[3]
3651
3622
 
3655
3626
            try:
3656
3627
                service.activate()
3657
3628
            except dbus.exceptions.DBusException as error:
3658
 
                log.critical("D-Bus Exception", exc_info=error)
 
3629
                logger.critical("D-Bus Exception", exc_info=error)
3659
3630
                cleanup()
3660
3631
                sys.exit(1)
3661
3632
            # End of Avahi example code
3666
3637
            lambda *args, **kwargs: (tcp_server.handle_request
3667
3638
                                     (*args[2:], **kwargs) or True))
3668
3639
 
3669
 
        log.debug("Starting main loop")
 
3640
        logger.debug("Starting main loop")
3670
3641
        main_loop.run()
3671
3642
    except AvahiError as error:
3672
 
        log.critical("Avahi Error", exc_info=error)
 
3643
        logger.critical("Avahi Error", exc_info=error)
3673
3644
        cleanup()
3674
3645
        sys.exit(1)
3675
3646
    except KeyboardInterrupt:
3676
3647
        if debug:
3677
3648
            print("", file=sys.stderr)
3678
 
        log.debug("Server received KeyboardInterrupt")
3679
 
    log.debug("Server exiting")
 
3649
        logger.debug("Server received KeyboardInterrupt")
 
3650
    logger.debug("Server exiting")
3680
3651
    # Must run before the D-Bus bus name gets deregistered
3681
3652
    cleanup()
3682
3653
 
3683
3654
 
3684
 
def parse_test_args():
3685
 
    # type: () -> argparse.Namespace
 
3655
def should_only_run_tests():
3686
3656
    parser = argparse.ArgumentParser(add_help=False)
3687
 
    parser.add_argument("--check", action="store_true")
3688
 
    parser.add_argument("--prefix", )
 
3657
    parser.add_argument("--check", action='store_true')
3689
3658
    args, unknown_args = parser.parse_known_args()
3690
 
    if args.check:
3691
 
        # Remove test options from sys.argv
 
3659
    run_tests = args.check
 
3660
    if run_tests:
 
3661
        # Remove --check argument from sys.argv
3692
3662
        sys.argv[1:] = unknown_args
3693
 
    return args
 
3663
    return run_tests
3694
3664
 
3695
3665
# Add all tests from doctest strings
3696
3666
def load_tests(loader, tests, none):
3698
3668
    tests.addTests(doctest.DocTestSuite())
3699
3669
    return tests
3700
3670
 
3701
 
if __name__ == "__main__":
3702
 
    options = parse_test_args()
 
3671
if __name__ == '__main__':
3703
3672
    try:
3704
 
        if options.check:
3705
 
            extra_test_prefix = options.prefix
3706
 
            if extra_test_prefix is not None:
3707
 
                if not (unittest.main(argv=[""], exit=False)
3708
 
                        .result.wasSuccessful()):
3709
 
                    sys.exit(1)
3710
 
                class ExtraTestLoader(unittest.TestLoader):
3711
 
                    testMethodPrefix = extra_test_prefix
3712
 
                # Call using ./scriptname --test [--verbose]
3713
 
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
3714
 
            else:
3715
 
                unittest.main(argv=[""])
 
3673
        if should_only_run_tests():
 
3674
            # Call using ./mandos --check [--verbose]
 
3675
            unittest.main()
3716
3676
        else:
3717
3677
            main()
3718
3678
    finally:
3719
3679
        logging.shutdown()
3720
 
 
3721
 
# Local Variables:
3722
 
# run-tests:
3723
 
# (lambda (&optional extra)
3724
 
#   (if (not (funcall run-tests-in-test-buffer default-directory
3725
 
#             extra))
3726
 
#       (funcall show-test-buffer-in-test-window)
3727
 
#     (funcall remove-test-window)
3728
 
#     (if extra (message "Extra tests run successfully!"))))
3729
 
# run-tests-in-test-buffer:
3730
 
# (lambda (dir &optional extra)
3731
 
#   (with-current-buffer (get-buffer-create "*Test*")
3732
 
#     (setq buffer-read-only nil
3733
 
#           default-directory dir)
3734
 
#     (erase-buffer)
3735
 
#     (compilation-mode))
3736
 
#   (let ((process-result
3737
 
#          (let ((inhibit-read-only t))
3738
 
#            (process-file-shell-command
3739
 
#             (funcall get-command-line extra) nil "*Test*"))))
3740
 
#     (and (numberp process-result)
3741
 
#          (= process-result 0))))
3742
 
# get-command-line:
3743
 
# (lambda (&optional extra)
3744
 
#   (let ((quoted-script
3745
 
#          (shell-quote-argument (funcall get-script-name))))
3746
 
#     (format
3747
 
#      (concat "%s --check" (if extra " --prefix=atest" ""))
3748
 
#      quoted-script)))
3749
 
# get-script-name:
3750
 
# (lambda ()
3751
 
#   (if (fboundp 'file-local-name)
3752
 
#       (file-local-name (buffer-file-name))
3753
 
#     (or (file-remote-p (buffer-file-name) 'localname)
3754
 
#         (buffer-file-name))))
3755
 
# remove-test-window:
3756
 
# (lambda ()
3757
 
#   (let ((test-window (get-buffer-window "*Test*")))
3758
 
#     (if test-window (delete-window test-window))))
3759
 
# show-test-buffer-in-test-window:
3760
 
# (lambda ()
3761
 
#   (when (not (get-buffer-window-list "*Test*"))
3762
 
#     (setq next-error-last-buffer (get-buffer "*Test*"))
3763
 
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3764
 
#            (display-buffer-overriding-action
3765
 
#             `((display-buffer-in-side-window) (side . ,side)
3766
 
#               (window-height . fit-window-to-buffer)
3767
 
#               (window-width . fit-window-to-buffer))))
3768
 
#       (display-buffer "*Test*"))))
3769
 
# eval:
3770
 
# (progn
3771
 
#   (let* ((run-extra-tests (lambda () (interactive)
3772
 
#                             (funcall run-tests t)))
3773
 
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3774
 
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
3775
 
#     (setq minor-mode-overriding-map-alist
3776
 
#           (cons `(run-tests . ,outer-keymap)
3777
 
#                 minor-mode-overriding-map-alist)))
3778
 
#   (add-hook 'after-save-hook run-tests 90 t))
3779
 
# End: