/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-02-07 20:53:34 UTC
  • mto: This revision was merged to the branch mainline in revision 396.
  • Revision ID: teddy@recompile.se-20200207205334-dp41p8c8vw0ytik5
Allow users to more easily alter mandos.service

The sysvinit script uses /etc/default/mandos as an environment file,
and supports adding additional server options to a DAEMON_ARGS
environment variable.  This should be supported by the systemd
service, too.

* mandos.service ([Service]/EnvironmentFile): New; set to
  "/etc/default/mandos ".
  ([Service]/ExecStart): Append "$DAEMON_ARGS".

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-2019 Teddy Hogeborn
 
15
# Copyright © 2008-2019 Björn Påhlsson
16
16
#
17
17
# This file is part of Mandos.
18
18
#
31
31
#
32
32
# Contact the authors at <mandos@recompile.se>.
33
33
#
 
34
 
34
35
from __future__ import (division, absolute_import, print_function,
35
36
                        unicode_literals)
36
37
 
39
40
except ImportError:
40
41
    pass
41
42
 
42
 
import sys
43
 
import unittest
44
 
import argparse
45
 
import logging
46
 
import os
47
43
try:
48
44
    import SocketServer as socketserver
49
45
except ImportError:
50
46
    import socketserver
51
47
import socket
 
48
import argparse
52
49
import datetime
53
50
import errno
54
51
try:
55
52
    import ConfigParser as configparser
56
53
except ImportError:
57
54
    import configparser
 
55
import sys
58
56
import re
 
57
import os
59
58
import signal
60
59
import subprocess
61
60
import atexit
62
61
import stat
 
62
import logging
63
63
import logging.handlers
64
64
import pwd
65
65
import contextlib
77
77
import itertools
78
78
import collections
79
79
import codecs
 
80
import unittest
80
81
import random
81
 
import shlex
82
82
 
83
83
import dbus
84
84
import dbus.service
93
93
if sys.version_info.major == 2:
94
94
    __metaclass__ = type
95
95
    str = unicode
96
 
    input = raw_input
97
96
 
98
97
# Add collections.abc.Callable if it does not exist
99
98
try:
104
103
    collections.abc = abc
105
104
    del abc
106
105
 
107
 
# Add shlex.quote if it does not exist
108
 
try:
109
 
    shlex.quote
110
 
except AttributeError:
111
 
    shlex.quote = re.escape
112
 
 
113
106
# Show warnings by default
114
107
if not sys.warnoptions:
115
108
    import warnings
143
136
if sys.version_info < (3, 2):
144
137
    configparser.Configparser = configparser.SafeConfigParser
145
138
 
146
 
version = "1.8.17"
 
139
version = "1.8.9"
147
140
stored_state_file = "clients.pickle"
148
141
 
149
 
log = logging.getLogger(os.path.basename(sys.argv[0]))
 
142
logger = logging.getLogger()
150
143
logging.captureWarnings(True)   # Show warnings via the logging system
151
144
syslogger = None
152
145
 
189
182
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
190
183
        address="/dev/log"))
191
184
    syslogger.setFormatter(logging.Formatter
192
 
                           ("Mandos [%(process)d]: %(levelname)s:"
193
 
                            " %(message)s"))
194
 
    log.addHandler(syslogger)
 
185
                           ('Mandos [%(process)d]: %(levelname)s:'
 
186
                            ' %(message)s'))
 
187
    logger.addHandler(syslogger)
195
188
 
196
189
    if debug:
197
190
        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)
 
191
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
192
                                               ' [%(process)d]:'
 
193
                                               ' %(levelname)s:'
 
194
                                               ' %(message)s'))
 
195
        logger.addHandler(console)
 
196
    logger.setLevel(level)
204
197
 
205
198
 
206
199
class PGPError(Exception):
224
217
        except OSError as e:
225
218
            if e.errno != errno.ENOENT:
226
219
                raise
227
 
        self.gnupgargs = ["--batch",
228
 
                          "--homedir", self.tempdir,
229
 
                          "--force-mdc",
230
 
                          "--quiet"]
 
220
        self.gnupgargs = ['--batch',
 
221
                          '--homedir', self.tempdir,
 
222
                          '--force-mdc',
 
223
                          '--quiet']
231
224
        # Only GPG version 1 has the --no-use-agent option.
232
225
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
233
226
            self.gnupgargs.append("--no-use-agent")
272
265
                dir=self.tempdir) as passfile:
273
266
            passfile.write(passphrase)
274
267
            passfile.flush()
