/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at recompile
  • Date: 2020-11-29 22:54:26 UTC
  • mto: This revision was merged to the branch mainline in revision 402.
  • Revision ID: teddy@recompile.se-20201129225426-6ud4hwj36zo67igi
Fix flaky test in password-agent

The test_send_password_to_socket_EMSGSIZE function should not use a
hard-coded constant to trigger an EMSGSIZE error from send().

* dracut-module/password-agent.c (send_password_to_socket): Only save
  errno from send() if it returned < 0.  Show strerror(errno) if
  send() does return EMSGSIZE.  Show number of bytes sent if send()
  sends less than all bytes.
  (test_send_password_to_socket_EMSGSIZE): Do not skip this test on
  non-AMD64 platforms.  Try to find a suitable message size to trigger
  EMSGSIZE before testing send_password_to_socket(), and only skip
  this test if such a triggering message size is not found.

Reported-By: Simon McVittie <smcv@debian.org>
Closes: #975457

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.16"
 
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
961
940
            # key_id() and fingerprint() functions
962
941
            client["key_id"] = (section.get("key_id", "").upper()
963
942
                                .replace(" ", ""))
964
 
            client["fingerprint"] = (section.get("fingerprint",
965
 
                                                 "").upper()
 
943
            client["fingerprint"] = (section["fingerprint"].upper()
966
944
                                     .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
945
            if "secret" in section:
973
946
                client["secret"] = codecs.decode(section["secret"]
974
947
                                                 .encode("utf-8"),
1015
988
            self.last_enabled = None
1016
989
            self.expires = None
1017
990
 
1018
 
        log.debug("Creating client %r", self.name)
1019
 
        log.debug("  Key ID: %s", self.key_id)
1020
 
        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)
1021
994
        self.created = settings.get("created",
1022
995
                                    datetime.datetime.utcnow())
1023
996
 
1051
1024
        if getattr(self, "enabled", False):
1052
1025
            # Already enabled
1053
1026
            return
 
1027
        self.expires = datetime.datetime.utcnow() + self.timeout
1054
1028
        self.enabled = True
1055
1029
        self.last_enabled = datetime.datetime.utcnow()
1056
1030
        self.init_checker()
1061
1035
        if not getattr(self, "enabled", False):
1062
1036
            return False
1063
1037
        if not quiet:
1064
 
            log.info("Disabling client %s", self.name)
 
1038
            logger.info("Disabling client %s", self.name)
1065
1039
        if getattr(self, "disable_initiator_tag", None) is not None:
1066
1040
            GLib.source_remove(self.disable_initiator_tag)
1067
1041
            self.disable_initiator_tag = None
1079
1053
    def __del__(self):
1080
1054
        self.disable()
1081
1055
 
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.
 
1056
    def init_checker(self):
 
1057
        # Schedule a new checker to be started an 'interval' from now,
 
1058
        # and every interval from then on.
1087
1059
        if self.checker_initiator_tag is not None:
1088
1060
            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
1061
        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
 
1062
            random.randrange(int(self.interval.total_seconds() * 1000
 
1063
                                 + 1)),
 
1064
            self.start_checker)
 
1065
        # Schedule a disable() when 'timeout' has passed
1106
1066
        if self.disable_initiator_tag is not None:
1107
1067
            GLib.source_remove(self.disable_initiator_tag)
1108
1068
        self.disable_initiator_tag = GLib.timeout_add(
1109
 
            int((self.expires - now).total_seconds() * 1000),
1110
 
            self.disable)
 
1069
            int(self.timeout.total_seconds() * 1000), self.disable)
 
1070
        # Also start a new checker *right now*.
 
1071
        self.start_checker()
1111
1072
 
1112
1073
    def checker_callback(self, source, condition, connection,
1113
1074
                         command):
1124
1085
            self.last_checker_status = returncode
1125
1086
            self.last_checker_signal = None
1126
1087
            if self.last_checker_status == 0:
1127
 
                log.info("Checker for %(name)s succeeded", vars(self))
 
1088
                logger.info("Checker for %(name)s succeeded",
 
1089
                            vars(self))
1128
1090
                self.checked_ok()
1129
1091
            else:
1130
 
                log.info("Checker for %(name)s failed", vars(self))
 
1092
                logger.info("Checker for %(name)s failed", vars(self))
1131
1093
        else:
1132
1094
            self.last_checker_status = -1
1133
1095
            self.last_checker_signal = -returncode
1134
 
            log.warning("Checker for %(name)s crashed?", vars(self))
 
1096
            logger.warning("Checker for %(name)s crashed?",
 
1097
                           vars(self))
1135
1098
        return False
1136
1099
 
1137
1100
    def checked_ok(self):
1156
1119
    def need_approval(self):
1157
1120
        self.last_approval_request = datetime.datetime.utcnow()
1158
1121
 
1159
 
    def start_checker(self, start_was_randomized=False):
 
1122
    def start_checker(self):
1160
1123
        """Start a new checker subprocess if one is not running.
1161
1124
 
1162
1125
        If a checker already exists, leave it running and do
1171
1134
        # should be.
1172
1135
 
1173
1136
        if self.checker is not None and not self.checker.is_alive():
1174
 
            log.warning("Checker was not alive; joining")
 
1137
            logger.warning("Checker was not alive; joining")
1175
1138
            self.checker.join()
1176
1139
            self.checker = None
1177
1140
        # Start a new checker if needed
1183
1146
            try:
1184
1147
                command = self.checker_command % escaped_attrs
1185
1148
            except TypeError as error:
1186
 
                log.error('Could not format string "%s"',
1187
 
                          self.checker_command, exc_info=error)
 
1149
                logger.error('Could not format string "%s"',
 
1150
                             self.checker_command,
 
1151
                             exc_info=error)
1188
1152
                return True     # Try again later
1189
1153
            self.current_checker_command = command
1190
 
            log.info("Starting checker %r for %s", command, self.name)
 
1154
            logger.info("Starting checker %r for %s", command,
 
1155
                        self.name)
1191
1156
            # We don't need to redirect stdout and stderr, since
1192
1157
            # in normal mode, that is already done by daemon(),
1193
1158
            # and in debug mode we don't want to.  (Stdin is
1212
1177
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1213
1178
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1214
1179
                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
1180
        # Re-run this periodically if run by GLib.timeout_add
1227
1181
        return True
1228
1182
 
1233
1187
            self.checker_callback_tag = None
1234
1188
        if getattr(self, "checker", None) is None:
1235
1189
            return
1236
 
        log.debug("Stopping checker for %(name)s", vars(self))
 
1190
        logger.debug("Stopping checker for %(name)s", vars(self))
1237
1191
        self.checker.terminate()
1238
1192
        self.checker = None
1239
1193
 
1266
1220
        func._dbus_name = func.__name__
1267
1221
        if func._dbus_name.endswith("_dbus_property"):
1268
1222
            func._dbus_name = func._dbus_name[:-14]
1269
 
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
 
1223
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1270
1224
        return func
1271
1225
 
1272
1226
    return decorator
1361
1315
 
1362
1316
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1363
1317
                         out_signature="s",
1364
 
                         path_keyword="object_path",
1365
 
                         connection_keyword="connection")
 
1318
                         path_keyword='object_path',
 
1319
                         connection_keyword='connection')
1366
1320
    def Introspect(self, object_path, connection):
1367
1321
        """Overloading of standard D-Bus method.
1368
1322
 
1417
1371
            document.unlink()
1418
1372
        except (AttributeError, xml.dom.DOMException,
1419
1373
                xml.parsers.expat.ExpatError) as error:
1420
 
            log.error("Failed to override Introspection method",
1421
 
                      exc_info=error)
 
1374
            logger.error("Failed to override Introspection method",
 
1375
                         exc_info=error)
1422
1376
        return xmlstring
1423
1377
 
1424
1378
 
1521
1475
 
1522
1476
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1523
1477
                         out_signature="s",
1524
 
                         path_keyword="object_path",
1525
 
                         connection_keyword="connection")
 
1478
                         path_keyword='object_path',
 
1479
                         connection_keyword='connection')
1526
1480
    def Introspect(self, object_path, connection):
1527
1481
        """Overloading of standard D-Bus method.
1528
1482
 
1584
1538
            document.unlink()
1585
1539
        except (AttributeError, xml.dom.DOMException,
1586
1540
                xml.parsers.expat.ExpatError) as error:
1587
 
            log.error("Failed to override Introspection method",
1588
 
                      exc_info=error)
 
1541
            logger.error("Failed to override Introspection method",
 
1542
                         exc_info=error)
1589
1543
        return xmlstring
1590
1544
 
1591
1545
 
1623
1577
 
1624
1578
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1625
1579
                         out_signature="s",
1626
 
                         path_keyword="object_path",
1627
 
                         connection_keyword="connection")
 
1580
                         path_keyword='object_path',
 
1581
                         connection_keyword='connection')
1628
1582
    def Introspect(self, object_path, connection):
1629
1583
        """Overloading of standard D-Bus method.
1630
1584
 
1655
1609
            document.unlink()
1656
1610
        except (AttributeError, xml.dom.DOMException,
1657
1611
                xml.parsers.expat.ExpatError) as error:
1658
 
            log.error("Failed to override Introspection method",
1659
 
                      exc_info=error)
 
1612
            logger.error("Failed to override Introspection method",
 
1613
                         exc_info=error)
1660
1614
        return xmlstring
1661
1615
 
1662
1616
 
2296
2250
class ProxyClient:
2297
2251
    def __init__(self, child_pipe, key_id, fpr, address):
2298
2252
        self._pipe = child_pipe
2299
 
        self._pipe.send(("init", key_id, fpr, address))
 
2253
        self._pipe.send(('init', key_id, fpr, address))
2300
2254
        if not self._pipe.recv():
2301
2255
            raise KeyError(key_id or fpr)
2302
2256
 
2303
2257
    def __getattribute__(self, name):
2304
 
        if name == "_pipe":
 
2258
        if name == '_pipe':
2305
2259
            return super(ProxyClient, self).__getattribute__(name)
2306
 
        self._pipe.send(("getattr", name))
 
2260
        self._pipe.send(('getattr', name))
2307
2261
        data = self._pipe.recv()
2308
 
        if data[0] == "data":
 
2262
        if data[0] == 'data':
2309
2263
            return data[1]
2310
 
        if data[0] == "function":
 
2264
        if data[0] == 'function':
2311
2265
 
2312
2266
            def func(*args, **kwargs):
2313
 
                self._pipe.send(("funcall", name, args, kwargs))
 
2267
                self._pipe.send(('funcall', name, args, kwargs))
2314
2268
                return self._pipe.recv()[1]
2315
2269
 
2316
2270
            return func
2317
2271
 
2318
2272
    def __setattr__(self, name, value):
2319
 
        if name == "_pipe":
 
2273
        if name == '_pipe':
2320
2274
            return super(ProxyClient, self).__setattr__(name, value)
2321
 
        self._pipe.send(("setattr", name, value))
 
2275
        self._pipe.send(('setattr', name, value))
2322
2276
 
2323
2277
 
2324
2278
class ClientHandler(socketserver.BaseRequestHandler, object):
2329
2283
 
2330
2284
    def handle(self):
2331
2285
        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())
 
2286
            logger.info("TCP connection from: %s",
 
2287
                        str(self.client_address))
 
2288
            logger.debug("Pipe FD: %d",
 
2289
                         self.server.child_pipe.fileno())
2335
2290
 
2336
2291
            session = gnutls.ClientSession(self.request)
2337
2292
 
2338
 
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
 
2293
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
2339
2294
            #                       "+AES-256-CBC", "+SHA1",
2340
2295
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2341
2296
            #                       "+DHE-DSS"))
2343
2298
            priority = self.server.gnutls_priority
2344
2299
            if priority is None:
2345
2300
                priority = "NORMAL"
2346
 
            gnutls.priority_set_direct(session,
2347
 
                                       priority.encode("utf-8"), None)
 
2301
            gnutls.priority_set_direct(session._c_object,
 
2302
                                       priority.encode("utf-8"),
 
2303
                                       None)
2348
2304
 
2349
2305
            # Start communication using the Mandos protocol
2350
2306
            # Get protocol number
2351
2307
            line = self.request.makefile().readline()
2352
 
            log.debug("Protocol version: %r", line)
 
2308
            logger.debug("Protocol version: %r", line)
2353
2309
            try:
2354
2310
                if int(line.strip().split()[0]) > 1:
2355
2311
                    raise RuntimeError(line)
2356
2312
            except (ValueError, IndexError, RuntimeError) as error:
2357
 
                log.error("Unknown protocol version: %s", error)
 
2313
                logger.error("Unknown protocol version: %s", error)
2358
2314
                return
2359
2315
 
2360
2316
            # Start GnuTLS connection
2361
2317
            try:
2362
2318
                session.handshake()
2363
2319
            except gnutls.Error as error:
2364
 
                log.warning("Handshake failed: %s", error)
 
2320
                logger.warning("Handshake failed: %s", error)
2365
2321
                # Do not run session.bye() here: the session is not
2366
2322
                # established.  Just abandon the request.
2367
2323
                return
2368
 
            log.debug("Handshake succeeded")
 
2324
            logger.debug("Handshake succeeded")
2369
2325
 
2370
2326
            approval_required = False
2371
2327
            try:
2375
2331
                        key_id = self.key_id(
2376
2332
                            self.peer_certificate(session))
2377
2333
                    except (TypeError, gnutls.Error) as error:
2378
 
                        log.warning("Bad certificate: %s", error)
 
2334
                        logger.warning("Bad certificate: %s", error)
2379
2335
                        return
2380
 
                    log.debug("Key ID: %s",
2381
 
                              key_id.decode("utf-8",
2382
 
                                            errors="replace"))
 
2336
                    logger.debug("Key ID: %s", key_id)
2383
2337
 
2384
2338
                else:
2385
2339
                    key_id = b""
2387
2341
                        fpr = self.fingerprint(
2388
2342
                            self.peer_certificate(session))
2389
2343
                    except (TypeError, gnutls.Error) as error:
2390
 
                        log.warning("Bad certificate: %s", error)
 
2344
                        logger.warning("Bad certificate: %s", error)
2391
2345
                        return
2392
 
                    log.debug("Fingerprint: %s", fpr)
 
2346
                    logger.debug("Fingerprint: %s", fpr)
2393
2347
 
2394
2348
                try:
2395
2349
                    client = ProxyClient(child_pipe, key_id, fpr,
2404
2358
 
2405
2359
                while True:
2406
2360
                    if not client.enabled:
2407
 
                        log.info("Client %s is disabled", client.name)
 
2361
                        logger.info("Client %s is disabled",
 
2362
                                    client.name)
2408
2363
                        if self.server.use_dbus:
2409
2364
                            # Emit D-Bus signal
2410
2365
                            client.Rejected("Disabled")
2414
2369
                        # We are approved or approval is disabled
2415
2370
                        break
2416
2371
                    elif client.approved is None:
2417
 
                        log.info("Client %s needs approval",
2418
 
                                 client.name)
 
2372
                        logger.info("Client %s needs approval",
 
2373
                                    client.name)
2419
2374
                        if self.server.use_dbus:
2420
2375
                            # Emit D-Bus signal
2421
2376
                            client.NeedApproval(
2422
2377
                                client.approval_delay.total_seconds()
2423
2378
                                * 1000, client.approved_by_default)
2424
2379
                    else:
2425
 
                        log.warning("Client %s was not approved",
2426
 
                                    client.name)
 
2380
                        logger.warning("Client %s was not approved",
 
2381
                                       client.name)
2427
2382
                        if self.server.use_dbus:
2428
2383
                            # Emit D-Bus signal
2429
2384
                            client.Rejected("Denied")
2437
2392
                    time2 = datetime.datetime.now()
2438
2393
                    if (time2 - time) >= delay:
2439
2394
                        if not client.approved_by_default:
2440
 
                            log.warning("Client %s timed out while"
2441
 
                                        " waiting for approval",
2442
 
                                        client.name)
 
2395
                            logger.warning("Client %s timed out while"
 
2396
                                           " waiting for approval",
 
2397
                                           client.name)
2443
2398
                            if self.server.use_dbus:
2444
2399
                                # Emit D-Bus signal
2445
2400
                                client.Rejected("Approval timed out")
2452
2407
                try:
2453
2408
                    session.send(client.secret)
2454
2409
                except gnutls.Error as error:
2455
 
                    log.warning("gnutls send failed", exc_info=error)
 
2410
                    logger.warning("gnutls send failed",
 
2411
                                   exc_info=error)
2456
2412
                    return
2457
2413
 
2458
 
                log.info("Sending secret to %s", client.name)
 
2414
                logger.info("Sending secret to %s", client.name)
2459
2415
                # bump the timeout using extended_timeout
2460
2416
                client.bump_timeout(client.extended_timeout)
2461
2417
                if self.server.use_dbus:
2468
2424
                try:
2469
2425
                    session.bye()
2470
2426
                except gnutls.Error as error:
2471
 
                    log.warning("GnuTLS bye failed", exc_info=error)
 
2427
                    logger.warning("GnuTLS bye failed",
 
2428
                                   exc_info=error)
2472
2429
 
2473
2430
    @staticmethod
2474
2431
    def peer_certificate(session):
2475
2432
        "Return the peer's certificate as a bytestring"
2476
2433
        try:
2477
 
            cert_type = gnutls.certificate_type_get2(
2478
 
                session, gnutls.CTYPE_PEERS)
 
2434
            cert_type = gnutls.certificate_type_get2(session._c_object,
 
2435
                                                     gnutls.CTYPE_PEERS)
2479
2436
        except AttributeError:
2480
 
            cert_type = gnutls.certificate_type_get(session)
 
2437
            cert_type = gnutls.certificate_type_get(session._c_object)
2481
2438
        if gnutls.has_rawpk:
2482
2439
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2483
2440
        else:
2484
2441
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2485
2442
        # If not a valid certificate type...
2486
2443
        if cert_type not in valid_cert_types:
2487
 
            log.info("Cert type %r not in %r", cert_type,
2488
 
                     valid_cert_types)
 
2444
            logger.info("Cert type %r not in %r", cert_type,
 
2445
                        valid_cert_types)
2489
2446
            # ...return invalid data
2490
2447
            return b""
2491
2448
        list_size = ctypes.c_uint(1)
2492
2449
        cert_list = (gnutls.certificate_get_peers
2493
 
                     (session, ctypes.byref(list_size)))
 
2450
                     (session._c_object, ctypes.byref(list_size)))
2494
2451
        if not bool(cert_list) and list_size.value != 0:
2495
2452
            raise gnutls.Error("error getting peer certificate")
2496
2453
        if list_size.value == 0:
2610
2567
 
2611
2568
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2612
2569
                     socketserver.TCPServer):
2613
 
    """IPv6-capable TCP server.  Accepts None as address and/or port
 
2570
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2614
2571
 
2615
2572
    Attributes:
2616
2573
        enabled:        Boolean; whether this server is activated yet
2667
2624
            if SO_BINDTODEVICE is None:
2668
2625
                # Fall back to a hard-coded value which seems to be
2669
2626
                # common enough.
2670
 
                log.warning("SO_BINDTODEVICE not found, trying 25")
 
2627
                logger.warning("SO_BINDTODEVICE not found, trying 25")
2671
2628
                SO_BINDTODEVICE = 25
2672
2629
            try:
2673
2630
                self.socket.setsockopt(
2675
2632
                    (self.interface + "\0").encode("utf-8"))
2676
2633
            except socket.error as error:
2677
2634
                if error.errno == errno.EPERM:
2678
 
                    log.error("No permission to bind to interface %s",
2679
 
                              self.interface)
 
2635
                    logger.error("No permission to bind to"
 
2636
                                 " interface %s", self.interface)
2680
2637
                elif error.errno == errno.ENOPROTOOPT:
2681
 
                    log.error("SO_BINDTODEVICE not available; cannot"
2682
 
                              " bind to interface %s", self.interface)
 
2638
                    logger.error("SO_BINDTODEVICE not available;"
 
2639
                                 " cannot bind to interface %s",
 
2640
                                 self.interface)
2683
2641
                elif error.errno == errno.ENODEV:
2684
 
                    log.error("Interface %s does not exist, cannot"
2685
 
                              " bind", self.interface)
 
2642
                    logger.error("Interface %s does not exist,"
 
2643
                                 " cannot bind", self.interface)
2686
2644
                else:
2687
2645
                    raise
2688
2646
        # Only bind(2) the socket if we really need to.
2767
2725
        request = parent_pipe.recv()
2768
2726
        command = request[0]
2769
2727
 
2770
 
        if command == "init":
 
2728
        if command == 'init':
2771
2729
            key_id = request[1].decode("ascii")
2772
2730
            fpr = request[2].decode("ascii")
2773
2731
            address = request[3]
2783
2741
                    client = c
2784
2742
                    break
2785
2743
            else:
2786
 
                log.info("Client not found for key ID: %s, address:"
2787
 
                         " %s", key_id or fpr, address)
 
2744
                logger.info("Client not found for key ID: %s, address"
 
2745
                            ": %s", key_id or fpr, address)
2788
2746
                if self.use_dbus:
2789
2747
                    # Emit D-Bus signal
2790
2748
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2803
2761
            # remove the old hook in favor of the new above hook on
2804
2762
            # same fileno
2805
2763
            return False
2806
 
        if command == "funcall":
 
2764
        if command == 'funcall':
2807
2765
            funcname = request[1]
2808
2766
            args = request[2]
2809
2767
            kwargs = request[3]
2810
2768
 
2811
 
            parent_pipe.send(("data", getattr(client_object,
 
2769
            parent_pipe.send(('data', getattr(client_object,
2812
2770
                                              funcname)(*args,
2813
2771
                                                        **kwargs)))
2814
2772
 
2815
 
        if command == "getattr":
 
2773
        if command == 'getattr':
2816
2774
            attrname = request[1]
2817
2775
            if isinstance(client_object.__getattribute__(attrname),
2818
2776
                          collections.abc.Callable):
2819
 
                parent_pipe.send(("function", ))
 
2777
                parent_pipe.send(('function', ))
2820
2778
            else:
2821
2779
                parent_pipe.send((
2822
 
                    "data", client_object.__getattribute__(attrname)))
 
2780
                    'data', client_object.__getattribute__(attrname)))
2823
2781
 
2824
 
        if command == "setattr":
 
2782
        if command == 'setattr':
2825
2783
            attrname = request[1]
2826
2784
            value = request[2]
2827
2785
            setattr(client_object, attrname, value)
2933
2891
def string_to_delta(interval):
2934
2892
    """Parse a string and return a datetime.timedelta
2935
2893
 
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)
 
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)
2947
2905
    True
2948
2906
    """
2949
2907
 
3153
3111
 
3154
3112
    if server_settings["servicename"] != "Mandos":
3155
3113
        syslogger.setFormatter(
3156
 
            logging.Formatter("Mandos ({}) [%(process)d]:"
3157
 
                              " %(levelname)s: %(message)s".format(
 
3114
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
3115
                              ' %(levelname)s: %(message)s'.format(
3158
3116
                                  server_settings["servicename"])))
3159
3117
 
3160
3118
    # Parse config file with clients
3184
3142
        try:
3185
3143
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3186
3144
        except IOError as e:
3187
 
            log.error("Could not open file %r", pidfilename,
3188
 
                      exc_info=e)
 
3145
            logger.error("Could not open file %r", pidfilename,
 
3146
                         exc_info=e)
3189
3147
 
3190
3148
    for name, group in (("_mandos", "_mandos"),
3191
3149
                        ("mandos", "mandos"),
3202
3160
    try:
3203
3161
        os.setgid(gid)
3204
3162
        os.setuid(uid)
3205
 
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
 
3163
        if debug:
 
3164
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3165
                                                             gid))
3206
3166
    except OSError as error:
3207
 
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3208
 
                    os.strerror(error.errno))
 
3167
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3168
                       .format(uid, gid, os.strerror(error.errno)))
3209
3169
        if error.errno != errno.EPERM:
3210
3170
            raise
3211
3171
 
3218
3178
 
3219
3179
        @gnutls.log_func
3220
3180
        def debug_gnutls(level, string):
3221
 
            log.debug("GnuTLS: %s",
3222
 
                      string[:-1].decode("utf-8", errors="replace"))
 
3181
            logger.debug("GnuTLS: %s", string[:-1])
3223
3182
 
3224
3183
        gnutls.global_set_log_function(debug_gnutls)
3225
3184
 
3254
3213
                "se.bsnet.fukt.Mandos", bus,
3255
3214
                do_not_queue=True)
3256
3215
        except dbus.exceptions.DBusException as e:
3257
 
            log.error("Disabling D-Bus:", exc_info=e)
 
3216
            logger.error("Disabling D-Bus:", exc_info=e)
3258
3217
            use_dbus = False
3259
3218
            server_settings["use_dbus"] = False
3260
3219
            tcp_server.use_dbus = False
3345
3304
            os.remove(stored_state_path)
3346
3305
        except IOError as e:
3347
3306
            if e.errno == errno.ENOENT:
3348
 
                log.warning("Could not load persistent state:"
3349
 
                            " %s", os.strerror(e.errno))
 
3307
                logger.warning("Could not load persistent state:"
 
3308
                               " {}".format(os.strerror(e.errno)))
3350
3309
            else:
3351
 
                log.critical("Could not load persistent state:",
3352
 
                             exc_info=e)
 
3310
                logger.critical("Could not load persistent state:",
 
3311
                                exc_info=e)
3353
3312
                raise
3354
3313
        except EOFError as e:
3355
 
            log.warning("Could not load persistent state: EOFError:",
3356
 
                        exc_info=e)
 
3314
            logger.warning("Could not load persistent state: "
 
3315
                           "EOFError:",
 
3316
                           exc_info=e)
3357
3317
 
3358
3318
    with PGPEngine() as pgp:
3359
3319
        for client_name, client in clients_data.items():
3386
3346
            if client["enabled"]:
3387
3347
                if datetime.datetime.utcnow() >= client["expires"]:
3388
3348
                    if not client["last_checked_ok"]:
3389
 
                        log.warning("disabling client %s - Client"
3390
 
                                    " never performed a successful"
3391
 
                                    " checker", client_name)
 
3349
                        logger.warning(
 
3350
                            "disabling client {} - Client never "
 
3351
                            "performed a successful checker".format(
 
3352
                                client_name))
3392
3353
                        client["enabled"] = False
3393
3354
                    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"])
 
3355
                        logger.warning(
 
3356
                            "disabling client {} - Client last"
 
3357
                            " checker failed with error code"
 
3358
                            " {}".format(
 
3359
                                client_name,
 
3360
                                client["last_checker_status"]))
3398
3361
                        client["enabled"] = False
3399
3362
                    else:
3400
3363
                        client["expires"] = (
3401
3364
                            datetime.datetime.utcnow()
3402
3365
                            + client["timeout"])
3403
 
                        log.debug("Last checker succeeded, keeping %s"
3404
 
                                  " enabled", client_name)
 
3366
                        logger.debug("Last checker succeeded,"
 
3367
                                     " keeping {} enabled".format(
 
3368
                                         client_name))
3405
3369
            try:
3406
3370
                client["secret"] = pgp.decrypt(
3407
3371
                    client["encrypted_secret"],
3408
3372
                    client_settings[client_name]["secret"])
3409
3373
            except PGPError:
3410
3374
                # If decryption fails, we use secret from new settings
3411
 
                log.debug("Failed to decrypt %s old secret",
3412
 
                          client_name)
 
3375
                logger.debug("Failed to decrypt {} old secret".format(
 
3376
                    client_name))
3413
3377
                client["secret"] = (client_settings[client_name]
3414
3378
                                    ["secret"])
3415
3379
 
3429
3393
            server_settings=server_settings)
3430
3394
 
3431
3395
    if not tcp_server.clients:
3432
 
        log.warning("No clients defined")
 
3396
        logger.warning("No clients defined")
3433
3397
 
3434
3398
    if not foreground:
3435
3399
        if pidfile is not None:
3438
3402
                with pidfile:
3439
3403
                    print(pid, file=pidfile)
3440
3404
            except IOError:
3441
 
                log.error("Could not write to file %r with PID %d",
3442
 
                          pidfilename, pid)
 
3405
                logger.error("Could not write to file %r with PID %d",
 
3406
                             pidfilename, pid)
3443
3407
        del pidfile
3444
3408
        del pidfilename
3445
3409
 
3595
3559
 
3596
3560
        try:
3597
3561
            with tempfile.NamedTemporaryFile(
3598
 
                    mode="wb",
 
3562
                    mode='wb',
3599
3563
                    suffix=".pickle",
3600
 
                    prefix="clients-",
 
3564
                    prefix='clients-',
3601
3565
                    dir=os.path.dirname(stored_state_path),
3602
3566
                    delete=False) as stored_state:
3603
3567
                pickle.dump((clients, client_settings), stored_state,
3611
3575
                except NameError:
3612
3576
                    pass
3613
3577
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3614
 
                log.warning("Could not save persistent state: %s",
3615
 
                            os.strerror(e.errno))
 
3578
                logger.warning("Could not save persistent state: {}"
 
3579
                               .format(os.strerror(e.errno)))
3616
3580
            else:
3617
 
                log.warning("Could not save persistent state:",
3618
 
                            exc_info=e)
 
3581
                logger.warning("Could not save persistent state:",
 
3582
                               exc_info=e)
3619
3583
                raise
3620
3584
 
3621
3585
        # Delete all clients, and settings from config
3638
3602
            mandos_dbus_service.client_added_signal(client)
3639
3603
        # Need to initiate checking of clients
3640
3604
        if client.enabled:
3641
 
            client.init_checker(randomize_start=True)
 
3605
            client.init_checker()
3642
3606
 
3643
3607
    tcp_server.enable()
3644
3608
    tcp_server.server_activate()
3647
3611
    if zeroconf:
3648
3612
        service.port = tcp_server.socket.getsockname()[1]
3649
3613
    if use_ipv6:
3650
 
        log.info("Now listening on address %r, port %d, flowinfo %d,"
3651
 
                 " 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())
3652
3617
    else:                       # IPv4
3653
 
        log.info("Now listening on address %r, port %d",
3654
 
                 *tcp_server.socket.getsockname())
 
3618
        logger.info("Now listening on address %r, port %d",
 
3619
                    *tcp_server.socket.getsockname())
3655
3620
 
3656
3621
    # service.interface = tcp_server.socket.getsockname()[3]
3657
3622
 
3661
3626
            try:
3662
3627
                service.activate()
3663
3628
            except dbus.exceptions.DBusException as error:
3664
 
                log.critical("D-Bus Exception", exc_info=error)
 
3629
                logger.critical("D-Bus Exception", exc_info=error)
3665
3630
                cleanup()
3666
3631
                sys.exit(1)
3667
3632
            # End of Avahi example code
3672
3637
            lambda *args, **kwargs: (tcp_server.handle_request
3673
3638
                                     (*args[2:], **kwargs) or True))
3674
3639
 
3675
 
        log.debug("Starting main loop")
 
3640
        logger.debug("Starting main loop")
3676
3641
        main_loop.run()
3677
3642
    except AvahiError as error:
3678
 
        log.critical("Avahi Error", exc_info=error)
 
3643
        logger.critical("Avahi Error", exc_info=error)
3679
3644
        cleanup()
3680
3645
        sys.exit(1)
3681
3646
    except KeyboardInterrupt:
3682
3647
        if debug:
3683
3648
            print("", file=sys.stderr)
3684
 
        log.debug("Server received KeyboardInterrupt")
3685
 
    log.debug("Server exiting")
 
3649
        logger.debug("Server received KeyboardInterrupt")
 
3650
    logger.debug("Server exiting")
3686
3651
    # Must run before the D-Bus bus name gets deregistered
3687
3652
    cleanup()
3688
3653
 
3689
3654
 
3690
 
def parse_test_args():
3691
 
    # type: () -> argparse.Namespace
 
3655
def should_only_run_tests():
3692
3656
    parser = argparse.ArgumentParser(add_help=False)
3693
 
    parser.add_argument("--check", action="store_true")
3694
 
    parser.add_argument("--prefix", )
 
3657
    parser.add_argument("--check", action='store_true')
3695
3658
    args, unknown_args = parser.parse_known_args()
3696
 
    if args.check:
3697
 
        # Remove test options from sys.argv
 
3659
    run_tests = args.check
 
3660
    if run_tests:
 
3661
        # Remove --check argument from sys.argv
3698
3662
        sys.argv[1:] = unknown_args
3699
 
    return args
 
3663
    return run_tests
3700
3664
 
3701
3665
# Add all tests from doctest strings
3702
3666
def load_tests(loader, tests, none):
3704
3668
    tests.addTests(doctest.DocTestSuite())
3705
3669
    return tests
3706
3670
 
3707
 
if __name__ == "__main__":
3708
 
    options = parse_test_args()
 
3671
if __name__ == '__main__':
3709
3672
    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=[""])
 
3673
        if should_only_run_tests():
 
3674
            # Call using ./mandos --check [--verbose]
 
3675
            unittest.main()
3722
3676
        else:
3723
3677
            main()
3724
3678
    finally:
3725
3679
        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: