/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2019-07-29 16:35:53 UTC
  • Revision ID: teddy@recompile.se-20190729163553-1i442i2cbx64c537
Make tests and man page examples match

Make the tests test_manual_page_example[1-5] match exactly what is
written in the manual page, and add comments to manual page as
reminders to keep tests and manual page examples in sync.

* mandos-ctl (Test_commands_from_options.test_manual_page_example_1):
  Remove "--verbose" option, since the manual does not have it as the
  first example, and change assertion to match.
* mandos-ctl.xml (EXAMPLE): Add comments to all examples documenting
  which test function they correspond to.  Also remove unnecessary
  quotes from option arguments in fourth example, and clarify language
  slightly in fifth example.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos
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 -*-
 
1
#!/usr/bin/python
 
2
# -*- mode: python; coding: utf-8 -*-
3
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
5
5
#
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
 
# Copyright © 2008-2020 Teddy Hogeborn
15
 
# Copyright © 2008-2020 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
#
77
77
import itertools
78
78
import collections
79
79
import codecs
80
 
import unittest
81
 
import random
82
 
import shlex
83
80
 
84
81
import dbus
85
82
import dbus.service
86
 
import gi
87
83
from gi.repository import GLib
88
84
from dbus.mainloop.glib import DBusGMainLoop
89
85
import ctypes
91
87
import xml.dom.minidom
92
88
import inspect
93
89
 
94
 
if sys.version_info.major == 2:
95
 
    __metaclass__ = type
96
 
    str = unicode
97
 
 
98
 
# Add collections.abc.Callable if it does not exist
99
 
try:
100
 
    collections.abc.Callable
101
 
except AttributeError:
102
 
    class abc:
103
 
        Callable = collections.Callable
104
 
    collections.abc = abc
105
 
    del abc
106
 
 
107
 
# Add shlex.quote if it does not exist
108
 
try:
109
 
    shlex.quote
110
 
except AttributeError:
111
 
    shlex.quote = re.escape
112
 
 
113
 
# Show warnings by default
114
 
if not sys.warnoptions:
115
 
    import warnings
116
 
    warnings.simplefilter("default")
117
 
 
118
90
# Try to find the value of SO_BINDTODEVICE:
119
91
try:
120
92
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
140
112
            # No value found
141
113
            SO_BINDTODEVICE = None
142
114
 
143
 
if sys.version_info < (3, 2):
144
 
    configparser.Configparser = configparser.SafeConfigParser
 
115
if sys.version_info.major == 2:
 
116
    str = unicode
145
117
 
146
 
version = "1.8.14"
 
118
version = "1.8.4"
147
119
stored_state_file = "clients.pickle"
148
120
 
149
121
logger = logging.getLogger()
150
 
logging.captureWarnings(True)   # Show warnings via the logging system
151
122
syslogger = None
152
123
 
153
124
try:
189
160
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
190
161
        address="/dev/log"))
191
162
    syslogger.setFormatter(logging.Formatter
192
 
                           ("Mandos [%(process)d]: %(levelname)s:"
193
 
                            " %(message)s"))
 
163
                           ('Mandos [%(process)d]: %(levelname)s:'
 
164
                            ' %(message)s'))
194
165
    logger.addHandler(syslogger)
195
166
 
196
167
    if debug:
197
168
        console = logging.StreamHandler()
198
 
        console.setFormatter(logging.Formatter("%(asctime)s %(name)s"
199
 
                                               " [%(process)d]:"
200
 
                                               " %(levelname)s:"
201
 
                                               " %(message)s"))
 
169
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
170
                                               ' [%(process)d]:'
 
171
                                               ' %(levelname)s:'
 
172
                                               ' %(message)s'))
202
173
        logger.addHandler(console)
203
174
    logger.setLevel(level)
204
175
 
208
179
    pass
209
180
 
210
181
 
211
 
class PGPEngine:
 
182
class PGPEngine(object):
212
183
    """A simple class for OpenPGP symmetric encryption & decryption"""
213
184
 
214
185
    def __init__(self):
218
189
            output = subprocess.check_output(["gpgconf"])
219
190
            for line in output.splitlines():
220
191
                name, text, path = line.split(b":")
221
 
                if name == b"gpg":
 
192
                if name == "gpg":
222
193
                    self.gpg = path
223
194
                    break
224
195
        except OSError as e:
225
196
            if e.errno != errno.ENOENT:
226
197
                raise
227
 
        self.gnupgargs = ["--batch",
228
 
                          "--homedir", self.tempdir,
229
 
                          "--force-mdc",
230
 
                          "--quiet"]
 
198
        self.gnupgargs = ['--batch',
 
199
                          '--homedir', self.tempdir,
 
200
                          '--force-mdc',
 
201
                          '--quiet']
231
202
        # Only GPG version 1 has the --no-use-agent option.
232
 
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
 
203
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
233
204
            self.gnupgargs.append("--no-use-agent")
234
205
 
235
206
    def __enter__(self):
272
243
                dir=self.tempdir) as passfile:
273
244
            passfile.write(passphrase)
274
245
            passfile.flush()
275
 
            proc = subprocess.Popen([self.gpg, "--symmetric",
276
 
                                     "--passphrase-file",
 
246
            proc = subprocess.Popen([self.gpg, '--symmetric',
 
247
                                     '--passphrase-file',
277
248
                                     passfile.name]
278
249
                                    + self.gnupgargs,
279
250
                                    stdin=subprocess.PIPE,
290
261
                dir=self.tempdir) as passfile:
291
262
            passfile.write(passphrase)
292
263
            passfile.flush()
293
 
            proc = subprocess.Popen([self.gpg, "--decrypt",
294
 
                                     "--passphrase-file",
 
264
            proc = subprocess.Popen([self.gpg, '--decrypt',
 
265
                                     '--passphrase-file',
295
266
                                     passfile.name]
296
267
                                    + self.gnupgargs,
297
268
                                    stdin=subprocess.PIPE,
304
275
 
305
276
 
306
277
# Pretend that we have an Avahi module
307
 
class avahi:
 
278
class avahi(object):
308
279
    """This isn't so much a class as it is a module-like namespace."""
309
280
    IF_UNSPEC = -1               # avahi-common/address.h
310
281
    PROTO_UNSPEC = -1            # avahi-common/address.h
344
315
    pass
345
316
 
346
317
 
347
 
class AvahiService:
 
318
class AvahiService(object):
348
319
    """An Avahi (Zeroconf) service.
349
320
 
350
321
    Attributes:
351
322
    interface: integer; avahi.IF_UNSPEC or an interface index.
352
323
               Used to optionally bind to the specified interface.
353
 
    name: string; Example: "Mandos"
354
 
    type: string; Example: "_mandos._tcp".
 
324
    name: string; Example: 'Mandos'
 
325
    type: string; Example: '_mandos._tcp'.
355
326
     See <https://www.iana.org/assignments/service-names-port-numbers>
356
327
    port: integer; what port to announce
357
328
    TXT: list of strings; TXT record for the service
435
406
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
436
407
        self.entry_group_state_changed_match = (
437
408
            self.group.connect_to_signal(
438
 
                "StateChanged", self.entry_group_state_changed))
 
409
                'StateChanged', self.entry_group_state_changed))
439
410
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
440
411
                     self.name, self.type)
441
412
        self.group.AddService(
524
495
class AvahiServiceToSyslog(AvahiService):
525
496
    def rename(self, *args, **kwargs):
526
497
        """Add the new name to the syslog messages"""
527
 
        ret = super(AvahiServiceToSyslog, self).rename(*args,
528
 
                                                       **kwargs)
 
498
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
529
499
        syslogger.setFormatter(logging.Formatter(
530
 
            "Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
 
500
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
531
501
            .format(self.name)))
532
502
        return ret
533
503
 
534
504
 
535
505
# Pretend that we have a GnuTLS module
536
 
class gnutls:
 
506
class gnutls(object):
537
507
    """This isn't so much a class as it is a module-like namespace."""
538
508
 
539
509
    library = ctypes.util.find_library("gnutls")
563
533
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
564
534
 
565
535
    # Types
566
 
    class _session_int(ctypes.Structure):
 
536
    class session_int(ctypes.Structure):
567
537
        _fields_ = []
568
 
    session_t = ctypes.POINTER(_session_int)
 
538
    session_t = ctypes.POINTER(session_int)
569
539
 
570
540
    class certificate_credentials_st(ctypes.Structure):
571
541
        _fields_ = []
574
544
    certificate_type_t = ctypes.c_int
575
545
 
576
546
    class datum_t(ctypes.Structure):
577
 
        _fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
578
 
                    ("size", ctypes.c_uint)]
 
547
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
548
                    ('size', ctypes.c_uint)]
579
549
 
580
 
    class _openpgp_crt_int(ctypes.Structure):
 
550
    class openpgp_crt_int(ctypes.Structure):
581
551
        _fields_ = []
582
 
    openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
 
552
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
583
553
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
584
554
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
585
555
    credentials_type_t = ctypes.c_int
594
564
            # gnutls.strerror()
595
565
            self.code = code
596
566
            if message is None and code is not None:
597
 
                message = gnutls.strerror(code).decode(
598
 
                    "utf-8", errors="replace")
 
567
                message = gnutls.strerror(code)
599
568
            return super(gnutls.Error, self).__init__(
600
569
                message, *args)
601
570
 
602
571
    class CertificateSecurityError(Error):
603
572
        pass
604
573
 
605
 
    class PointerTo:
606
 
        def __init__(self, cls):
607
 
            self.cls = cls
608
 
 
609
 
        def from_param(self, obj):
610
 
            if not isinstance(obj, self.cls):
611
 
                raise TypeError("Not of type {}: {!r}"
612
 
                                .format(self.cls.__name__, obj))
613
 
            return ctypes.byref(obj.from_param(obj))
614
 
 
615
 
    class CastToVoidPointer:
616
 
        def __init__(self, cls):
617
 
            self.cls = cls
618
 
 
619
 
        def from_param(self, obj):
620
 
            if not isinstance(obj, self.cls):
621
 
                raise TypeError("Not of type {}: {!r}"
622
 
                                .format(self.cls.__name__, obj))
623
 
            return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)
624
 
 
625
 
    class With_from_param:
626
 
        @classmethod
627
 
        def from_param(cls, obj):
628
 
            return obj._as_parameter_
629
 
 
630
574
    # Classes
631
 
    class Credentials(With_from_param):
 
575
    class Credentials(object):
632
576
        def __init__(self):
633
 
            self._as_parameter_ = gnutls.certificate_credentials_t()
634
 
            gnutls.certificate_allocate_credentials(self)
 
577
            self._c_object = gnutls.certificate_credentials_t()
 
578
            gnutls.certificate_allocate_credentials(
 
579
                ctypes.byref(self._c_object))
635
580
            self.type = gnutls.CRD_CERTIFICATE
636
581
 
637
582
        def __del__(self):
638
 
            gnutls.certificate_free_credentials(self)
 
583
            gnutls.certificate_free_credentials(self._c_object)
639
584
 
640
 
    class ClientSession(With_from_param):
 
585
    class ClientSession(object):
641
586
        def __init__(self, socket, credentials=None):
642
 
            self._as_parameter_ = gnutls.session_t()
 
587
            self._c_object = gnutls.session_t()
643
588
            gnutls_flags = gnutls.CLIENT
644
589
            if gnutls.check_version(b"3.5.6"):
645
590
                gnutls_flags |= gnutls.NO_TICKETS
646
591
            if gnutls.has_rawpk:
647
592
                gnutls_flags |= gnutls.ENABLE_RAWPK
648
 
            gnutls.init(self, gnutls_flags)
 
593
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
649
594
            del gnutls_flags
650
 
            gnutls.set_default_priority(self)
651
 
            gnutls.transport_set_ptr(self, socket.fileno())
652
 
            gnutls.handshake_set_private_extensions(self, True)
 
595
            gnutls.set_default_priority(self._c_object)
 
596
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
597
            gnutls.handshake_set_private_extensions(self._c_object,
 
598
                                                    True)
653
599
            self.socket = socket
654
600
            if credentials is None:
655
601
                credentials = gnutls.Credentials()
656
 
            gnutls.credentials_set(self, credentials.type,
657
 
                                   credentials)
 
602
            gnutls.credentials_set(self._c_object, credentials.type,
 
603
                                   ctypes.cast(credentials._c_object,
 
604
                                               ctypes.c_void_p))
658
605
            self.credentials = credentials
659
606
 
660
607
        def __del__(self):
661
 
            gnutls.deinit(self)
 
608
            gnutls.deinit(self._c_object)
662
609
 
663
610
        def handshake(self):
664
 
            return gnutls.handshake(self)
 
611
            return gnutls.handshake(self._c_object)
665
612
 
666
613
        def send(self, data):
667
614
            data = bytes(data)
668
615
            data_len = len(data)
669
616
            while data_len > 0:
670
 
                data_len -= gnutls.record_send(self, data[-data_len:],
 
617
                data_len -= gnutls.record_send(self._c_object,
 
618
                                               data[-data_len:],
671
619
                                               data_len)
672
620
 
673
621
        def bye(self):
674
 
            return gnutls.bye(self, gnutls.SHUT_RDWR)
 
622
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
675
623
 
676
624
    # Error handling functions
677
625
    def _error_code(result):
678
626
        """A function to raise exceptions on errors, suitable
679
 
        for the "restype" attribute on ctypes functions"""
680
 
        if result >= gnutls.E_SUCCESS:
 
627
        for the 'restype' attribute on ctypes functions"""
 
628
        if result >= 0:
681
629
            return result
682
630
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
683
631
            raise gnutls.CertificateSecurityError(code=result)
684
632
        raise gnutls.Error(code=result)
685
633
 
686
 
    def _retry_on_error(result, func, arguments,
687
 
                        _error_code=_error_code):
 
634
    def _retry_on_error(result, func, arguments):
688
635
        """A function to retry on some errors, suitable
689
 
        for the "errcheck" attribute on ctypes functions"""
690
 
        while result < gnutls.E_SUCCESS:
 
636
        for the 'errcheck' attribute on ctypes functions"""
 
637
        while result < 0:
691
638
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
692
639
                return _error_code(result)
693
640
            result = func(*arguments)
698
645
 
699
646
    # Functions
700
647
    priority_set_direct = _library.gnutls_priority_set_direct
701
 
    priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
 
648
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
702
649
                                    ctypes.POINTER(ctypes.c_char_p)]
703
650
    priority_set_direct.restype = _error_code
704
651
 
705
652
    init = _library.gnutls_init
706
 
    init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
 
653
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
707
654
    init.restype = _error_code
708
655
 
709
656
    set_default_priority = _library.gnutls_set_default_priority
710
 
    set_default_priority.argtypes = [ClientSession]
 
657
    set_default_priority.argtypes = [session_t]
711
658
    set_default_priority.restype = _error_code
712
659
 
713
660
    record_send = _library.gnutls_record_send
714
 
    record_send.argtypes = [ClientSession, ctypes.c_void_p,
 
661
    record_send.argtypes = [session_t, ctypes.c_void_p,
715
662
                            ctypes.c_size_t]
716
663
    record_send.restype = ctypes.c_ssize_t
717
664
    record_send.errcheck = _retry_on_error
719
666
    certificate_allocate_credentials = (
720
667
        _library.gnutls_certificate_allocate_credentials)
721
668
    certificate_allocate_credentials.argtypes = [
722
 
        PointerTo(Credentials)]
 
669
        ctypes.POINTER(certificate_credentials_t)]
723
670
    certificate_allocate_credentials.restype = _error_code
724
671
 
725
672
    certificate_free_credentials = (
726
673
        _library.gnutls_certificate_free_credentials)
727
 
    certificate_free_credentials.argtypes = [Credentials]
 
674
    certificate_free_credentials.argtypes = [
 
675
        certificate_credentials_t]
728
676
    certificate_free_credentials.restype = None
729
677
 
730
678
    handshake_set_private_extensions = (
731
679
        _library.gnutls_handshake_set_private_extensions)
732
 
    handshake_set_private_extensions.argtypes = [ClientSession,
 
680
    handshake_set_private_extensions.argtypes = [session_t,
733
681
                                                 ctypes.c_int]
734
682
    handshake_set_private_extensions.restype = None
735
683
 
736
684
    credentials_set = _library.gnutls_credentials_set
737
 
    credentials_set.argtypes = [ClientSession, credentials_type_t,
738
 
                                CastToVoidPointer(Credentials)]
 
685
    credentials_set.argtypes = [session_t, credentials_type_t,
 
686
                                ctypes.c_void_p]
739
687
    credentials_set.restype = _error_code
740
688
 
741
689
    strerror = _library.gnutls_strerror
743
691
    strerror.restype = ctypes.c_char_p
744
692
 
745
693
    certificate_type_get = _library.gnutls_certificate_type_get
746
 
    certificate_type_get.argtypes = [ClientSession]
 
694
    certificate_type_get.argtypes = [session_t]
747
695
    certificate_type_get.restype = _error_code
748
696
 
749
697
    certificate_get_peers = _library.gnutls_certificate_get_peers
750
 
    certificate_get_peers.argtypes = [ClientSession,
 
698
    certificate_get_peers.argtypes = [session_t,
751
699
                                      ctypes.POINTER(ctypes.c_uint)]
752
700
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
753
701
 
760
708
    global_set_log_function.restype = None
761
709
 
762
710
    deinit = _library.gnutls_deinit
763
 
    deinit.argtypes = [ClientSession]
 
711
    deinit.argtypes = [session_t]
764
712
    deinit.restype = None
765
713
 
766
714
    handshake = _library.gnutls_handshake
767
 
    handshake.argtypes = [ClientSession]
768
 
    handshake.restype = ctypes.c_int
 
715
    handshake.argtypes = [session_t]
 
716
    handshake.restype = _error_code
769
717
    handshake.errcheck = _retry_on_error
770
718
 
771
719
    transport_set_ptr = _library.gnutls_transport_set_ptr
772
 
    transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
 
720
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
773
721
    transport_set_ptr.restype = None
774
722
 
775
723
    bye = _library.gnutls_bye
776
 
    bye.argtypes = [ClientSession, close_request_t]
777
 
    bye.restype = ctypes.c_int
 
724
    bye.argtypes = [session_t, close_request_t]
 
725
    bye.restype = _error_code
778
726
    bye.errcheck = _retry_on_error
779
727
 
780
728
    check_version = _library.gnutls_check_version
797
745
 
798
746
        x509_crt_fmt_t = ctypes.c_int
799
747
 
800
 
        # All the function declarations below are from
801
 
        # gnutls/abstract.h
 
748
        # All the function declarations below are from gnutls/abstract.h
802
749
        pubkey_init = _library.gnutls_pubkey_init
803
750
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
804
751
        pubkey_init.restype = _error_code
818
765
        pubkey_deinit.argtypes = [pubkey_t]
819
766
        pubkey_deinit.restype = None
820
767
    else:
821
 
        # All the function declarations below are from
822
 
        # gnutls/openpgp.h
 
768
        # All the function declarations below are from gnutls/openpgp.h
823
769
 
824
770
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
825
771
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
831
777
                                       openpgp_crt_fmt_t]
832
778
        openpgp_crt_import.restype = _error_code
833
779
 
834
 
        openpgp_crt_verify_self = \
835
 
            _library.gnutls_openpgp_crt_verify_self
836
 
        openpgp_crt_verify_self.argtypes = [
837
 
            openpgp_crt_t,
838
 
            ctypes.c_uint,
839
 
            ctypes.POINTER(ctypes.c_uint),
840
 
        ]
 
780
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
781
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
782
                                            ctypes.POINTER(ctypes.c_uint)]
841
783
        openpgp_crt_verify_self.restype = _error_code
842
784
 
843
785
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
854
796
 
855
797
    if check_version(b"3.6.4"):
856
798
        certificate_type_get2 = _library.gnutls_certificate_type_get2
857
 
        certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
 
799
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
858
800
        certificate_type_get2.restype = _error_code
859
801
 
860
802
    # Remove non-public functions
872
814
    connection.close()
873
815
 
874
816
 
875
 
class Client:
 
817
class Client(object):
876
818
    """A representation of a client host served by this server.
877
819
 
878
820
    Attributes:
879
 
    approved:   bool(); None if not yet approved/disapproved
 
821
    approved:   bool(); 'None' if not yet approved/disapproved
880
822
    approval_delay: datetime.timedelta(); Time to wait for approval
881
823
    approval_duration: datetime.timedelta(); Duration of one approval
882
 
    checker: multiprocessing.Process(); a running checker process used
883
 
             to see if the client lives. None if no process is
884
 
             running.
 
824
    checker:    subprocess.Popen(); a running checker process used
 
825
                                    to see if the client lives.
 
826
                                    'None' if no process is running.
885
827
    checker_callback_tag: a GLib event source tag, or None
886
828
    checker_command: string; External command which is run to check
887
829
                     if client lives.  %() expansions are done at
1081
1023
        if self.checker_initiator_tag is not None:
1082
1024
            GLib.source_remove(self.checker_initiator_tag)
1083
1025
        self.checker_initiator_tag = GLib.timeout_add(
1084
 
            random.randrange(int(self.interval.total_seconds() * 1000
1085
 
                                 + 1)),
 
1026
            int(self.interval.total_seconds() * 1000),
1086
1027
            self.start_checker)
1087
1028
        # Schedule a disable() when 'timeout' has passed
1088
1029
        if self.disable_initiator_tag is not None:
1095
1036
    def checker_callback(self, source, condition, connection,
1096
1037
                         command):
1097
1038
        """The checker has completed, so take appropriate actions."""
 
1039
        self.checker_callback_tag = None
 
1040
        self.checker = None
1098
1041
        # Read return code from connection (see call_pipe)
1099
1042
        returncode = connection.recv()
1100
1043
        connection.close()
1101
 
        if self.checker is not None:
1102
 
            self.checker.join()
1103
 
        self.checker_callback_tag = None
1104
 
        self.checker = None
1105
1044
 
1106
1045
        if returncode >= 0:
1107
1046
            self.last_checker_status = returncode
1163
1102
        if self.checker is None:
1164
1103
            # Escape attributes for the shell
1165
1104
            escaped_attrs = {
1166
 
                attr: shlex.quote(str(getattr(self, attr)))
 
1105
                attr: re.escape(str(getattr(self, attr)))
1167
1106
                for attr in self.runtime_expansions}
1168
1107
            try:
1169
1108
                command = self.checker_command % escaped_attrs
1196
1135
                kwargs=popen_args)
1197
1136
            self.checker.start()
1198
1137
            self.checker_callback_tag = GLib.io_add_watch(
1199
 
                GLib.IOChannel.unix_new(pipe[0].fileno()),
1200
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
1138
                pipe[0].fileno(), GLib.IO_IN,
1201
1139
                self.checker_callback, pipe[0], command)
1202
1140
        # Re-run this periodically if run by GLib.timeout_add
1203
1141
        return True
1242
1180
        func._dbus_name = func.__name__
1243
1181
        if func._dbus_name.endswith("_dbus_property"):
1244
1182
            func._dbus_name = func._dbus_name[:-14]
1245
 
        func._dbus_get_args_options = {"byte_arrays": byte_arrays}
 
1183
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1246
1184
        return func
1247
1185
 
1248
1186
    return decorator
1337
1275
 
1338
1276
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1339
1277
                         out_signature="s",
1340
 
                         path_keyword="object_path",
1341
 
                         connection_keyword="connection")
 
1278
                         path_keyword='object_path',
 
1279
                         connection_keyword='connection')
1342
1280
    def Introspect(self, object_path, connection):
1343
1281
        """Overloading of standard D-Bus method.
1344
1282
 
1458
1396
                raise ValueError("Byte arrays not supported for non-"
1459
1397
                                 "'ay' signature {!r}"
1460
1398
                                 .format(prop._dbus_signature))
1461
 
            value = dbus.ByteArray(bytes(value))
 
1399
            value = dbus.ByteArray(b''.join(chr(byte)
 
1400
                                            for byte in value))
1462
1401
        prop(value)
1463
1402
 
1464
1403
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1497
1436
 
1498
1437
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1499
1438
                         out_signature="s",
1500
 
                         path_keyword="object_path",
1501
 
                         connection_keyword="connection")
 
1439
                         path_keyword='object_path',
 
1440
                         connection_keyword='connection')
1502
1441
    def Introspect(self, object_path, connection):
1503
1442
        """Overloading of standard D-Bus method.
1504
1443
 
1599
1538
 
1600
1539
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1601
1540
                         out_signature="s",
1602
 
                         path_keyword="object_path",
1603
 
                         connection_keyword="connection")
 
1541
                         path_keyword='object_path',
 
1542
                         connection_keyword='connection')
1604
1543
    def Introspect(self, object_path, connection):
1605
1544
        """Overloading of standard D-Bus method.
1606
1545
 
2269
2208
    del _interface
2270
2209
 
2271
2210
 
2272
 
class ProxyClient:
 
2211
class ProxyClient(object):
2273
2212
    def __init__(self, child_pipe, key_id, fpr, address):
2274
2213
        self._pipe = child_pipe
2275
 
        self._pipe.send(("init", key_id, fpr, address))
 
2214
        self._pipe.send(('init', key_id, fpr, address))
2276
2215
        if not self._pipe.recv():
2277
2216
            raise KeyError(key_id or fpr)
2278
2217
 
2279
2218
    def __getattribute__(self, name):
2280
 
        if name == "_pipe":
 
2219
        if name == '_pipe':
2281
2220
            return super(ProxyClient, self).__getattribute__(name)
2282
 
        self._pipe.send(("getattr", name))
 
2221
        self._pipe.send(('getattr', name))
2283
2222
        data = self._pipe.recv()
2284
 
        if data[0] == "data":
 
2223
        if data[0] == 'data':
2285
2224
            return data[1]
2286
 
        if data[0] == "function":
 
2225
        if data[0] == 'function':
2287
2226
 
2288
2227
            def func(*args, **kwargs):
2289
 
                self._pipe.send(("funcall", name, args, kwargs))
 
2228
                self._pipe.send(('funcall', name, args, kwargs))
2290
2229
                return self._pipe.recv()[1]
2291
2230
 
2292
2231
            return func
2293
2232
 
2294
2233
    def __setattr__(self, name, value):
2295
 
        if name == "_pipe":
 
2234
        if name == '_pipe':
2296
2235
            return super(ProxyClient, self).__setattr__(name, value)
2297
 
        self._pipe.send(("setattr", name, value))
 
2236
        self._pipe.send(('setattr', name, value))
2298
2237
 
2299
2238
 
2300
2239
class ClientHandler(socketserver.BaseRequestHandler, object):
2312
2251
 
2313
2252
            session = gnutls.ClientSession(self.request)
2314
2253
 
2315
 
            # priority = ":".join(("NONE", "+VERS-TLS1.1",
 
2254
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
2316
2255
            #                       "+AES-256-CBC", "+SHA1",
2317
2256
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
2318
2257
            #                       "+DHE-DSS"))
2320
2259
            priority = self.server.gnutls_priority
2321
2260
            if priority is None:
2322
2261
                priority = "NORMAL"
2323
 
            gnutls.priority_set_direct(session,
2324
 
                                       priority.encode("utf-8"), None)
 
2262
            gnutls.priority_set_direct(session._c_object,
 
2263
                                       priority.encode("utf-8"),
 
2264
                                       None)
2325
2265
 
2326
2266
            # Start communication using the Mandos protocol
2327
2267
            # Get protocol number
2354
2294
                    except (TypeError, gnutls.Error) as error:
2355
2295
                        logger.warning("Bad certificate: %s", error)
2356
2296
                        return
2357
 
                    logger.debug("Key ID: %s",
2358
 
                                 key_id.decode("utf-8",
2359
 
                                               errors="replace"))
 
2297
                    logger.debug("Key ID: %s", key_id)
2360
2298
 
2361
2299
                else:
2362
2300
                    key_id = b""
2454
2392
    def peer_certificate(session):
2455
2393
        "Return the peer's certificate as a bytestring"
2456
2394
        try:
2457
 
            cert_type = gnutls.certificate_type_get2(
2458
 
                session, gnutls.CTYPE_PEERS)
 
2395
            cert_type = gnutls.certificate_type_get2(session._c_object,
 
2396
                                                     gnutls.CTYPE_PEERS)
2459
2397
        except AttributeError:
2460
 
            cert_type = gnutls.certificate_type_get(session)
 
2398
            cert_type = gnutls.certificate_type_get(session._c_object)
2461
2399
        if gnutls.has_rawpk:
2462
2400
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2463
2401
        else:
2470
2408
            return b""
2471
2409
        list_size = ctypes.c_uint(1)
2472
2410
        cert_list = (gnutls.certificate_get_peers
2473
 
                     (session, ctypes.byref(list_size)))
 
2411
                     (session._c_object, ctypes.byref(list_size)))
2474
2412
        if not bool(cert_list) and list_size.value != 0:
2475
2413
            raise gnutls.Error("error getting peer certificate")
2476
2414
        if list_size.value == 0:
2498
2436
        buf = ctypes.create_string_buffer(32)
2499
2437
        buf_len = ctypes.c_size_t(len(buf))
2500
2438
        # Get the key ID from the raw public key into the buffer
2501
 
        gnutls.pubkey_get_key_id(
2502
 
            pubkey,
2503
 
            gnutls.KEYID_USE_SHA256,
2504
 
            ctypes.cast(ctypes.byref(buf),
2505
 
                        ctypes.POINTER(ctypes.c_ubyte)),
2506
 
            ctypes.byref(buf_len))
 
2439
        gnutls.pubkey_get_key_id(pubkey,
 
2440
                                 gnutls.KEYID_USE_SHA256,
 
2441
                                 ctypes.cast(ctypes.byref(buf),
 
2442
                                             ctypes.POINTER(ctypes.c_ubyte)),
 
2443
                                 ctypes.byref(buf_len))
2507
2444
        # Deinit the certificate
2508
2445
        gnutls.pubkey_deinit(pubkey)
2509
2446
 
2550
2487
        return hex_fpr
2551
2488
 
2552
2489
 
2553
 
class MultiprocessingMixIn:
 
2490
class MultiprocessingMixIn(object):
2554
2491
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2555
2492
 
2556
2493
    def sub_process_main(self, request, address):
2568
2505
        return proc
2569
2506
 
2570
2507
 
2571
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
2508
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2572
2509
    """ adds a pipe to the MixIn """
2573
2510
 
2574
2511
    def process_request(self, request, client_address):
2589
2526
 
2590
2527
 
2591
2528
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2592
 
                     socketserver.TCPServer):
2593
 
    """IPv6-capable TCP server.  Accepts None as address and/or port
 
2529
                     socketserver.TCPServer, object):
 
2530
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2594
2531
 
2595
2532
    Attributes:
2596
2533
        enabled:        Boolean; whether this server is activated yet
2728
2665
    def add_pipe(self, parent_pipe, proc):
2729
2666
        # Call "handle_ipc" for both data and EOF events
2730
2667
        GLib.io_add_watch(
2731
 
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
2732
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2668
            parent_pipe.fileno(),
 
2669
            GLib.IO_IN | GLib.IO_HUP,
2733
2670
            functools.partial(self.handle_ipc,
2734
2671
                              parent_pipe=parent_pipe,
2735
2672
                              proc=proc))
2748
2685
        request = parent_pipe.recv()
2749
2686
        command = request[0]
2750
2687
 
2751
 
        if command == "init":
 
2688
        if command == 'init':
2752
2689
            key_id = request[1].decode("ascii")
2753
2690
            fpr = request[2].decode("ascii")
2754
2691
            address = request[3]
2755
2692
 
2756
2693
            for c in self.clients.values():
2757
 
                if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2758
 
                              "27AE41E4649B934CA495991B7852B855"):
 
2694
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2759
2695
                    continue
2760
2696
                if key_id and c.key_id == key_id:
2761
2697
                    client = c
2774
2710
                return False
2775
2711
 
2776
2712
            GLib.io_add_watch(
2777
 
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
2778
 
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
 
2713
                parent_pipe.fileno(),
 
2714
                GLib.IO_IN | GLib.IO_HUP,
2779
2715
                functools.partial(self.handle_ipc,
2780
2716
                                  parent_pipe=parent_pipe,
2781
2717
                                  proc=proc,
2784
2720
            # remove the old hook in favor of the new above hook on
2785
2721
            # same fileno
2786
2722
            return False
2787
 
        if command == "funcall":
 
2723
        if command == 'funcall':
2788
2724
            funcname = request[1]
2789
2725
            args = request[2]
2790
2726
            kwargs = request[3]
2791
2727
 
2792
 
            parent_pipe.send(("data", getattr(client_object,
 
2728
            parent_pipe.send(('data', getattr(client_object,
2793
2729
                                              funcname)(*args,
2794
2730
                                                        **kwargs)))
2795
2731
 
2796
 
        if command == "getattr":
 
2732
        if command == 'getattr':
2797
2733
            attrname = request[1]
2798
2734
            if isinstance(client_object.__getattribute__(attrname),
2799
 
                          collections.abc.Callable):
2800
 
                parent_pipe.send(("function", ))
 
2735
                          collections.Callable):
 
2736
                parent_pipe.send(('function', ))
2801
2737
            else:
2802
2738
                parent_pipe.send((
2803
 
                    "data", client_object.__getattribute__(attrname)))
 
2739
                    'data', client_object.__getattribute__(attrname)))
2804
2740
 
2805
 
        if command == "setattr":
 
2741
        if command == 'setattr':
2806
2742
            attrname = request[1]
2807
2743
            value = request[2]
2808
2744
            setattr(client_object, attrname, value)
2813
2749
def rfc3339_duration_to_delta(duration):
2814
2750
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2815
2751
 
2816
 
    >>> timedelta = datetime.timedelta
2817
 
    >>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2818
 
    True
2819
 
    >>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2820
 
    True
2821
 
    >>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2822
 
    True
2823
 
    >>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2824
 
    True
2825
 
    >>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2826
 
    True
2827
 
    >>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2828
 
    True
2829
 
    >>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2830
 
    True
2831
 
    >>> del timedelta
 
2752
    >>> rfc3339_duration_to_delta("P7D")
 
2753
    datetime.timedelta(7)
 
2754
    >>> rfc3339_duration_to_delta("PT60S")
 
2755
    datetime.timedelta(0, 60)
 
2756
    >>> rfc3339_duration_to_delta("PT60M")
 
2757
    datetime.timedelta(0, 3600)
 
2758
    >>> rfc3339_duration_to_delta("PT24H")
 
2759
    datetime.timedelta(1)
 
2760
    >>> rfc3339_duration_to_delta("P1W")
 
2761
    datetime.timedelta(7)
 
2762
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2763
    datetime.timedelta(0, 330)
 
2764
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2765
    datetime.timedelta(1, 200)
2832
2766
    """
2833
2767
 
2834
2768
    # Parsing an RFC 3339 duration with regular expressions is not
2914
2848
def string_to_delta(interval):
2915
2849
    """Parse a string and return a datetime.timedelta
2916
2850
 
2917
 
    >>> string_to_delta("7d") == datetime.timedelta(7)
2918
 
    True
2919
 
    >>> string_to_delta("60s") == datetime.timedelta(0, 60)
2920
 
    True
2921
 
    >>> string_to_delta("60m") == datetime.timedelta(0, 3600)
2922
 
    True
2923
 
    >>> string_to_delta("24h") == datetime.timedelta(1)
2924
 
    True
2925
 
    >>> string_to_delta("1w") == datetime.timedelta(7)
2926
 
    True
2927
 
    >>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
2928
 
    True
 
2851
    >>> string_to_delta('7d')
 
2852
    datetime.timedelta(7)
 
2853
    >>> string_to_delta('60s')
 
2854
    datetime.timedelta(0, 60)
 
2855
    >>> string_to_delta('60m')
 
2856
    datetime.timedelta(0, 3600)
 
2857
    >>> string_to_delta('24h')
 
2858
    datetime.timedelta(1)
 
2859
    >>> string_to_delta('1w')
 
2860
    datetime.timedelta(7)
 
2861
    >>> string_to_delta('5m 30s')
 
2862
    datetime.timedelta(0, 330)
2929
2863
    """
2930
2864
 
2931
2865
    try:
3033
2967
 
3034
2968
    options = parser.parse_args()
3035
2969
 
 
2970
    if options.check:
 
2971
        import doctest
 
2972
        fail_count, test_count = doctest.testmod()
 
2973
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2974
 
3036
2975
    # Default values for config file for server-global settings
3037
2976
    if gnutls.has_rawpk:
3038
2977
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3058
2997
    del priority
3059
2998
 
3060
2999
    # Parse config file for server-global settings
3061
 
    server_config = configparser.ConfigParser(server_defaults)
 
3000
    server_config = configparser.SafeConfigParser(server_defaults)
3062
3001
    del server_defaults
3063
3002
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
3064
 
    # Convert the ConfigParser object to a dict
 
3003
    # Convert the SafeConfigParser object to a dict
3065
3004
    server_settings = server_config.defaults()
3066
3005
    # Use the appropriate methods on the non-string config options
3067
3006
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
3134
3073
 
3135
3074
    if server_settings["servicename"] != "Mandos":
3136
3075
        syslogger.setFormatter(
3137
 
            logging.Formatter("Mandos ({}) [%(process)d]:"
3138
 
                              " %(levelname)s: %(message)s".format(
 
3076
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
3077
                              ' %(levelname)s: %(message)s'.format(
3139
3078
                                  server_settings["servicename"])))
3140
3079
 
3141
3080
    # Parse config file with clients
3142
 
    client_config = configparser.ConfigParser(Client.client_defaults)
 
3081
    client_config = configparser.SafeConfigParser(Client
 
3082
                                                  .client_defaults)
3143
3083
    client_config.read(os.path.join(server_settings["configdir"],
3144
3084
                                    "clients.conf"))
3145
3085
 
3201
3141
 
3202
3142
        @gnutls.log_func
3203
3143
        def debug_gnutls(level, string):
3204
 
            logger.debug("GnuTLS: %s",
3205
 
                         string[:-1].decode("utf-8",
3206
 
                                            errors="replace"))
 
3144
            logger.debug("GnuTLS: %s", string[:-1])
3207
3145
 
3208
3146
        gnutls.global_set_log_function(debug_gnutls)
3209
3147
 
3218
3156
        # Close all input and output, do double fork, etc.
3219
3157
        daemon()
3220
3158
 
3221
 
    if gi.version_info < (3, 10, 2):
3222
 
        # multiprocessing will use threads, so before we use GLib we
3223
 
        # need to inform GLib that threads will be used.
3224
 
        GLib.threads_init()
 
3159
    # multiprocessing will use threads, so before we use GLib we need
 
3160
    # to inform GLib that threads will be used.
 
3161
    GLib.threads_init()
3225
3162
 
3226
3163
    global main_loop
3227
3164
    # From the Avahi example code
3303
3240
                             if isinstance(s, bytes)
3304
3241
                             else s) for s in
3305
3242
                            value["client_structure"]]
3306
 
                        # .name, .host, and .checker_command
3307
 
                        for k in ("name", "host", "checker_command"):
 
3243
                        # .name & .host
 
3244
                        for k in ("name", "host"):
3308
3245
                            if isinstance(value[k], bytes):
3309
3246
                                value[k] = value[k].decode("utf-8")
3310
3247
                        if "key_id" not in value:
3320
3257
                        for key, value in
3321
3258
                        bytes_old_client_settings.items()}
3322
3259
                    del bytes_old_client_settings
3323
 
                    # .host and .checker_command
 
3260
                    # .host
3324
3261
                    for value in old_client_settings.values():
3325
 
                        for attribute in ("host", "checker_command"):
3326
 
                            if isinstance(value[attribute], bytes):
3327
 
                                value[attribute] = (value[attribute]
3328
 
                                                    .decode("utf-8"))
 
3262
                        if isinstance(value["host"], bytes):
 
3263
                            value["host"] = (value["host"]
 
3264
                                             .decode("utf-8"))
3329
3265
            os.remove(stored_state_path)
3330
3266
        except IOError as e:
3331
3267
            if e.errno == errno.ENOENT:
3584
3520
 
3585
3521
        try:
3586
3522
            with tempfile.NamedTemporaryFile(
3587
 
                    mode="wb",
 
3523
                    mode='wb',
3588
3524
                    suffix=".pickle",
3589
 
                    prefix="clients-",
 
3525
                    prefix='clients-',
3590
3526
                    dir=os.path.dirname(stored_state_path),
3591
3527
                    delete=False) as stored_state:
3592
3528
                pickle.dump((clients, client_settings), stored_state,
3656
3592
                sys.exit(1)
3657
3593
            # End of Avahi example code
3658
3594
 
3659
 
        GLib.io_add_watch(
3660
 
            GLib.IOChannel.unix_new(tcp_server.fileno()),
3661
 
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3662
 
            lambda *args, **kwargs: (tcp_server.handle_request
3663
 
                                     (*args[2:], **kwargs) or True))
 
3595
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3596
                          lambda *args, **kwargs:
 
3597
                          (tcp_server.handle_request
 
3598
                           (*args[2:], **kwargs) or True))
3664
3599
 
3665
3600
        logger.debug("Starting main loop")
3666
3601
        main_loop.run()
3676
3611
    # Must run before the D-Bus bus name gets deregistered
3677
3612
    cleanup()
3678
3613
 
3679
 
 
3680
 
def should_only_run_tests():
3681
 
    parser = argparse.ArgumentParser(add_help=False)
3682
 
    parser.add_argument("--check", action="store_true")
3683
 
    args, unknown_args = parser.parse_known_args()
3684
 
    run_tests = args.check
3685
 
    if run_tests:
3686
 
        # Remove --check argument from sys.argv
3687
 
        sys.argv[1:] = unknown_args
3688
 
    return run_tests
3689
 
 
3690
 
# Add all tests from doctest strings
3691
 
def load_tests(loader, tests, none):
3692
 
    import doctest
3693
 
    tests.addTests(doctest.DocTestSuite())
3694
 
    return tests
3695
 
 
3696
 
if __name__ == "__main__":
3697
 
    try:
3698
 
        if should_only_run_tests():
3699
 
            # Call using ./mandos --check [--verbose]
3700
 
            unittest.main()
3701
 
        else:
3702
 
            main()
3703
 
    finally:
3704
 
        logging.shutdown()
 
3614
 
 
3615
if __name__ == '__main__':
 
3616
    main()