275
 
            proc = subprocess.Popen([self.gpg, "--symmetric",
276
 
                                     "--passphrase-file",
 
268
            proc = subprocess.Popen([self.gpg, '--symmetric',
 
269
                                     '--passphrase-file',
277
270
                                     passfile.name]
278
271
                                    + self.gnupgargs,
279
272
                                    stdin=subprocess.PIPE,
290
283
                dir=self.tempdir) as passfile:
291
284
            passfile.write(passphrase)
292
285
            passfile.flush()
293
 
            proc = subprocess.Popen([self.gpg, "--decrypt",
294
 
                                     "--passphrase-file",
 
286
            proc = subprocess.Popen([self.gpg, '--decrypt',
 
287
                                     '--passphrase-file',
295
288
                                     passfile.name]
296
289
                                    + self.gnupgargs,
297
290
                                    stdin=subprocess.PIPE,
350
343
    Attributes:
351
344
    interface: integer; avahi.IF_UNSPEC or an interface index.
352
345
               Used to optionally bind to the specified interface.
353
 
    name: string; Example: "Mandos"
354
 
    type: string; Example: "_mandos._tcp".
 
346
    name: string; Example: 'Mandos'
 
347
    type: string; Example: '_mandos._tcp'.
355
348
     See <https://www.iana.org/assignments/service-names-port-numbers>
356
349
    port: integer; what port to announce
357
350
    TXT: list of strings; TXT record for the service
394
387
    def rename(self, remove=True):
395
388
        """Derived from the Avahi example code"""
396
389
        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)
 
390
            logger.critical("No suitable Zeroconf service name found"
 
391
                            " after %i retries, exiting.",
 
392
                            self.rename_count)
400
393
            raise AvahiServiceError("Too many renames")
401
394
        self.name = str(
402
395
            self.server.GetAlternativeServiceName(self.name))
403
396
        self.rename_count += 1
404
 
        log.info("Changing Zeroconf service name to %r ...",
405
 
                 self.name)
 
397
        logger.info("Changing Zeroconf service name to %r ...",
 
398
                    self.name)
406
399
        if remove:
407
400
            self.remove()
408
401
        try:
410
403
        except dbus.exceptions.DBusException as error:
411
404
            if (error.get_dbus_name()
412
405
                == "org.freedesktop.Avahi.CollisionError"):
413
 
                log.info("Local Zeroconf service name collision.")
 
406
                logger.info("Local Zeroconf service name collision.")
414
407
                return self.rename(remove=False)
415
408
            else:
416
 
                log.critical("D-Bus Exception", exc_info=error)
 
409
                logger.critical("D-Bus Exception", exc_info=error)
417
410
                self.cleanup()
418
411
                os._exit(1)
419
412
 
435
428
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
436
429
        self.entry_group_state_changed_match = (
437
430
            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)
 
431
                'StateChanged', self.entry_group_state_changed))
 
432
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
433
                     self.name, self.type)
441
434
        self.group.AddService(
442
435
            self.interface,
443
436
            self.protocol,
450
443
 
451
444
    def entry_group_state_changed(self, state, error):
452
445
        """Derived from the Avahi example code"""
453
 
        log.debug("Avahi entry group state change: %i", state)
 
446
        logger.debug("Avahi entry group state change: %i", state)
454
447
 
455
448
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
456
 
            log.debug("Zeroconf service established.")
 
449
            logger.debug("Zeroconf service established.")
457
450
        elif state == avahi.ENTRY_GROUP_COLLISION:
458
 
            log.info("Zeroconf service name collision.")
 
451
            logger.info("Zeroconf service name collision.")
459
452
            self.rename()
460
453
        elif state == avahi.ENTRY_GROUP_FAILURE:
461
 
            log.critical("Avahi: Error in group state changed %s",
462
 
                         str(error))
 
454
            logger.critical("Avahi: Error in group state changed %s",
 
455
                            str(error))
463
456
            raise AvahiGroupError("State changed: {!s}".format(error))
464
457
 
465
458
    def cleanup(self):
475
468
 
476
469
    def server_state_changed(self, state, error=None):
477
470
        """Derived from the Avahi example code"""
478
 
        log.debug("Avahi server state change: %i", state)
 
471
        logger.debug("Avahi server state change: %i", state)
479
472
        bad_states = {
480
473
            avahi.SERVER_INVALID: "Zeroconf server invalid",
481
474
            avahi.SERVER_REGISTERING: None,
485
478
        if state in bad_states:
486
479
            if bad_states[state] is not None:
487
480
                if error is None:
488
 
                    log.error(bad_states[state])
 
481
                    logger.error(bad_states[state])
489
482
                else:
490
 
                    log.error(bad_states[state] + ": %r", error)
 
483
                    logger.error(bad_states[state] + ": %r", error)
491
484
            self.cleanup()
492
485
        elif state == avahi.SERVER_RUNNING:
493
486
            try:
495
488
            except dbus.exceptions.DBusException as error:
496
489
                if (error.get_dbus_name()
497
490
                    == "org.freedesktop.Avahi.CollisionError"):
498
 
                    log.info("Local Zeroconf service name collision.")
 
491
                    logger.info("Local Zeroconf service name"
 
492
                                " collision.")
499
493
                    return self.rename(remove=False)
500
494
                else:
501
 
                    log.critical("D-Bus Exception", exc_info=error)
 
495
                    logger.critical("D-Bus Exception", exc_info=error)
502
496
                    self.cleanup()
503
497
                    os._exit(1)
504
498
        else:
505
499
            if error is None:
506
 
                log.debug("Unknown state: %r", state)
 
500
                logger.debug("Unknown state: %r", state)
507
501
            else:
508
 
                log.debug("Unknown state: %r: %r", state, error)
 
502
                logger.debug("Unknown state: %r: %r", state, error)
509
503
 
510
504
    def activate(self):
511
505
        """Derived from the Avahi example code"""
523
517
class AvahiServiceToSyslog(AvahiService):
524
518
    def rename(self, *args, **kwargs):
525
519
        """Add the new name to the syslog messages"""
526
 
        ret = super(AvahiServiceToSyslog, self).rename(*args,
527
 
                                                       **kwargs)
 
520
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
528
521
        syslogger.setFormatter(logging.Formatter(
529
 
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
 
522
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
530
523
            .format(self.name)))
531
524
        return ret
532
525
 
562
555
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
563
556
 
564
557
    # Types
565
 
    class _session_int(ctypes.Structure):
 
558
    class session_int(ctypes.Structure):
566
559
        _fields_ = []
567
 
    session_t = ctypes.POINTER(_session_int)
 
560
    session_t = ctypes.POINTER(session_int)
568
561
 
569
562
    class certificate_credentials_st(ctypes.Structure):
570
563
        _fields_ = []
573
566
    certificate_type_t = ctypes.c_int
574
567
 
575
568
    class datum_t(ctypes.Structure):
576
 
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
577
 
                    ("size", ctypes.c_uint)]
 
569
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
570
                    ('size', ctypes.c_uint)]
578
571
 
579
 
    class _openpgp_crt_int(ctypes.Structure):
 
572
    class openpgp_crt_int(ctypes.Structure):
580
573
        _fields_ = []
581
 
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
 
574
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
582
575
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
583
576
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
584
577
    credentials_type_t = ctypes.c_int
593
586
            # gnutls.strerror()
594
587
            self.code = code
595
588
            if message is None and code is not None:
596
 
                message = gnutls.strerror(code).decode(
597
 
                    "utf-8", errors="replace")
 
589
                message = gnutls.strerror(code)
598
590
            return super(gnutls.Error, self).__init__(
599
591
                message, *args)
600
592
 
601
593
    class CertificateSecurityError(Error):
602
594
        pass
603
595
 
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
596
    # Classes
630
 
    class Credentials(With_from_param):
 
597
    class Credentials:
631
598
        def __init__(self):
632
 
            self._as_parameter_ = gnutls.certificate_credentials_t()
633
 
            gnutls.certificate_allocate_credentials(self)
 
599
            self._c_object = gnutls.certificate_credentials_t()
 
600
            gnutls.certificate_allocate_credentials(
 
601
                ctypes.byref(self._c_object))
634
602
            self.type = gnutls.CRD_CERTIFICATE
635
603
 
636
604
        def __del__(self):
637
 
            gnutls.certificate_free_credentials(self)
 
605
            gnutls.certificate_free_credentials(self._c_object)
638
606
 
639
 
    class ClientSession(With_from_param):
 
607
    class ClientSession:
640
608
        def __init__(self, socket, credentials=None):
641
 
            self._as_parameter_ = gnutls.session_t()
 
609
            self._c_object = gnutls.session_t()
642
610
            gnutls_flags = gnutls.CLIENT
643
611
            if gnutls.check_version(b"3.5.6"):
644
612
                gnutls_flags |= gnutls.NO_TICKETS
645
613
            if gnutls.has_rawpk:
646
614
                gnutls_flags |= gnutls.ENABLE_RAWPK
647
 
            gnutls.init(self, gnutls_flags)
 
615
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
648
616
            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)
 
617
            gnutls.set_default_priority(self._c_object)
 
618
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
619
            gnutls.handshake_set_private_extensions(self._c_object,
 
620
                                                    True)
652
621
            self.socket = socket
653
622
            if credentials is None:
654
623
                credentials = gnutls.Credentials()
655
 
            gnutls.credentials_set(self, credentials.type,
656
 
                                   credentials)
 
624
            gnutls.credentials_set(self._c_object, credentials.type,
 
625
                                   ctypes.cast(credentials._c_object,
 
626
                                               ctypes.c_void_p))
657
627
            self.credentials = credentials
658
628
 
659
629
        def __del__(self):
660
 
            gnutls.deinit(self)
 
630
            gnutls.deinit(self._c_object)
661
631
 
662
632
        def handshake(self):
663
 
            return gnutls.handshake(self)
 
633
            return gnutls.handshake(self._c_object)
664
634
 
665
635
        def send(self, data):
666
636
            data = bytes(data)
667
637
            data_len = len(data)
668
638
            while data_len > 0:
669
 
                data_len -= gnutls.record_send(self, data[-data_len:],
 
639
                data_len -= gnutls.record_send(self._c_object,
 
640
                                               data[-data_len:],
670
641
                                               data_len)
671
642
 
672
643
        def bye(self):
673
 
            return gnutls.bye(self, gnutls.SHUT_RDWR)
 
644
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
674
645
 
675
646
    # Error handling functions
676
647
    def _error_code(result):
677
648
        """A function to raise exceptions on errors, suitable
678
 
        for the "restype" attribute on ctypes functions"""
679
 
        if result >= gnutls.E_SUCCESS:
 
649
        for the 'restype' attribute on ctypes functions"""
 
650
        if result >= 0:
680
651
            return result
681
652
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
682
653
            raise gnutls.CertificateSecurityError(code=result)
683
654
        raise gnutls.Error(code=result)
684
655
 
685
 
    def _retry_on_error(result, func, arguments,
686
 
                        _error_code=_error_code):
 
656
    def _retry_on_error(result, func, arguments):
687
657
        """A function to retry on some errors, suitable
688
 
        for the "errcheck" attribute on ctypes functions"""
689
 
        while result < gnutls.E_SUCCESS:
 
658
        for the 'errcheck' attribute on ctypes functions"""
 
659
        while result < 0:
690
660
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
691
661
                return _error_code(result)
692
662
            result = func(*arguments)
697
667
 
698
668
    # Functions
699
669
    priority_set_direct = _library.gnutls_priority_set_direct
700
 
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
 
670
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
701
671
                                    ctypes.POINTER(ctypes.c_char_p)]
702
672
    priority_set_direct.restype = _error_code
703
673
 
704
674
    init = _library.gnutls_init
705
 
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
 
675
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
706
676
    init.restype = _error_code
707
677
 
708
678
    set_default_priority = _library.gnutls_set_default_priority
709
 
    set_default_priority.argtypes = [ClientSession]
 
679
    set_default_priority.argtypes = [session_t]
710
680
    set_default_priority.restype = _error_code
711
681
 
712
682
    record_send = _library.gnutls_record_send
713
 
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
 
683
    record_send.argtypes = [session_t, ctypes.c_void_p,
714
684
                            ctypes.c_size_t]
715
685
    record_send.restype = ctypes.c_ssize_t
716
686
    record_send.errcheck = _retry_on_error
718
688
    certificate_allocate_credentials = (
719
689
        _library.gnutls_certificate_allocate_credentials)
720
690
    certificate_allocate_credentials.argtypes = [
721
 
        PointerTo(Credentials)]
 
691
        ctypes.POINTER(certificate_credentials_t)]
722
692
    certificate_allocate_credentials.restype = _error_code
723
693
 
724
694
    certificate_free_credentials = (
725
695
        _library.gnutls_certificate_free_credentials)
726
 
    certificate_free_credentials.argtypes = [Credentials]
 
696
    certificate_free_credentials.argtypes = [
 
697
        certificate_credentials_t]
727
698
    certificate_free_credentials.restype = None
728
699
 
729
700
    handshake_set_private_extensions = (
730
701
        _library.gnutls_handshake_set_private_extensions)
731
 
    handshake_set_private_extensions.argtypes = [ClientSession,
 
702
    handshake_set_private_extensions.argtypes = [session_t,
732
703
                                                 ctypes.c_int]
733
704
    handshake_set_private_extensions.restype = None
734
705
 
735
706
    credentials_set = _library.gnutls_credentials_set
736
 
    credentials_set.argtypes = [ClientSession, credentials_type_t,
737
 
                                CastToVoidPointer(Credentials)]
 
707
    credentials_set.argtypes = [session_t, credentials_type_t,
 
708
                                ctypes.c_void_p]
738
709
    credentials_set.restype = _error_code
739
710
 
740
711
    strerror = _library.gnutls_strerror
742
713
    strerror.restype = ctypes.c_char_p
743
714
 
744
715
    certificate_type_get = _library.gnutls_certificate_type_get
745
 
    certificate_type_get.argtypes = [ClientSession]
 
716
    certificate_type_get.argtypes = [session_t]
746
717
    certificate_type_get.restype = _error_code
747
718
 
748
719
    certificate_get_peers = _library.gnutls_certificate_get_peers
749
 
    certificate_get_peers.argtypes = [ClientSession,
 
720
    certificate_get_peers.argtypes = [session_t,
750
721
                                      ctypes.POINTER(ctypes.c_uint)]
751
722
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
752
723
 
759
730
    global_set_log_function.restype = None
760
731
 
761
732
    deinit = _library.gnutls_deinit
762
 
    deinit.argtypes = [ClientSession]
 
733
    deinit.argtypes = [session_t]
763
734
    deinit.restype = None
764
735
 
765
736
    handshake = _library.gnutls_handshake
766
 
    handshake.argtypes = [ClientSession]
767
 
    handshake.restype = ctypes.c_int
 
737
    handshake.argtypes = [session_t]
 
738
    handshake.restype = _error_code
768
739
    handshake.errcheck = _retry_on_error
769
740
 
770
741
    transport_set_ptr = _library.gnutls_transport_set_ptr
771
 
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
 
742
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
772
743
    transport_set_ptr.restype = None
773
744
 
774
745
    bye = _library.gnutls_bye
775
 
    bye.argtypes = [ClientSession, close_request_t]
776
 
    bye.restype = ctypes.c_int
 
746
    bye.argtypes = [session_t, close_request_t]
 
747
    bye.restype = _error_code
777
748
    bye.errcheck = _retry_on_error
778
749
 
779
750
    check_version = _library.gnutls_check_version
796
767
 
797
768
        x509_crt_fmt_t = ctypes.c_int
798
769
 
799
 
        # All the function declarations below are from
800
 
        # gnutls/abstract.h
 
770
        # All the function declarations below are from gnutls/abstract.h
801
771
        pubkey_init = _library.gnutls_pubkey_init
802
772
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
803
773
        pubkey_init.restype = _error_code
817
787
        pubkey_deinit.argtypes = [pubkey_t]
818
788
        pubkey_deinit.restype = None
819
789
    else:
820
 
        # All the function declarations below are from
821
 
        # gnutls/openpgp.h
 
790
        # All the function declarations below are from gnutls/openpgp.h
822
791
 
823
792
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
824
793
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
830
799
                                       openpgp_crt_fmt_t]
831
800
        openpgp_crt_import.restype = _error_code
832
801
 
833
 
        openpgp_crt_verify_self = \
834
 
            _library.gnutls_openpgp_crt_verify_self
835
 
        openpgp_crt_verify_self.argtypes = [
836
 
            openpgp_crt_t,
837
 
            ctypes.c_uint,
838
 
            ctypes.POINTER(ctypes.c_uint),
839
 
        ]
 
802
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
803
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
804
                                            ctypes.POINTER(ctypes.c_uint)]
840
805
        openpgp_crt_verify_self.restype = _error_code
841
806
 
842
807
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
853
818
 
854
819
    if check_version(b"3.6.4"):
855
820
        certificate_type_get2 = _library.gnutls_certificate_type_get2
856
 
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
 
821
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
857
822
        certificate_type_get2.restype = _error_code
858
823
 
859
824
    # Remove non-public functions
875
840
    """A representation of a client host served by this server.
876
841
 
877
842
    Attributes:
878
 
    approved:   bool(); None if not yet approved/disapproved
 
843
    approved:   bool(); 'None' if not yet approved/disapproved
879
844
    approval_delay: datetime.timedelta(); Time to wait for approval
880
845
    approval_duration: datetime.timedelta(); Duration of one approval
881
846
    checker: multiprocessing.Process(); a running checker process used
882
 
             to see if the client lives. None if no process is
 
847
             to see if the client lives. 'None' if no process is
883
848
             running.
884
849
    checker_callback_tag: a GLib event source tag, or None
885
850
    checker_command: string; External command which is run to check
961
926
            # key_id() and fingerprint() functions
962
927
            client["key_id"] = (section.get("key_id", "").upper()
963
928
                                .replace(" ", ""))
964
 
            client["fingerprint"] = (section.get("fingerprint",
965
 
                                                 "").upper()
 
929
            client["fingerprint"] = (section["fingerprint"].upper()
966
930
                                     .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
931
            if "secret" in section:
973
932
                client["secret"] = codecs.decode(section["secret"]
974
933
                                                 .encode("utf-8"),
1015
974
            self.last_enabled = None
1016
975
            self.expires = None
1017
976
 
1018
 
        log.debug("Creating client %r", self.name)
1019
 
        log.debug("  Key ID: %s", self.key_id)
1020
 
        log.debug("  Fingerprint: %s", self.fingerprint)
 
977
        logger.debug("Creating client %r", self.name)
 
978
        logger.debug("  Key ID: %s", self.key_id)
 
979
        logger.debug("  Fingerprint: %s", self.fingerprint)
1021
980
        self.created = settings.get("created",
1022
981
                                    datetime.datetime.utcnow())
1023
982
 
1051
1010
        if getattr(self, "enabled", False):
1052
1011
            # Already enabled
1053
1012
            return
 
1013
        self.expires = datetime.datetime.utcnow() + self.timeout
1054
1014
        self.enabled = True
1055
1015
        self.last_enabled = datetime.datetime.utcnow()
1056
1016
        self.init_checker()
1061
1021
        if not getattr(self, "enabled", False):
1062
1022
            return False
1063
1023
        if not quiet:
1064
 
            log.info("Disabling client %s", self.name)
 
1024
            logger.info("Disabling client %s", self.name)
1065
1025
        if getattr(self, "disable_initiator_tag", None) is not None:
1066
1026
            GLib.source_remove(self.disable_initiator_tag)
1067
1027
            self.disable_initiator_tag = None
1079
1039
    def __del__(self):
1080
1040
        self.disable()
1081
1041
 
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.
 
1042
    def init_checker(self):
 
1043
        # Schedule a new checker to be started an 'interval' from now,
 
1044
        # and every interval from then on.
1087
1045
        if self.checker_initiator_tag is not None:
1088
1046
            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
1047
        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
 
1048
            random.randrange(int(self.interval.total_seconds() * 1000
 
1049
                                 + 1)),
 
1050
            self.start_checker)
 
1051
        # Schedule a disable() when 'timeout' has passed
1106
1052
        if self.disable_initiator_tag is not None:
1107
1053
            GLib.source_remove(self.disable_initiator_tag)
1108
1054
        self.disable_initiator_tag = GLib.timeout_add(
1109
 
            int((self.expires - now).total_seconds() * 1000),
1110
 
            self.disable)
 
1055
            int(self.timeout.total_seconds() * 1000), self.disable)
 
1056
        # Also start a new checker *right now*.
 
1057
        self.start_checker()
1111
1058
 
1112
1059
    def checker_callback(self, source, condition, connection,
1113
1060
                         command):
1124
1071
            self.last_checker_status = returncode
1125
1072
            self.last_checker_signal = None
1126
1073
            if self.last_checker_status == 0:
1127
 
                log.info("Checker for %(name)s succeeded", vars(self))
 
1074
                logger.info("Checker for %(name)s succeeded",
 
1075
                            vars(self))
1128
1076
                self.checked_ok()
1129
1077
            else:
1130
 
                log.info("Checker for %(name)s failed", vars(self))
 
1078
                logger.info("Checker for %(name)s failed", vars(self))
1131
1079
        else:
1132
1080
            self.last_checker_status = -1
1133
1081
            self.last_checker_signal = -returncode
1134
 
            log.warning("Checker for %(name)s crashed?", vars(self))
 
1082
            logger.warning("Checker for %(name)s crashed?",
 
1083
                           vars(self))
1135
1084
        return False
1136
1085
 
1137
1086
    def checked_ok(self):
1156
1105
    def need_approval(self):
1157
1106
        self.last_approval_request = datetime.datetime.utcnow()
1158
1107
 
1159
 
    def start_checker(self, start_was_randomized=False):
 
1108
    def start_checker(self):
1160
1109
        """Start a new checker subprocess if one is not running.
1161
1110
 
1162
1111
        If a checker already exists, leave it running and do
1171
1120
        # should be.
1172
1121
 
1173
1122
        if self.checker is not None and not self.checker.is_alive():
1174
 
            log.warning("Checker was not alive; joining")
 
1123
            logger.warning("Checker was not alive; joining")
1175
1124
            self.checker.join()
1176
1125
            self.checker = None
1177
1126
        # Start a new checker if needed
1178
1127
        if self.checker is None:
1179
1128
            # Escape attributes for the shell
1180
1129
            escaped_attrs = {
1181
 
                attr: shlex.quote(str(getattr(self, attr)))
 
1130
                attr: re.escape(str(getattr(self, attr)))
1182
1131
                for attr in self.runtime_expansions}
1183
1132
            try:
1184
1133
                command = self.checker_command % escaped_attrs
1185
1134
            except TypeError as error:
1186
 
                log.error('Could not format string "%s"',
1187
 
                          self.checker_command, exc_info=error)
 
1135
                logger.error('Could not format string "%s"',
 
1136
                             self.checker_command,
 
1137
                             exc_info=error)
1188
1138
                return True     # Try again later
1189
1139
            self.current_checker_command = command
1190
 
            log.info("Starting checker %r for %s", command, self.name)
 
1140
            logger.info("Starting checker %r for %s", command,
 
1141
                        self.name)
1191
1142
            # We don't need to redirect stdout and stderr, since
1192
1143
            # in normal mode, that is already done by daemon(),
1193
1144
            # and in debug mode we don't want to.  (Stdin is
1212
1163
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1213
1164
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1214
1165
                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
1166
        # Re-run this periodically if run by GLib.timeout_add
1227
1167
        return True
1228
1168
 
1233
1173
            self.checker_callback_tag = None
1234
1174
        if getattr(self, "checker", None) is None:
1235
1175
            return
1236
 
        log.debug("Stopping checker for %(name)s", vars(self))
 
1176
        logger.debug("Stopping checker for %(name)s", vars(self))
1237
1177
        self.checker.terminate()
1238
1178
        self.checker = None
1239
1179
 
1266
1206
        func._dbus_name = func.__name__
1267
1207
        if func._dbus_name.endswith("_dbus_property"):
1268
1208
            func._dbus_name = func._dbus_name[:-14]
1269
 
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
 
1209
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1270
1210
        return func
1271
1211
 
1272
1212
    return decorator
1361
1301
 
1362
1302
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1363
1303
                         out_signature="s",
1364
 
                         path_keyword="object_path",
1365
 
                         connection_keyword="connection")
 
1304
                         path_keyword='object_path',
 
1305
                         connection_keyword='connection')
1366
1306
    def Introspect(self, object_path, connection):
1367
1307
        """Overloading of standard D-Bus method.
1368
1308
 
1417
1357
            document.unlink()
1418
1358
        except (AttributeError, xml.dom.DOMException,
1419
1359
                xml.parsers.expat.ExpatError) as error:
1420
 
            log.error("Failed to override Introspection method",
1421
 
                      exc_info=error)
 
1360
            logger.error("Failed to override Introspection method",
 
1361
                         exc_info=error)
1422
1362
        return xmlstring
1423
1363
 
1424
1364
 
1521
1461
 
1522
1462
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1523
1463
                         out_signature="s",
1524
 
                         path_keyword="object_path",
1525
 
                         connection_keyword="connection")
 
1464
                         path_keyword='object_path',
 
1465
                         connection_keyword='connection')
1526
1466
    def Introspect(self, object_path, connection):
1527
1467
        """Overloading of standard D-Bus method.
1528
1468
 
1584
1524
            document.unlink()
1585
1525
        except (AttributeError, xml.dom.DOMException,
1586
1526
                xml.parsers.expat.ExpatError) as error:
1587
 
            log.error("Failed to override Introspection method",
1588
 
                      exc_info=error)
 
1527
            logger.error("Failed to override Introspection method",
 
1528
                         exc_info=error)
1589
1529
        return xmlstring
1590
1530
 
1591
1531
 
1623
1563
 
1624
1564
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1625
1565
                         out_signature="s",
1626
 
                         path_keyword="object_path",
1627
 
                         connection_keyword="connection")
 
1566
                         path_keyword='object_path',
 
1567
                         connection_keyword='connection')
1628
1568
    def Introspect(self, object_path, connection):
1629
1569
        """Overloading of standard D-Bus method.
1630
1570
 
1655
1595
            document.unlink()
1656
1596
        except (AttributeError, xml.dom.DOMException,
1657
1597
                xml.parsers.expat.ExpatError) as error:
1658
 
            log.error("Failed to override Introspection method",
1659
 
                      exc_info=error)
 
1598
            logger.error("Failed to override Introspection method",
 
1599
                         exc_info=error)
1660
1600
        return xmlstring
1661
1601
 
1662
1602
 
2296
2236
class ProxyClient:
2297
2237
    def __init__(self, child_pipe, key_id, fpr, address):
2298
2238
        self._pipe = child_pipe
2299
 
        self._pipe.send(("init", key_id, fpr, address))
 
2239
        self._pipe.send(('init', key_id, fpr, address))
2300
2240
        if not self._pipe.recv():
2301
2241
            raise KeyError(key_id or fpr)
2302
2242
 
2303
2243
    def __getattribute__(self, name):
2304
 
        if name == "_pipe":
 
2244
        if name == '_pipe':
2305
2245
            return super(ProxyClient, self).__getattribute__(name)
2306
 
        self._pipe.send(("getattr", name))
 
2246
        self._pipe.send(('getattr', name))
2307
2247
        data = self._pipe.recv()
2308
 
        if data[0] == "data":
 
2248
        if data[0] == 'data':
2309
2249
            return data[1]
2310
 
        if data[0] == "function":
 
2250
        if data[0] == 'function':
2311
2251
 
2312
2252
            def func(*args, **kwargs):
2313
 
                self._pipe.send(("funcall", name, args, kwargs))
 
2253
                self._pipe.send(('funcall', name, args, kwargs))
2314
2254
                return self._pipe.recv()[1]
2315
2255
 
2316
2256
            return func
2317
2257
 
2318
2258
    def __setattr__(self, name, value):
2319
 
        if name == "_pipe":
 
2259
        if name == '_pipe':
2320
2260
            return super(ProxyClient, self).__setattr__(name, value)
2321
 
        self._pipe.send(("setattr", name, value))
 
2261
        self._pipe.send(('setattr', name, value))
2322
2262
 
2323
2263
 
2324
2264
class ClientHandler(socketserver.BaseRequestHandler, object):
2329
2269
 
2330
2270
    def handle(self):
2331
2271
        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())
 
2272
            logger.info("TCP connection from: %s",
 
2273
                        str(self.client_address))
 
2274
            logger.debug("Pipe FD: %d",
 
2275
                         self.server.child_pipe.fileno())
2335
2276
 
2336
2277
            session = gnutls.ClientSession(self.request)
2337
2278
 
2338
 
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
 
2279
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
2339
2280
            #                       "+AES-256-CBC", "+SHA1",
2340
2281
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2341
2282
            #                       "+DHE-DSS"))
2343
2284
            priority = self.server.gnutls_priority
2344
2285
            if priority is None:
2345
2286
                priority = "NORMAL"
2346
 
            gnutls.priority_set_direct(session,
2347
 
                                       priority.encode("utf-8"), None)
 
2287
            gnutls.priority_set_direct(session._c_object,
 
2288
                                       priority.encode("utf-8"),
 
2289
                                       None)
2348
2290
 
2349
2291
            # Start communication using the Mandos protocol
2350
2292
            # Get protocol number
2351
2293
            line = self.request.makefile().readline()
2352
 
            log.debug("Protocol version: %r", line)
 
2294
            logger.debug("Protocol version: %r", line)
2353
2295
            try:
2354
2296
                if int(line.strip().split()[0]) > 1:
2355
2297
                    raise RuntimeError(line)
2356
2298
            except (ValueError, IndexError, RuntimeError) as error:
2357
 
                log.error("Unknown protocol version: %s", error)
 
2299
                logger.error("Unknown protocol version: %s", error)
2358
2300
                return
2359
2301
 
2360
2302
            # Start GnuTLS connection
2361
2303
            try:
2362
2304
                session.handshake()
2363
2305
            except gnutls.Error as error:
2364
 
                log.warning("Handshake failed: %s", error)
 
2306
                logger.warning("Handshake failed: %s", error)
2365
2307
                # Do not run session.bye() here: the session is not
2366
2308
                # established.  Just abandon the request.
2367
2309
                return
2368
 
            log.debug("Handshake succeeded")
 
2310
            logger.debug("Handshake succeeded")
2369
2311
 
2370
2312
            approval_required = False
2371
2313
            try:
2375
2317
                        key_id = self.key_id(
2376
2318
                            self.peer_certificate(session))
2377
2319
                    except (TypeError, gnutls.Error) as error:
2378
 
                        log.warning("Bad certificate: %s", error)
 
2320
                        logger.warning("Bad certificate: %s", error)
2379
2321
                        return
2380
 
                    log.debug("Key ID: %s",
2381
 
                              key_id.decode("utf-8",
2382
 
                                            errors="replace"))
 
2322
                    logger.debug("Key ID: %s", key_id)
2383
2323
 
2384
2324
                else:
2385
2325
                    key_id = b""
2387
2327
                        fpr = self.fingerprint(
2388
2328
                            self.peer_certificate(session))
2389
2329
                    except (TypeError, gnutls.Error) as error:
2390
 
                        log.warning("Bad certificate: %s", error)
 
2330
                        logger.warning("Bad certificate: %s", error)
2391
2331
                        return
2392
 
                    log.debug("Fingerprint: %s", fpr)
 
2332
                    logger.debug("Fingerprint: %s", fpr)
2393
2333
 
2394
2334
                try:
2395
2335
                    client = ProxyClient(child_pipe, key_id, fpr,
2404
2344
 
2405
2345
                while True:
2406
2346
                    if not client.enabled:
2407
 
                        log.info("Client %s is disabled", client.name)
 
2347
                        logger.info("Client %s is disabled",
 
2348
                                    client.name)
2408
2349
                        if self.server.use_dbus:
2409
2350
                            # Emit D-Bus signal
2410
2351
                            client.Rejected("Disabled")
2414
2355
                        # We are approved or approval is disabled
2415
2356
                        break
2416
2357
                    elif client.approved is None:
2417
 
                        log.info("Client %s needs approval",
2418
 
                                 client.name)
 
2358
                        logger.info("Client %s needs approval",
 
2359
                                    client.name)
2419
2360
                        if self.server.use_dbus:
2420
2361
                            # Emit D-Bus signal
2421
2362
                            client.NeedApproval(
2422
2363
                                client.approval_delay.total_seconds()
2423
2364
                                * 1000, client.approved_by_default)
2424
2365
                    else:
2425
 
                        log.warning("Client %s was not approved",
2426
 
                                    client.name)
 
2366
                        logger.warning("Client %s was not approved",
 
2367
                                       client.name)
2427
2368
                        if self.server.use_dbus:
2428
2369
                            # Emit D-Bus signal
2429
2370
                            client.Rejected("Denied")
2437
2378
                    time2 = datetime.datetime.now()
2438
2379
                    if (time2 - time) >= delay:
2439
2380
                        if not client.approved_by_default:
2440
 
                            log.warning("Client %s timed out while"
2441
 
                                        " waiting for approval",
2442
 
                                        client.name)
 
2381
                            logger.warning("Client %s timed out while"
 
2382
                                           " waiting for approval",
 
2383
                                           client.name)
2443
2384
                            if self.server.use_dbus:
2444
2385
                                # Emit D-Bus signal
2445
2386
                                client.Rejected("Approval timed out")
2452
2393
                try:
2453
2394
                    session.send(client.secret)
2454
2395
                except gnutls.Error as error:
2455
 
                    log.warning("gnutls send failed", exc_info=error)
 
2396
                    logger.warning("gnutls send failed",
 
2397
                                   exc_info=error)
2456
2398
                    return
2457
2399
 
2458
 
                log.info("Sending secret to %s", client.name)
 
2400
                logger.info("Sending secret to %s", client.name)
2459
2401
                # bump the timeout using extended_timeout
2460
2402
                client.bump_timeout(client.extended_timeout)
2461
2403
                if self.server.use_dbus:
2468
2410
                try:
2469
2411
                    session.bye()
2470
2412
                except gnutls.Error as error:
2471
 
                    log.warning("GnuTLS bye failed", exc_info=error)
 
2413
                    logger.warning("GnuTLS bye failed",
 
2414
                                   exc_info=error)
2472
2415
 
2473
2416
    @staticmethod
2474
2417
    def peer_certificate(session):
2475
2418
        "Return the peer's certificate as a bytestring"
2476
2419
        try:
2477
 
            cert_type = gnutls.certificate_type_get2(
2478
 
                session, gnutls.CTYPE_PEERS)
 
2420
            cert_type = gnutls.certificate_type_get2(session._c_object,
 
2421
                                                     gnutls.CTYPE_PEERS)
2479
2422
        except AttributeError:
2480
 
            cert_type = gnutls.certificate_type_get(session)
 
2423
            cert_type = gnutls.certificate_type_get(session._c_object)
2481
2424
        if gnutls.has_rawpk:
2482
2425
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2483
2426
        else:
2484
2427
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2485
2428
        # If not a valid certificate type...
2486
2429
        if cert_type not in valid_cert_types:
2487
 
            log.info("Cert type %r not in %r", cert_type,
2488
 
                     valid_cert_types)
 
2430
            logger.info("Cert type %r not in %r", cert_type,
 
2431
                        valid_cert_types)
2489
2432
            # ...return invalid data
2490
2433
            return b""
2491
2434
        list_size = ctypes.c_uint(1)
2492
2435
        cert_list = (gnutls.certificate_get_peers
2493
 
                     (session, ctypes.byref(list_size)))
 
2436
                     (session._c_object, ctypes.byref(list_size)))
2494
2437
        if not bool(cert_list) and list_size.value != 0:
2495
2438
            raise gnutls.Error("error getting peer certificate")
2496
2439
        if list_size.value == 0:
2518
2461
        buf = ctypes.create_string_buffer(32)
2519
2462
        buf_len = ctypes.c_size_t(len(buf))
2520
2463
        # Get the key ID from the raw public key into the buffer
2521
 
        gnutls.pubkey_get_key_id(
2522
 
            pubkey,
2523
 
            gnutls.KEYID_USE_SHA256,
2524
 
            ctypes.cast(ctypes.byref(buf),
2525
 
                        ctypes.POINTER(ctypes.c_ubyte)),
2526
 
            ctypes.byref(buf_len))
 
2464
        gnutls.pubkey_get_key_id(pubkey,
 
2465
                                 gnutls.KEYID_USE_SHA256,
 
2466
                                 ctypes.cast(ctypes.byref(buf),
 
2467
                                             ctypes.POINTER(ctypes.c_ubyte)),
 
2468
                                 ctypes.byref(buf_len))
2527
2469
        # Deinit the certificate
2528
2470
        gnutls.pubkey_deinit(pubkey)
2529
2471
 
2610
2552
 
2611
2553
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2612
2554
                     socketserver.TCPServer):
2613
 
    """IPv6-capable TCP server.  Accepts None as address and/or port
 
2555
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2614
2556
 
2615
2557
    Attributes:
2616
2558
        enabled:        Boolean; whether this server is activated yet
2667
2609
            if SO_BINDTODEVICE is None:
2668
2610
                # Fall back to a hard-coded value which seems to be
2669
2611
                # common enough.
2670
 
                log.warning("SO_BINDTODEVICE not found, trying 25")
 
2612
                logger.warning("SO_BINDTODEVICE not found, trying 25")
2671
2613
                SO_BINDTODEVICE = 25
2672
2614
            try:
2673
2615
                self.socket.setsockopt(
2675
2617
                    (self.interface + "\0").encode("utf-8"))
2676
2618
            except socket.error as error:
2677
2619
                if error.errno == errno.EPERM:
2678
 
                    log.error("No permission to bind to interface %s",
2679
 
                              self.interface)
 
2620
                    logger.error("No permission to bind to"
 
2621
                                 " interface %s", self.interface)
2680
2622
                elif error.errno == errno.ENOPROTOOPT:
2681
 
                    log.error("SO_BINDTODEVICE not available; cannot"
2682
 
                              " bind to interface %s", self.interface)
 
2623
                    logger.error("SO_BINDTODEVICE not available;"
 
2624
                                 " cannot bind to interface %s",
 
2625
                                 self.interface)
2683
2626
                elif error.errno == errno.ENODEV:
2684
 
                    log.error("Interface %s does not exist, cannot"
2685
 
                              " bind", self.interface)
 
2627
                    logger.error("Interface %s does not exist,"
 
2628
                                 " cannot bind", self.interface)
2686
2629
                else:
2687
2630
                    raise
2688
2631
        # Only bind(2) the socket if we really need to.
2767
2710
        request = parent_pipe.recv()
2768
2711
        command = request[0]
2769
2712
 
2770
 
        if command == "init":
 
2713
        if command == 'init':
2771
2714
            key_id = request[1].decode("ascii")
2772
2715
            fpr = request[2].decode("ascii")
2773
2716
            address = request[3]
2774
2717
 
2775
2718
            for c in self.clients.values():
2776
 
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2777
 
                              "27AE41E4649B934CA495991B7852B855"):
 
2719
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2778
2720
                    continue
2779
2721
                if key_id and c.key_id == key_id:
2780
2722
                    client = c
2783
2725
                    client = c
2784
2726
                    break
2785
2727
            else:
2786
 
                log.info("Client not found for key ID: %s, address:"
2787
 
                         " %s", key_id or fpr, address)
 
2728
                logger.info("Client not found for key ID: %s, address"
 
2729
                            ": %s", key_id or fpr, address)
2788
2730
                if self.use_dbus:
2789
2731
                    # Emit D-Bus signal
2790
2732
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2803
2745
            # remove the old hook in favor of the new above hook on
2804
2746
            # same fileno
2805
2747
            return False
2806
 
        if command == "funcall":
 
2748
        if command == 'funcall':
2807
2749
            funcname = request[1]
2808
2750
            args = request[2]
2809
2751
            kwargs = request[3]
2810
2752
 
2811
 
            parent_pipe.send(("data", getattr(client_object,
 
2753
            parent_pipe.send(('data', getattr(client_object,
2812
2754
                                              funcname)(*args,
2813
2755
                                                        **kwargs)))
2814
2756
 
2815
 
        if command == "getattr":
 
2757
        if command == 'getattr':
2816
2758
            attrname = request[1]
2817
2759
            if isinstance(client_object.__getattribute__(attrname),
2818
2760
                          collections.abc.Callable):
2819
 
                parent_pipe.send(("function", ))
 
2761
                parent_pipe.send(('function', ))
2820
2762
            else:
2821
2763
                parent_pipe.send((
2822
 
                    "data", client_object.__getattribute__(attrname)))
 
2764
                    'data', client_object.__getattribute__(attrname)))
2823
2765
 
2824
 
        if command == "setattr":
 
2766
        if command == 'setattr':
2825
2767
            attrname = request[1]
2826
2768
            value = request[2]
2827
2769
            setattr(client_object, attrname, value)
2832
2774
def rfc3339_duration_to_delta(duration):
2833
2775
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2834
2776
 
2835
 
    >>> timedelta = datetime.timedelta
2836
 
    >>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2837
 
    True
2838
 
    >>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2839
 
    True
2840
 
    >>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2841
 
    True
2842
 
    >>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2843
 
    True
2844
 
    >>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2845
 
    True
2846
 
    >>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2847
 
    True
2848
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2849
 
    True
2850
 
    >>> del timedelta
 
2777
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
 
2778
    True
 
2779
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
 
2780
    True
 
2781
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
 
2782
    True
 
2783
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
 
2784
    True
 
2785
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
 
2786
    True
 
2787
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
 
2788
    True
 
2789
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
 
2790
    True
2851
2791
    """
2852
2792
 
2853
2793
    # Parsing an RFC 3339 duration with regular expressions is not
2933
2873
def string_to_delta(interval):
2934
2874
    """Parse a string and return a datetime.timedelta
2935
2875
 
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)
 
2876
    >>> string_to_delta('7d') == datetime.timedelta(7)
 
2877
    True
 
2878
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
 
2879
    True
 
2880
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
 
2881
    True
 
2882
    >>> string_to_delta('24h') == datetime.timedelta(1)
 
2883
    True
 
2884
    >>> string_to_delta('1w') == datetime.timedelta(7)
 
2885
    True
 
2886
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
2947
2887
    True
2948
2888
    """
2949
2889
 
3153
3093
 
3154
3094
    if server_settings["servicename"] != "Mandos":
3155
3095
        syslogger.setFormatter(
3156
 
            logging.Formatter("Mandos ({}) [%(process)d]:"
3157
 
                              " %(levelname)s: %(message)s".format(
 
3096
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
3097
                              ' %(levelname)s: %(message)s'.format(
3158
3098
                                  server_settings["servicename"])))
3159
3099
 
3160
3100
    # Parse config file with clients
3184
3124
        try:
3185
3125
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3186
3126
        except IOError as e:
3187
 
            log.error("Could not open file %r", pidfilename,
3188
 
                      exc_info=e)
 
3127
            logger.error("Could not open file %r", pidfilename,
 
3128
                         exc_info=e)
3189
3129
 
3190
3130
    for name, group in (("_mandos", "_mandos"),
3191
3131
                        ("mandos", "mandos"),
3202
3142
    try:
3203
3143
        os.setgid(gid)
3204
3144
        os.setuid(uid)
3205
 
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
 
3145
        if debug:
 
3146
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3147
                                                             gid))
3206
3148
    except OSError as error:
3207
 
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3208
 
                    os.strerror(error.errno))
 
3149
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3150
                       .format(uid, gid, os.strerror(error.errno)))
3209
3151
        if error.errno != errno.EPERM:
3210
3152
            raise
3211
3153
 
3218
3160
 
3219
3161
        @gnutls.log_func
3220
3162
        def debug_gnutls(level, string):
3221
 
            log.debug("GnuTLS: %s",
3222
 
                      string[:-1].decode("utf-8", errors="replace"))
 
3163
            logger.debug("GnuTLS: %s", string[:-1])
3223
3164
 
3224
3165
        gnutls.global_set_log_function(debug_gnutls)
3225
3166
 
3243
3184
    # From the Avahi example code
3244
3185
    DBusGMainLoop(set_as_default=True)
3245
3186
    main_loop = GLib.MainLoop()
3246
 
    if use_dbus or zeroconf:
3247
 
        bus = dbus.SystemBus()
 
3187
    bus = dbus.SystemBus()
3248
3188
    # End of Avahi example code
3249
3189
    if use_dbus:
3250
3190
        try:
3255
3195
                "se.bsnet.fukt.Mandos", bus,
3256
3196
                do_not_queue=True)
3257
3197
        except dbus.exceptions.DBusException as e:
3258
 
            log.error("Disabling D-Bus:", exc_info=e)
 
3198
            logger.error("Disabling D-Bus:", exc_info=e)
3259
3199
            use_dbus = False
3260
3200
            server_settings["use_dbus"] = False
3261
3201
            tcp_server.use_dbus = False
3346
3286
            os.remove(stored_state_path)
3347
3287
        except IOError as e:
3348
3288
            if e.errno == errno.ENOENT:
3349
 
                log.warning("Could not load persistent state:"
3350
 
                            " %s", os.strerror(e.errno))
 
3289
                logger.warning("Could not load persistent state:"
 
3290
                               " {}".format(os.strerror(e.errno)))
3351
3291
            else:
3352
 
                log.critical("Could not load persistent state:",
3353
 
                             exc_info=e)
 
3292
                logger.critical("Could not load persistent state:",
 
3293
                                exc_info=e)
3354
3294
                raise
3355
3295
        except EOFError as e:
3356
 
            log.warning("Could not load persistent state: EOFError:",
3357
 
                        exc_info=e)
 
3296
            logger.warning("Could not load persistent state: "
 
3297
                           "EOFError:",
 
3298
                           exc_info=e)
3358
3299
 
3359
3300
    with PGPEngine() as pgp:
3360
3301
        for client_name, client in clients_data.items():
3387
3328
            if client["enabled"]:
3388
3329
                if datetime.datetime.utcnow() >= client["expires"]:
3389
3330
                    if not client["last_checked_ok"]:
3390
 
                        log.warning("disabling client %s - Client"
3391
 
                                    " never performed a successful"
3392
 
                                    " checker", client_name)
 
3331
                        logger.warning(
 
3332
                            "disabling client {} - Client never "
 
3333
                            "performed a successful checker".format(
 
3334
                                client_name))
3393
3335
                        client["enabled"] = False
3394
3336
                    elif client["last_checker_status"] != 0:
3395
 
                        log.warning("disabling client %s - Client"
3396
 
                                    " last checker failed with error"
3397
 
                                    " code %s", client_name,
3398
 
                                    client["last_checker_status"])
 
3337
                        logger.warning(
 
3338
                            "disabling client {} - Client last"
 
3339
                            " checker failed with error code"
 
3340
                            " {}".format(
 
3341
                                client_name,
 
3342
                                client["last_checker_status"]))
3399
3343
                        client["enabled"] = False
3400
3344
                    else:
3401
3345
                        client["expires"] = (
3402
3346
                            datetime.datetime.utcnow()
3403
3347
                            + client["timeout"])
3404
 
                        log.debug("Last checker succeeded, keeping %s"
3405
 
                                  " enabled", client_name)
 
3348
                        logger.debug("Last checker succeeded,"
 
3349
                                     " keeping {} enabled".format(
 
3350
                                         client_name))
3406
3351
            try:
3407
3352
                client["secret"] = pgp.decrypt(
3408
3353
                    client["encrypted_secret"],
3409
3354
                    client_settings[client_name]["secret"])
3410
3355
            except PGPError:
3411
3356
                # If decryption fails, we use secret from new settings
3412
 
                log.debug("Failed to decrypt %s old secret",
3413
 
                          client_name)
 
3357
                logger.debug("Failed to decrypt {} old secret".format(
 
3358
                    client_name))
3414
3359
                client["secret"] = (client_settings[client_name]
3415
3360
                                    ["secret"])
3416
3361
 
3430
3375
            server_settings=server_settings)
3431
3376
 
3432
3377
    if not tcp_server.clients:
3433
 
        log.warning("No clients defined")
 
3378
        logger.warning("No clients defined")
3434
3379
 
3435
3380
    if not foreground:
3436
3381
        if pidfile is not None:
3439
3384
                with pidfile:
3440
3385
                    print(pid, file=pidfile)
3441
3386
            except IOError:
3442
 
                log.error("Could not write to file %r with PID %d",
3443
 
                          pidfilename, pid)
 
3387
                logger.error("Could not write to file %r with PID %d",
 
3388
                             pidfilename, pid)
3444
3389
        del pidfile
3445
3390
        del pidfilename
3446
3391
 
3596
3541
 
3597
3542
        try:
3598
3543
            with tempfile.NamedTemporaryFile(
3599
 
                    mode="wb",
 
3544
                    mode='wb',
3600
3545
                    suffix=".pickle",
3601
 
                    prefix="clients-",
 
3546
                    prefix='clients-',
3602
3547
                    dir=os.path.dirname(stored_state_path),
3603
3548
                    delete=False) as stored_state:
3604
3549
                pickle.dump((clients, client_settings), stored_state,
3612
3557
                except NameError:
3613
3558
                    pass
3614
3559
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3615
 
                log.warning("Could not save persistent state: %s",
3616
 
                            os.strerror(e.errno))
 
3560
                logger.warning("Could not save persistent state: {}"
 
3561
                               .format(os.strerror(e.errno)))
3617
3562
            else:
3618
 
                log.warning("Could not save persistent state:",
3619
 
                            exc_info=e)
 
3563
                logger.warning("Could not save persistent state:",
 
3564
                               exc_info=e)
3620
3565
                raise
3621
3566
 
3622
3567
        # Delete all clients, and settings from config
3639
3584
            mandos_dbus_service.client_added_signal(client)
3640
3585
        # Need to initiate checking of clients
3641
3586
        if client.enabled:
3642
 
            client.init_checker(randomize_start=True)
 
3587
            client.init_checker()
3643
3588
 
3644
3589
    tcp_server.enable()
3645
3590
    tcp_server.server_activate()
3648
3593
    if zeroconf:
3649
3594
        service.port = tcp_server.socket.getsockname()[1]
3650
3595
    if use_ipv6:
3651
 
        log.info("Now listening on address %r, port %d, flowinfo %d,"
3652
 
                 " scope_id %d", *tcp_server.socket.getsockname())
 
3596
        logger.info("Now listening on address %r, port %d,"
 
3597
                    " flowinfo %d, scope_id %d",
 
3598
                    *tcp_server.socket.getsockname())
3653
3599
    else:                       # IPv4
3654
 
        log.info("Now listening on address %r, port %d",
3655
 
                 *tcp_server.socket.getsockname())
 
3600
        logger.info("Now listening on address %r, port %d",
 
3601
                    *tcp_server.socket.getsockname())
3656
3602
 
3657
3603
    # service.interface = tcp_server.socket.getsockname()[3]
3658
3604
 
3662
3608
            try:
3663
3609
                service.activate()
3664
3610
            except dbus.exceptions.DBusException as error:
3665
 
                log.critical("D-Bus Exception", exc_info=error)
 
3611
                logger.critical("D-Bus Exception", exc_info=error)
3666
3612
                cleanup()
3667
3613
                sys.exit(1)
3668
3614
            # End of Avahi example code
3673
3619
            lambda *args, **kwargs: (tcp_server.handle_request
3674
3620
                                     (*args[2:], **kwargs) or True))
3675
3621
 
3676
 
        log.debug("Starting main loop")
 
3622
        logger.debug("Starting main loop")
3677
3623
        main_loop.run()
3678
3624
    except AvahiError as error:
3679
 
        log.critical("Avahi Error", exc_info=error)
 
3625
        logger.critical("Avahi Error", exc_info=error)
3680
3626
        cleanup()
3681
3627
        sys.exit(1)
3682
3628
    except KeyboardInterrupt:
3683
3629
        if debug:
3684
3630
            print("", file=sys.stderr)
3685
 
        log.debug("Server received KeyboardInterrupt")
3686
 
    log.debug("Server exiting")
 
3631
        logger.debug("Server received KeyboardInterrupt")
 
3632
    logger.debug("Server exiting")
3687
3633
    # Must run before the D-Bus bus name gets deregistered
3688
3634
    cleanup()
3689
3635
 
3690
3636
 
3691
 
def parse_test_args():
3692
 
    # type: () -> argparse.Namespace
 
3637
def should_only_run_tests():
3693
3638
    parser = argparse.ArgumentParser(add_help=False)
3694
 
    parser.add_argument("--check", action="store_true")
3695
 
    parser.add_argument("--prefix", )
 
3639
    parser.add_argument("--check", action='store_true')
3696
3640
    args, unknown_args = parser.parse_known_args()
3697
 
    if args.check:
3698
 
        # Remove test options from sys.argv
 
3641
    run_tests = args.check
 
3642
    if run_tests:
 
3643
        # Remove --check argument from sys.argv
3699
3644
        sys.argv[1:] = unknown_args
3700
 
    return args
 
3645
    return run_tests
3701
3646
 
3702
3647
# Add all tests from doctest strings
3703
3648
def load_tests(loader, tests, none):
3705
3650
    tests.addTests(doctest.DocTestSuite())
3706
3651
    return tests
3707
3652
 
3708
 
if __name__ == "__main__":
3709
 
    options = parse_test_args()
 
3653
if __name__ == '__main__':
3710
3654
    try:
3711
 
        if options.check:
3712
 
            extra_test_prefix = options.prefix
3713
 
            if extra_test_prefix is not None:
3714
 
                if not (unittest.main(argv=[""], exit=False)
3715
 
                        .result.wasSuccessful()):
3716
 
                    sys.exit(1)
3717
 
                class ExtraTestLoader(unittest.TestLoader):
3718
 
                    testMethodPrefix = extra_test_prefix
3719
 
                # Call using ./scriptname --test [--verbose]
3720
 
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
3721
 
            else:
3722
 
                unittest.main(argv=[""])
 
3655
        if should_only_run_tests():
 
3656
            # Call using ./mandos --check [--verbose]
 
3657
            unittest.main()
3723
3658
        else:
3724
3659
            main()
3725
3660
    finally:
3726
3661
        logging.shutdown()
3727
 
 
3728
 
# Local Variables:
3729
 
# run-tests:
3730
 
# (lambda (&optional extra)
3731
 
#   (if (not (funcall run-tests-in-test-buffer default-directory
3732
 
#             extra))
3733
 
#       (funcall show-test-buffer-in-test-window)
3734
 
#     (funcall remove-test-window)
3735
 
#     (if extra (message "Extra tests run successfully!"))))
3736
 
# run-tests-in-test-buffer:
3737
 
# (lambda (dir &optional extra)
3738
 
#   (with-current-buffer (get-buffer-create "*Test*")
3739
 
#     (setq buffer-read-only nil
3740
 
#           default-directory dir)
3741
 
#     (erase-buffer)
3742
 
#     (compilation-mode))
3743
 
#   (let ((process-result
3744
 
#          (let ((inhibit-read-only t))
3745
 
#            (process-file-shell-command
3746
 
#             (funcall get-command-line extra) nil "*Test*"))))
3747
 
#     (and (numberp process-result)
3748
 
#          (= process-result 0))))
3749
 
# get-command-line:
3750
 
# (lambda (&optional extra)
3751
 
#   (let ((quoted-script
3752
 
#          (shell-quote-argument (funcall get-script-name))))
3753
 
#     (format
3754
 
#      (concat "%s --check" (if extra " --prefix=atest" ""))
3755
 
#      quoted-script)))
3756
 
# get-script-name:
3757
 
# (lambda ()
3758
 
#   (if (fboundp 'file-local-name)
3759
 
#       (file-local-name (buffer-file-name))
3760
 
#     (or (file-remote-p (buffer-file-name) 'localname)
3761
 
#         (buffer-file-name))))
3762
 
# remove-test-window:
3763
 
# (lambda ()
3764
 
#   (let ((test-window (get-buffer-window "*Test*")))
3765
 
#     (if test-window (delete-window test-window))))
3766
 
# show-test-buffer-in-test-window:
3767
 
# (lambda ()
3768
 
#   (when (not (get-buffer-window-list "*Test*"))
3769
 
#     (setq next-error-last-buffer (get-buffer "*Test*"))
3770
 
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3771
 
#            (display-buffer-overriding-action
3772
 
#             `((display-buffer-in-side-window) (side . ,side)
3773
 
#               (window-height . fit-window-to-buffer)
3774
 
#               (window-width . fit-window-to-buffer))))
3775
 
#       (display-buffer "*Test*"))))
3776
 
# eval:
3777
 
# (progn
3778
 
#   (let* ((run-extra-tests (lambda () (interactive)
3779
 
#                             (funcall run-tests t)))
3780
 
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3781
 
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
3782
 
#     (setq minor-mode-overriding-map-alist
3783
 
#           (cons `(run-tests . ,outer-keymap)
3784
 
#                 minor-mode-overriding-map-alist)))
3785
 
#   (add-hook 'after-save-hook run-tests 90 t))
3786
 
# End: