/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: teddy at recompile
  • Date: 2020-02-05 20:32:33 UTC
  • mto: This revision was merged to the branch mainline in revision 396.
  • Revision ID: teddy@recompile.se-20200205203233-450ojm36jseglq4m
Server: Stagger checker runs when creating clients

To avoid checkers for all clients all running at the same time
periodically, schedule every initially scheduled future checker to run
at a time in the future a random amount of the interval, from the
current time.

* mandos (Client.init_checker): Schedule the first scheduled future
  run of a checker to be a randomly chosen amount of this client's
  "interval" (instead of a full interval).

Show diffs side-by-side

added added

removed removed

Lines of Context:
mandos
1
 
#!/usr/bin/python
2
 
# -*- mode: python; coding: utf-8 -*-
 
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 -*-
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-2016 Teddy Hogeborn
15
 
# Copyright © 2008-2016 Björn Påhlsson
16
 
#
17
 
# This program is free software: you can redistribute it and/or modify
18
 
# it under the terms of the GNU General Public License as published by
 
14
# Copyright © 2008-2019 Teddy Hogeborn
 
15
# Copyright © 2008-2019 Björn Påhlsson
 
16
#
 
17
# This file is part of Mandos.
 
18
#
 
19
# Mandos is free software: you can redistribute it and/or modify it
 
20
# under the terms of the GNU General Public License as published by
19
21
# the Free Software Foundation, either version 3 of the License, or
20
22
# (at your option) any later version.
21
23
#
22
 
#     This program is distributed in the hope that it will be useful,
23
 
#     but WITHOUT ANY WARRANTY; without even the implied warranty of
 
24
#     Mandos is distributed in the hope that it will be useful, but
 
25
#     WITHOUT ANY WARRANTY; without even the implied warranty of
24
26
#     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25
27
#     GNU General Public License for more details.
26
28
#
27
29
# You should have received a copy of the GNU General Public License
28
 
# along with this program.  If not, see
29
 
# <http://www.gnu.org/licenses/>.
 
30
# along with Mandos.  If not, see <http://www.gnu.org/licenses/>.
30
31
#
31
32
# Contact the authors at <mandos@recompile.se>.
32
33
#
76
77
import itertools
77
78
import collections
78
79
import codecs
 
80
import unittest
 
81
import random
79
82
 
80
83
import dbus
81
84
import dbus.service
 
85
import gi
82
86
from gi.repository import GLib
83
87
from dbus.mainloop.glib import DBusGMainLoop
84
88
import ctypes
86
90
import xml.dom.minidom
87
91
import inspect
88
92
 
 
93
if sys.version_info.major == 2:
 
94
    __metaclass__ = type
 
95
    str = unicode
 
96
 
 
97
# Show warnings by default
 
98
if not sys.warnoptions:
 
99
    import warnings
 
100
    warnings.simplefilter("default")
 
101
 
89
102
# Try to find the value of SO_BINDTODEVICE:
90
103
try:
91
104
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
111
124
            # No value found
112
125
            SO_BINDTODEVICE = None
113
126
 
114
 
if sys.version_info.major == 2:
115
 
    str = unicode
 
127
if sys.version_info < (3, 2):
 
128
    configparser.Configparser = configparser.SafeConfigParser
116
129
 
117
 
version = "1.7.13"
 
130
version = "1.8.9"
118
131
stored_state_file = "clients.pickle"
119
132
 
120
133
logger = logging.getLogger()
 
134
logging.captureWarnings(True)   # Show warnings via the logging system
121
135
syslogger = None
122
136
 
123
137
try:
178
192
    pass
179
193
 
180
194
 
181
 
class PGPEngine(object):
 
195
class PGPEngine:
182
196
    """A simple class for OpenPGP symmetric encryption & decryption"""
183
197
 
184
198
    def __init__(self):
188
202
            output = subprocess.check_output(["gpgconf"])
189
203
            for line in output.splitlines():
190
204
                name, text, path = line.split(b":")
191
 
                if name == "gpg":
 
205
                if name == b"gpg":
192
206
                    self.gpg = path
193
207
                    break
194
208
        except OSError as e:
199
213
                          '--force-mdc',
200
214
                          '--quiet']
201
215
        # Only GPG version 1 has the --no-use-agent option.
202
 
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
 
216
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
203
217
            self.gnupgargs.append("--no-use-agent")
204
218
 
205
219
    def __enter__(self):
274
288
 
275
289
 
276
290
# Pretend that we have an Avahi module
277
 
class Avahi(object):
278
 
    """This isn't so much a class as it is a module-like namespace.
279
 
    It is instantiated once, and simulates having an Avahi module."""
 
291
class avahi:
 
292
    """This isn't so much a class as it is a module-like namespace."""
280
293
    IF_UNSPEC = -1               # avahi-common/address.h
281
294
    PROTO_UNSPEC = -1            # avahi-common/address.h
282
295
    PROTO_INET = 0               # avahi-common/address.h
286
299
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
287
300
    DBUS_PATH_SERVER = "/"
288
301
 
289
 
    def string_array_to_txt_array(self, t):
 
302
    @staticmethod
 
303
    def string_array_to_txt_array(t):
290
304
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
291
305
                           for s in t), signature="ay")
292
306
    ENTRY_GROUP_ESTABLISHED = 2  # avahi-common/defs.h
297
311
    SERVER_RUNNING = 2           # avahi-common/defs.h
298
312
    SERVER_COLLISION = 3         # avahi-common/defs.h
299
313
    SERVER_FAILURE = 4           # avahi-common/defs.h
300
 
avahi = Avahi()
301
314
 
302
315
 
303
316
class AvahiError(Exception):
315
328
    pass
316
329
 
317
330
 
318
 
class AvahiService(object):
 
331
class AvahiService:
319
332
    """An Avahi (Zeroconf) service.
320
333
 
321
334
    Attributes:
495
508
class AvahiServiceToSyslog(AvahiService):
496
509
    def rename(self, *args, **kwargs):
497
510
        """Add the new name to the syslog messages"""
498
 
        ret = AvahiService.rename(self, *args, **kwargs)
 
511
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
499
512
        syslogger.setFormatter(logging.Formatter(
500
513
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
501
514
            .format(self.name)))
503
516
 
504
517
 
505
518
# Pretend that we have a GnuTLS module
506
 
class GnuTLS(object):
507
 
    """This isn't so much a class as it is a module-like namespace.
508
 
    It is instantiated once, and simulates having a GnuTLS module."""
 
519
class gnutls:
 
520
    """This isn't so much a class as it is a module-like namespace."""
509
521
 
510
522
    library = ctypes.util.find_library("gnutls")
511
523
    if library is None:
512
524
        library = ctypes.util.find_library("gnutls-deb0")
513
525
    _library = ctypes.cdll.LoadLibrary(library)
514
526
    del library
515
 
    _need_version = b"3.3.0"
516
 
 
517
 
    def __init__(self):
518
 
        # Need to use "self" here, since this method is called before
519
 
        # the assignment to the "gnutls" global variable happens.
520
 
        if self.check_version(self._need_version) is None:
521
 
            raise self.Error("Needs GnuTLS {} or later"
522
 
                             .format(self._need_version))
523
527
 
524
528
    # Unless otherwise indicated, the constants and types below are
525
529
    # all from the gnutls/gnutls.h C header file.
529
533
    E_INTERRUPTED = -52
530
534
    E_AGAIN = -28
531
535
    CRT_OPENPGP = 2
 
536
    CRT_RAWPK = 3
532
537
    CLIENT = 2
533
538
    SHUT_RDWR = 0
534
539
    CRD_CERTIFICATE = 1
535
540
    E_NO_CERTIFICATE_FOUND = -49
 
541
    X509_FMT_DER = 0
 
542
    NO_TICKETS = 1<<10
 
543
    ENABLE_RAWPK = 1<<18
 
544
    CTYPE_PEERS = 3
 
545
    KEYID_USE_SHA256 = 1        # gnutls/x509.h
536
546
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
537
547
 
538
548
    # Types
561
571
 
562
572
    # Exceptions
563
573
    class Error(Exception):
564
 
        # We need to use the class name "GnuTLS" here, since this
565
 
        # exception might be raised from within GnuTLS.__init__,
566
 
        # which is called before the assignment to the "gnutls"
567
 
        # global variable has happened.
568
574
        def __init__(self, message=None, code=None, args=()):
569
575
            # Default usage is by a message string, but if a return
570
576
            # code is passed, convert it to a string with
571
577
            # gnutls.strerror()
572
578
            self.code = code
573
579
            if message is None and code is not None:
574
 
                message = GnuTLS.strerror(code)
575
 
            return super(GnuTLS.Error, self).__init__(
 
580
                message = gnutls.strerror(code)
 
581
            return super(gnutls.Error, self).__init__(
576
582
                message, *args)
577
583
 
578
584
    class CertificateSecurityError(Error):
579
585
        pass
580
586
 
581
587
    # Classes
582
 
    class Credentials(object):
 
588
    class Credentials:
583
589
        def __init__(self):
584
590
            self._c_object = gnutls.certificate_credentials_t()
585
591
            gnutls.certificate_allocate_credentials(
589
595
        def __del__(self):
590
596
            gnutls.certificate_free_credentials(self._c_object)
591
597
 
592
 
    class ClientSession(object):
 
598
    class ClientSession:
593
599
        def __init__(self, socket, credentials=None):
594
600
            self._c_object = gnutls.session_t()
595
 
            gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
 
601
            gnutls_flags = gnutls.CLIENT
 
602
            if gnutls.check_version(b"3.5.6"):
 
603
                gnutls_flags |= gnutls.NO_TICKETS
 
604
            if gnutls.has_rawpk:
 
605
                gnutls_flags |= gnutls.ENABLE_RAWPK
 
606
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
 
607
            del gnutls_flags
596
608
            gnutls.set_default_priority(self._c_object)
597
609
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
598
610
            gnutls.handshake_set_private_extensions(self._c_object,
730
742
    check_version.argtypes = [ctypes.c_char_p]
731
743
    check_version.restype = ctypes.c_char_p
732
744
 
733
 
    # All the function declarations below are from gnutls/openpgp.h
734
 
 
735
 
    openpgp_crt_init = _library.gnutls_openpgp_crt_init
736
 
    openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
737
 
    openpgp_crt_init.restype = _error_code
738
 
 
739
 
    openpgp_crt_import = _library.gnutls_openpgp_crt_import
740
 
    openpgp_crt_import.argtypes = [openpgp_crt_t,
741
 
                                   ctypes.POINTER(datum_t),
742
 
                                   openpgp_crt_fmt_t]
743
 
    openpgp_crt_import.restype = _error_code
744
 
 
745
 
    openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
746
 
    openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
747
 
                                        ctypes.POINTER(ctypes.c_uint)]
748
 
    openpgp_crt_verify_self.restype = _error_code
749
 
 
750
 
    openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
751
 
    openpgp_crt_deinit.argtypes = [openpgp_crt_t]
752
 
    openpgp_crt_deinit.restype = None
753
 
 
754
 
    openpgp_crt_get_fingerprint = (
755
 
        _library.gnutls_openpgp_crt_get_fingerprint)
756
 
    openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
757
 
                                            ctypes.c_void_p,
758
 
                                            ctypes.POINTER(
759
 
                                                ctypes.c_size_t)]
760
 
    openpgp_crt_get_fingerprint.restype = _error_code
 
745
    _need_version = b"3.3.0"
 
746
    if check_version(_need_version) is None:
 
747
        raise self.Error("Needs GnuTLS {} or later"
 
748
                         .format(_need_version))
 
749
 
 
750
    _tls_rawpk_version = b"3.6.6"
 
751
    has_rawpk = bool(check_version(_tls_rawpk_version))
 
752
 
 
753
    if has_rawpk:
 
754
        # Types
 
755
        class pubkey_st(ctypes.Structure):
 
756
            _fields = []
 
757
        pubkey_t = ctypes.POINTER(pubkey_st)
 
758
 
 
759
        x509_crt_fmt_t = ctypes.c_int
 
760
 
 
761
        # All the function declarations below are from gnutls/abstract.h
 
762
        pubkey_init = _library.gnutls_pubkey_init
 
763
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
 
764
        pubkey_init.restype = _error_code
 
765
 
 
766
        pubkey_import = _library.gnutls_pubkey_import
 
767
        pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
 
768
                                  x509_crt_fmt_t]
 
769
        pubkey_import.restype = _error_code
 
770
 
 
771
        pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
 
772
        pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
 
773
                                      ctypes.POINTER(ctypes.c_ubyte),
 
774
                                      ctypes.POINTER(ctypes.c_size_t)]
 
775
        pubkey_get_key_id.restype = _error_code
 
776
 
 
777
        pubkey_deinit = _library.gnutls_pubkey_deinit
 
778
        pubkey_deinit.argtypes = [pubkey_t]
 
779
        pubkey_deinit.restype = None
 
780
    else:
 
781
        # All the function declarations below are from gnutls/openpgp.h
 
782
 
 
783
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
784
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
785
        openpgp_crt_init.restype = _error_code
 
786
 
 
787
        openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
788
        openpgp_crt_import.argtypes = [openpgp_crt_t,
 
789
                                       ctypes.POINTER(datum_t),
 
790
                                       openpgp_crt_fmt_t]
 
791
        openpgp_crt_import.restype = _error_code
 
792
 
 
793
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
794
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
795
                                            ctypes.POINTER(ctypes.c_uint)]
 
796
        openpgp_crt_verify_self.restype = _error_code
 
797
 
 
798
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
799
        openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
800
        openpgp_crt_deinit.restype = None
 
801
 
 
802
        openpgp_crt_get_fingerprint = (
 
803
            _library.gnutls_openpgp_crt_get_fingerprint)
 
804
        openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
805
                                                ctypes.c_void_p,
 
806
                                                ctypes.POINTER(
 
807
                                                    ctypes.c_size_t)]
 
808
        openpgp_crt_get_fingerprint.restype = _error_code
 
809
 
 
810
    if check_version(b"3.6.4"):
 
811
        certificate_type_get2 = _library.gnutls_certificate_type_get2
 
812
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
 
813
        certificate_type_get2.restype = _error_code
761
814
 
762
815
    # Remove non-public functions
763
816
    del _error_code, _retry_on_error
764
 
# Create the global "gnutls" object, simulating a module
765
 
gnutls = GnuTLS()
766
817
 
767
818
 
768
819
def call_pipe(connection,       # : multiprocessing.Connection
776
827
    connection.close()
777
828
 
778
829
 
779
 
class Client(object):
 
830
class Client:
780
831
    """A representation of a client host served by this server.
781
832
 
782
833
    Attributes:
783
834
    approved:   bool(); 'None' if not yet approved/disapproved
784
835
    approval_delay: datetime.timedelta(); Time to wait for approval
785
836
    approval_duration: datetime.timedelta(); Duration of one approval
786
 
    checker:    subprocess.Popen(); a running checker process used
787
 
                                    to see if the client lives.
788
 
                                    'None' if no process is running.
 
837
    checker: multiprocessing.Process(); a running checker process used
 
838
             to see if the client lives. 'None' if no process is
 
839
             running.
789
840
    checker_callback_tag: a GLib event source tag, or None
790
841
    checker_command: string; External command which is run to check
791
842
                     if client lives.  %() expansions are done at
799
850
    disable_initiator_tag: a GLib event source tag, or None
800
851
    enabled:    bool()
801
852
    fingerprint: string (40 or 32 hexadecimal digits); used to
802
 
                 uniquely identify the client
 
853
                 uniquely identify an OpenPGP client
 
854
    key_id: string (64 hexadecimal digits); used to uniquely identify
 
855
            a client using raw public keys
803
856
    host:       string; available for use by the checker command
804
857
    interval:   datetime.timedelta(); How often to start a new checker
805
858
    last_approval_request: datetime.datetime(); (UTC) or None
823
876
    """
824
877
 
825
878
    runtime_expansions = ("approval_delay", "approval_duration",
826
 
                          "created", "enabled", "expires",
 
879
                          "created", "enabled", "expires", "key_id",
827
880
                          "fingerprint", "host", "interval",
828
881
                          "last_approval_request", "last_checked_ok",
829
882
                          "last_enabled", "name", "timeout")
859
912
            client["enabled"] = config.getboolean(client_name,
860
913
                                                  "enabled")
861
914
 
862
 
            # Uppercase and remove spaces from fingerprint for later
863
 
            # comparison purposes with return value from the
864
 
            # fingerprint() function
 
915
            # Uppercase and remove spaces from key_id and fingerprint
 
916
            # for later comparison purposes with return value from the
 
917
            # key_id() and fingerprint() functions
 
918
            client["key_id"] = (section.get("key_id", "").upper()
 
919
                                .replace(" ", ""))
865
920
            client["fingerprint"] = (section["fingerprint"].upper()
866
921
                                     .replace(" ", ""))
867
922
            if "secret" in section:
911
966
            self.expires = None
912
967
 
913
968
        logger.debug("Creating client %r", self.name)
 
969
        logger.debug("  Key ID: %s", self.key_id)
914
970
        logger.debug("  Fingerprint: %s", self.fingerprint)
915
971
        self.created = settings.get("created",
916
972
                                    datetime.datetime.utcnow())
980
1036
        if self.checker_initiator_tag is not None:
981
1037
            GLib.source_remove(self.checker_initiator_tag)
982
1038
        self.checker_initiator_tag = GLib.timeout_add(
983
 
            int(self.interval.total_seconds() * 1000),
 
1039
            random.randrange(int(self.interval.total_seconds() * 1000
 
1040
                                 + 1)),
984
1041
            self.start_checker)
985
1042
        # Schedule a disable() when 'timeout' has passed
986
1043
        if self.disable_initiator_tag is not None:
993
1050
    def checker_callback(self, source, condition, connection,
994
1051
                         command):
995
1052
        """The checker has completed, so take appropriate actions."""
996
 
        self.checker_callback_tag = None
997
 
        self.checker = None
998
1053
        # Read return code from connection (see call_pipe)
999
1054
        returncode = connection.recv()
1000
1055
        connection.close()
 
1056
        if self.checker is not None:
 
1057
            self.checker.join()
 
1058
        self.checker_callback_tag = None
 
1059
        self.checker = None
1001
1060
 
1002
1061
        if returncode >= 0:
1003
1062
            self.last_checker_status = returncode
1092
1151
                kwargs=popen_args)
1093
1152
            self.checker.start()
1094
1153
            self.checker_callback_tag = GLib.io_add_watch(
1095
 
                pipe[0].fileno(), GLib.IO_IN,
 
1154
                GLib.IOChannel.unix_new(pipe[0].fileno()),
 
1155
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1096
1156
                self.checker_callback, pipe[0], command)
1097
1157
        # Re-run this periodically if run by GLib.timeout_add
1098
1158
        return True
1353
1413
                raise ValueError("Byte arrays not supported for non-"
1354
1414
                                 "'ay' signature {!r}"
1355
1415
                                 .format(prop._dbus_signature))
1356
 
            value = dbus.ByteArray(b''.join(chr(byte)
1357
 
                                            for byte in value))
 
1416
            value = dbus.ByteArray(bytes(value))
1358
1417
        prop(value)
1359
1418
 
1360
1419
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1998
2057
    def Name_dbus_property(self):
1999
2058
        return dbus.String(self.name)
2000
2059
 
 
2060
    # KeyID - property
 
2061
    @dbus_annotations(
 
2062
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
 
2063
    @dbus_service_property(_interface, signature="s", access="read")
 
2064
    def KeyID_dbus_property(self):
 
2065
        return dbus.String(self.key_id)
 
2066
 
2001
2067
    # Fingerprint - property
2002
2068
    @dbus_annotations(
2003
2069
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2158
2224
    del _interface
2159
2225
 
2160
2226
 
2161
 
class ProxyClient(object):
2162
 
    def __init__(self, child_pipe, fpr, address):
 
2227
class ProxyClient:
 
2228
    def __init__(self, child_pipe, key_id, fpr, address):
2163
2229
        self._pipe = child_pipe
2164
 
        self._pipe.send(('init', fpr, address))
 
2230
        self._pipe.send(('init', key_id, fpr, address))
2165
2231
        if not self._pipe.recv():
2166
 
            raise KeyError(fpr)
 
2232
            raise KeyError(key_id or fpr)
2167
2233
 
2168
2234
    def __getattribute__(self, name):
2169
2235
        if name == '_pipe':
2236
2302
 
2237
2303
            approval_required = False
2238
2304
            try:
2239
 
                try:
2240
 
                    fpr = self.fingerprint(
2241
 
                        self.peer_certificate(session))
2242
 
                except (TypeError, gnutls.Error) as error:
2243
 
                    logger.warning("Bad certificate: %s", error)
2244
 
                    return
2245
 
                logger.debug("Fingerprint: %s", fpr)
2246
 
 
2247
 
                try:
2248
 
                    client = ProxyClient(child_pipe, fpr,
 
2305
                if gnutls.has_rawpk:
 
2306
                    fpr = b""
 
2307
                    try:
 
2308
                        key_id = self.key_id(
 
2309
                            self.peer_certificate(session))
 
2310
                    except (TypeError, gnutls.Error) as error:
 
2311
                        logger.warning("Bad certificate: %s", error)
 
2312
                        return
 
2313
                    logger.debug("Key ID: %s", key_id)
 
2314
 
 
2315
                else:
 
2316
                    key_id = b""
 
2317
                    try:
 
2318
                        fpr = self.fingerprint(
 
2319
                            self.peer_certificate(session))
 
2320
                    except (TypeError, gnutls.Error) as error:
 
2321
                        logger.warning("Bad certificate: %s", error)
 
2322
                        return
 
2323
                    logger.debug("Fingerprint: %s", fpr)
 
2324
 
 
2325
                try:
 
2326
                    client = ProxyClient(child_pipe, key_id, fpr,
2249
2327
                                         self.client_address)
2250
2328
                except KeyError:
2251
2329
                    return
2328
2406
 
2329
2407
    @staticmethod
2330
2408
    def peer_certificate(session):
2331
 
        "Return the peer's OpenPGP certificate as a bytestring"
2332
 
        # If not an OpenPGP certificate...
2333
 
        if (gnutls.certificate_type_get(session._c_object)
2334
 
            != gnutls.CRT_OPENPGP):
 
2409
        "Return the peer's certificate as a bytestring"
 
2410
        try:
 
2411
            cert_type = gnutls.certificate_type_get2(session._c_object,
 
2412
                                                     gnutls.CTYPE_PEERS)
 
2413
        except AttributeError:
 
2414
            cert_type = gnutls.certificate_type_get(session._c_object)
 
2415
        if gnutls.has_rawpk:
 
2416
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
 
2417
        else:
 
2418
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
 
2419
        # If not a valid certificate type...
 
2420
        if cert_type not in valid_cert_types:
 
2421
            logger.info("Cert type %r not in %r", cert_type,
 
2422
                        valid_cert_types)
2335
2423
            # ...return invalid data
2336
2424
            return b""
2337
2425
        list_size = ctypes.c_uint(1)
2345
2433
        return ctypes.string_at(cert.data, cert.size)
2346
2434
 
2347
2435
    @staticmethod
 
2436
    def key_id(certificate):
 
2437
        "Convert a certificate bytestring to a hexdigit key ID"
 
2438
        # New GnuTLS "datum" with the public key
 
2439
        datum = gnutls.datum_t(
 
2440
            ctypes.cast(ctypes.c_char_p(certificate),
 
2441
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2442
            ctypes.c_uint(len(certificate)))
 
2443
        # XXX all these need to be created in the gnutls "module"
 
2444
        # New empty GnuTLS certificate
 
2445
        pubkey = gnutls.pubkey_t()
 
2446
        gnutls.pubkey_init(ctypes.byref(pubkey))
 
2447
        # Import the raw public key into the certificate
 
2448
        gnutls.pubkey_import(pubkey,
 
2449
                             ctypes.byref(datum),
 
2450
                             gnutls.X509_FMT_DER)
 
2451
        # New buffer for the key ID
 
2452
        buf = ctypes.create_string_buffer(32)
 
2453
        buf_len = ctypes.c_size_t(len(buf))
 
2454
        # Get the key ID from the raw public key into the buffer
 
2455
        gnutls.pubkey_get_key_id(pubkey,
 
2456
                                 gnutls.KEYID_USE_SHA256,
 
2457
                                 ctypes.cast(ctypes.byref(buf),
 
2458
                                             ctypes.POINTER(ctypes.c_ubyte)),
 
2459
                                 ctypes.byref(buf_len))
 
2460
        # Deinit the certificate
 
2461
        gnutls.pubkey_deinit(pubkey)
 
2462
 
 
2463
        # Convert the buffer to a Python bytestring
 
2464
        key_id = ctypes.string_at(buf, buf_len.value)
 
2465
        # Convert the bytestring to hexadecimal notation
 
2466
        hex_key_id = binascii.hexlify(key_id).upper()
 
2467
        return hex_key_id
 
2468
 
 
2469
    @staticmethod
2348
2470
    def fingerprint(openpgp):
2349
2471
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
2350
2472
        # New GnuTLS "datum" with the OpenPGP public key
2364
2486
                                       ctypes.byref(crtverify))
2365
2487
        if crtverify.value != 0:
2366
2488
            gnutls.openpgp_crt_deinit(crt)
2367
 
            raise gnutls.CertificateSecurityError("Verify failed")
 
2489
            raise gnutls.CertificateSecurityError(code
 
2490
                                                  =crtverify.value)
2368
2491
        # New buffer for the fingerprint
2369
2492
        buf = ctypes.create_string_buffer(20)
2370
2493
        buf_len = ctypes.c_size_t()
2380
2503
        return hex_fpr
2381
2504
 
2382
2505
 
2383
 
class MultiprocessingMixIn(object):
 
2506
class MultiprocessingMixIn:
2384
2507
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2385
2508
 
2386
2509
    def sub_process_main(self, request, address):
2398
2521
        return proc
2399
2522
 
2400
2523
 
2401
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
 
2524
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
2402
2525
    """ adds a pipe to the MixIn """
2403
2526
 
2404
2527
    def process_request(self, request, client_address):
2419
2542
 
2420
2543
 
2421
2544
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2422
 
                     socketserver.TCPServer, object):
 
2545
                     socketserver.TCPServer):
2423
2546
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
2424
2547
 
2425
2548
    Attributes:
2498
2621
                    raise
2499
2622
        # Only bind(2) the socket if we really need to.
2500
2623
        if self.server_address[0] or self.server_address[1]:
 
2624
            if self.server_address[1]:
 
2625
                self.allow_reuse_address = True
2501
2626
            if not self.server_address[0]:
2502
2627
                if self.address_family == socket.AF_INET6:
2503
2628
                    any_address = "::"  # in6addr_any
2556
2681
    def add_pipe(self, parent_pipe, proc):
2557
2682
        # Call "handle_ipc" for both data and EOF events
2558
2683
        GLib.io_add_watch(
2559
 
            parent_pipe.fileno(),
2560
 
            GLib.IO_IN | GLib.IO_HUP,
 
2684
            GLib.IOChannel.unix_new(parent_pipe.fileno()),
 
2685
            GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2561
2686
            functools.partial(self.handle_ipc,
2562
2687
                              parent_pipe=parent_pipe,
2563
2688
                              proc=proc))
2577
2702
        command = request[0]
2578
2703
 
2579
2704
        if command == 'init':
2580
 
            fpr = request[1]
2581
 
            address = request[2]
 
2705
            key_id = request[1].decode("ascii")
 
2706
            fpr = request[2].decode("ascii")
 
2707
            address = request[3]
2582
2708
 
2583
2709
            for c in self.clients.values():
2584
 
                if c.fingerprint == fpr:
 
2710
                if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
 
2711
                    continue
 
2712
                if key_id and c.key_id == key_id:
 
2713
                    client = c
 
2714
                    break
 
2715
                if fpr and c.fingerprint == fpr:
2585
2716
                    client = c
2586
2717
                    break
2587
2718
            else:
2588
 
                logger.info("Client not found for fingerprint: %s, ad"
2589
 
                            "dress: %s", fpr, address)
 
2719
                logger.info("Client not found for key ID: %s, address"
 
2720
                            ": %s", key_id or fpr, address)
2590
2721
                if self.use_dbus:
2591
2722
                    # Emit D-Bus signal
2592
 
                    mandos_dbus_service.ClientNotFound(fpr,
 
2723
                    mandos_dbus_service.ClientNotFound(key_id or fpr,
2593
2724
                                                       address[0])
2594
2725
                parent_pipe.send(False)
2595
2726
                return False
2596
2727
 
2597
2728
            GLib.io_add_watch(
2598
 
                parent_pipe.fileno(),
2599
 
                GLib.IO_IN | GLib.IO_HUP,
 
2729
                GLib.IOChannel.unix_new(parent_pipe.fileno()),
 
2730
                GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2600
2731
                functools.partial(self.handle_ipc,
2601
2732
                                  parent_pipe=parent_pipe,
2602
2733
                                  proc=proc,
2634
2765
def rfc3339_duration_to_delta(duration):
2635
2766
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
2636
2767
 
2637
 
    >>> rfc3339_duration_to_delta("P7D")
2638
 
    datetime.timedelta(7)
2639
 
    >>> rfc3339_duration_to_delta("PT60S")
2640
 
    datetime.timedelta(0, 60)
2641
 
    >>> rfc3339_duration_to_delta("PT60M")
2642
 
    datetime.timedelta(0, 3600)
2643
 
    >>> rfc3339_duration_to_delta("PT24H")
2644
 
    datetime.timedelta(1)
2645
 
    >>> rfc3339_duration_to_delta("P1W")
2646
 
    datetime.timedelta(7)
2647
 
    >>> rfc3339_duration_to_delta("PT5M30S")
2648
 
    datetime.timedelta(0, 330)
2649
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
2650
 
    datetime.timedelta(1, 200)
 
2768
    >>> rfc3339_duration_to_delta("P7D") == datetime.timedelta(7)
 
2769
    True
 
2770
    >>> rfc3339_duration_to_delta("PT60S") == datetime.timedelta(0, 60)
 
2771
    True
 
2772
    >>> rfc3339_duration_to_delta("PT60M") == datetime.timedelta(0, 3600)
 
2773
    True
 
2774
    >>> rfc3339_duration_to_delta("PT24H") == datetime.timedelta(1)
 
2775
    True
 
2776
    >>> rfc3339_duration_to_delta("P1W") == datetime.timedelta(7)
 
2777
    True
 
2778
    >>> rfc3339_duration_to_delta("PT5M30S") == datetime.timedelta(0, 330)
 
2779
    True
 
2780
    >>> rfc3339_duration_to_delta("P1DT3M20S") == datetime.timedelta(1, 200)
 
2781
    True
2651
2782
    """
2652
2783
 
2653
2784
    # Parsing an RFC 3339 duration with regular expressions is not
2733
2864
def string_to_delta(interval):
2734
2865
    """Parse a string and return a datetime.timedelta
2735
2866
 
2736
 
    >>> string_to_delta('7d')
2737
 
    datetime.timedelta(7)
2738
 
    >>> string_to_delta('60s')
2739
 
    datetime.timedelta(0, 60)
2740
 
    >>> string_to_delta('60m')
2741
 
    datetime.timedelta(0, 3600)
2742
 
    >>> string_to_delta('24h')
2743
 
    datetime.timedelta(1)
2744
 
    >>> string_to_delta('1w')
2745
 
    datetime.timedelta(7)
2746
 
    >>> string_to_delta('5m 30s')
2747
 
    datetime.timedelta(0, 330)
 
2867
    >>> string_to_delta('7d') == datetime.timedelta(7)
 
2868
    True
 
2869
    >>> string_to_delta('60s') == datetime.timedelta(0, 60)
 
2870
    True
 
2871
    >>> string_to_delta('60m') == datetime.timedelta(0, 3600)
 
2872
    True
 
2873
    >>> string_to_delta('24h') == datetime.timedelta(1)
 
2874
    True
 
2875
    >>> string_to_delta('1w') == datetime.timedelta(7)
 
2876
    True
 
2877
    >>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
 
2878
    True
2748
2879
    """
2749
2880
 
2750
2881
    try:
2852
2983
 
2853
2984
    options = parser.parse_args()
2854
2985
 
2855
 
    if options.check:
2856
 
        import doctest
2857
 
        fail_count, test_count = doctest.testmod()
2858
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
2859
 
 
2860
2986
    # Default values for config file for server-global settings
 
2987
    if gnutls.has_rawpk:
 
2988
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
 
2989
                    ":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
 
2990
    else:
 
2991
        priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2992
                    ":+SIGN-DSA-SHA256")
2861
2993
    server_defaults = {"interface": "",
2862
2994
                       "address": "",
2863
2995
                       "port": "",
2864
2996
                       "debug": "False",
2865
 
                       "priority":
2866
 
                       "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2867
 
                       ":+SIGN-DSA-SHA256",
 
2997
                       "priority": priority,
2868
2998
                       "servicename": "Mandos",
2869
2999
                       "use_dbus": "True",
2870
3000
                       "use_ipv6": "True",
2875
3005
                       "foreground": "False",
2876
3006
                       "zeroconf": "True",
2877
3007
                       }
 
3008
    del priority
2878
3009
 
2879
3010
    # Parse config file for server-global settings
2880
 
    server_config = configparser.SafeConfigParser(server_defaults)
 
3011
    server_config = configparser.ConfigParser(server_defaults)
2881
3012
    del server_defaults
2882
3013
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
2883
 
    # Convert the SafeConfigParser object to a dict
 
3014
    # Convert the ConfigParser object to a dict
2884
3015
    server_settings = server_config.defaults()
2885
3016
    # Use the appropriate methods on the non-string config options
2886
 
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
3017
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
3018
                   "foreground", "zeroconf"):
2887
3019
        server_settings[option] = server_config.getboolean("DEFAULT",
2888
3020
                                                           option)
2889
3021
    if server_settings["port"]:
2957
3089
                                  server_settings["servicename"])))
2958
3090
 
2959
3091
    # Parse config file with clients
2960
 
    client_config = configparser.SafeConfigParser(Client
2961
 
                                                  .client_defaults)
 
3092
    client_config = configparser.ConfigParser(Client.client_defaults)
2962
3093
    client_config.read(os.path.join(server_settings["configdir"],
2963
3094
                                    "clients.conf"))
2964
3095
 
3035
3166
        # Close all input and output, do double fork, etc.
3036
3167
        daemon()
3037
3168
 
3038
 
    # multiprocessing will use threads, so before we use GLib we need
3039
 
    # to inform GLib that threads will be used.
3040
 
    GLib.threads_init()
 
3169
    if gi.version_info < (3, 10, 2):
 
3170
        # multiprocessing will use threads, so before we use GLib we
 
3171
        # need to inform GLib that threads will be used.
 
3172
        GLib.threads_init()
3041
3173
 
3042
3174
    global main_loop
3043
3175
    # From the Avahi example code
3119
3251
                             if isinstance(s, bytes)
3120
3252
                             else s) for s in
3121
3253
                            value["client_structure"]]
3122
 
                        # .name & .host
3123
 
                        for k in ("name", "host"):
 
3254
                        # .name, .host, and .checker_command
 
3255
                        for k in ("name", "host", "checker_command"):
3124
3256
                            if isinstance(value[k], bytes):
3125
3257
                                value[k] = value[k].decode("utf-8")
 
3258
                        if "key_id" not in value:
 
3259
                            value["key_id"] = ""
 
3260
                        elif "fingerprint" not in value:
 
3261
                            value["fingerprint"] = ""
3126
3262
                    #  old_client_settings
3127
3263
                    # .keys()
3128
3264
                    old_client_settings = {
3132
3268
                        for key, value in
3133
3269
                        bytes_old_client_settings.items()}
3134
3270
                    del bytes_old_client_settings
3135
 
                    # .host
 
3271
                    # .host and .checker_command
3136
3272
                    for value in old_client_settings.values():
3137
 
                        if isinstance(value["host"], bytes):
3138
 
                            value["host"] = (value["host"]
3139
 
                                             .decode("utf-8"))
 
3273
                        for attribute in ("host", "checker_command"):
 
3274
                            if isinstance(value[attribute], bytes):
 
3275
                                value[attribute] = (value[attribute]
 
3276
                                                    .decode("utf-8"))
3140
3277
            os.remove(stored_state_path)
3141
3278
        except IOError as e:
3142
3279
            if e.errno == errno.ENOENT:
3265
3402
                pass
3266
3403
 
3267
3404
            @dbus.service.signal(_interface, signature="ss")
3268
 
            def ClientNotFound(self, fingerprint, address):
 
3405
            def ClientNotFound(self, key_id, address):
3269
3406
                "D-Bus signal"
3270
3407
                pass
3271
3408
 
3467
3604
                sys.exit(1)
3468
3605
            # End of Avahi example code
3469
3606
 
3470
 
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3471
 
                          lambda *args, **kwargs:
3472
 
                          (tcp_server.handle_request
3473
 
                           (*args[2:], **kwargs) or True))
 
3607
        GLib.io_add_watch(
 
3608
            GLib.IOChannel.unix_new(tcp_server.fileno()),
 
3609
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
3610
            lambda *args, **kwargs: (tcp_server.handle_request
 
3611
                                     (*args[2:], **kwargs) or True))
3474
3612
 
3475
3613
        logger.debug("Starting main loop")
3476
3614
        main_loop.run()
3486
3624
    # Must run before the D-Bus bus name gets deregistered
3487
3625
    cleanup()
3488
3626
 
 
3627
 
 
3628
def should_only_run_tests():
 
3629
    parser = argparse.ArgumentParser(add_help=False)
 
3630
    parser.add_argument("--check", action='store_true')
 
3631
    args, unknown_args = parser.parse_known_args()
 
3632
    run_tests = args.check
 
3633
    if run_tests:
 
3634
        # Remove --check argument from sys.argv
 
3635
        sys.argv[1:] = unknown_args
 
3636
    return run_tests
 
3637
 
 
3638
# Add all tests from doctest strings
 
3639
def load_tests(loader, tests, none):
 
3640
    import doctest
 
3641
    tests.addTests(doctest.DocTestSuite())
 
3642
    return tests
3489
3643
 
3490
3644
if __name__ == '__main__':
3491
 
    main()
 
3645
    try:
 
3646
        if should_only_run_tests():
 
3647
            # Call using ./mandos --check [--verbose]
 
3648
            unittest.main()
 
3649
        else:
 
3650
            main()
 
3651
    finally:
 
3652
        logging.shutdown()