/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2023-02-07 19:40:12 UTC
  • Revision ID: teddy@recompile.se-20230207194012-hm2gev01cn7vlodp
Make builds reproducible 

* debian/rules (override_dh_fixperms-arch): Exclude from dh_fixperms
  only what is inside the
  /usr/share/doc/mandos-client/examples/network-hooks.d/ directory.
  That is, do not exclude (i.e. include in the normal dh_fixperms) the
  example/network-hooks.d directory itself.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
#!/usr/bin/python3 -bI
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 -*-
 
2
# -*- coding: utf-8; lexical-binding: t -*-
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-2019 Teddy Hogeborn
15
 
# Copyright © 2008-2019 Björn Påhlsson
 
14
# Copyright © 2008-2022 Teddy Hogeborn
 
15
# Copyright © 2008-2022 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
 
 
35
34
from __future__ import (division, absolute_import, print_function,
36
35
                        unicode_literals)
37
36
 
40
39
except ImportError:
41
40
    pass
42
41
 
 
42
import sys
 
43
import unittest
 
44
import argparse
 
45
import logging
 
46
import os
43
47
try:
44
48
    import SocketServer as socketserver
45
49
except ImportError:
46
50
    import socketserver
47
51
import socket
48
 
import argparse
49
52
import datetime
50
53
import errno
51
54
try:
52
55
    import ConfigParser as configparser
53
56
except ImportError:
54
57
    import configparser
55
 
import sys
56
58
import re
57
 
import os
58
59
import signal
59
60
import subprocess
60
61
import atexit
61
62
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
import random
 
81
import shlex
81
82
 
82
83
import dbus
83
84
import dbus.service
91
92
 
92
93
if sys.version_info.major == 2:
93
94
    __metaclass__ = type
 
95
    str = unicode
 
96
    input = raw_input
 
97
 
 
98
# Add collections.abc.Callable if it does not exist
 
99
try:
 
100
    collections.abc.Callable
 
101
except AttributeError:
 
102
    class abc:
 
103
        Callable = collections.Callable
 
104
    collections.abc = abc
 
105
    del abc
 
106
 
 
107
# Add shlex.quote if it does not exist
 
108
try:
 
109
    shlex.quote
 
110
except AttributeError:
 
111
    shlex.quote = re.escape
94
112
 
95
113
# Show warnings by default
96
114
if not sys.warnoptions:
122
140
            # No value found
123
141
            SO_BINDTODEVICE = None
124
142
 
125
 
if sys.version_info.major == 2:
126
 
    str = unicode
127
 
 
128
143
if sys.version_info < (3, 2):
129
144
    configparser.Configparser = configparser.SafeConfigParser
130
145
 
131
 
version = "1.8.9"
 
146
version = "1.8.15"
132
147
stored_state_file = "clients.pickle"
133
148
 
134
 
logger = logging.getLogger()
 
149
log = logging.getLogger(os.path.basename(sys.argv[0]))
135
150
logging.captureWarnings(True)   # Show warnings via the logging system
136
151
syslogger = None
137
152
 
174
189
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
175
190
        address="/dev/log"))
176
191
    syslogger.setFormatter(logging.Formatter
177
 
                           ('Mandos [%(process)d]: %(levelname)s:'
178
 
                            ' %(message)s'))
179
 
    logger.addHandler(syslogger)
 
192
                           ("Mandos [%(process)d]: %(levelname)s:"
 
193
                            " %(message)s"))
 
194
    log.addHandler(syslogger)
180
195
 
181
196
    if debug:
182
197
        console = logging.StreamHandler()
183
 
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
184
 
                                               ' [%(process)d]:'
185
 
                                               ' %(levelname)s:'
186
 
                                               ' %(message)s'))
187
 
        logger.addHandler(console)
188
 
    logger.setLevel(level)
 
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)
189
204
 
190
205
 
191
206
class PGPError(Exception):
209
224
        except OSError as e:
210
225
            if e.errno != errno.ENOENT:
211
226
                raise
212
 
        self.gnupgargs = ['--batch',
213
 
                          '--homedir', self.tempdir,
214
 
                          '--force-mdc',
215
 
                          '--quiet']
 
227
        self.gnupgargs = ["--batch",
 
228
                          "--homedir", self.tempdir,
 
229
                          "--force-mdc",
 
230
                          "--quiet"]
216
231
        # Only GPG version 1 has the --no-use-agent option.
217
232
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
218
233
            self.gnupgargs.append("--no-use-agent")
257
272
                dir=self.tempdir) as passfile:
258
273
            passfile.write(passphrase)
259
274
            passfile.flush()
260
 
            proc = subprocess.Popen([self.gpg, '--symmetric',
261
 
                                     '--passphrase-file',
 
275
            proc = subprocess.Popen([self.gpg, "--symmetric",
 
276
                                     "--passphrase-file",
262
277
                                     passfile.name]
263
278
                                    + self.gnupgargs,
264
279
                                    stdin=subprocess.PIPE,
275
290
                dir=self.tempdir) as passfile:
276
291
            passfile.write(passphrase)
277
292
            passfile.flush()
278
 
            proc = subprocess.Popen([self.gpg, '--decrypt',
279
 
                                     '--passphrase-file',
 
293
            proc = subprocess.Popen([self.gpg, "--decrypt",
 
294
                                     "--passphrase-file",
280
295
                                     passfile.name]
281
296
                                    + self.gnupgargs,
282
297
                                    stdin=subprocess.PIPE,
335
350
    Attributes:
336
351
    interface: integer; avahi.IF_UNSPEC or an interface index.
337
352
               Used to optionally bind to the specified interface.
338
 
    name: string; Example: 'Mandos'
339
 
    type: string; Example: '_mandos._tcp'.
 
353
    name: string; Example: "Mandos"
 
354
    type: string; Example: "_mandos._tcp".
340
355
     See <https://www.iana.org/assignments/service-names-port-numbers>
341
356
    port: integer; what port to announce
342
357
    TXT: list of strings; TXT record for the service
379
394
    def rename(self, remove=True):
380
395
        """Derived from the Avahi example code"""
381
396
        if self.rename_count >= self.max_renames:
382
 
            logger.critical("No suitable Zeroconf service name found"
383
 
                            " after %i retries, exiting.",
384
 
                            self.rename_count)
 
397
            log.critical("No suitable Zeroconf service name found"
 
398
                         " after %i retries, exiting.",
 
399
                         self.rename_count)
385
400
            raise AvahiServiceError("Too many renames")
386
401
        self.name = str(
387
402
            self.server.GetAlternativeServiceName(self.name))
388
403
        self.rename_count += 1
389
 
        logger.info("Changing Zeroconf service name to %r ...",
390
 
                    self.name)
 
404
        log.info("Changing Zeroconf service name to %r ...",
 
405
                 self.name)
391
406
        if remove:
392
407
            self.remove()
393
408
        try:
395
410
        except dbus.exceptions.DBusException as error:
396
411
            if (error.get_dbus_name()
397
412
                == "org.freedesktop.Avahi.CollisionError"):
398
 
                logger.info("Local Zeroconf service name collision.")
 
413
                log.info("Local Zeroconf service name collision.")
399
414
                return self.rename(remove=False)
400
415
            else:
401
 
                logger.critical("D-Bus Exception", exc_info=error)
 
416
                log.critical("D-Bus Exception", exc_info=error)
402
417
                self.cleanup()
403
418
                os._exit(1)
404
419
 
420
435
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
421
436
        self.entry_group_state_changed_match = (
422
437
            self.group.connect_to_signal(
423
 
                'StateChanged', self.entry_group_state_changed))
424
 
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
425
 
                     self.name, self.type)
 
438
                "StateChanged", self.entry_group_state_changed))
 
439
        log.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
440
                  self.name, self.type)
426
441
        self.group.AddService(
427
442
            self.interface,
428
443
            self.protocol,
435
450
 
436
451
    def entry_group_state_changed(self, state, error):
437
452
        """Derived from the Avahi example code"""
438
 
        logger.debug("Avahi entry group state change: %i", state)
 
453
        log.debug("Avahi entry group state change: %i", state)
439
454
 
440
455
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
441
 
            logger.debug("Zeroconf service established.")
 
456
            log.debug("Zeroconf service established.")
442
457
        elif state == avahi.ENTRY_GROUP_COLLISION:
443
 
            logger.info("Zeroconf service name collision.")
 
458
            log.info("Zeroconf service name collision.")
444
459
            self.rename()
445
460
        elif state == avahi.ENTRY_GROUP_FAILURE:
446
 
            logger.critical("Avahi: Error in group state changed %s",
447
 
                            str(error))
 
461
            log.critical("Avahi: Error in group state changed %s",
 
462
                         str(error))
448
463
            raise AvahiGroupError("State changed: {!s}".format(error))
449
464
 
450
465
    def cleanup(self):
460
475
 
461
476
    def server_state_changed(self, state, error=None):
462
477
        """Derived from the Avahi example code"""
463
 
        logger.debug("Avahi server state change: %i", state)
 
478
        log.debug("Avahi server state change: %i", state)
464
479
        bad_states = {
465
480
            avahi.SERVER_INVALID: "Zeroconf server invalid",
466
481
            avahi.SERVER_REGISTERING: None,
470
485
        if state in bad_states:
471
486
            if bad_states[state] is not None:
472
487
                if error is None:
473
 
                    logger.error(bad_states[state])
 
488
                    log.error(bad_states[state])
474
489
                else:
475
 
                    logger.error(bad_states[state] + ": %r", error)
 
490
                    log.error(bad_states[state] + ": %r", error)
476
491
            self.cleanup()
477
492
        elif state == avahi.SERVER_RUNNING:
478
493
            try:
480
495
            except dbus.exceptions.DBusException as error:
481
496
                if (error.get_dbus_name()
482
497
                    == "org.freedesktop.Avahi.CollisionError"):
483
 
                    logger.info("Local Zeroconf service name"
484
 
                                " collision.")
 
498
                    log.info("Local Zeroconf service name collision.")
485
499
                    return self.rename(remove=False)
486
500
                else:
487
 
                    logger.critical("D-Bus Exception", exc_info=error)
 
501
                    log.critical("D-Bus Exception", exc_info=error)
488
502
                    self.cleanup()
489
503
                    os._exit(1)
490
504
        else:
491
505
            if error is None:
492
 
                logger.debug("Unknown state: %r", state)
 
506
                log.debug("Unknown state: %r", state)
493
507
            else:
494
 
                logger.debug("Unknown state: %r: %r", state, error)
 
508
                log.debug("Unknown state: %r: %r", state, error)
495
509
 
496
510
    def activate(self):
497
511
        """Derived from the Avahi example code"""
509
523
class AvahiServiceToSyslog(AvahiService):
510
524
    def rename(self, *args, **kwargs):
511
525
        """Add the new name to the syslog messages"""
512
 
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
 
526
        ret = super(AvahiServiceToSyslog, self).rename(*args,
 
527
                                                       **kwargs)
513
528
        syslogger.setFormatter(logging.Formatter(
514
 
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
529
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
515
530
            .format(self.name)))
516
531
        return ret
517
532
 
547
562
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
548
563
 
549
564
    # Types
550
 
    class session_int(ctypes.Structure):
 
565
    class _session_int(ctypes.Structure):
551
566
        _fields_ = []
552
 
    session_t = ctypes.POINTER(session_int)
 
567
    session_t = ctypes.POINTER(_session_int)
553
568
 
554
569
    class certificate_credentials_st(ctypes.Structure):
555
570
        _fields_ = []
558
573
    certificate_type_t = ctypes.c_int
559
574
 
560
575
    class datum_t(ctypes.Structure):
561
 
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
562
 
                    ('size', ctypes.c_uint)]
 
576
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
 
577
                    ("size", ctypes.c_uint)]
563
578
 
564
 
    class openpgp_crt_int(ctypes.Structure):
 
579
    class _openpgp_crt_int(ctypes.Structure):
565
580
        _fields_ = []
566
 
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
581
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
567
582
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
568
583
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
569
584
    credentials_type_t = ctypes.c_int
578
593
            # gnutls.strerror()
579
594
            self.code = code
580
595
            if message is None and code is not None:
581
 
                message = gnutls.strerror(code)
 
596
                message = gnutls.strerror(code).decode(
 
597
                    "utf-8", errors="replace")
582
598
            return super(gnutls.Error, self).__init__(
583
599
                message, *args)
584
600
 
585
601
    class CertificateSecurityError(Error):
586
602
        pass
587
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
 
588
629
    # Classes
589
 
    class Credentials:
 
630
    class Credentials(With_from_param):
590
631
        def __init__(self):
591
 
            self._c_object = gnutls.certificate_credentials_t()
592
 
            gnutls.certificate_allocate_credentials(
593
 
                ctypes.byref(self._c_object))
 
632
            self._as_parameter_ = gnutls.certificate_credentials_t()
 
633
            gnutls.certificate_allocate_credentials(self)
594
634
            self.type = gnutls.CRD_CERTIFICATE
595
635
 
596
636
        def __del__(self):
597
 
            gnutls.certificate_free_credentials(self._c_object)
 
637
            gnutls.certificate_free_credentials(self)
598
638
 
599
 
    class ClientSession:
 
639
    class ClientSession(With_from_param):
600
640
        def __init__(self, socket, credentials=None):
601
 
            self._c_object = gnutls.session_t()
 
641
            self._as_parameter_ = gnutls.session_t()
602
642
            gnutls_flags = gnutls.CLIENT
603
643
            if gnutls.check_version(b"3.5.6"):
604
644
                gnutls_flags |= gnutls.NO_TICKETS
605
645
            if gnutls.has_rawpk:
606
646
                gnutls_flags |= gnutls.ENABLE_RAWPK
607
 
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
 
647
            gnutls.init(self, gnutls_flags)
608
648
            del gnutls_flags
609
 
            gnutls.set_default_priority(self._c_object)
610
 
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
611
 
            gnutls.handshake_set_private_extensions(self._c_object,
612
 
                                                    True)
 
649
            gnutls.set_default_priority(self)
 
650
            gnutls.transport_set_ptr(self, socket.fileno())
 
651
            gnutls.handshake_set_private_extensions(self, True)
613
652
            self.socket = socket
614
653
            if credentials is None:
615
654
                credentials = gnutls.Credentials()
616
 
            gnutls.credentials_set(self._c_object, credentials.type,
617
 
                                   ctypes.cast(credentials._c_object,
618
 
                                               ctypes.c_void_p))
 
655
            gnutls.credentials_set(self, credentials.type,
 
656
                                   credentials)
619
657
            self.credentials = credentials
620
658
 
621
659
        def __del__(self):
622
 
            gnutls.deinit(self._c_object)
 
660
            gnutls.deinit(self)
623
661
 
624
662
        def handshake(self):
625
 
            return gnutls.handshake(self._c_object)
 
663
            return gnutls.handshake(self)
626
664
 
627
665
        def send(self, data):
628
666
            data = bytes(data)
629
667
            data_len = len(data)
630
668
            while data_len > 0:
631
 
                data_len -= gnutls.record_send(self._c_object,
632
 
                                               data[-data_len:],
 
669
                data_len -= gnutls.record_send(self, data[-data_len:],
633
670
                                               data_len)
634
671
 
635
672
        def bye(self):
636
 
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
673
            return gnutls.bye(self, gnutls.SHUT_RDWR)
637
674
 
638
675
    # Error handling functions
639
676
    def _error_code(result):
640
677
        """A function to raise exceptions on errors, suitable
641
 
        for the 'restype' attribute on ctypes functions"""
642
 
        if result >= 0:
 
678
        for the "restype" attribute on ctypes functions"""
 
679
        if result >= gnutls.E_SUCCESS:
643
680
            return result
644
681
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
645
682
            raise gnutls.CertificateSecurityError(code=result)
646
683
        raise gnutls.Error(code=result)
647
684
 
648
 
    def _retry_on_error(result, func, arguments):
 
685
    def _retry_on_error(result, func, arguments,
 
686
                        _error_code=_error_code):
649
687
        """A function to retry on some errors, suitable
650
 
        for the 'errcheck' attribute on ctypes functions"""
651
 
        while result < 0:
 
688
        for the "errcheck" attribute on ctypes functions"""
 
689
        while result < gnutls.E_SUCCESS:
652
690
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
653
691
                return _error_code(result)
654
692
            result = func(*arguments)
659
697
 
660
698
    # Functions
661
699
    priority_set_direct = _library.gnutls_priority_set_direct
662
 
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
700
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
663
701
                                    ctypes.POINTER(ctypes.c_char_p)]
664
702
    priority_set_direct.restype = _error_code
665
703
 
666
704
    init = _library.gnutls_init
667
 
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
705
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
668
706
    init.restype = _error_code
669
707
 
670
708
    set_default_priority = _library.gnutls_set_default_priority
671
 
    set_default_priority.argtypes = [session_t]
 
709
    set_default_priority.argtypes = [ClientSession]
672
710
    set_default_priority.restype = _error_code
673
711
 
674
712
    record_send = _library.gnutls_record_send
675
 
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
713
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
676
714
                            ctypes.c_size_t]
677
715
    record_send.restype = ctypes.c_ssize_t
678
716
    record_send.errcheck = _retry_on_error
680
718
    certificate_allocate_credentials = (
681
719
        _library.gnutls_certificate_allocate_credentials)
682
720
    certificate_allocate_credentials.argtypes = [
683
 
        ctypes.POINTER(certificate_credentials_t)]
 
721
        PointerTo(Credentials)]
684
722
    certificate_allocate_credentials.restype = _error_code
685
723
 
686
724
    certificate_free_credentials = (
687
725
        _library.gnutls_certificate_free_credentials)
688
 
    certificate_free_credentials.argtypes = [
689
 
        certificate_credentials_t]
 
726
    certificate_free_credentials.argtypes = [Credentials]
690
727
    certificate_free_credentials.restype = None
691
728
 
692
729
    handshake_set_private_extensions = (
693
730
        _library.gnutls_handshake_set_private_extensions)
694
 
    handshake_set_private_extensions.argtypes = [session_t,
 
731
    handshake_set_private_extensions.argtypes = [ClientSession,
695
732
                                                 ctypes.c_int]
696
733
    handshake_set_private_extensions.restype = None
697
734
 
698
735
    credentials_set = _library.gnutls_credentials_set
699
 
    credentials_set.argtypes = [session_t, credentials_type_t,
700
 
                                ctypes.c_void_p]
 
736
    credentials_set.argtypes = [ClientSession, credentials_type_t,
 
737
                                CastToVoidPointer(Credentials)]
701
738
    credentials_set.restype = _error_code
702
739
 
703
740
    strerror = _library.gnutls_strerror
705
742
    strerror.restype = ctypes.c_char_p
706
743
 
707
744
    certificate_type_get = _library.gnutls_certificate_type_get
708
 
    certificate_type_get.argtypes = [session_t]
 
745
    certificate_type_get.argtypes = [ClientSession]
709
746
    certificate_type_get.restype = _error_code
710
747
 
711
748
    certificate_get_peers = _library.gnutls_certificate_get_peers
712
 
    certificate_get_peers.argtypes = [session_t,
 
749
    certificate_get_peers.argtypes = [ClientSession,
713
750
                                      ctypes.POINTER(ctypes.c_uint)]
714
751
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
715
752
 
722
759
    global_set_log_function.restype = None
723
760
 
724
761
    deinit = _library.gnutls_deinit
725
 
    deinit.argtypes = [session_t]
 
762
    deinit.argtypes = [ClientSession]
726
763
    deinit.restype = None
727
764
 
728
765
    handshake = _library.gnutls_handshake
729
 
    handshake.argtypes = [session_t]
730
 
    handshake.restype = _error_code
 
766
    handshake.argtypes = [ClientSession]
 
767
    handshake.restype = ctypes.c_int
731
768
    handshake.errcheck = _retry_on_error
732
769
 
733
770
    transport_set_ptr = _library.gnutls_transport_set_ptr
734
 
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
771
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
735
772
    transport_set_ptr.restype = None
736
773
 
737
774
    bye = _library.gnutls_bye
738
 
    bye.argtypes = [session_t, close_request_t]
739
 
    bye.restype = _error_code
 
775
    bye.argtypes = [ClientSession, close_request_t]
 
776
    bye.restype = ctypes.c_int
740
777
    bye.errcheck = _retry_on_error
741
778
 
742
779
    check_version = _library.gnutls_check_version
759
796
 
760
797
        x509_crt_fmt_t = ctypes.c_int
761
798
 
762
 
        # All the function declarations below are from gnutls/abstract.h
 
799
        # All the function declarations below are from
 
800
        # gnutls/abstract.h
763
801
        pubkey_init = _library.gnutls_pubkey_init
764
802
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
765
803
        pubkey_init.restype = _error_code
779
817
        pubkey_deinit.argtypes = [pubkey_t]
780
818
        pubkey_deinit.restype = None
781
819
    else:
782
 
        # All the function declarations below are from gnutls/openpgp.h
 
820
        # All the function declarations below are from
 
821
        # gnutls/openpgp.h
783
822
 
784
823
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
785
824
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
791
830
                                       openpgp_crt_fmt_t]
792
831
        openpgp_crt_import.restype = _error_code
793
832
 
794
 
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
795
 
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
796
 
                                            ctypes.POINTER(ctypes.c_uint)]
 
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
        ]
797
840
        openpgp_crt_verify_self.restype = _error_code
798
841
 
799
842
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
810
853
 
811
854
    if check_version(b"3.6.4"):
812
855
        certificate_type_get2 = _library.gnutls_certificate_type_get2
813
 
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
 
856
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
814
857
        certificate_type_get2.restype = _error_code
815
858
 
816
859
    # Remove non-public functions
832
875
    """A representation of a client host served by this server.
833
876
 
834
877
    Attributes:
835
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
878
    approved:   bool(); None if not yet approved/disapproved
836
879
    approval_delay: datetime.timedelta(); Time to wait for approval
837
880
    approval_duration: datetime.timedelta(); Duration of one approval
838
881
    checker: multiprocessing.Process(); a running checker process used
839
 
             to see if the client lives. 'None' if no process is
 
882
             to see if the client lives. None if no process is
840
883
             running.
841
884
    checker_callback_tag: a GLib event source tag, or None
842
885
    checker_command: string; External command which is run to check
966
1009
            self.last_enabled = None
967
1010
            self.expires = None
968
1011
 
969
 
        logger.debug("Creating client %r", self.name)
970
 
        logger.debug("  Key ID: %s", self.key_id)
971
 
        logger.debug("  Fingerprint: %s", self.fingerprint)
 
1012
        log.debug("Creating client %r", self.name)
 
1013
        log.debug("  Key ID: %s", self.key_id)
 
1014
        log.debug("  Fingerprint: %s", self.fingerprint)
972
1015
        self.created = settings.get("created",
973
1016
                                    datetime.datetime.utcnow())
974
1017
 
1013
1056
        if not getattr(self, "enabled", False):
1014
1057
            return False
1015
1058
        if not quiet:
1016
 
            logger.info("Disabling client %s", self.name)
 
1059
            log.info("Disabling client %s", self.name)
1017
1060
        if getattr(self, "disable_initiator_tag", None) is not None:
1018
1061
            GLib.source_remove(self.disable_initiator_tag)
1019
1062
            self.disable_initiator_tag = None
1037
1080
        if self.checker_initiator_tag is not None:
1038
1081
            GLib.source_remove(self.checker_initiator_tag)
1039
1082
        self.checker_initiator_tag = GLib.timeout_add(
1040
 
            int(self.interval.total_seconds() * 1000),
 
1083
            random.randrange(int(self.interval.total_seconds() * 1000
 
1084
                                 + 1)),
1041
1085
            self.start_checker)
1042
1086
        # Schedule a disable() when 'timeout' has passed
1043
1087
        if self.disable_initiator_tag is not None:
1062
1106
            self.last_checker_status = returncode
1063
1107
            self.last_checker_signal = None
1064
1108
            if self.last_checker_status == 0:
1065
 
                logger.info("Checker for %(name)s succeeded",
1066
 
                            vars(self))
 
1109
                log.info("Checker for %(name)s succeeded", vars(self))
1067
1110
                self.checked_ok()
1068
1111
            else:
1069
 
                logger.info("Checker for %(name)s failed", vars(self))
 
1112
                log.info("Checker for %(name)s failed", vars(self))
1070
1113
        else:
1071
1114
            self.last_checker_status = -1
1072
1115
            self.last_checker_signal = -returncode
1073
 
            logger.warning("Checker for %(name)s crashed?",
1074
 
                           vars(self))
 
1116
            log.warning("Checker for %(name)s crashed?", vars(self))
1075
1117
        return False
1076
1118
 
1077
1119
    def checked_ok(self):
1111
1153
        # should be.
1112
1154
 
1113
1155
        if self.checker is not None and not self.checker.is_alive():
1114
 
            logger.warning("Checker was not alive; joining")
 
1156
            log.warning("Checker was not alive; joining")
1115
1157
            self.checker.join()
1116
1158
            self.checker = None
1117
1159
        # Start a new checker if needed
1118
1160
        if self.checker is None:
1119
1161
            # Escape attributes for the shell
1120
1162
            escaped_attrs = {
1121
 
                attr: re.escape(str(getattr(self, attr)))
 
1163
                attr: shlex.quote(str(getattr(self, attr)))
1122
1164
                for attr in self.runtime_expansions}
1123
1165
            try:
1124
1166
                command = self.checker_command % escaped_attrs
1125
1167
            except TypeError as error:
1126
 
                logger.error('Could not format string "%s"',
1127
 
                             self.checker_command,
1128
 
                             exc_info=error)
 
1168
                log.error('Could not format string "%s"',
 
1169
                          self.checker_command, exc_info=error)
1129
1170
                return True     # Try again later
1130
1171
            self.current_checker_command = command
1131
 
            logger.info("Starting checker %r for %s", command,
1132
 
                        self.name)
 
1172
            log.info("Starting checker %r for %s", command, self.name)
1133
1173
            # We don't need to redirect stdout and stderr, since
1134
1174
            # in normal mode, that is already done by daemon(),
1135
1175
            # and in debug mode we don't want to.  (Stdin is
1164
1204
            self.checker_callback_tag = None
1165
1205
        if getattr(self, "checker", None) is None:
1166
1206
            return
1167
 
        logger.debug("Stopping checker for %(name)s", vars(self))
 
1207
        log.debug("Stopping checker for %(name)s", vars(self))
1168
1208
        self.checker.terminate()
1169
1209
        self.checker = None
1170
1210
 
1197
1237
        func._dbus_name = func.__name__
1198
1238
        if func._dbus_name.endswith("_dbus_property"):
1199
1239
            func._dbus_name = func._dbus_name[:-14]
1200
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
 
1240
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
1201
1241
        return func
1202
1242
 
1203
1243
    return decorator
1292
1332
 
1293
1333
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1294
1334
                         out_signature="s",
1295
 
                         path_keyword='object_path',
1296
 
                         connection_keyword='connection')
 
1335
                         path_keyword="object_path",
 
1336
                         connection_keyword="connection")
1297
1337
    def Introspect(self, object_path, connection):
1298
1338
        """Overloading of standard D-Bus method.
1299
1339
 
1348
1388
            document.unlink()
1349
1389
        except (AttributeError, xml.dom.DOMException,
1350
1390
                xml.parsers.expat.ExpatError) as error:
1351
 
            logger.error("Failed to override Introspection method",
1352
 
                         exc_info=error)
 
1391
            log.error("Failed to override Introspection method",
 
1392
                      exc_info=error)
1353
1393
        return xmlstring
1354
1394
 
1355
1395
 
1413
1453
                raise ValueError("Byte arrays not supported for non-"
1414
1454
                                 "'ay' signature {!r}"
1415
1455
                                 .format(prop._dbus_signature))
1416
 
            value = dbus.ByteArray(b''.join(chr(byte)
1417
 
                                            for byte in value))
 
1456
            value = dbus.ByteArray(bytes(value))
1418
1457
        prop(value)
1419
1458
 
1420
1459
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1453
1492
 
1454
1493
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1455
1494
                         out_signature="s",
1456
 
                         path_keyword='object_path',
1457
 
                         connection_keyword='connection')
 
1495
                         path_keyword="object_path",
 
1496
                         connection_keyword="connection")
1458
1497
    def Introspect(self, object_path, connection):
1459
1498
        """Overloading of standard D-Bus method.
1460
1499
 
1516
1555
            document.unlink()
1517
1556
        except (AttributeError, xml.dom.DOMException,
1518
1557
                xml.parsers.expat.ExpatError) as error:
1519
 
            logger.error("Failed to override Introspection method",
1520
 
                         exc_info=error)
 
1558
            log.error("Failed to override Introspection method",
 
1559
                      exc_info=error)
1521
1560
        return xmlstring
1522
1561
 
1523
1562
 
1555
1594
 
1556
1595
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1557
1596
                         out_signature="s",
1558
 
                         path_keyword='object_path',
1559
 
                         connection_keyword='connection')
 
1597
                         path_keyword="object_path",
 
1598
                         connection_keyword="connection")
1560
1599
    def Introspect(self, object_path, connection):
1561
1600
        """Overloading of standard D-Bus method.
1562
1601
 
1587
1626
            document.unlink()
1588
1627
        except (AttributeError, xml.dom.DOMException,
1589
1628
                xml.parsers.expat.ExpatError) as error:
1590
 
            logger.error("Failed to override Introspection method",
1591
 
                         exc_info=error)
 
1629
            log.error("Failed to override Introspection method",
 
1630
                      exc_info=error)
1592
1631
        return xmlstring
1593
1632
 
1594
1633
 
2228
2267
class ProxyClient:
2229
2268
    def __init__(self, child_pipe, key_id, fpr, address):
2230
2269
        self._pipe = child_pipe
2231
 
        self._pipe.send(('init', key_id, fpr, address))
 
2270
        self._pipe.send(("init", key_id, fpr, address))
2232
2271
        if not self._pipe.recv():
2233
2272
            raise KeyError(key_id or fpr)
2234
2273
 
2235
2274
    def __getattribute__(self, name):
2236
 
        if name == '_pipe':
 
2275
        if name == "_pipe":
2237
2276
            return super(ProxyClient, self).__getattribute__(name)
2238
 
        self._pipe.send(('getattr', name))
 
2277
        self._pipe.send(("getattr", name))
2239
2278
        data = self._pipe.recv()
2240
 
        if data[0] == 'data':
 
2279
        if data[0] == "data":
2241
2280
            return data[1]
2242
 
        if data[0] == 'function':
 
2281
        if data[0] == "function":
2243
2282
 
2244
2283
            def func(*args, **kwargs):
2245
 
                self._pipe.send(('funcall', name, args, kwargs))
 
2284
                self._pipe.send(("funcall", name, args, kwargs))
2246
2285
                return self._pipe.recv()[1]
2247
2286
 
2248
2287
            return func
2249
2288
 
2250
2289
    def __setattr__(self, name, value):
2251
 
        if name == '_pipe':
 
2290
        if name == "_pipe":
2252
2291
            return super(ProxyClient, self).__setattr__(name, value)
2253
 
        self._pipe.send(('setattr', name, value))
 
2292
        self._pipe.send(("setattr", name, value))
2254
2293
 
2255
2294
 
2256
2295
class ClientHandler(socketserver.BaseRequestHandler, object):
2261
2300
 
2262
2301
    def handle(self):
2263
2302
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2264
 
            logger.info("TCP connection from: %s",
2265
 
                        str(self.client_address))
2266
 
            logger.debug("Pipe FD: %d",
2267
 
                         self.server.child_pipe.fileno())
 
2303
            log.info("TCP connection from: %s",
 
2304
                     str(self.client_address))
 
2305
            log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
2268
2306
 
2269
2307
            session = gnutls.ClientSession(self.request)
2270
2308
 
2271
 
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
2309
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
2272
2310
            #                       "+AES-256-CBC", "+SHA1",
2273
2311
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2274
2312
            #                       "+DHE-DSS"))
2276
2314
            priority = self.server.gnutls_priority
2277
2315
            if priority is None:
2278
2316
                priority = "NORMAL"
2279
 
            gnutls.priority_set_direct(session._c_object,
2280
 
                                       priority.encode("utf-8"),
2281
 
                                       None)
 
2317
            gnutls.priority_set_direct(session,
 
2318
                                       priority.encode("utf-8"), None)
2282
2319
 
2283
2320
            # Start communication using the Mandos protocol
2284
2321
            # Get protocol number
2285
2322
            line = self.request.makefile().readline()
2286
 
            logger.debug("Protocol version: %r", line)
 
2323
            log.debug("Protocol version: %r", line)
2287
2324
            try:
2288
2325
                if int(line.strip().split()[0]) > 1:
2289
2326
                    raise RuntimeError(line)
2290
2327
            except (ValueError, IndexError, RuntimeError) as error:
2291
 
                logger.error("Unknown protocol version: %s", error)
 
2328
                log.error("Unknown protocol version: %s", error)
2292
2329
                return
2293
2330
 
2294
2331
            # Start GnuTLS connection
2295
2332
            try:
2296
2333
                session.handshake()
2297
2334
            except gnutls.Error as error:
2298
 
                logger.warning("Handshake failed: %s", error)
 
2335
                log.warning("Handshake failed: %s", error)
2299
2336
                # Do not run session.bye() here: the session is not
2300
2337
                # established.  Just abandon the request.
2301
2338
                return
2302
 
            logger.debug("Handshake succeeded")
 
2339
            log.debug("Handshake succeeded")
2303
2340
 
2304
2341
            approval_required = False
2305
2342
            try:
2309
2346
                        key_id = self.key_id(
2310
2347
                            self.peer_certificate(session))
2311
2348
                    except (TypeError, gnutls.Error) as error:
2312
 
                        logger.warning("Bad certificate: %s", error)
 
2349
                        log.warning("Bad certificate: %s", error)
2313
2350
                        return
2314
 
                    logger.debug("Key ID: %s", key_id)
 
2351
                    log.debug("Key ID: %s",
 
2352
                              key_id.decode("utf-8",
 
2353
                                            errors="replace"))
2315
2354
 
2316
2355
                else:
2317
2356
                    key_id = b""
2319
2358
                        fpr = self.fingerprint(
2320
2359
                            self.peer_certificate(session))
2321
2360
                    except (TypeError, gnutls.Error) as error:
2322
 
                        logger.warning("Bad certificate: %s", error)
 
2361
                        log.warning("Bad certificate: %s", error)
2323
2362
                        return
2324
 
                    logger.debug("Fingerprint: %s", fpr)
 
2363
                    log.debug("Fingerprint: %s", fpr)
2325
2364
 
2326
2365
                try:
2327
2366
                    client = ProxyClient(child_pipe, key_id, fpr,
2336
2375
 
2337
2376
                while True:
2338
2377
                    if not client.enabled:
2339
 
                        logger.info("Client %s is disabled",
2340
 
                                    client.name)
 
2378
                        log.info("Client %s is disabled", client.name)
2341
2379
                        if self.server.use_dbus:
2342
2380
                            # Emit D-Bus signal
2343
2381
                            client.Rejected("Disabled")
2347
2385
                        # We are approved or approval is disabled
2348
2386
                        break
2349
2387
                    elif client.approved is None:
2350
 
                        logger.info("Client %s needs approval",
2351
 
                                    client.name)
 
2388
                        log.info("Client %s needs approval",
 
2389
                                 client.name)
2352
2390
                        if self.server.use_dbus:
2353
2391
                            # Emit D-Bus signal
2354
2392
                            client.NeedApproval(
2355
2393
                                client.approval_delay.total_seconds()
2356
2394
                                * 1000, client.approved_by_default)
2357
2395
                    else:
2358
 
                        logger.warning("Client %s was not approved",
2359
 
                                       client.name)
 
2396
                        log.warning("Client %s was not approved",
 
2397
                                    client.name)
2360
2398
                        if self.server.use_dbus:
2361
2399
                            # Emit D-Bus signal
2362
2400
                            client.Rejected("Denied")
2370
2408
                    time2 = datetime.datetime.now()
2371
2409
                    if (time2 - time) >= delay:
2372
2410
                        if not client.approved_by_default:
2373
 
                            logger.warning("Client %s timed out while"
2374
 
                                           " waiting for approval",
2375
 
                                           client.name)
 
2411
                            log.warning("Client %s timed out while"
 
2412
                                        " waiting for approval",
 
2413
                                        client.name)
2376
2414
                            if self.server.use_dbus:
2377
2415
                                # Emit D-Bus signal
2378
2416
                                client.Rejected("Approval timed out")
2385
2423
                try:
2386
2424
                    session.send(client.secret)
2387
2425
                except gnutls.Error as error:
2388
 
                    logger.warning("gnutls send failed",
2389
 
                                   exc_info=error)
 
2426
                    log.warning("gnutls send failed", exc_info=error)
2390
2427
                    return
2391
2428
 
2392
 
                logger.info("Sending secret to %s", client.name)
 
2429
                log.info("Sending secret to %s", client.name)
2393
2430
                # bump the timeout using extended_timeout
2394
2431
                client.bump_timeout(client.extended_timeout)
2395
2432
                if self.server.use_dbus:
2402
2439
                try:
2403
2440
                    session.bye()
2404
2441
                except gnutls.Error as error:
2405
 
                    logger.warning("GnuTLS bye failed",
2406
 
                                   exc_info=error)
 
2442
                    log.warning("GnuTLS bye failed", exc_info=error)
2407
2443
 
2408
2444
    @staticmethod
2409
2445
    def peer_certificate(session):
2410
2446
        "Return the peer's certificate as a bytestring"
2411
2447
        try:
2412
 
            cert_type = gnutls.certificate_type_get2(session._c_object,
2413
 
                                                     gnutls.CTYPE_PEERS)
 
2448
            cert_type = gnutls.certificate_type_get2(
 
2449
                session, gnutls.CTYPE_PEERS)
2414
2450
        except AttributeError:
2415
 
            cert_type = gnutls.certificate_type_get(session._c_object)
 
2451
            cert_type = gnutls.certificate_type_get(session)
2416
2452
        if gnutls.has_rawpk:
2417
2453
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2418
2454
        else:
2419
2455
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2420
2456
        # If not a valid certificate type...
2421
2457
        if cert_type not in valid_cert_types:
2422
 
            logger.info("Cert type %r not in %r", cert_type,
2423
 
                        valid_cert_types)
 
2458
            log.info("Cert type %r not in %r", cert_type,
 
2459
                     valid_cert_types)
2424
2460
            # ...return invalid data
2425
2461
            return b""
2426
2462
        list_size = ctypes.c_uint(1)
2427
2463
        cert_list = (gnutls.certificate_get_peers
2428
 
                     (session._c_object, ctypes.byref(list_size)))
 
2464
                     (session, ctypes.byref(list_size)))
2429
2465
        if not bool(cert_list) and list_size.value != 0:
2430
2466
            raise gnutls.Error("error getting peer certificate")
2431
2467
        if list_size.value == 0:
2453
2489
        buf = ctypes.create_string_buffer(32)
2454
2490
        buf_len = ctypes.c_size_t(len(buf))
2455
2491
        # Get the key ID from the raw public key into the buffer
2456
 
        gnutls.pubkey_get_key_id(pubkey,
2457
 
                                 gnutls.KEYID_USE_SHA256,
2458
 
                                 ctypes.cast(ctypes.byref(buf),
2459
 
                                             ctypes.POINTER(ctypes.c_ubyte)),
2460
 
                                 ctypes.byref(buf_len))
 
2492
        gnutls.pubkey_get_key_id(
 
2493
            pubkey,
 
2494
            gnutls.KEYID_USE_SHA256,
 
2495
            ctypes.cast(ctypes.byref(buf),
 
2496
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2497
            ctypes.byref(buf_len))
2461
2498
        # Deinit the certificate
2462
2499
        gnutls.pubkey_deinit(pubkey)
2463
2500
 
2544
2581
 
2545
2582
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2546
2583
                     socketserver.TCPServer):
2547
 
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
 
2584
    """IPv6-capable TCP server.  Accepts None as address and/or port
2548
2585
 
2549
2586
    Attributes:
2550
2587
        enabled:        Boolean; whether this server is activated yet
2601
2638
            if SO_BINDTODEVICE is None:
2602
2639
                # Fall back to a hard-coded value which seems to be
2603
2640
                # common enough.
2604
 
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
2641
                log.warning("SO_BINDTODEVICE not found, trying 25")
2605
2642
                SO_BINDTODEVICE = 25
2606
2643
            try:
2607
2644
                self.socket.setsockopt(
2609
2646
                    (self.interface + "\0").encode("utf-8"))
2610
2647
            except socket.error as error:
2611
2648
                if error.errno == errno.EPERM:
2612
 
                    logger.error("No permission to bind to"
2613
 
                                 " interface %s", self.interface)
 
2649
                    log.error("No permission to bind to interface %s",
 
2650
                              self.interface)
2614
2651
                elif error.errno == errno.ENOPROTOOPT:
2615
 
                    logger.error("SO_BINDTODEVICE not available;"
2616
 
                                 " cannot bind to interface %s",
2617
 
                                 self.interface)
 
2652
                    log.error("SO_BINDTODEVICE not available; cannot"
 
2653
                              " bind to interface %s", self.interface)
2618
2654
                elif error.errno == errno.ENODEV:
2619
 
                    logger.error("Interface %s does not exist,"
2620
 
                                 " cannot bind", self.interface)
 
2655
                    log.error("Interface %s does not exist, cannot"
 
2656
                              " bind", self.interface)
2621
2657
                else:
2622
2658
                    raise
2623
2659
        # Only bind(2) the socket if we really need to.
2702
2738
        request = parent_pipe.recv()
2703
2739
        command = request[0]
2704
2740
 
2705
 
        if command == 'init':
 
2741
        if command == "init":
2706
2742
            key_id = request[1].decode("ascii")
2707
2743
            fpr = request[2].decode("ascii")
2708
2744
            address = request[3]
2709
2745
 
2710
2746
            for c in self.clients.values():
2711
 
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
 
2747
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
 
2748
                              "27AE41E4649B934CA495991B7852B855"):
2712
2749
                    continue
2713
2750
                if key_id and c.key_id == key_id:
2714
2751
                    client = c
2717
2754
                    client = c
2718
2755
                    break
2719
2756
            else:
2720
 
                logger.info("Client not found for key ID: %s, address"
2721
 
                            ": %s", key_id or fpr, address)
 
2757
                log.info("Client not found for key ID: %s, address:"
 
2758
                         " %s", key_id or fpr, address)
2722
2759
                if self.use_dbus:
2723
2760
                    # Emit D-Bus signal
2724
2761
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2737
2774
            # remove the old hook in favor of the new above hook on
2738
2775
            # same fileno
2739
2776
            return False
2740
 
        if command == 'funcall':
 
2777
        if command == "funcall":
2741
2778
            funcname = request[1]
2742
2779
            args = request[2]
2743
2780
            kwargs = request[3]
2744
2781
 
2745
 
            parent_pipe.send(('data', getattr(client_object,
 
2782
            parent_pipe.send(("data", getattr(client_object,
2746
2783
                                              funcname)(*args,
2747
2784
                                                        **kwargs)))
2748
2785
 
2749
 
        if command == 'getattr':
 
2786
        if command == "getattr":
2750
2787
            attrname = request[1]
2751
2788
            if isinstance(client_object.__getattribute__(attrname),
2752
 
                          collections.Callable):
2753
 
                parent_pipe.send(('function', ))
 
2789
                          collections.abc.Callable):
 
2790
                parent_pipe.send(("function", ))
2754
2791
            else:
2755
2792
                parent_pipe.send((
2756
 
                    'data', client_object.__getattribute__(attrname)))
 
2793
                    "data", client_object.__getattribute__(attrname)))
2757
2794
 
2758
 
        if command == 'setattr':
 
2795
        if command == "setattr":
2759
2796
            attrname = request[1]
2760
2797
            value = request[2]
2761
2798
            setattr(client_object, attrname, value)
2766
2803
def rfc3339_duration_to_delta(duration):
2767
2804
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2768
2805
 
2769
 
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
2770
 
    True
2771
 
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
2772
 
    True
2773
 
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
2774
 
    True
2775
 
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
2776
 
    True
2777
 
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
2778
 
    True
2779
 
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
2780
 
    True
2781
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
2782
 
    True
 
2806
    >>> timedelta = datetime.timedelta
 
2807
    >>> rfc3339_duration_to_delta("P7D") == timedelta(7)
 
2808
    True
 
2809
    >>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
 
2810
    True
 
2811
    >>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
 
2812
    True
 
2813
    >>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
 
2814
    True
 
2815
    >>> rfc3339_duration_to_delta("P1W") == timedelta(7)
 
2816
    True
 
2817
    >>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
 
2818
    True
 
2819
    >>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
 
2820
    True
 
2821
    >>> del timedelta
2783
2822
    """
2784
2823
 
2785
2824
    # Parsing an RFC 3339 duration with regular expressions is not
2865
2904
def string_to_delta(interval):
2866
2905
    """Parse a string and return a datetime.timedelta
2867
2906
 
2868
 
    >>> string_to_delta('7d') == datetime.timedelta(7)
2869
 
    True
2870
 
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
2871
 
    True
2872
 
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2873
 
    True
2874
 
    >>> string_to_delta('24h') == datetime.timedelta(1)
2875
 
    True
2876
 
    >>> string_to_delta('1w') == datetime.timedelta(7)
2877
 
    True
2878
 
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
 
2907
    >>> string_to_delta("7d") == datetime.timedelta(7)
 
2908
    True
 
2909
    >>> string_to_delta("60s") == datetime.timedelta(0, 60)
 
2910
    True
 
2911
    >>> string_to_delta("60m") == datetime.timedelta(0, 3600)
 
2912
    True
 
2913
    >>> string_to_delta("24h") == datetime.timedelta(1)
 
2914
    True
 
2915
    >>> string_to_delta("1w") == datetime.timedelta(7)
 
2916
    True
 
2917
    >>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
2879
2918
    True
2880
2919
    """
2881
2920
 
3085
3124
 
3086
3125
    if server_settings["servicename"] != "Mandos":
3087
3126
        syslogger.setFormatter(
3088
 
            logging.Formatter('Mandos ({}) [%(process)d]:'
3089
 
                              ' %(levelname)s: %(message)s'.format(
 
3127
            logging.Formatter("Mandos ({}) [%(process)d]:"
 
3128
                              " %(levelname)s: %(message)s".format(
3090
3129
                                  server_settings["servicename"])))
3091
3130
 
3092
3131
    # Parse config file with clients
3116
3155
        try:
3117
3156
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3118
3157
        except IOError as e:
3119
 
            logger.error("Could not open file %r", pidfilename,
3120
 
                         exc_info=e)
 
3158
            log.error("Could not open file %r", pidfilename,
 
3159
                      exc_info=e)
3121
3160
 
3122
3161
    for name, group in (("_mandos", "_mandos"),
3123
3162
                        ("mandos", "mandos"),
3134
3173
    try:
3135
3174
        os.setgid(gid)
3136
3175
        os.setuid(uid)
3137
 
        if debug:
3138
 
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
3139
 
                                                             gid))
 
3176
        log.debug("Did setuid/setgid to %s:%s", uid, gid)
3140
3177
    except OSError as error:
3141
 
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
3142
 
                       .format(uid, gid, os.strerror(error.errno)))
 
3178
        log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
 
3179
                    os.strerror(error.errno))
3143
3180
        if error.errno != errno.EPERM:
3144
3181
            raise
3145
3182
 
3152
3189
 
3153
3190
        @gnutls.log_func
3154
3191
        def debug_gnutls(level, string):
3155
 
            logger.debug("GnuTLS: %s", string[:-1])
 
3192
            log.debug("GnuTLS: %s",
 
3193
                      string[:-1].decode("utf-8", errors="replace"))
3156
3194
 
3157
3195
        gnutls.global_set_log_function(debug_gnutls)
3158
3196
 
3187
3225
                "se.bsnet.fukt.Mandos", bus,
3188
3226
                do_not_queue=True)
3189
3227
        except dbus.exceptions.DBusException as e:
3190
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
3228
            log.error("Disabling D-Bus:", exc_info=e)
3191
3229
            use_dbus = False
3192
3230
            server_settings["use_dbus"] = False
3193
3231
            tcp_server.use_dbus = False
3278
3316
            os.remove(stored_state_path)
3279
3317
        except IOError as e:
3280
3318
            if e.errno == errno.ENOENT:
3281
 
                logger.warning("Could not load persistent state:"
3282
 
                               " {}".format(os.strerror(e.errno)))
 
3319
                log.warning("Could not load persistent state:"
 
3320
                            " %s", os.strerror(e.errno))
3283
3321
            else:
3284
 
                logger.critical("Could not load persistent state:",
3285
 
                                exc_info=e)
 
3322
                log.critical("Could not load persistent state:",
 
3323
                             exc_info=e)
3286
3324
                raise
3287
3325
        except EOFError as e:
3288
 
            logger.warning("Could not load persistent state: "
3289
 
                           "EOFError:",
3290
 
                           exc_info=e)
 
3326
            log.warning("Could not load persistent state: EOFError:",
 
3327
                        exc_info=e)
3291
3328
 
3292
3329
    with PGPEngine() as pgp:
3293
3330
        for client_name, client in clients_data.items():
3320
3357
            if client["enabled"]:
3321
3358
                if datetime.datetime.utcnow() >= client["expires"]:
3322
3359
                    if not client["last_checked_ok"]:
3323
 
                        logger.warning(
3324
 
                            "disabling client {} - Client never "
3325
 
                            "performed a successful checker".format(
3326
 
                                client_name))
 
3360
                        log.warning("disabling client %s - Client"
 
3361
                                    " never performed a successful"
 
3362
                                    " checker", client_name)
3327
3363
                        client["enabled"] = False
3328
3364
                    elif client["last_checker_status"] != 0:
3329
 
                        logger.warning(
3330
 
                            "disabling client {} - Client last"
3331
 
                            " checker failed with error code"
3332
 
                            " {}".format(
3333
 
                                client_name,
3334
 
                                client["last_checker_status"]))
 
3365
                        log.warning("disabling client %s - Client"
 
3366
                                    " last checker failed with error"
 
3367
                                    " code %s", client_name,
 
3368
                                    client["last_checker_status"])
3335
3369
                        client["enabled"] = False
3336
3370
                    else:
3337
3371
                        client["expires"] = (
3338
3372
                            datetime.datetime.utcnow()
3339
3373
                            + client["timeout"])
3340
 
                        logger.debug("Last checker succeeded,"
3341
 
                                     " keeping {} enabled".format(
3342
 
                                         client_name))
 
3374
                        log.debug("Last checker succeeded, keeping %s"
 
3375
                                  " enabled", client_name)
3343
3376
            try:
3344
3377
                client["secret"] = pgp.decrypt(
3345
3378
                    client["encrypted_secret"],
3346
3379
                    client_settings[client_name]["secret"])
3347
3380
            except PGPError:
3348
3381
                # If decryption fails, we use secret from new settings
3349
 
                logger.debug("Failed to decrypt {} old secret".format(
3350
 
                    client_name))
 
3382
                log.debug("Failed to decrypt %s old secret",
 
3383
                          client_name)
3351
3384
                client["secret"] = (client_settings[client_name]
3352
3385
                                    ["secret"])
3353
3386
 
3367
3400
            server_settings=server_settings)
3368
3401
 
3369
3402
    if not tcp_server.clients:
3370
 
        logger.warning("No clients defined")
 
3403
        log.warning("No clients defined")
3371
3404
 
3372
3405
    if not foreground:
3373
3406
        if pidfile is not None:
3376
3409
                with pidfile:
3377
3410
                    print(pid, file=pidfile)
3378
3411
            except IOError:
3379
 
                logger.error("Could not write to file %r with PID %d",
3380
 
                             pidfilename, pid)
 
3412
                log.error("Could not write to file %r with PID %d",
 
3413
                          pidfilename, pid)
3381
3414
        del pidfile
3382
3415
        del pidfilename
3383
3416
 
3533
3566
 
3534
3567
        try:
3535
3568
            with tempfile.NamedTemporaryFile(
3536
 
                    mode='wb',
 
3569
                    mode="wb",
3537
3570
                    suffix=".pickle",
3538
 
                    prefix='clients-',
 
3571
                    prefix="clients-",
3539
3572
                    dir=os.path.dirname(stored_state_path),
3540
3573
                    delete=False) as stored_state:
3541
3574
                pickle.dump((clients, client_settings), stored_state,
3549
3582
                except NameError:
3550
3583
                    pass
3551
3584
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3552
 
                logger.warning("Could not save persistent state: {}"
3553
 
                               .format(os.strerror(e.errno)))
 
3585
                log.warning("Could not save persistent state: %s",
 
3586
                            os.strerror(e.errno))
3554
3587
            else:
3555
 
                logger.warning("Could not save persistent state:",
3556
 
                               exc_info=e)
 
3588
                log.warning("Could not save persistent state:",
 
3589
                            exc_info=e)
3557
3590
                raise
3558
3591
 
3559
3592
        # Delete all clients, and settings from config
3585
3618
    if zeroconf:
3586
3619
        service.port = tcp_server.socket.getsockname()[1]
3587
3620
    if use_ipv6:
3588
 
        logger.info("Now listening on address %r, port %d,"
3589
 
                    " flowinfo %d, scope_id %d",
3590
 
                    *tcp_server.socket.getsockname())
 
3621
        log.info("Now listening on address %r, port %d, flowinfo %d,"
 
3622
                 " scope_id %d", *tcp_server.socket.getsockname())
3591
3623
    else:                       # IPv4
3592
 
        logger.info("Now listening on address %r, port %d",
3593
 
                    *tcp_server.socket.getsockname())
 
3624
        log.info("Now listening on address %r, port %d",
 
3625
                 *tcp_server.socket.getsockname())
3594
3626
 
3595
3627
    # service.interface = tcp_server.socket.getsockname()[3]
3596
3628
 
3600
3632
            try:
3601
3633
                service.activate()
3602
3634
            except dbus.exceptions.DBusException as error:
3603
 
                logger.critical("D-Bus Exception", exc_info=error)
 
3635
                log.critical("D-Bus Exception", exc_info=error)
3604
3636
                cleanup()
3605
3637
                sys.exit(1)
3606
3638
            # End of Avahi example code
3611
3643
            lambda *args, **kwargs: (tcp_server.handle_request
3612
3644
                                     (*args[2:], **kwargs) or True))
3613
3645
 
3614
 
        logger.debug("Starting main loop")
 
3646
        log.debug("Starting main loop")
3615
3647
        main_loop.run()
3616
3648
    except AvahiError as error:
3617
 
        logger.critical("Avahi Error", exc_info=error)
 
3649
        log.critical("Avahi Error", exc_info=error)
3618
3650
        cleanup()
3619
3651
        sys.exit(1)
3620
3652
    except KeyboardInterrupt:
3621
3653
        if debug:
3622
3654
            print("", file=sys.stderr)
3623
 
        logger.debug("Server received KeyboardInterrupt")
3624
 
    logger.debug("Server exiting")
 
3655
        log.debug("Server received KeyboardInterrupt")
 
3656
    log.debug("Server exiting")
3625
3657
    # Must run before the D-Bus bus name gets deregistered
3626
3658
    cleanup()
3627
3659
 
3628
3660
 
3629
 
def should_only_run_tests():
 
3661
def parse_test_args():
 
3662
    # type: () -> argparse.Namespace
3630
3663
    parser = argparse.ArgumentParser(add_help=False)
3631
 
    parser.add_argument("--check", action='store_true')
 
3664
    parser.add_argument("--check", action="store_true")
 
3665
    parser.add_argument("--prefix", )
3632
3666
    args, unknown_args = parser.parse_known_args()
3633
 
    run_tests = args.check
3634
 
    if run_tests:
3635
 
        # Remove --check argument from sys.argv
 
3667
    if args.check:
 
3668
        # Remove test options from sys.argv
3636
3669
        sys.argv[1:] = unknown_args
3637
 
    return run_tests
 
3670
    return args
3638
3671
 
3639
3672
# Add all tests from doctest strings
3640
3673
def load_tests(loader, tests, none):
3642
3675
    tests.addTests(doctest.DocTestSuite())
3643
3676
    return tests
3644
3677
 
3645
 
if __name__ == '__main__':
 
3678
if __name__ == "__main__":
 
3679
    options = parse_test_args()
3646
3680
    try:
3647
 
        if should_only_run_tests():
3648
 
            # Call using ./mandos --check [--verbose]
3649
 
            unittest.main()
 
3681
        if options.check:
 
3682
            extra_test_prefix = options.prefix
 
3683
            if extra_test_prefix is not None:
 
3684
                if not (unittest.main(argv=[""], exit=False)
 
3685
                        .result.wasSuccessful()):
 
3686
                    sys.exit(1)
 
3687
                class ExtraTestLoader(unittest.TestLoader):
 
3688
                    testMethodPrefix = extra_test_prefix
 
3689
                # Call using ./scriptname --test [--verbose]
 
3690
                unittest.main(argv=[""], testLoader=ExtraTestLoader())
 
3691
            else:
 
3692
                unittest.main(argv=[""])
3650
3693
        else:
3651
3694
            main()
3652
3695
    finally:
3653
3696
        logging.shutdown()
 
3697
 
 
3698
# Local Variables:
 
3699
# run-tests:
 
3700
# (lambda (&optional extra)
 
3701
#   (if (not (funcall run-tests-in-test-buffer default-directory
 
3702
#             extra))
 
3703
#       (funcall show-test-buffer-in-test-window)
 
3704
#     (funcall remove-test-window)
 
3705
#     (if extra (message "Extra tests run successfully!"))))
 
3706
# run-tests-in-test-buffer:
 
3707
# (lambda (dir &optional extra)
 
3708
#   (with-current-buffer (get-buffer-create "*Test*")
 
3709
#     (setq buffer-read-only nil
 
3710
#           default-directory dir)
 
3711
#     (erase-buffer)
 
3712
#     (compilation-mode))
 
3713
#   (let ((process-result
 
3714
#          (let ((inhibit-read-only t))
 
3715
#            (process-file-shell-command
 
3716
#             (funcall get-command-line extra) nil "*Test*"))))
 
3717
#     (and (numberp process-result)
 
3718
#          (= process-result 0))))
 
3719
# get-command-line:
 
3720
# (lambda (&optional extra)
 
3721
#   (let ((quoted-script
 
3722
#          (shell-quote-argument (funcall get-script-name))))
 
3723
#     (format
 
3724
#      (concat "%s --check" (if extra " --prefix=atest" ""))
 
3725
#      quoted-script)))
 
3726
# get-script-name:
 
3727
# (lambda ()
 
3728
#   (if (fboundp 'file-local-name)
 
3729
#       (file-local-name (buffer-file-name))
 
3730
#     (or (file-remote-p (buffer-file-name) 'localname)
 
3731
#         (buffer-file-name))))
 
3732
# remove-test-window:
 
3733
# (lambda ()
 
3734
#   (let ((test-window (get-buffer-window "*Test*")))
 
3735
#     (if test-window (delete-window test-window))))
 
3736
# show-test-buffer-in-test-window:
 
3737
# (lambda ()
 
3738
#   (when (not (get-buffer-window-list "*Test*"))
 
3739
#     (setq next-error-last-buffer (get-buffer "*Test*"))
 
3740
#     (let* ((side (if (>= (window-width) 146) 'right 'bottom))
 
3741
#            (display-buffer-overriding-action
 
3742
#             `((display-buffer-in-side-window) (side . ,side)
 
3743
#               (window-height . fit-window-to-buffer)
 
3744
#               (window-width . fit-window-to-buffer))))
 
3745
#       (display-buffer "*Test*"))))
 
3746
# eval:
 
3747
# (progn
 
3748
#   (let* ((run-extra-tests (lambda () (interactive)
 
3749
#                             (funcall run-tests t)))
 
3750
#          (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
 
3751
#          (outer-keymap `(keymap (3 . ,inner-keymap))))     ; C-c
 
3752
#     (setq minor-mode-overriding-map-alist
 
3753
#           (cons `(run-tests . ,outer-keymap)
 
3754
#                 minor-mode-overriding-map-alist)))
 
3755
#   (add-hook 'after-save-hook run-tests 90 t))
 
3756
# End: