63
 
import cPickle as pickle
 
 
70
    import cPickle as pickle
 
64
73
import multiprocessing
 
68
85
import dbus.service
 
 
87
from gi.repository import GLib
 
71
88
from dbus.mainloop.glib import DBusGMainLoop
 
74
91
import xml.dom.minidom
 
 
94
if sys.version_info.major == 2:
 
 
98
# Add collections.abc.Callable if it does not exist
 
 
100
    collections.abc.Callable
 
 
101
except AttributeError:
 
 
103
        Callable = collections.Callable
 
 
104
    collections.abc = abc
 
 
107
# Add shlex.quote if it does not exist
 
 
110
except AttributeError:
 
 
111
    shlex.quote = re.escape
 
 
113
# Show warnings by default
 
 
114
if not sys.warnoptions:
 
 
116
    warnings.simplefilter("default")
 
 
118
# Try to find the value of SO_BINDTODEVICE:
 
 
120
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
 
 
121
    # newer, and it is also the most natural place for it:
 
78
122
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
 
79
123
except AttributeError:
 
 
125
        # This is where SO_BINDTODEVICE was up to and including Python
 
81
127
        from IN import SO_BINDTODEVICE
 
82
128
    except ImportError:
 
83
 
        SO_BINDTODEVICE = None
 
88
 
#logger = logging.getLogger('mandos')
 
89
 
logger = logging.Logger('mandos')
 
90
 
syslogger = (logging.handlers.SysLogHandler
 
91
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
92
 
              address = str("/dev/log")))
 
93
 
syslogger.setFormatter(logging.Formatter
 
94
 
                       ('Mandos [%(process)d]: %(levelname)s:'
 
96
 
logger.addHandler(syslogger)
 
98
 
console = logging.StreamHandler()
 
99
 
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
 
102
 
logger.addHandler(console)
 
 
129
        # In Python 2.7 it seems to have been removed entirely.
 
 
130
        # Try running the C preprocessor:
 
 
132
            cc = subprocess.Popen(["cc", "--language=c", "-E",
 
 
134
                                  stdin=subprocess.PIPE,
 
 
135
                                  stdout=subprocess.PIPE)
 
 
136
            stdout = cc.communicate(
 
 
137
                "#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
 
 
138
            SO_BINDTODEVICE = int(stdout.splitlines()[-1])
 
 
139
        except (OSError, ValueError, IndexError):
 
 
141
            SO_BINDTODEVICE = None
 
 
143
if sys.version_info < (3, 2):
 
 
144
    configparser.Configparser = configparser.SafeConfigParser
 
 
147
stored_state_file = "clients.pickle"
 
 
149
logger = logging.getLogger()
 
 
150
logging.captureWarnings(True)   # Show warnings via the logging system
 
 
154
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
 
155
        ctypes.util.find_library("c")).if_nametoindex
 
 
156
except (OSError, AttributeError):
 
 
158
    def if_nametoindex(interface):
 
 
159
        "Get an interface index the hard way, i.e. using fcntl()"
 
 
160
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
 
161
        with contextlib.closing(socket.socket()) as s:
 
 
162
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
 
163
                                struct.pack(b"16s16x", interface))
 
 
164
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
 
165
        return interface_index
 
 
168
def copy_function(func):
 
 
169
    """Make a copy of a function"""
 
 
170
    if sys.version_info.major == 2:
 
 
171
        return types.FunctionType(func.func_code,
 
 
177
        return types.FunctionType(func.__code__,
 
 
184
def initlogger(debug, level=logging.WARNING):
 
 
185
    """init logger and add loglevel"""
 
 
188
    syslogger = (logging.handlers.SysLogHandler(
 
 
189
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
 
 
191
    syslogger.setFormatter(logging.Formatter
 
 
192
                           ('Mandos [%(process)d]: %(levelname)s:'
 
 
194
    logger.addHandler(syslogger)
 
 
197
        console = logging.StreamHandler()
 
 
198
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
 
202
        logger.addHandler(console)
 
 
203
    logger.setLevel(level)
 
 
206
class PGPError(Exception):
 
 
207
    """Exception if encryption/decryption fails"""
 
 
212
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
 
215
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
 
218
            output = subprocess.check_output(["gpgconf"])
 
 
219
            for line in output.splitlines():
 
 
220
                name, text, path = line.split(b":")
 
 
225
            if e.errno != errno.ENOENT:
 
 
227
        self.gnupgargs = ['--batch',
 
 
228
                          '--homedir', self.tempdir,
 
 
231
        # Only GPG version 1 has the --no-use-agent option.
 
 
232
        if self.gpg == b"gpg" or self.gpg.endswith(b"/gpg"):
 
 
233
            self.gnupgargs.append("--no-use-agent")
 
 
238
    def __exit__(self, exc_type, exc_value, traceback):
 
 
246
        if self.tempdir is not None:
 
 
247
            # Delete contents of tempdir
 
 
248
            for root, dirs, files in os.walk(self.tempdir,
 
 
250
                for filename in files:
 
 
251
                    os.remove(os.path.join(root, filename))
 
 
253
                    os.rmdir(os.path.join(root, dirname))
 
 
255
            os.rmdir(self.tempdir)
 
 
258
    def password_encode(self, password):
 
 
259
        # Passphrase can not be empty and can not contain newlines or
 
 
260
        # NUL bytes.  So we prefix it and hex encode it.
 
 
261
        encoded = b"mandos" + binascii.hexlify(password)
 
 
262
        if len(encoded) > 2048:
 
 
263
            # GnuPG can't handle long passwords, so encode differently
 
 
264
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
 
 
265
                       .replace(b"\n", b"\\n")
 
 
266
                       .replace(b"\0", b"\\x00"))
 
 
269
    def encrypt(self, data, password):
 
 
270
        passphrase = self.password_encode(password)
 
 
271
        with tempfile.NamedTemporaryFile(
 
 
272
                dir=self.tempdir) as passfile:
 
 
273
            passfile.write(passphrase)
 
 
275
            proc = subprocess.Popen([self.gpg, '--symmetric',
 
 
279
                                    stdin=subprocess.PIPE,
 
 
280
                                    stdout=subprocess.PIPE,
 
 
281
                                    stderr=subprocess.PIPE)
 
 
282
            ciphertext, err = proc.communicate(input=data)
 
 
283
        if proc.returncode != 0:
 
 
287
    def decrypt(self, data, password):
 
 
288
        passphrase = self.password_encode(password)
 
 
289
        with tempfile.NamedTemporaryFile(
 
 
290
                dir=self.tempdir) as passfile:
 
 
291
            passfile.write(passphrase)
 
 
293
            proc = subprocess.Popen([self.gpg, '--decrypt',
 
 
297
                                    stdin=subprocess.PIPE,
 
 
298
                                    stdout=subprocess.PIPE,
 
 
299
                                    stderr=subprocess.PIPE)
 
 
300
            decrypted_plaintext, err = proc.communicate(input=data)
 
 
301
        if proc.returncode != 0:
 
 
303
        return decrypted_plaintext
 
 
306
# Pretend that we have an Avahi module
 
 
308
    """This isn't so much a class as it is a module-like namespace."""
 
 
309
    IF_UNSPEC = -1               # avahi-common/address.h
 
 
310
    PROTO_UNSPEC = -1            # avahi-common/address.h
 
 
311
    PROTO_INET = 0               # avahi-common/address.h
 
 
312
    PROTO_INET6 = 1              # avahi-common/address.h
 
 
313
    DBUS_NAME = "org.freedesktop.Avahi"
 
 
314
    DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
 
 
315
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
 
 
316
    DBUS_PATH_SERVER = "/"
 
 
319
    def string_array_to_txt_array(t):
 
 
320
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
 
 
321
                           for s in t), signature="ay")
 
 
322
    ENTRY_GROUP_ESTABLISHED = 2  # avahi-common/defs.h
 
 
323
    ENTRY_GROUP_COLLISION = 3    # avahi-common/defs.h
 
 
324
    ENTRY_GROUP_FAILURE = 4      # avahi-common/defs.h
 
 
325
    SERVER_INVALID = 0           # avahi-common/defs.h
 
 
326
    SERVER_REGISTERING = 1       # avahi-common/defs.h
 
 
327
    SERVER_RUNNING = 2           # avahi-common/defs.h
 
 
328
    SERVER_COLLISION = 3         # avahi-common/defs.h
 
 
329
    SERVER_FAILURE = 4           # avahi-common/defs.h
 
104
332
class AvahiError(Exception):
 
105
333
    def __init__(self, value, *args, **kwargs):
 
106
334
        self.value = value
 
107
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
 
108
 
    def __unicode__(self):
 
109
 
        return unicode(repr(self.value))
 
 
335
        return super(AvahiError, self).__init__(value, *args,
 
111
339
class AvahiServiceError(AvahiError):
 
114
343
class AvahiGroupError(AvahiError):
 
118
 
class AvahiService(object):
 
119
348
    """An Avahi (Zeroconf) service.
 
122
351
    interface: integer; avahi.IF_UNSPEC or an interface index.
 
123
352
               Used to optionally bind to the specified interface.
 
124
353
    name: string; Example: 'Mandos'
 
125
354
    type: string; Example: '_mandos._tcp'.
 
126
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
 
355
     See <https://www.iana.org/assignments/service-names-port-numbers>
 
127
356
    port: integer; what port to announce
 
128
357
    TXT: list of strings; TXT record for the service
 
129
358
    domain: string; Domain to publish on, default to .local if empty.
 
 
262
517
                                    follow_name_owner_changes=True),
 
263
518
                avahi.DBUS_INTERFACE_SERVER)
 
264
519
        self.server.connect_to_signal("StateChanged",
 
265
 
                                 self.server_state_changed)
 
 
520
                                      self.server_state_changed)
 
266
521
        self.server_state_changed(self.server.GetState())
 
269
 
def _timedelta_to_milliseconds(td):
 
270
 
    "Convert a datetime.timedelta() to milliseconds"
 
271
 
    return ((td.days * 24 * 60 * 60 * 1000)
 
272
 
            + (td.seconds * 1000)
 
273
 
            + (td.microseconds // 1000))
 
275
 
class Client(object):
 
 
524
class AvahiServiceToSyslog(AvahiService):
 
 
525
    def rename(self, *args, **kwargs):
 
 
526
        """Add the new name to the syslog messages"""
 
 
527
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
 
 
528
        syslogger.setFormatter(logging.Formatter(
 
 
529
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
 
534
# Pretend that we have a GnuTLS module
 
 
536
    """This isn't so much a class as it is a module-like namespace."""
 
 
538
    library = ctypes.util.find_library("gnutls")
 
 
540
        library = ctypes.util.find_library("gnutls-deb0")
 
 
541
    _library = ctypes.cdll.LoadLibrary(library)
 
 
544
    # Unless otherwise indicated, the constants and types below are
 
 
545
    # all from the gnutls/gnutls.h C header file.
 
 
556
    E_NO_CERTIFICATE_FOUND = -49
 
 
561
    KEYID_USE_SHA256 = 1        # gnutls/x509.h
 
 
562
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
 
 
565
    class session_int(ctypes.Structure):
 
 
567
    session_t = ctypes.POINTER(session_int)
 
 
569
    class certificate_credentials_st(ctypes.Structure):
 
 
571
    certificate_credentials_t = ctypes.POINTER(
 
 
572
        certificate_credentials_st)
 
 
573
    certificate_type_t = ctypes.c_int
 
 
575
    class datum_t(ctypes.Structure):
 
 
576
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
 
577
                    ('size', ctypes.c_uint)]
 
 
579
    class openpgp_crt_int(ctypes.Structure):
 
 
581
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
 
582
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
 
 
583
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
 
 
584
    credentials_type_t = ctypes.c_int
 
 
585
    transport_ptr_t = ctypes.c_void_p
 
 
586
    close_request_t = ctypes.c_int
 
 
589
    class Error(Exception):
 
 
590
        def __init__(self, message=None, code=None, args=()):
 
 
591
            # Default usage is by a message string, but if a return
 
 
592
            # code is passed, convert it to a string with
 
 
595
            if message is None and code is not None:
 
 
596
                message = gnutls.strerror(code)
 
 
597
            return super(gnutls.Error, self).__init__(
 
 
600
    class CertificateSecurityError(Error):
 
 
606
            self._c_object = gnutls.certificate_credentials_t()
 
 
607
            gnutls.certificate_allocate_credentials(
 
 
608
                ctypes.byref(self._c_object))
 
 
609
            self.type = gnutls.CRD_CERTIFICATE
 
 
612
            gnutls.certificate_free_credentials(self._c_object)
 
 
615
        def __init__(self, socket, credentials=None):
 
 
616
            self._c_object = gnutls.session_t()
 
 
617
            gnutls_flags = gnutls.CLIENT
 
 
618
            if gnutls.check_version(b"3.5.6"):
 
 
619
                gnutls_flags |= gnutls.NO_TICKETS
 
 
621
                gnutls_flags |= gnutls.ENABLE_RAWPK
 
 
622
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
 
 
624
            gnutls.set_default_priority(self._c_object)
 
 
625
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
 
626
            gnutls.handshake_set_private_extensions(self._c_object,
 
 
629
            if credentials is None:
 
 
630
                credentials = gnutls.Credentials()
 
 
631
            gnutls.credentials_set(self._c_object, credentials.type,
 
 
632
                                   ctypes.cast(credentials._c_object,
 
 
634
            self.credentials = credentials
 
 
637
            gnutls.deinit(self._c_object)
 
 
640
            return gnutls.handshake(self._c_object)
 
 
642
        def send(self, data):
 
 
646
                data_len -= gnutls.record_send(self._c_object,
 
 
651
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
 
653
    # Error handling functions
 
 
654
    def _error_code(result):
 
 
655
        """A function to raise exceptions on errors, suitable
 
 
656
        for the 'restype' attribute on ctypes functions"""
 
 
659
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
 
 
660
            raise gnutls.CertificateSecurityError(code=result)
 
 
661
        raise gnutls.Error(code=result)
 
 
663
    def _retry_on_error(result, func, arguments):
 
 
664
        """A function to retry on some errors, suitable
 
 
665
        for the 'errcheck' attribute on ctypes functions"""
 
 
667
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
 
 
668
                return _error_code(result)
 
 
669
            result = func(*arguments)
 
 
672
    # Unless otherwise indicated, the function declarations below are
 
 
673
    # all from the gnutls/gnutls.h C header file.
 
 
676
    priority_set_direct = _library.gnutls_priority_set_direct
 
 
677
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
 
678
                                    ctypes.POINTER(ctypes.c_char_p)]
 
 
679
    priority_set_direct.restype = _error_code
 
 
681
    init = _library.gnutls_init
 
 
682
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
 
683
    init.restype = _error_code
 
 
685
    set_default_priority = _library.gnutls_set_default_priority
 
 
686
    set_default_priority.argtypes = [session_t]
 
 
687
    set_default_priority.restype = _error_code
 
 
689
    record_send = _library.gnutls_record_send
 
 
690
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
 
692
    record_send.restype = ctypes.c_ssize_t
 
 
693
    record_send.errcheck = _retry_on_error
 
 
695
    certificate_allocate_credentials = (
 
 
696
        _library.gnutls_certificate_allocate_credentials)
 
 
697
    certificate_allocate_credentials.argtypes = [
 
 
698
        ctypes.POINTER(certificate_credentials_t)]
 
 
699
    certificate_allocate_credentials.restype = _error_code
 
 
701
    certificate_free_credentials = (
 
 
702
        _library.gnutls_certificate_free_credentials)
 
 
703
    certificate_free_credentials.argtypes = [
 
 
704
        certificate_credentials_t]
 
 
705
    certificate_free_credentials.restype = None
 
 
707
    handshake_set_private_extensions = (
 
 
708
        _library.gnutls_handshake_set_private_extensions)
 
 
709
    handshake_set_private_extensions.argtypes = [session_t,
 
 
711
    handshake_set_private_extensions.restype = None
 
 
713
    credentials_set = _library.gnutls_credentials_set
 
 
714
    credentials_set.argtypes = [session_t, credentials_type_t,
 
 
716
    credentials_set.restype = _error_code
 
 
718
    strerror = _library.gnutls_strerror
 
 
719
    strerror.argtypes = [ctypes.c_int]
 
 
720
    strerror.restype = ctypes.c_char_p
 
 
722
    certificate_type_get = _library.gnutls_certificate_type_get
 
 
723
    certificate_type_get.argtypes = [session_t]
 
 
724
    certificate_type_get.restype = _error_code
 
 
726
    certificate_get_peers = _library.gnutls_certificate_get_peers
 
 
727
    certificate_get_peers.argtypes = [session_t,
 
 
728
                                      ctypes.POINTER(ctypes.c_uint)]
 
 
729
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
 
 
731
    global_set_log_level = _library.gnutls_global_set_log_level
 
 
732
    global_set_log_level.argtypes = [ctypes.c_int]
 
 
733
    global_set_log_level.restype = None
 
 
735
    global_set_log_function = _library.gnutls_global_set_log_function
 
 
736
    global_set_log_function.argtypes = [log_func]
 
 
737
    global_set_log_function.restype = None
 
 
739
    deinit = _library.gnutls_deinit
 
 
740
    deinit.argtypes = [session_t]
 
 
741
    deinit.restype = None
 
 
743
    handshake = _library.gnutls_handshake
 
 
744
    handshake.argtypes = [session_t]
 
 
745
    handshake.restype = _error_code
 
 
746
    handshake.errcheck = _retry_on_error
 
 
748
    transport_set_ptr = _library.gnutls_transport_set_ptr
 
 
749
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
 
750
    transport_set_ptr.restype = None
 
 
752
    bye = _library.gnutls_bye
 
 
753
    bye.argtypes = [session_t, close_request_t]
 
 
754
    bye.restype = _error_code
 
 
755
    bye.errcheck = _retry_on_error
 
 
757
    check_version = _library.gnutls_check_version
 
 
758
    check_version.argtypes = [ctypes.c_char_p]
 
 
759
    check_version.restype = ctypes.c_char_p
 
 
761
    _need_version = b"3.3.0"
 
 
762
    if check_version(_need_version) is None:
 
 
763
        raise self.Error("Needs GnuTLS {} or later"
 
 
764
                         .format(_need_version))
 
 
766
    _tls_rawpk_version = b"3.6.6"
 
 
767
    has_rawpk = bool(check_version(_tls_rawpk_version))
 
 
771
        class pubkey_st(ctypes.Structure):
 
 
773
        pubkey_t = ctypes.POINTER(pubkey_st)
 
 
775
        x509_crt_fmt_t = ctypes.c_int
 
 
777
        # All the function declarations below are from gnutls/abstract.h
 
 
778
        pubkey_init = _library.gnutls_pubkey_init
 
 
779
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
 
 
780
        pubkey_init.restype = _error_code
 
 
782
        pubkey_import = _library.gnutls_pubkey_import
 
 
783
        pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
 
 
785
        pubkey_import.restype = _error_code
 
 
787
        pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
 
 
788
        pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
 
 
789
                                      ctypes.POINTER(ctypes.c_ubyte),
 
 
790
                                      ctypes.POINTER(ctypes.c_size_t)]
 
 
791
        pubkey_get_key_id.restype = _error_code
 
 
793
        pubkey_deinit = _library.gnutls_pubkey_deinit
 
 
794
        pubkey_deinit.argtypes = [pubkey_t]
 
 
795
        pubkey_deinit.restype = None
 
 
797
        # All the function declarations below are from gnutls/openpgp.h
 
 
799
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
 
800
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
 
801
        openpgp_crt_init.restype = _error_code
 
 
803
        openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
 
804
        openpgp_crt_import.argtypes = [openpgp_crt_t,
 
 
805
                                       ctypes.POINTER(datum_t),
 
 
807
        openpgp_crt_import.restype = _error_code
 
 
809
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
 
810
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
 
811
                                            ctypes.POINTER(ctypes.c_uint)]
 
 
812
        openpgp_crt_verify_self.restype = _error_code
 
 
814
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
 
815
        openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
 
816
        openpgp_crt_deinit.restype = None
 
 
818
        openpgp_crt_get_fingerprint = (
 
 
819
            _library.gnutls_openpgp_crt_get_fingerprint)
 
 
820
        openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
 
824
        openpgp_crt_get_fingerprint.restype = _error_code
 
 
826
    if check_version(b"3.6.4"):
 
 
827
        certificate_type_get2 = _library.gnutls_certificate_type_get2
 
 
828
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
 
 
829
        certificate_type_get2.restype = _error_code
 
 
831
    # Remove non-public functions
 
 
832
    del _error_code, _retry_on_error
 
 
835
def call_pipe(connection,       # : multiprocessing.Connection
 
 
836
              func, *args, **kwargs):
 
 
837
    """This function is meant to be called by multiprocessing.Process
 
 
839
    This function runs func(*args, **kwargs), and writes the resulting
 
 
840
    return value on the provided multiprocessing.Connection.
 
 
842
    connection.send(func(*args, **kwargs))
 
276
847
    """A representation of a client host served by this server.
 
279
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
 
850
    approved:   bool(); 'None' if not yet approved/disapproved
 
280
851
    approval_delay: datetime.timedelta(); Time to wait for approval
 
281
852
    approval_duration: datetime.timedelta(); Duration of one approval
 
282
 
    checker:    subprocess.Popen(); a running checker process used
 
283
 
                                    to see if the client lives.
 
284
 
                                    'None' if no process is running.
 
285
 
    checker_callback_tag: a gobject event source tag, or None
 
 
853
    checker: multiprocessing.Process(); a running checker process used
 
 
854
             to see if the client lives. 'None' if no process is
 
 
856
    checker_callback_tag: a GLib event source tag, or None
 
286
857
    checker_command: string; External command which is run to check
 
287
858
                     if client lives.  %() expansions are done at
 
288
859
                     runtime with vars(self) as dict, so that for
 
289
860
                     instance %(name)s can be used in the command.
 
290
 
    checker_initiator_tag: a gobject event source tag, or None
 
 
861
    checker_initiator_tag: a GLib event source tag, or None
 
291
862
    created:    datetime.datetime(); (UTC) object creation
 
 
863
    client_structure: Object describing what attributes a client has
 
 
864
                      and is used for storing the client at exit
 
292
865
    current_checker_command: string; current running checker_command
 
293
 
    disable_hook:  If set, called by disable() as disable_hook(self)
 
294
 
    disable_initiator_tag: a gobject event source tag, or None
 
 
866
    disable_initiator_tag: a GLib event source tag, or None
 
296
868
    fingerprint: string (40 or 32 hexadecimal digits); used to
 
297
 
                 uniquely identify the client
 
 
869
                 uniquely identify an OpenPGP client
 
 
870
    key_id: string (64 hexadecimal digits); used to uniquely identify
 
 
871
            a client using raw public keys
 
298
872
    host:       string; available for use by the checker command
 
299
873
    interval:   datetime.timedelta(); How often to start a new checker
 
300
874
    last_approval_request: datetime.datetime(); (UTC) or None
 
301
875
    last_checked_ok: datetime.datetime(); (UTC) or None
 
302
 
    last_enabled: datetime.datetime(); (UTC)
 
 
876
    last_checker_status: integer between 0 and 255 reflecting exit
 
 
877
                         status of last checker. -1 reflects crashed
 
 
878
                         checker, -2 means no checker completed yet.
 
 
879
    last_checker_signal: The signal which killed the last checker, if
 
 
880
                         last_checker_status is -1
 
 
881
    last_enabled: datetime.datetime(); (UTC) or None
 
303
882
    name:       string; from the config file, used in log messages and
 
304
883
                        D-Bus identifiers
 
305
884
    secret:     bytestring; sent verbatim (over TLS) to client
 
306
885
    timeout:    datetime.timedelta(); How long from last_checked_ok
 
307
886
                                      until this client is disabled
 
308
 
    extended_timeout:   extra long timeout when password has been sent
 
 
887
    extended_timeout:   extra long timeout when secret has been sent
 
309
888
    runtime_expansions: Allowed attributes for runtime expansion.
 
310
889
    expires:    datetime.datetime(); time (UTC) when a client will be
 
311
890
                disabled, or None
 
 
891
    server_settings: The server_settings dict from main()
 
314
894
    runtime_expansions = ("approval_delay", "approval_duration",
 
315
 
                          "created", "enabled", "fingerprint",
 
316
 
                          "host", "interval", "last_checked_ok",
 
 
895
                          "created", "enabled", "expires", "key_id",
 
 
896
                          "fingerprint", "host", "interval",
 
 
897
                          "last_approval_request", "last_checked_ok",
 
317
898
                          "last_enabled", "name", "timeout")
 
319
 
    def timeout_milliseconds(self):
 
320
 
        "Return the 'timeout' attribute in milliseconds"
 
321
 
        return _timedelta_to_milliseconds(self.timeout)
 
323
 
    def extended_timeout_milliseconds(self):
 
324
 
        "Return the 'extended_timeout' attribute in milliseconds"
 
325
 
        return _timedelta_to_milliseconds(self.extended_timeout)
 
327
 
    def interval_milliseconds(self):
 
328
 
        "Return the 'interval' attribute in milliseconds"
 
329
 
        return _timedelta_to_milliseconds(self.interval)
 
331
 
    def approval_delay_milliseconds(self):
 
332
 
        return _timedelta_to_milliseconds(self.approval_delay)
 
334
 
    def __init__(self, name = None, disable_hook=None, config=None):
 
335
 
        """Note: the 'checker' key in 'config' sets the
 
336
 
        'checker_command' attribute and *not* the 'checker'
 
 
901
        "extended_timeout": "PT15M",
 
 
903
        "checker": "fping -q -- %%(host)s",
 
 
905
        "approval_delay": "PT0S",
 
 
906
        "approval_duration": "PT1S",
 
 
907
        "approved_by_default": "True",
 
 
912
    def config_parser(config):
 
 
913
        """Construct a new dict of client settings of this form:
 
 
914
        { client_name: {setting_name: value, ...}, ...}
 
 
915
        with exceptions for any special settings as defined above.
 
 
916
        NOTE: Must be a pure function. Must return the same result
 
 
917
        value given the same arguments.
 
 
920
        for client_name in config.sections():
 
 
921
            section = dict(config.items(client_name))
 
 
922
            client = settings[client_name] = {}
 
 
924
            client["host"] = section["host"]
 
 
925
            # Reformat values from string types to Python types
 
 
926
            client["approved_by_default"] = config.getboolean(
 
 
927
                client_name, "approved_by_default")
 
 
928
            client["enabled"] = config.getboolean(client_name,
 
 
931
            # Uppercase and remove spaces from key_id and fingerprint
 
 
932
            # for later comparison purposes with return value from the
 
 
933
            # key_id() and fingerprint() functions
 
 
934
            client["key_id"] = (section.get("key_id", "").upper()
 
 
936
            client["fingerprint"] = (section["fingerprint"].upper()
 
 
938
            if "secret" in section:
 
 
939
                client["secret"] = codecs.decode(section["secret"]
 
 
942
            elif "secfile" in section:
 
 
943
                with open(os.path.expanduser(os.path.expandvars
 
 
944
                                             (section["secfile"])),
 
 
946
                    client["secret"] = secfile.read()
 
 
948
                raise TypeError("No secret or secfile for section {}"
 
 
950
            client["timeout"] = string_to_delta(section["timeout"])
 
 
951
            client["extended_timeout"] = string_to_delta(
 
 
952
                section["extended_timeout"])
 
 
953
            client["interval"] = string_to_delta(section["interval"])
 
 
954
            client["approval_delay"] = string_to_delta(
 
 
955
                section["approval_delay"])
 
 
956
            client["approval_duration"] = string_to_delta(
 
 
957
                section["approval_duration"])
 
 
958
            client["checker_command"] = section["checker"]
 
 
959
            client["last_approval_request"] = None
 
 
960
            client["last_checked_ok"] = None
 
 
961
            client["last_checker_status"] = -2
 
 
965
    def __init__(self, settings, name=None, server_settings=None):
 
 
967
        if server_settings is None:
 
 
969
        self.server_settings = server_settings
 
 
970
        # adding all client settings
 
 
971
        for setting, value in settings.items():
 
 
972
            setattr(self, setting, value)
 
 
975
            if not hasattr(self, "last_enabled"):
 
 
976
                self.last_enabled = datetime.datetime.utcnow()
 
 
977
            if not hasattr(self, "expires"):
 
 
978
                self.expires = (datetime.datetime.utcnow()
 
 
981
            self.last_enabled = None
 
341
984
        logger.debug("Creating client %r", self.name)
 
342
 
        # Uppercase and remove spaces from fingerprint for later
 
343
 
        # comparison purposes with return value from the fingerprint()
 
345
 
        self.fingerprint = (config["fingerprint"].upper()
 
 
985
        logger.debug("  Key ID: %s", self.key_id)
 
347
986
        logger.debug("  Fingerprint: %s", self.fingerprint)
 
348
 
        if "secret" in config:
 
349
 
            self.secret = config["secret"].decode("base64")
 
350
 
        elif "secfile" in config:
 
351
 
            with open(os.path.expanduser(os.path.expandvars
 
352
 
                                         (config["secfile"])),
 
354
 
                self.secret = secfile.read()
 
356
 
            raise TypeError("No secret or secfile for client %s"
 
358
 
        self.host = config.get("host", "")
 
359
 
        self.created = datetime.datetime.utcnow()
 
361
 
        self.last_approval_request = None
 
362
 
        self.last_enabled = None
 
363
 
        self.last_checked_ok = None
 
364
 
        self.timeout = string_to_delta(config["timeout"])
 
365
 
        self.extended_timeout = string_to_delta(config
 
366
 
                                                ["extended_timeout"])
 
367
 
        self.interval = string_to_delta(config["interval"])
 
368
 
        self.disable_hook = disable_hook
 
 
987
        self.created = settings.get("created",
 
 
988
                                    datetime.datetime.utcnow())
 
 
990
        # attributes specific for this server instance
 
369
991
        self.checker = None
 
370
992
        self.checker_initiator_tag = None
 
371
993
        self.disable_initiator_tag = None
 
373
994
        self.checker_callback_tag = None
 
374
 
        self.checker_command = config["checker"]
 
375
995
        self.current_checker_command = None
 
376
 
        self.last_connect = None
 
377
 
        self._approved = None
 
378
 
        self.approved_by_default = config.get("approved_by_default",
 
380
997
        self.approvals_pending = 0
 
381
 
        self.approval_delay = string_to_delta(
 
382
 
            config["approval_delay"])
 
383
 
        self.approval_duration = string_to_delta(
 
384
 
            config["approval_duration"])
 
385
 
        self.changedstate = (multiprocessing_manager
 
386
 
                             .Condition(multiprocessing_manager
 
 
998
        self.changedstate = multiprocessing_manager.Condition(
 
 
999
            multiprocessing_manager.Lock())
 
 
1000
        self.client_structure = [attr
 
 
1001
                                 for attr in self.__dict__.keys()
 
 
1002
                                 if not attr.startswith("_")]
 
 
1003
        self.client_structure.append("client_structure")
 
 
1005
        for name, t in inspect.getmembers(
 
 
1006
                type(self), lambda obj: isinstance(obj, property)):
 
 
1007
            if not name.startswith("_"):
 
 
1008
                self.client_structure.append(name)
 
 
1010
    # Send notice to process children that client state has changed
 
389
1011
    def send_changedstate(self):
 
390
 
        self.changedstate.acquire()
 
391
 
        self.changedstate.notify_all()
 
392
 
        self.changedstate.release()
 
 
1012
        with self.changedstate:
 
 
1013
            self.changedstate.notify_all()
 
394
1015
    def enable(self):
 
395
1016
        """Start this client's checker and timeout hooks"""
 
396
1017
        if getattr(self, "enabled", False):
 
397
1018
            # Already enabled
 
399
 
        self.send_changedstate()
 
400
 
        # Schedule a new checker to be started an 'interval' from now,
 
401
 
        # and every interval from then on.
 
402
 
        self.checker_initiator_tag = (gobject.timeout_add
 
403
 
                                      (self.interval_milliseconds(),
 
405
 
        # Schedule a disable() when 'timeout' has passed
 
406
1020
        self.expires = datetime.datetime.utcnow() + self.timeout
 
407
 
        self.disable_initiator_tag = (gobject.timeout_add
 
408
 
                                   (self.timeout_milliseconds(),
 
410
1021
        self.enabled = True
 
411
1022
        self.last_enabled = datetime.datetime.utcnow()
 
412
 
        # Also start a new checker *right now*.
 
 
1024
        self.send_changedstate()
 
415
1026
    def disable(self, quiet=True):
 
416
1027
        """Disable this client."""
 
417
1028
        if not getattr(self, "enabled", False):
 
420
 
            self.send_changedstate()
 
422
1031
            logger.info("Disabling client %s", self.name)
 
423
 
        if getattr(self, "disable_initiator_tag", False):
 
424
 
            gobject.source_remove(self.disable_initiator_tag)
 
 
1032
        if getattr(self, "disable_initiator_tag", None) is not None:
 
 
1033
            GLib.source_remove(self.disable_initiator_tag)
 
425
1034
            self.disable_initiator_tag = None
 
426
1035
        self.expires = None
 
427
 
        if getattr(self, "checker_initiator_tag", False):
 
428
 
            gobject.source_remove(self.checker_initiator_tag)
 
 
1036
        if getattr(self, "checker_initiator_tag", None) is not None:
 
 
1037
            GLib.source_remove(self.checker_initiator_tag)
 
429
1038
            self.checker_initiator_tag = None
 
430
1039
        self.stop_checker()
 
431
 
        if self.disable_hook:
 
432
 
            self.disable_hook(self)
 
433
1040
        self.enabled = False
 
434
 
        # Do not run this again if called by a gobject.timeout_add
 
 
1042
            self.send_changedstate()
 
 
1043
        # Do not run this again if called by a GLib.timeout_add
 
437
1046
    def __del__(self):
 
438
 
        self.disable_hook = None
 
441
 
    def checker_callback(self, pid, condition, command):
 
 
1049
    def init_checker(self):
 
 
1050
        # Schedule a new checker to be started an 'interval' from now,
 
 
1051
        # and every interval from then on.
 
 
1052
        if self.checker_initiator_tag is not None:
 
 
1053
            GLib.source_remove(self.checker_initiator_tag)
 
 
1054
        self.checker_initiator_tag = GLib.timeout_add(
 
 
1055
            random.randrange(int(self.interval.total_seconds() * 1000
 
 
1058
        # Schedule a disable() when 'timeout' has passed
 
 
1059
        if self.disable_initiator_tag is not None:
 
 
1060
            GLib.source_remove(self.disable_initiator_tag)
 
 
1061
        self.disable_initiator_tag = GLib.timeout_add(
 
 
1062
            int(self.timeout.total_seconds() * 1000), self.disable)
 
 
1063
        # Also start a new checker *right now*.
 
 
1064
        self.start_checker()
 
 
1066
    def checker_callback(self, source, condition, connection,
 
442
1068
        """The checker has completed, so take appropriate actions."""
 
 
1069
        # Read return code from connection (see call_pipe)
 
 
1070
        returncode = connection.recv()
 
 
1072
        if self.checker is not None:
 
443
1074
        self.checker_callback_tag = None
 
444
1075
        self.checker = None
 
445
 
        if os.WIFEXITED(condition):
 
446
 
            exitstatus = os.WEXITSTATUS(condition)
 
 
1078
            self.last_checker_status = returncode
 
 
1079
            self.last_checker_signal = None
 
 
1080
            if self.last_checker_status == 0:
 
448
1081
                logger.info("Checker for %(name)s succeeded",
 
450
1083
                self.checked_ok()
 
452
 
                logger.info("Checker for %(name)s failed",
 
 
1085
                logger.info("Checker for %(name)s failed", vars(self))
 
 
1087
            self.last_checker_status = -1
 
 
1088
            self.last_checker_signal = -returncode
 
455
1089
            logger.warning("Checker for %(name)s crashed?",
 
458
 
    def checked_ok(self, timeout=None):
 
459
 
        """Bump up the timeout for this client.
 
461
 
        This should only be called when the client has been seen,
 
 
1093
    def checked_ok(self):
 
 
1094
        """Assert that the client has been seen, alive and well."""
 
 
1095
        self.last_checked_ok = datetime.datetime.utcnow()
 
 
1096
        self.last_checker_status = 0
 
 
1097
        self.last_checker_signal = None
 
 
1100
    def bump_timeout(self, timeout=None):
 
 
1101
        """Bump up the timeout for this client."""
 
464
1102
        if timeout is None:
 
465
1103
            timeout = self.timeout
 
466
 
        self.last_checked_ok = datetime.datetime.utcnow()
 
467
 
        gobject.source_remove(self.disable_initiator_tag)
 
468
 
        self.disable_initiator_tag = (gobject.timeout_add
 
469
 
                                      (_timedelta_to_milliseconds
 
470
 
                                       (timeout), self.disable))
 
471
 
        self.expires = datetime.datetime.utcnow() + timeout
 
 
1104
        if self.disable_initiator_tag is not None:
 
 
1105
            GLib.source_remove(self.disable_initiator_tag)
 
 
1106
            self.disable_initiator_tag = None
 
 
1107
        if getattr(self, "enabled", False):
 
 
1108
            self.disable_initiator_tag = GLib.timeout_add(
 
 
1109
                int(timeout.total_seconds() * 1000), self.disable)
 
 
1110
            self.expires = datetime.datetime.utcnow() + timeout
 
473
1112
    def need_approval(self):
 
474
1113
        self.last_approval_request = datetime.datetime.utcnow()
 
476
1115
    def start_checker(self):
 
477
1116
        """Start a new checker subprocess if one is not running.
 
479
1118
        If a checker already exists, leave it running and do
 
481
1120
        # The reason for not killing a running checker is that if we
 
482
 
        # did that, then if a checker (for some reason) started
 
483
 
        # running slowly and taking more than 'interval' time, the
 
484
 
        # client would inevitably timeout, since no checker would get
 
485
 
        # a chance to run to completion.  If we instead leave running
 
 
1121
        # did that, and if a checker (for some reason) started running
 
 
1122
        # slowly and taking more than 'interval' time, then the client
 
 
1123
        # would inevitably timeout, since no checker would get a
 
 
1124
        # chance to run to completion.  If we instead leave running
 
486
1125
        # checkers alone, the checker would have to take more time
 
487
1126
        # than 'timeout' for the client to be disabled, which is as it
 
490
 
        # If a checker exists, make sure it is not a zombie
 
492
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
493
 
        except (AttributeError, OSError) as error:
 
494
 
            if (isinstance(error, OSError)
 
495
 
                and error.errno != errno.ECHILD):
 
499
 
                logger.warning("Checker was a zombie")
 
500
 
                gobject.source_remove(self.checker_callback_tag)
 
501
 
                self.checker_callback(pid, status,
 
502
 
                                      self.current_checker_command)
 
 
1129
        if self.checker is not None and not self.checker.is_alive():
 
 
1130
            logger.warning("Checker was not alive; joining")
 
503
1133
        # Start a new checker if needed
 
504
1134
        if self.checker is None:
 
 
1135
            # Escape attributes for the shell
 
 
1137
                attr: shlex.quote(str(getattr(self, attr)))
 
 
1138
                for attr in self.runtime_expansions}
 
506
 
                # In case checker_command has exactly one % operator
 
507
 
                command = self.checker_command % self.host
 
509
 
                # Escape attributes for the shell
 
510
 
                escaped_attrs = dict(
 
512
 
                     re.escape(unicode(str(getattr(self, attr, "")),
 
516
 
                    self.runtime_expansions)
 
519
 
                    command = self.checker_command % escaped_attrs
 
520
 
                except TypeError as error:
 
521
 
                    logger.error('Could not format string "%s":'
 
522
 
                                 ' %s', self.checker_command, error)
 
523
 
                    return True # Try again later
 
 
1140
                command = self.checker_command % escaped_attrs
 
 
1141
            except TypeError as error:
 
 
1142
                logger.error('Could not format string "%s"',
 
 
1143
                             self.checker_command,
 
 
1145
                return True     # Try again later
 
524
1146
            self.current_checker_command = command
 
526
 
                logger.info("Starting checker %r for %s",
 
528
 
                # We don't need to redirect stdout and stderr, since
 
529
 
                # in normal mode, that is already done by daemon(),
 
530
 
                # and in debug mode we don't want to.  (Stdin is
 
531
 
                # always replaced by /dev/null.)
 
532
 
                self.checker = subprocess.Popen(command,
 
535
 
                self.checker_callback_tag = (gobject.child_watch_add
 
537
 
                                              self.checker_callback,
 
539
 
                # The checker may have completed before the gobject
 
540
 
                # watch was added.  Check for this.
 
541
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
543
 
                    gobject.source_remove(self.checker_callback_tag)
 
544
 
                    self.checker_callback(pid, status, command)
 
545
 
            except OSError as error:
 
546
 
                logger.error("Failed to start subprocess: %s",
 
548
 
        # Re-run this periodically if run by gobject.timeout_add
 
 
1147
            logger.info("Starting checker %r for %s", command,
 
 
1149
            # We don't need to redirect stdout and stderr, since
 
 
1150
            # in normal mode, that is already done by daemon(),
 
 
1151
            # and in debug mode we don't want to.  (Stdin is
 
 
1152
            # always replaced by /dev/null.)
 
 
1153
            # The exception is when not debugging but nevertheless
 
 
1154
            # running in the foreground; use the previously
 
 
1156
            popen_args = {"close_fds": True,
 
 
1159
            if (not self.server_settings["debug"]
 
 
1160
                and self.server_settings["foreground"]):
 
 
1161
                popen_args.update({"stdout": wnull,
 
 
1163
            pipe = multiprocessing.Pipe(duplex=False)
 
 
1164
            self.checker = multiprocessing.Process(
 
 
1166
                args=(pipe[1], subprocess.call, command),
 
 
1168
            self.checker.start()
 
 
1169
            self.checker_callback_tag = GLib.io_add_watch(
 
 
1170
                GLib.IOChannel.unix_new(pipe[0].fileno()),
 
 
1171
                GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
 
1172
                self.checker_callback, pipe[0], command)
 
 
1173
        # Re-run this periodically if run by GLib.timeout_add
 
551
1176
    def stop_checker(self):
 
552
1177
        """Force the checker process, if any, to stop."""
 
553
1178
        if self.checker_callback_tag:
 
554
 
            gobject.source_remove(self.checker_callback_tag)
 
 
1179
            GLib.source_remove(self.checker_callback_tag)
 
555
1180
            self.checker_callback_tag = None
 
556
1181
        if getattr(self, "checker", None) is None:
 
558
1183
        logger.debug("Stopping checker for %(name)s", vars(self))
 
560
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
562
 
            #if self.checker.poll() is None:
 
563
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
564
 
        except OSError as error:
 
565
 
            if error.errno != errno.ESRCH: # No such process
 
 
1184
        self.checker.terminate()
 
567
1185
        self.checker = None
 
570
 
def dbus_service_property(dbus_interface, signature="v",
 
571
 
                          access="readwrite", byte_arrays=False):
 
 
1188
def dbus_service_property(dbus_interface,
 
572
1192
    """Decorators for marking methods of a DBusObjectWithProperties to
 
573
1193
    become properties on the D-Bus.
 
575
1195
    The decorated method will be called with no arguments by "Get"
 
576
1196
    and with one argument by "Set".
 
578
1198
    The parameters, where they are supported, are the same as
 
579
1199
    dbus.service.method, except there is only "signature", since the
 
580
1200
    type from Get() and the type sent to Set() is the same.
 
 
750
1532
        except (AttributeError, xml.dom.DOMException,
 
751
1533
                xml.parsers.expat.ExpatError) as error:
 
752
1534
            logger.error("Failed to override Introspection method",
 
757
 
def datetime_to_dbus (dt, variant_level=0):
 
 
1540
    dbus.OBJECT_MANAGER_IFACE
 
 
1541
except AttributeError:
 
 
1542
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
 
1545
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
 
 
1546
    """A D-Bus object with an ObjectManager.
 
 
1548
    Classes inheriting from this exposes the standard
 
 
1549
    GetManagedObjects call and the InterfacesAdded and
 
 
1550
    InterfacesRemoved signals on the standard
 
 
1551
    "org.freedesktop.DBus.ObjectManager" interface.
 
 
1553
    Note: No signals are sent automatically; they must be sent
 
 
1556
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
 
1557
                         out_signature="a{oa{sa{sv}}}")
 
 
1558
    def GetManagedObjects(self):
 
 
1559
        """This function must be overridden"""
 
 
1560
        raise NotImplementedError()
 
 
1562
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
 
 
1563
                         signature="oa{sa{sv}}")
 
 
1564
    def InterfacesAdded(self, object_path, interfaces_and_properties):
 
 
1567
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
 
 
1568
    def InterfacesRemoved(self, object_path, interfaces):
 
 
1571
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
 
1573
                         path_keyword='object_path',
 
 
1574
                         connection_keyword='connection')
 
 
1575
    def Introspect(self, object_path, connection):
 
 
1576
        """Overloading of standard D-Bus method.
 
 
1578
        Override return argument name of GetManagedObjects to be
 
 
1579
        "objpath_interfaces_and_properties"
 
 
1581
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
 
1585
            document = xml.dom.minidom.parseString(xmlstring)
 
 
1587
            for if_tag in document.getElementsByTagName("interface"):
 
 
1588
                # Fix argument name for the GetManagedObjects method
 
 
1589
                if (if_tag.getAttribute("name")
 
 
1590
                    == dbus.OBJECT_MANAGER_IFACE):
 
 
1591
                    for cn in if_tag.getElementsByTagName("method"):
 
 
1592
                        if (cn.getAttribute("name")
 
 
1593
                            == "GetManagedObjects"):
 
 
1594
                            for arg in cn.getElementsByTagName("arg"):
 
 
1595
                                if (arg.getAttribute("direction")
 
 
1599
                                        "objpath_interfaces"
 
 
1601
            xmlstring = document.toxml("utf-8")
 
 
1603
        except (AttributeError, xml.dom.DOMException,
 
 
1604
                xml.parsers.expat.ExpatError) as error:
 
 
1605
            logger.error("Failed to override Introspection method",
 
 
1610
def datetime_to_dbus(dt, variant_level=0):
 
758
1611
    """Convert a UTC datetime.datetime() to a D-Bus type."""
 
760
 
        return dbus.String("", variant_level = variant_level)
 
761
 
    return dbus.String(dt.isoformat(),
 
762
 
                       variant_level=variant_level)
 
764
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
 
766
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
 
767
 
    will add additional D-Bus attributes matching a certain pattern.
 
 
1613
        return dbus.String("", variant_level=variant_level)
 
 
1614
    return dbus.String(dt.isoformat(), variant_level=variant_level)
 
 
1617
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
 
1618
    """A class decorator; applied to a subclass of
 
 
1619
    dbus.service.Object, it will add alternate D-Bus attributes with
 
 
1620
    interface names according to the "alt_interface_names" mapping.
 
 
1623
    @alternate_dbus_interfaces({"org.example.Interface":
 
 
1624
                                    "net.example.AlternateInterface"})
 
 
1625
    class SampleDBusObject(dbus.service.Object):
 
 
1626
        @dbus.service.method("org.example.Interface")
 
 
1627
        def SampleDBusMethod():
 
 
1630
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
 
1631
    reachable via two interfaces: "org.example.Interface" and
 
 
1632
    "net.example.AlternateInterface", the latter of which will have
 
 
1633
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
 
1634
    "true", unless "deprecate" is passed with a False value.
 
 
1636
    This works for methods and signals, and also for D-Bus properties
 
 
1637
    (from DBusObjectWithProperties) and interfaces (from the
 
 
1638
    dbus_interface_annotations decorator).
 
769
 
    def __new__(mcs, name, bases, attr):
 
770
 
        # Go through all the base classes which could have D-Bus
 
771
 
        # methods, signals, or properties in them
 
772
 
        for base in (b for b in bases
 
773
 
                     if issubclass(b, dbus.service.Object)):
 
774
 
            # Go though all attributes of the base class
 
775
 
            for attrname, attribute in inspect.getmembers(base):
 
 
1642
        for orig_interface_name, alt_interface_name in (
 
 
1643
                alt_interface_names.items()):
 
 
1645
            interface_names = set()
 
 
1646
            # Go though all attributes of the class
 
 
1647
            for attrname, attribute in inspect.getmembers(cls):
 
776
1648
                # Ignore non-D-Bus attributes, and D-Bus attributes
 
777
1649
                # with the wrong interface name
 
778
1650
                if (not hasattr(attribute, "_dbus_interface")
 
779
 
                    or not attribute._dbus_interface
 
780
 
                    .startswith("se.recompile.Mandos")):
 
 
1651
                    or not attribute._dbus_interface.startswith(
 
 
1652
                        orig_interface_name)):
 
782
1654
                # Create an alternate D-Bus interface name based on
 
783
1655
                # the current name
 
784
 
                alt_interface = (attribute._dbus_interface
 
785
 
                                 .replace("se.recompile.Mandos",
 
786
 
                                          "se.bsnet.fukt.Mandos"))
 
 
1656
                alt_interface = attribute._dbus_interface.replace(
 
 
1657
                    orig_interface_name, alt_interface_name)
 
 
1658
                interface_names.add(alt_interface)
 
787
1659
                # Is this a D-Bus signal?
 
788
1660
                if getattr(attribute, "_dbus_is_signal", False):
 
789
 
                    # Extract the original non-method function by
 
791
 
                    nonmethod_func = (dict(
 
 
1661
                    # Extract the original non-method undecorated
 
 
1662
                    # function by black magic
 
 
1663
                    if sys.version_info.major == 2:
 
 
1664
                        nonmethod_func = (dict(
 
792
1665
                            zip(attribute.func_code.co_freevars,
 
793
 
                                attribute.__closure__))["func"]
 
 
1666
                                attribute.__closure__))
 
 
1667
                                          ["func"].cell_contents)
 
 
1669
                        nonmethod_func = (dict(
 
 
1670
                            zip(attribute.__code__.co_freevars,
 
 
1671
                                attribute.__closure__))
 
 
1672
                                          ["func"].cell_contents)
 
795
1673
                    # Create a new, but exactly alike, function
 
796
1674
                    # object, and decorate it to be a new D-Bus signal
 
797
1675
                    # with the alternate D-Bus interface name
 
798
 
                    new_function = (dbus.service.signal
 
800
 
                                     attribute._dbus_signature)
 
802
 
                                nonmethod_func.func_code,
 
803
 
                                nonmethod_func.func_globals,
 
804
 
                                nonmethod_func.func_name,
 
805
 
                                nonmethod_func.func_defaults,
 
806
 
                                nonmethod_func.func_closure)))
 
 
1676
                    new_function = copy_function(nonmethod_func)
 
 
1677
                    new_function = (dbus.service.signal(
 
 
1679
                        attribute._dbus_signature)(new_function))
 
 
1680
                    # Copy annotations, if any
 
 
1682
                        new_function._dbus_annotations = dict(
 
 
1683
                            attribute._dbus_annotations)
 
 
1684
                    except AttributeError:
 
807
1687
                    # Define a creator of a function to call both the
 
808
 
                    # old and new functions, so both the old and new
 
809
 
                    # signals gets sent when the function is called
 
 
1688
                    # original and alternate functions, so both the
 
 
1689
                    # original and alternate signals gets sent when
 
 
1690
                    # the function is called
 
810
1691
                    def fixscope(func1, func2):
 
811
1692
                        """This function is a scope container to pass
 
812
1693
                        func1 and func2 to the "call_both" function
 
813
1694
                        outside of its arguments"""
 
 
1696
                        @functools.wraps(func2)
 
814
1697
                        def call_both(*args, **kwargs):
 
815
1698
                            """This function will emit two D-Bus
 
816
1699
                            signals by calling func1 and func2"""
 
817
1700
                            func1(*args, **kwargs)
 
818
1701
                            func2(*args, **kwargs)
 
 
1702
                        # Make wrapper function look like a D-Bus
 
 
1704
                        for name, attr in inspect.getmembers(func2):
 
 
1705
                            if name.startswith("_dbus_"):
 
 
1706
                                setattr(call_both, name, attr)
 
819
1708
                        return call_both
 
820
1709
                    # Create the "call_both" function and add it to
 
822
 
                    attr[attrname] = fixscope(attribute,
 
 
1711
                    attr[attrname] = fixscope(attribute, new_function)
 
824
1712
                # Is this a D-Bus method?
 
825
1713
                elif getattr(attribute, "_dbus_is_method", False):
 
826
1714
                    # Create a new, but exactly alike, function
 
827
1715
                    # object.  Decorate it to be a new D-Bus method
 
828
1716
                    # with the alternate D-Bus interface name.  Add it
 
830
 
                    attr[attrname] = (dbus.service.method
 
832
 
                                       attribute._dbus_in_signature,
 
833
 
                                       attribute._dbus_out_signature)
 
835
 
                                       (attribute.func_code,
 
836
 
                                        attribute.func_globals,
 
838
 
                                        attribute.func_defaults,
 
839
 
                                        attribute.func_closure)))
 
 
1719
                        dbus.service.method(
 
 
1721
                            attribute._dbus_in_signature,
 
 
1722
                            attribute._dbus_out_signature)
 
 
1723
                        (copy_function(attribute)))
 
 
1724
                    # Copy annotations, if any
 
 
1726
                        attr[attrname]._dbus_annotations = dict(
 
 
1727
                            attribute._dbus_annotations)
 
 
1728
                    except AttributeError:
 
840
1730
                # Is this a D-Bus property?
 
841
1731
                elif getattr(attribute, "_dbus_is_property", False):
 
842
1732
                    # Create a new, but exactly alike, function
 
843
1733
                    # object, and decorate it to be a new D-Bus
 
844
1734
                    # property with the alternate D-Bus interface
 
845
1735
                    # name.  Add it to the class.
 
846
 
                    attr[attrname] = (dbus_service_property
 
848
 
                                       attribute._dbus_signature,
 
849
 
                                       attribute._dbus_access,
 
851
 
                                       ._dbus_get_args_options
 
854
 
                                       (attribute.func_code,
 
855
 
                                        attribute.func_globals,
 
857
 
                                        attribute.func_defaults,
 
858
 
                                        attribute.func_closure)))
 
859
 
        return type.__new__(mcs, name, bases, attr)
 
 
1736
                    attr[attrname] = (dbus_service_property(
 
 
1737
                        alt_interface, attribute._dbus_signature,
 
 
1738
                        attribute._dbus_access,
 
 
1739
                        attribute._dbus_get_args_options
 
 
1741
                                      (copy_function(attribute)))
 
 
1742
                    # Copy annotations, if any
 
 
1744
                        attr[attrname]._dbus_annotations = dict(
 
 
1745
                            attribute._dbus_annotations)
 
 
1746
                    except AttributeError:
 
 
1748
                # Is this a D-Bus interface?
 
 
1749
                elif getattr(attribute, "_dbus_is_interface", False):
 
 
1750
                    # Create a new, but exactly alike, function
 
 
1751
                    # object.  Decorate it to be a new D-Bus interface
 
 
1752
                    # with the alternate D-Bus interface name.  Add it
 
 
1755
                        dbus_interface_annotations(alt_interface)
 
 
1756
                        (copy_function(attribute)))
 
 
1758
                # Deprecate all alternate interfaces
 
 
1759
                iname = "_AlternateDBusNames_interface_annotation{}"
 
 
1760
                for interface_name in interface_names:
 
 
1762
                    @dbus_interface_annotations(interface_name)
 
 
1764
                        return {"org.freedesktop.DBus.Deprecated":
 
 
1766
                    # Find an unused name
 
 
1767
                    for aname in (iname.format(i)
 
 
1768
                                  for i in itertools.count()):
 
 
1769
                        if aname not in attr:
 
 
1773
                # Replace the class with a new subclass of it with
 
 
1774
                # methods, signals, etc. as created above.
 
 
1775
                if sys.version_info.major == 2:
 
 
1776
                    cls = type(b"{}Alternate".format(cls.__name__),
 
 
1779
                    cls = type("{}Alternate".format(cls.__name__),
 
 
1786
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
 
1787
                            "se.bsnet.fukt.Mandos"})
 
861
1788
class ClientDBus(Client, DBusObjectWithProperties):
 
862
1789
    """A Client class using D-Bus
 
865
1792
    dbus_object_path: dbus.ObjectPath
 
866
1793
    bus: dbus.SystemBus()
 
869
1796
    runtime_expansions = (Client.runtime_expansions
 
870
 
                          + ("dbus_object_path",))
 
 
1797
                          + ("dbus_object_path", ))
 
 
1799
    _interface = "se.recompile.Mandos.Client"
 
872
1801
    # dbus.service.Object doesn't use super(), so we can't either.
 
874
 
    def __init__(self, bus = None, *args, **kwargs):
 
875
 
        self._approvals_pending = 0
 
 
1803
    def __init__(self, bus=None, *args, **kwargs):
 
877
1805
        Client.__init__(self, *args, **kwargs)
 
878
1806
        # Only now, when this client is initialized, can it show up on
 
880
 
        client_object_name = unicode(self.name).translate(
 
 
1808
        client_object_name = str(self.name).translate(
 
881
1809
            {ord("."): ord("_"),
 
882
1810
             ord("-"): ord("_")})
 
883
 
        self.dbus_object_path = (dbus.ObjectPath
 
884
 
                                 ("/clients/" + client_object_name))
 
 
1811
        self.dbus_object_path = dbus.ObjectPath(
 
 
1812
            "/clients/" + client_object_name)
 
885
1813
        DBusObjectWithProperties.__init__(self, self.bus,
 
886
1814
                                          self.dbus_object_path)
 
888
 
    def notifychangeproperty(transform_func,
 
889
 
                             dbus_name, type_func=lambda x: x,
 
 
1816
    def notifychangeproperty(transform_func, dbus_name,
 
 
1817
                             type_func=lambda x: x,
 
 
1819
                             invalidate_only=False,
 
 
1820
                             _interface=_interface):
 
891
1821
        """ Modify a variable so that it's a property which announces
 
892
1822
        its changes to DBus.
 
894
 
        transform_fun: Function that takes a value and transforms it
 
 
1824
        transform_fun: Function that takes a value and a variant_level
 
 
1825
                       and transforms it to a D-Bus type.
 
896
1826
        dbus_name: D-Bus name of the variable
 
897
1827
        type_func: Function that transform the value before sending it
 
898
1828
                   to the D-Bus.  Default: no transform
 
899
1829
        variant_level: D-Bus variant level.  Default: 1
 
901
 
        attrname = "_{0}".format(dbus_name)
 
 
1831
        attrname = "_{}".format(dbus_name)
 
902
1833
        def setter(self, value):
 
903
1834
            if hasattr(self, "dbus_object_path"):
 
904
1835
                if (not hasattr(self, attrname) or
 
905
1836
                    type_func(getattr(self, attrname, None))
 
906
1837
                    != type_func(value)):
 
907
 
                    dbus_value = transform_func(type_func(value),
 
909
 
                    self.PropertyChanged(dbus.String(dbus_name),
 
 
1839
                        self.PropertiesChanged(
 
 
1840
                            _interface, dbus.Dictionary(),
 
 
1841
                            dbus.Array((dbus_name, )))
 
 
1843
                        dbus_value = transform_func(
 
 
1845
                            variant_level=variant_level)
 
 
1846
                        self.PropertyChanged(dbus.String(dbus_name),
 
 
1848
                        self.PropertiesChanged(
 
 
1850
                            dbus.Dictionary({dbus.String(dbus_name):
 
911
1853
            setattr(self, attrname, value)
 
913
1855
        return property(lambda self: getattr(self, attrname), setter)
 
916
1857
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
 
917
1858
    approvals_pending = notifychangeproperty(dbus.Boolean,
 
918
1859
                                             "ApprovalPending",
 
920
1861
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
 
921
1862
    last_enabled = notifychangeproperty(datetime_to_dbus,
 
923
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
 
924
 
                                   type_func = lambda checker:
 
 
1864
    checker = notifychangeproperty(
 
 
1865
        dbus.Boolean, "CheckerRunning",
 
 
1866
        type_func=lambda checker: checker is not None)
 
926
1867
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
 
927
1868
                                           "LastCheckedOK")
 
 
1869
    last_checker_status = notifychangeproperty(dbus.Int16,
 
 
1870
                                               "LastCheckerStatus")
 
928
1871
    last_approval_request = notifychangeproperty(
 
929
1872
        datetime_to_dbus, "LastApprovalRequest")
 
930
1873
    approved_by_default = notifychangeproperty(dbus.Boolean,
 
931
1874
                                               "ApprovedByDefault")
 
932
 
    approval_delay = notifychangeproperty(dbus.UInt16,
 
935
 
                                          _timedelta_to_milliseconds)
 
 
1875
    approval_delay = notifychangeproperty(
 
 
1876
        dbus.UInt64, "ApprovalDelay",
 
 
1877
        type_func=lambda td: td.total_seconds() * 1000)
 
936
1878
    approval_duration = notifychangeproperty(
 
937
 
        dbus.UInt16, "ApprovalDuration",
 
938
 
        type_func = _timedelta_to_milliseconds)
 
 
1879
        dbus.UInt64, "ApprovalDuration",
 
 
1880
        type_func=lambda td: td.total_seconds() * 1000)
 
939
1881
    host = notifychangeproperty(dbus.String, "Host")
 
940
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
 
942
 
                                   _timedelta_to_milliseconds)
 
 
1882
    timeout = notifychangeproperty(
 
 
1883
        dbus.UInt64, "Timeout",
 
 
1884
        type_func=lambda td: td.total_seconds() * 1000)
 
943
1885
    extended_timeout = notifychangeproperty(
 
944
 
        dbus.UInt16, "ExtendedTimeout",
 
945
 
        type_func = _timedelta_to_milliseconds)
 
946
 
    interval = notifychangeproperty(dbus.UInt16,
 
949
 
                                    _timedelta_to_milliseconds)
 
 
1886
        dbus.UInt64, "ExtendedTimeout",
 
 
1887
        type_func=lambda td: td.total_seconds() * 1000)
 
 
1888
    interval = notifychangeproperty(
 
 
1889
        dbus.UInt64, "Interval",
 
 
1890
        type_func=lambda td: td.total_seconds() * 1000)
 
950
1891
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
 
1892
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
 
1893
                                  invalidate_only=True)
 
952
1895
    del notifychangeproperty
 
954
1897
    def __del__(self, *args, **kwargs):
 
956
1899
            self.remove_from_connection()
 
 
1244
2217
            self.start_checker()
 
1246
2219
            self.stop_checker()
 
1248
2221
    # ObjectPath - property
 
 
2223
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
 
2224
         "org.freedesktop.DBus.Deprecated": "true"})
 
1249
2225
    @dbus_service_property(_interface, signature="o", access="read")
 
1250
2226
    def ObjectPath_dbus_property(self):
 
1251
 
        return self.dbus_object_path # is already a dbus.ObjectPath
 
 
2227
        return self.dbus_object_path  # is already a dbus.ObjectPath
 
1253
2229
    # Secret = property
 
1254
 
    @dbus_service_property(_interface, signature="ay",
 
1255
 
                           access="write", byte_arrays=True)
 
 
2231
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
 
 
2233
    @dbus_service_property(_interface,
 
1256
2237
    def Secret_dbus_property(self, value):
 
1257
 
        self.secret = str(value)
 
 
2238
        self.secret = bytes(value)
 
1262
 
class ProxyClient(object):
 
1263
 
    def __init__(self, child_pipe, fpr, address):
 
 
2244
    def __init__(self, child_pipe, key_id, fpr, address):
 
1264
2245
        self._pipe = child_pipe
 
1265
 
        self._pipe.send(('init', fpr, address))
 
 
2246
        self._pipe.send(('init', key_id, fpr, address))
 
1266
2247
        if not self._pipe.recv():
 
 
2248
            raise KeyError(key_id or fpr)
 
1269
2250
    def __getattribute__(self, name):
 
1270
 
        if(name == '_pipe'):
 
1271
2252
            return super(ProxyClient, self).__getattribute__(name)
 
1272
2253
        self._pipe.send(('getattr', name))
 
1273
2254
        data = self._pipe.recv()
 
1274
2255
        if data[0] == 'data':
 
1276
2257
        if data[0] == 'function':
 
1277
2259
            def func(*args, **kwargs):
 
1278
2260
                self._pipe.send(('funcall', name, args, kwargs))
 
1279
2261
                return self._pipe.recv()[1]
 
1282
2265
    def __setattr__(self, name, value):
 
1283
 
        if(name == '_pipe'):
 
1284
2267
            return super(ProxyClient, self).__setattr__(name, value)
 
1285
2268
        self._pipe.send(('setattr', name, value))
 
1287
 
class ClientDBusTransitional(ClientDBus):
 
1288
 
    __metaclass__ = AlternateDBusNamesMetaclass
 
1290
2271
class ClientHandler(socketserver.BaseRequestHandler, object):
 
1291
2272
    """A class to handle client connections.
 
1293
2274
    Instantiated once for each connection to handle it.
 
1294
2275
    Note: This will run in its own forked process."""
 
1296
2277
    def handle(self):
 
1297
2278
        with contextlib.closing(self.server.child_pipe) as child_pipe:
 
1298
2279
            logger.info("TCP connection from: %s",
 
1299
 
                        unicode(self.client_address))
 
 
2280
                        str(self.client_address))
 
1300
2281
            logger.debug("Pipe FD: %d",
 
1301
2282
                         self.server.child_pipe.fileno())
 
1303
 
            session = (gnutls.connection
 
1304
 
                       .ClientSession(self.request,
 
1306
 
                                      .X509Credentials()))
 
1308
 
            # Note: gnutls.connection.X509Credentials is really a
 
1309
 
            # generic GnuTLS certificate credentials object so long as
 
1310
 
            # no X.509 keys are added to it.  Therefore, we can use it
 
1311
 
            # here despite using OpenPGP certificates.
 
1313
 
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
1314
 
            #                      "+AES-256-CBC", "+SHA1",
 
1315
 
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
 
 
2284
            session = gnutls.ClientSession(self.request)
 
 
2286
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
 
2287
            #                       "+AES-256-CBC", "+SHA1",
 
 
2288
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
 
1317
2290
            # Use a fallback default, since this MUST be set.
 
1318
2291
            priority = self.server.gnutls_priority
 
1319
2292
            if priority is None:
 
1320
2293
                priority = "NORMAL"
 
1321
 
            (gnutls.library.functions
 
1322
 
             .gnutls_priority_set_direct(session._c_object,
 
 
2294
            gnutls.priority_set_direct(session._c_object,
 
 
2295
                                       priority.encode("utf-8"),
 
1325
2298
            # Start communication using the Mandos protocol
 
1326
2299
            # Get protocol number
 
1327
2300
            line = self.request.makefile().readline()
 
1328
2301
            logger.debug("Protocol version: %r", line)
 
1330
2303
                if int(line.strip().split()[0]) > 1:
 
 
2304
                    raise RuntimeError(line)
 
1332
2305
            except (ValueError, IndexError, RuntimeError) as error:
 
1333
2306
                logger.error("Unknown protocol version: %s", error)
 
1336
2309
            # Start GnuTLS connection
 
1338
2311
                session.handshake()
 
1339
 
            except gnutls.errors.GNUTLSError as error:
 
 
2312
            except gnutls.Error as error:
 
1340
2313
                logger.warning("Handshake failed: %s", error)
 
1341
2314
                # Do not run session.bye() here: the session is not
 
1342
2315
                # established.  Just abandon the request.
 
1344
2317
            logger.debug("Handshake succeeded")
 
1346
2319
            approval_required = False
 
1349
 
                    fpr = self.fingerprint(self.peer_certificate
 
1352
 
                        gnutls.errors.GNUTLSError) as error:
 
1353
 
                    logger.warning("Bad certificate: %s", error)
 
1355
 
                logger.debug("Fingerprint: %s", fpr)
 
1358
 
                    client = ProxyClient(child_pipe, fpr,
 
 
2321
                if gnutls.has_rawpk:
 
 
2324
                        key_id = self.key_id(
 
 
2325
                            self.peer_certificate(session))
 
 
2326
                    except (TypeError, gnutls.Error) as error:
 
 
2327
                        logger.warning("Bad certificate: %s", error)
 
 
2329
                    logger.debug("Key ID: %s", key_id)
 
 
2334
                        fpr = self.fingerprint(
 
 
2335
                            self.peer_certificate(session))
 
 
2336
                    except (TypeError, gnutls.Error) as error:
 
 
2337
                        logger.warning("Bad certificate: %s", error)
 
 
2339
                    logger.debug("Fingerprint: %s", fpr)
 
 
2342
                    client = ProxyClient(child_pipe, key_id, fpr,
 
1359
2343
                                         self.client_address)
 
1360
2344
                except KeyError:
 
1363
2347
                if client.approval_delay:
 
1364
2348
                    delay = client.approval_delay
 
1365
2349
                    client.approvals_pending += 1
 
1366
2350
                    approval_required = True
 
1369
2353
                    if not client.enabled:
 
1370
2354
                        logger.info("Client %s is disabled",
 
1372
2356
                        if self.server.use_dbus:
 
1373
2357
                            # Emit D-Bus signal
 
1374
2358
                            client.Rejected("Disabled")
 
1377
 
                    if client._approved or not client.approval_delay:
 
1378
 
                        #We are approved or approval is disabled
 
 
2361
                    if client.approved or not client.approval_delay:
 
 
2362
                        # We are approved or approval is disabled
 
1380
 
                    elif client._approved is None:
 
 
2364
                    elif client.approved is None:
 
1381
2365
                        logger.info("Client %s needs approval",
 
1383
2367
                        if self.server.use_dbus:
 
1384
2368
                            # Emit D-Bus signal
 
1385
2369
                            client.NeedApproval(
 
1386
 
                                client.approval_delay_milliseconds(),
 
1387
 
                                client.approved_by_default)
 
 
2370
                                client.approval_delay.total_seconds()
 
 
2371
                                * 1000, client.approved_by_default)
 
1389
2373
                        logger.warning("Client %s was not approved",
 
 
1416
2398
                        delay -= time2 - time
 
1419
 
                while sent_size < len(client.secret):
 
1421
 
                        sent = session.send(client.secret[sent_size:])
 
1422
 
                    except gnutls.errors.GNUTLSError as error:
 
1423
 
                        logger.warning("gnutls send failed")
 
1425
 
                    logger.debug("Sent: %d, remaining: %d",
 
1426
 
                                 sent, len(client.secret)
 
1427
 
                                 - (sent_size + sent))
 
 
2401
                    session.send(client.secret)
 
 
2402
                except gnutls.Error as error:
 
 
2403
                    logger.warning("gnutls send failed",
 
1430
2407
                logger.info("Sending secret to %s", client.name)
 
1431
 
                # bump the timeout as if seen
 
1432
 
                client.checked_ok(client.extended_timeout)
 
 
2408
                # bump the timeout using extended_timeout
 
 
2409
                client.bump_timeout(client.extended_timeout)
 
1433
2410
                if self.server.use_dbus:
 
1434
2411
                    # Emit D-Bus signal
 
1435
2412
                    client.GotSecret()
 
1438
2415
                if approval_required:
 
1439
2416
                    client.approvals_pending -= 1
 
1442
 
                except gnutls.errors.GNUTLSError as error:
 
1443
 
                    logger.warning("GnuTLS bye failed")
 
 
2419
                except gnutls.Error as error:
 
 
2420
                    logger.warning("GnuTLS bye failed",
 
1446
2424
    def peer_certificate(session):
 
1447
 
        "Return the peer's OpenPGP certificate as a bytestring"
 
1448
 
        # If not an OpenPGP certificate...
 
1449
 
        if (gnutls.library.functions
 
1450
 
            .gnutls_certificate_type_get(session._c_object)
 
1451
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
 
1452
 
            # ...do the normal thing
 
1453
 
            return session.peer_certificate
 
 
2425
        "Return the peer's certificate as a bytestring"
 
 
2427
            cert_type = gnutls.certificate_type_get2(session._c_object,
 
 
2429
        except AttributeError:
 
 
2430
            cert_type = gnutls.certificate_type_get(session._c_object)
 
 
2431
        if gnutls.has_rawpk:
 
 
2432
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
 
 
2434
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
 
 
2435
        # If not a valid certificate type...
 
 
2436
        if cert_type not in valid_cert_types:
 
 
2437
            logger.info("Cert type %r not in %r", cert_type,
 
 
2439
            # ...return invalid data
 
1454
2441
        list_size = ctypes.c_uint(1)
 
1455
 
        cert_list = (gnutls.library.functions
 
1456
 
                     .gnutls_certificate_get_peers
 
 
2442
        cert_list = (gnutls.certificate_get_peers
 
1457
2443
                     (session._c_object, ctypes.byref(list_size)))
 
1458
2444
        if not bool(cert_list) and list_size.value != 0:
 
1459
 
            raise gnutls.errors.GNUTLSError("error getting peer"
 
 
2445
            raise gnutls.Error("error getting peer certificate")
 
1461
2446
        if list_size.value == 0:
 
1463
2448
        cert = cert_list[0]
 
1464
2449
        return ctypes.string_at(cert.data, cert.size)
 
 
2452
    def key_id(certificate):
 
 
2453
        "Convert a certificate bytestring to a hexdigit key ID"
 
 
2454
        # New GnuTLS "datum" with the public key
 
 
2455
        datum = gnutls.datum_t(
 
 
2456
            ctypes.cast(ctypes.c_char_p(certificate),
 
 
2457
                        ctypes.POINTER(ctypes.c_ubyte)),
 
 
2458
            ctypes.c_uint(len(certificate)))
 
 
2459
        # XXX all these need to be created in the gnutls "module"
 
 
2460
        # New empty GnuTLS certificate
 
 
2461
        pubkey = gnutls.pubkey_t()
 
 
2462
        gnutls.pubkey_init(ctypes.byref(pubkey))
 
 
2463
        # Import the raw public key into the certificate
 
 
2464
        gnutls.pubkey_import(pubkey,
 
 
2465
                             ctypes.byref(datum),
 
 
2466
                             gnutls.X509_FMT_DER)
 
 
2467
        # New buffer for the key ID
 
 
2468
        buf = ctypes.create_string_buffer(32)
 
 
2469
        buf_len = ctypes.c_size_t(len(buf))
 
 
2470
        # Get the key ID from the raw public key into the buffer
 
 
2471
        gnutls.pubkey_get_key_id(pubkey,
 
 
2472
                                 gnutls.KEYID_USE_SHA256,
 
 
2473
                                 ctypes.cast(ctypes.byref(buf),
 
 
2474
                                             ctypes.POINTER(ctypes.c_ubyte)),
 
 
2475
                                 ctypes.byref(buf_len))
 
 
2476
        # Deinit the certificate
 
 
2477
        gnutls.pubkey_deinit(pubkey)
 
 
2479
        # Convert the buffer to a Python bytestring
 
 
2480
        key_id = ctypes.string_at(buf, buf_len.value)
 
 
2481
        # Convert the bytestring to hexadecimal notation
 
 
2482
        hex_key_id = binascii.hexlify(key_id).upper()
 
1467
2486
    def fingerprint(openpgp):
 
1468
2487
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
 
1469
2488
        # New GnuTLS "datum" with the OpenPGP public key
 
1470
 
        datum = (gnutls.library.types
 
1471
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
 
1474
 
                                 ctypes.c_uint(len(openpgp))))
 
 
2489
        datum = gnutls.datum_t(
 
 
2490
            ctypes.cast(ctypes.c_char_p(openpgp),
 
 
2491
                        ctypes.POINTER(ctypes.c_ubyte)),
 
 
2492
            ctypes.c_uint(len(openpgp)))
 
1475
2493
        # New empty GnuTLS certificate
 
1476
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
1477
 
        (gnutls.library.functions
 
1478
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
 
2494
        crt = gnutls.openpgp_crt_t()
 
 
2495
        gnutls.openpgp_crt_init(ctypes.byref(crt))
 
1479
2496
        # Import the OpenPGP public key into the certificate
 
1480
 
        (gnutls.library.functions
 
1481
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
1482
 
                                    gnutls.library.constants
 
1483
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
 
2497
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
 
2498
                                  gnutls.OPENPGP_FMT_RAW)
 
1484
2499
        # Verify the self signature in the key
 
1485
2500
        crtverify = ctypes.c_uint()
 
1486
 
        (gnutls.library.functions
 
1487
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
 
1488
 
                                         ctypes.byref(crtverify)))
 
 
2501
        gnutls.openpgp_crt_verify_self(crt, 0,
 
 
2502
                                       ctypes.byref(crtverify))
 
1489
2503
        if crtverify.value != 0:
 
1490
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
1491
 
            raise (gnutls.errors.CertificateSecurityError
 
 
2504
            gnutls.openpgp_crt_deinit(crt)
 
 
2505
            raise gnutls.CertificateSecurityError(code
 
1493
2507
        # New buffer for the fingerprint
 
1494
2508
        buf = ctypes.create_string_buffer(20)
 
1495
2509
        buf_len = ctypes.c_size_t()
 
1496
2510
        # Get the fingerprint from the certificate into the buffer
 
1497
 
        (gnutls.library.functions
 
1498
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
1499
 
                                             ctypes.byref(buf_len)))
 
 
2511
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
 
2512
                                           ctypes.byref(buf_len))
 
1500
2513
        # Deinit the certificate
 
1501
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
 
2514
        gnutls.openpgp_crt_deinit(crt)
 
1502
2515
        # Convert the buffer to a Python bytestring
 
1503
2516
        fpr = ctypes.string_at(buf, buf_len.value)
 
1504
2517
        # Convert the bytestring to hexadecimal notation
 
1505
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
 
2518
        hex_fpr = binascii.hexlify(fpr).upper()
 
1509
 
class MultiprocessingMixIn(object):
 
 
2522
class MultiprocessingMixIn:
 
1510
2523
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
1511
2525
    def sub_process_main(self, request, address):
 
1513
2527
            self.finish_request(request, address)
 
1515
2529
            self.handle_error(request, address)
 
1516
2530
        self.close_request(request)
 
1518
2532
    def process_request(self, request, address):
 
1519
2533
        """Start a new process to process the request."""
 
1520
 
        proc = multiprocessing.Process(target = self.sub_process_main,
 
 
2534
        proc = multiprocessing.Process(target=self.sub_process_main,
 
 
2535
                                       args=(request, address))
 
1527
 
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
 
 
2540
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
 
1528
2541
    """ adds a pipe to the MixIn """
 
1529
2543
    def process_request(self, request, client_address):
 
1530
2544
        """Overrides and wraps the original process_request().
 
1532
2546
        This function creates a new pipe in self.pipe
 
1534
2548
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
 
1536
2550
        proc = MultiprocessingMixIn.process_request(self, request,
 
1537
2551
                                                    client_address)
 
1538
2552
        self.child_pipe.close()
 
1539
2553
        self.add_pipe(parent_pipe, proc)
 
1541
2555
    def add_pipe(self, parent_pipe, proc):
 
1542
2556
        """Dummy function; override as necessary"""
 
1543
 
        raise NotImplementedError
 
 
2557
        raise NotImplementedError()
 
1546
2560
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
 
1547
 
                     socketserver.TCPServer, object):
 
 
2561
                     socketserver.TCPServer):
 
1548
2562
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
 
1551
2565
        enabled:        Boolean; whether this server is activated yet
 
1552
2566
        interface:      None or a network interface name (string)
 
1553
2567
        use_ipv6:       Boolean; to use IPv6 or not
 
1555
2570
    def __init__(self, server_address, RequestHandlerClass,
 
1556
 
                 interface=None, use_ipv6=True):
 
 
2574
        """If socketfd is set, use that file descriptor instead of
 
 
2575
        creating a new one with socket.socket().
 
1557
2577
        self.interface = interface
 
1559
2579
            self.address_family = socket.AF_INET6
 
 
2580
        if socketfd is not None:
 
 
2581
            # Save the file descriptor
 
 
2582
            self.socketfd = socketfd
 
 
2583
            # Save the original socket.socket() function
 
 
2584
            self.socket_socket = socket.socket
 
 
2586
            # To implement --socket, we monkey patch socket.socket.
 
 
2588
            # (When socketserver.TCPServer is a new-style class, we
 
 
2589
            # could make self.socket into a property instead of monkey
 
 
2590
            # patching socket.socket.)
 
 
2592
            # Create a one-time-only replacement for socket.socket()
 
 
2593
            @functools.wraps(socket.socket)
 
 
2594
            def socket_wrapper(*args, **kwargs):
 
 
2595
                # Restore original function so subsequent calls are
 
 
2597
                socket.socket = self.socket_socket
 
 
2598
                del self.socket_socket
 
 
2599
                # This time only, return a new socket object from the
 
 
2600
                # saved file descriptor.
 
 
2601
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
 
2602
            # Replace socket.socket() function with wrapper
 
 
2603
            socket.socket = socket_wrapper
 
 
2604
        # The socketserver.TCPServer.__init__ will call
 
 
2605
        # socket.socket(), which might be our replacement,
 
 
2606
        # socket_wrapper(), if socketfd was set.
 
1560
2607
        socketserver.TCPServer.__init__(self, server_address,
 
1561
2608
                                        RequestHandlerClass)
 
1562
2610
    def server_bind(self):
 
1563
2611
        """This overrides the normal server_bind() function
 
1564
2612
        to bind to an interface if one was specified, and also NOT to
 
1565
2613
        bind to an address or port if they were not specified."""
 
 
2614
        global SO_BINDTODEVICE
 
1566
2615
        if self.interface is not None:
 
1567
2616
            if SO_BINDTODEVICE is None:
 
1568
 
                logger.error("SO_BINDTODEVICE does not exist;"
 
1569
 
                             " cannot bind to interface %s",
 
1573
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
 
1577
 
                except socket.error as error:
 
1578
 
                    if error[0] == errno.EPERM:
 
1579
 
                        logger.error("No permission to"
 
1580
 
                                     " bind to interface %s",
 
1582
 
                    elif error[0] == errno.ENOPROTOOPT:
 
1583
 
                        logger.error("SO_BINDTODEVICE not available;"
 
1584
 
                                     " cannot bind to interface %s",
 
 
2617
                # Fall back to a hard-coded value which seems to be
 
 
2619
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
 
2620
                SO_BINDTODEVICE = 25
 
 
2622
                self.socket.setsockopt(
 
 
2623
                    socket.SOL_SOCKET, SO_BINDTODEVICE,
 
 
2624
                    (self.interface + "\0").encode("utf-8"))
 
 
2625
            except socket.error as error:
 
 
2626
                if error.errno == errno.EPERM:
 
 
2627
                    logger.error("No permission to bind to"
 
 
2628
                                 " interface %s", self.interface)
 
 
2629
                elif error.errno == errno.ENOPROTOOPT:
 
 
2630
                    logger.error("SO_BINDTODEVICE not available;"
 
 
2631
                                 " cannot bind to interface %s",
 
 
2633
                elif error.errno == errno.ENODEV:
 
 
2634
                    logger.error("Interface %s does not exist,"
 
 
2635
                                 " cannot bind", self.interface)
 
1588
2638
        # Only bind(2) the socket if we really need to.
 
1589
2639
        if self.server_address[0] or self.server_address[1]:
 
 
2640
            if self.server_address[1]:
 
 
2641
                self.allow_reuse_address = True
 
1590
2642
            if not self.server_address[0]:
 
1591
2643
                if self.address_family == socket.AF_INET6:
 
1592
 
                    any_address = "::" # in6addr_any
 
 
2644
                    any_address = "::"  # in6addr_any
 
1594
 
                    any_address = socket.INADDR_ANY
 
 
2646
                    any_address = "0.0.0.0"  # INADDR_ANY
 
1595
2647
                self.server_address = (any_address,
 
1596
2648
                                       self.server_address[1])
 
1597
2649
            elif not self.server_address[1]:
 
1598
 
                self.server_address = (self.server_address[0],
 
 
2650
                self.server_address = (self.server_address[0], 0)
 
1600
2651
#                 if self.interface:
 
1601
2652
#                     self.server_address = (self.server_address[0],
 
 
1846
2980
    parser.add_argument("--no-dbus", action="store_false",
 
1847
2981
                        dest="use_dbus", help="Do not provide D-Bus"
 
1848
 
                        " system bus interface")
 
 
2982
                        " system bus interface", default=None)
 
1849
2983
    parser.add_argument("--no-ipv6", action="store_false",
 
1850
 
                        dest="use_ipv6", help="Do not use IPv6")
 
 
2984
                        dest="use_ipv6", help="Do not use IPv6",
 
 
2986
    parser.add_argument("--no-restore", action="store_false",
 
 
2987
                        dest="restore", help="Do not restore stored"
 
 
2988
                        " state", default=None)
 
 
2989
    parser.add_argument("--socket", type=int,
 
 
2990
                        help="Specify a file descriptor to a network"
 
 
2991
                        " socket to use instead of creating one")
 
 
2992
    parser.add_argument("--statedir", metavar="DIR",
 
 
2993
                        help="Directory to save/restore state in")
 
 
2994
    parser.add_argument("--foreground", action="store_true",
 
 
2995
                        help="Run in foreground", default=None)
 
 
2996
    parser.add_argument("--no-zeroconf", action="store_false",
 
 
2997
                        dest="zeroconf", help="Do not use Zeroconf",
 
1851
3000
    options = parser.parse_args()
 
1858
3002
    # Default values for config file for server-global settings
 
1859
 
    server_defaults = { "interface": "",
 
1864
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
1865
 
                        "servicename": "Mandos",
 
 
3003
    if gnutls.has_rawpk:
 
 
3004
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
 
 
3005
                    ":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
 
 
3007
        priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
 
3008
                    ":+SIGN-DSA-SHA256")
 
 
3009
    server_defaults = {"interface": "",
 
 
3013
                       "priority": priority,
 
 
3014
                       "servicename": "Mandos",
 
 
3020
                       "statedir": "/var/lib/mandos",
 
 
3021
                       "foreground": "False",
 
1871
3026
    # Parse config file for server-global settings
 
1872
 
    server_config = configparser.SafeConfigParser(server_defaults)
 
 
3027
    server_config = configparser.ConfigParser(server_defaults)
 
1873
3028
    del server_defaults
 
1874
 
    server_config.read(os.path.join(options.configdir,
 
1876
 
    # Convert the SafeConfigParser object to a dict
 
 
3029
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
 
3030
    # Convert the ConfigParser object to a dict
 
1877
3031
    server_settings = server_config.defaults()
 
1878
3032
    # Use the appropriate methods on the non-string config options
 
1879
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
 
3033
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
 
3034
                   "foreground", "zeroconf"):
 
1880
3035
        server_settings[option] = server_config.getboolean("DEFAULT",
 
1882
3037
    if server_settings["port"]:
 
1883
3038
        server_settings["port"] = server_config.getint("DEFAULT",
 
 
3040
    if server_settings["socket"]:
 
 
3041
        server_settings["socket"] = server_config.getint("DEFAULT",
 
 
3043
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
 
3044
        # over with an opened os.devnull.  But we don't want this to
 
 
3045
        # happen with a supplied network socket.
 
 
3046
        if 0 <= server_settings["socket"] <= 2:
 
 
3047
            server_settings["socket"] = os.dup(server_settings
 
1885
3049
    del server_config
 
1887
3051
    # Override the settings from the config file with command line
 
1888
3052
    # options, if set.
 
1889
3053
    for option in ("interface", "address", "port", "debug",
 
1890
 
                   "priority", "servicename", "configdir",
 
1891
 
                   "use_dbus", "use_ipv6", "debuglevel"):
 
 
3054
                   "priority", "servicename", "configdir", "use_dbus",
 
 
3055
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
 
3056
                   "socket", "foreground", "zeroconf"):
 
1892
3057
        value = getattr(options, option)
 
1893
3058
        if value is not None:
 
1894
3059
            server_settings[option] = value
 
1896
3061
    # Force all strings to be unicode
 
1897
3062
    for option in server_settings.keys():
 
1898
 
        if type(server_settings[option]) is str:
 
1899
 
            server_settings[option] = unicode(server_settings[option])
 
 
3063
        if isinstance(server_settings[option], bytes):
 
 
3064
            server_settings[option] = (server_settings[option]
 
 
3066
    # Force all boolean options to be boolean
 
 
3067
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
 
3068
                   "foreground", "zeroconf"):
 
 
3069
        server_settings[option] = bool(server_settings[option])
 
 
3070
    # Debug implies foreground
 
 
3071
    if server_settings["debug"]:
 
 
3072
        server_settings["foreground"] = True
 
1900
3073
    # Now we have our good server settings in "server_settings"
 
1902
3075
    ##################################################################
 
 
3077
    if (not server_settings["zeroconf"]
 
 
3078
        and not (server_settings["port"]
 
 
3079
                 or server_settings["socket"] != "")):
 
 
3080
        parser.error("Needs port or socket to work without Zeroconf")
 
1904
3082
    # For convenience
 
1905
3083
    debug = server_settings["debug"]
 
1906
3084
    debuglevel = server_settings["debuglevel"]
 
1907
3085
    use_dbus = server_settings["use_dbus"]
 
1908
3086
    use_ipv6 = server_settings["use_ipv6"]
 
 
3087
    stored_state_path = os.path.join(server_settings["statedir"],
 
 
3089
    foreground = server_settings["foreground"]
 
 
3090
    zeroconf = server_settings["zeroconf"]
 
 
3093
        initlogger(debug, logging.DEBUG)
 
 
3098
            level = getattr(logging, debuglevel.upper())
 
 
3099
            initlogger(debug, level)
 
1910
3101
    if server_settings["servicename"] != "Mandos":
 
1911
 
        syslogger.setFormatter(logging.Formatter
 
1912
 
                               ('Mandos (%s) [%%(process)d]:'
 
1913
 
                                ' %%(levelname)s: %%(message)s'
 
1914
 
                                % server_settings["servicename"]))
 
 
3102
        syslogger.setFormatter(
 
 
3103
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
 
3104
                              ' %(levelname)s: %(message)s'.format(
 
 
3105
                                  server_settings["servicename"])))
 
1916
3107
    # Parse config file with clients
 
1917
 
    client_defaults = { "timeout": "5m",
 
1918
 
                        "extended_timeout": "15m",
 
1920
 
                        "checker": "fping -q -- %%(host)s",
 
1922
 
                        "approval_delay": "0s",
 
1923
 
                        "approval_duration": "1s",
 
1925
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
 
3108
    client_config = configparser.ConfigParser(Client.client_defaults)
 
1926
3109
    client_config.read(os.path.join(server_settings["configdir"],
 
1927
3110
                                    "clients.conf"))
 
1929
3112
    global mandos_dbus_service
 
1930
3113
    mandos_dbus_service = None
 
1932
 
    tcp_server = MandosServer((server_settings["address"],
 
1933
 
                               server_settings["port"]),
 
1935
 
                              interface=(server_settings["interface"]
 
1939
 
                              server_settings["priority"],
 
1942
 
        pidfilename = "/var/run/mandos.pid"
 
1944
 
            pidfile = open(pidfilename, "w")
 
1946
 
            logger.error("Could not open file %r", pidfilename)
 
1949
 
        uid = pwd.getpwnam("_mandos").pw_uid
 
1950
 
        gid = pwd.getpwnam("_mandos").pw_gid
 
1953
 
            uid = pwd.getpwnam("mandos").pw_uid
 
1954
 
            gid = pwd.getpwnam("mandos").pw_gid
 
 
3116
    if server_settings["socket"] != "":
 
 
3117
        socketfd = server_settings["socket"]
 
 
3118
    tcp_server = MandosServer(
 
 
3119
        (server_settings["address"], server_settings["port"]),
 
 
3121
        interface=(server_settings["interface"] or None),
 
 
3123
        gnutls_priority=server_settings["priority"],
 
 
3127
        pidfilename = "/run/mandos.pid"
 
 
3128
        if not os.path.isdir("/run/."):
 
 
3129
            pidfilename = "/var/run/mandos.pid"
 
 
3132
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
 
 
3133
        except IOError as e:
 
 
3134
            logger.error("Could not open file %r", pidfilename,
 
 
3137
    for name, group in (("_mandos", "_mandos"),
 
 
3138
                        ("mandos", "mandos"),
 
 
3139
                        ("nobody", "nogroup")):
 
 
3141
            uid = pwd.getpwnam(name).pw_uid
 
 
3142
            gid = pwd.getpwnam(group).pw_gid
 
1955
3144
        except KeyError:
 
1957
 
                uid = pwd.getpwnam("nobody").pw_uid
 
1958
 
                gid = pwd.getpwnam("nobody").pw_gid
 
 
3153
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
1965
3155
    except OSError as error:
 
1966
 
        if error[0] != errno.EPERM:
 
1969
 
    if not debug and not debuglevel:
 
1970
 
        syslogger.setLevel(logging.WARNING)
 
1971
 
        console.setLevel(logging.WARNING)
 
1973
 
        level = getattr(logging, debuglevel.upper())
 
1974
 
        syslogger.setLevel(level)
 
1975
 
        console.setLevel(level)
 
 
3156
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
 
3157
                       .format(uid, gid, os.strerror(error.errno)))
 
 
3158
        if error.errno != errno.EPERM:
 
1978
3162
        # Enable all possible GnuTLS debugging
 
1980
3164
        # "Use a log level over 10 to enable all debugging options."
 
1981
3165
        # - GnuTLS manual
 
1982
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
1984
 
        @gnutls.library.types.gnutls_log_func
 
 
3166
        gnutls.global_set_log_level(11)
 
1985
3169
        def debug_gnutls(level, string):
 
1986
3170
            logger.debug("GnuTLS: %s", string[:-1])
 
1988
 
        (gnutls.library.functions
 
1989
 
         .gnutls_global_set_log_function(debug_gnutls))
 
 
3172
        gnutls.global_set_log_function(debug_gnutls)
 
1991
3174
        # Redirect stdin so all checkers get /dev/null
 
1992
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
 
3175
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1993
3176
        os.dup2(null, sys.stdin.fileno())
 
1997
 
        # No console logging
 
1998
 
        logger.removeHandler(console)
 
2000
3180
    # Need to fork before connecting to D-Bus
 
2002
3182
        # Close all input and output, do double fork, etc.
 
 
3185
    if gi.version_info < (3, 10, 2):
 
 
3186
        # multiprocessing will use threads, so before we use GLib we
 
 
3187
        # need to inform GLib that threads will be used.
 
2005
3190
    global main_loop
 
2006
3191
    # From the Avahi example code
 
2007
 
    DBusGMainLoop(set_as_default=True )
 
2008
 
    main_loop = gobject.MainLoop()
 
 
3192
    DBusGMainLoop(set_as_default=True)
 
 
3193
    main_loop = GLib.MainLoop()
 
2009
3194
    bus = dbus.SystemBus()
 
2010
3195
    # End of Avahi example code
 
2013
3198
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
2014
 
                                            bus, do_not_queue=True)
 
2015
 
            old_bus_name = (dbus.service.BusName
 
2016
 
                            ("se.bsnet.fukt.Mandos", bus,
 
2018
 
        except dbus.exceptions.NameExistsException as e:
 
2019
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
 
3201
            old_bus_name = dbus.service.BusName(
 
 
3202
                "se.bsnet.fukt.Mandos", bus,
 
 
3204
        except dbus.exceptions.DBusException as e:
 
 
3205
            logger.error("Disabling D-Bus:", exc_info=e)
 
2020
3206
            use_dbus = False
 
2021
3207
            server_settings["use_dbus"] = False
 
2022
3208
            tcp_server.use_dbus = False
 
2023
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2024
 
    service = AvahiService(name = server_settings["servicename"],
 
2025
 
                           servicetype = "_mandos._tcp",
 
2026
 
                           protocol = protocol, bus = bus)
 
2027
 
    if server_settings["interface"]:
 
2028
 
        service.interface = (if_nametoindex
 
2029
 
                             (str(server_settings["interface"])))
 
 
3210
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
 
3211
        service = AvahiServiceToSyslog(
 
 
3212
            name=server_settings["servicename"],
 
 
3213
            servicetype="_mandos._tcp",
 
 
3216
        if server_settings["interface"]:
 
 
3217
            service.interface = if_nametoindex(
 
 
3218
                server_settings["interface"].encode("utf-8"))
 
2031
3220
    global multiprocessing_manager
 
2032
3221
    multiprocessing_manager = multiprocessing.Manager()
 
2034
3223
    client_class = Client
 
2036
 
        client_class = functools.partial(ClientDBusTransitional,
 
2038
 
    def client_config_items(config, section):
 
2039
 
        special_settings = {
 
2040
 
            "approved_by_default":
 
2041
 
                lambda: config.getboolean(section,
 
2042
 
                                          "approved_by_default"),
 
2044
 
        for name, value in config.items(section):
 
 
3225
        client_class = functools.partial(ClientDBus, bus=bus)
 
 
3227
    client_settings = Client.config_parser(client_config)
 
 
3228
    old_client_settings = {}
 
 
3231
    # This is used to redirect stdout and stderr for checker processes
 
 
3233
    wnull = open(os.devnull, "w")  # A writable /dev/null
 
 
3234
    # Only used if server is running in foreground but not in debug
 
 
3236
    if debug or not foreground:
 
 
3239
    # Get client data and settings from last running state.
 
 
3240
    if server_settings["restore"]:
 
 
3242
            with open(stored_state_path, "rb") as stored_state:
 
 
3243
                if sys.version_info.major == 2:
 
 
3244
                    clients_data, old_client_settings = pickle.load(
 
 
3247
                    bytes_clients_data, bytes_old_client_settings = (
 
 
3248
                        pickle.load(stored_state, encoding="bytes"))
 
 
3249
                    #   Fix bytes to strings
 
 
3252
                    clients_data = {(key.decode("utf-8")
 
 
3253
                                     if isinstance(key, bytes)
 
 
3256
                                    bytes_clients_data.items()}
 
 
3257
                    del bytes_clients_data
 
 
3258
                    for key in clients_data:
 
 
3259
                        value = {(k.decode("utf-8")
 
 
3260
                                  if isinstance(k, bytes) else k): v
 
 
3262
                                 clients_data[key].items()}
 
 
3263
                        clients_data[key] = value
 
 
3265
                        value["client_structure"] = [
 
 
3267
                             if isinstance(s, bytes)
 
 
3269
                            value["client_structure"]]
 
 
3270
                        # .name, .host, and .checker_command
 
 
3271
                        for k in ("name", "host", "checker_command"):
 
 
3272
                            if isinstance(value[k], bytes):
 
 
3273
                                value[k] = value[k].decode("utf-8")
 
 
3274
                        if "key_id" not in value:
 
 
3275
                            value["key_id"] = ""
 
 
3276
                        elif "fingerprint" not in value:
 
 
3277
                            value["fingerprint"] = ""
 
 
3278
                    #  old_client_settings
 
 
3280
                    old_client_settings = {
 
 
3281
                        (key.decode("utf-8")
 
 
3282
                         if isinstance(key, bytes)
 
 
3285
                        bytes_old_client_settings.items()}
 
 
3286
                    del bytes_old_client_settings
 
 
3287
                    # .host and .checker_command
 
 
3288
                    for value in old_client_settings.values():
 
 
3289
                        for attribute in ("host", "checker_command"):
 
 
3290
                            if isinstance(value[attribute], bytes):
 
 
3291
                                value[attribute] = (value[attribute]
 
 
3293
            os.remove(stored_state_path)
 
 
3294
        except IOError as e:
 
 
3295
            if e.errno == errno.ENOENT:
 
 
3296
                logger.warning("Could not load persistent state:"
 
 
3297
                               " {}".format(os.strerror(e.errno)))
 
 
3299
                logger.critical("Could not load persistent state:",
 
 
3302
        except EOFError as e:
 
 
3303
            logger.warning("Could not load persistent state: "
 
 
3307
    with PGPEngine() as pgp:
 
 
3308
        for client_name, client in clients_data.items():
 
 
3309
            # Skip removed clients
 
 
3310
            if client_name not in client_settings:
 
 
3313
            # Decide which value to use after restoring saved state.
 
 
3314
            # We have three different values: Old config file,
 
 
3315
            # new config file, and saved state.
 
 
3316
            # New config value takes precedence if it differs from old
 
 
3317
            # config value, otherwise use saved state.
 
 
3318
            for name, value in client_settings[client_name].items():
 
 
3320
                    # For each value in new config, check if it
 
 
3321
                    # differs from the old config value (Except for
 
 
3322
                    # the "secret" attribute)
 
 
3323
                    if (name != "secret"
 
 
3325
                             old_client_settings[client_name][name])):
 
 
3326
                        client[name] = value
 
 
3330
            # Clients who has passed its expire date can still be
 
 
3331
            # enabled if its last checker was successful.  A Client
 
 
3332
            # whose checker succeeded before we stored its state is
 
 
3333
            # assumed to have successfully run all checkers during
 
 
3335
            if client["enabled"]:
 
 
3336
                if datetime.datetime.utcnow() >= client["expires"]:
 
 
3337
                    if not client["last_checked_ok"]:
 
 
3339
                            "disabling client {} - Client never "
 
 
3340
                            "performed a successful checker".format(
 
 
3342
                        client["enabled"] = False
 
 
3343
                    elif client["last_checker_status"] != 0:
 
 
3345
                            "disabling client {} - Client last"
 
 
3346
                            " checker failed with error code"
 
 
3349
                                client["last_checker_status"]))
 
 
3350
                        client["enabled"] = False
 
 
3352
                        client["expires"] = (
 
 
3353
                            datetime.datetime.utcnow()
 
 
3354
                            + client["timeout"])
 
 
3355
                        logger.debug("Last checker succeeded,"
 
 
3356
                                     " keeping {} enabled".format(
 
2046
 
                yield (name, special_settings[name]())
 
2050
 
    tcp_server.clients.update(set(
 
2051
 
            client_class(name = section,
 
2052
 
                         config= dict(client_config_items(
 
2053
 
                        client_config, section)))
 
2054
 
            for section in client_config.sections()))
 
 
3359
                client["secret"] = pgp.decrypt(
 
 
3360
                    client["encrypted_secret"],
 
 
3361
                    client_settings[client_name]["secret"])
 
 
3363
                # If decryption fails, we use secret from new settings
 
 
3364
                logger.debug("Failed to decrypt {} old secret".format(
 
 
3366
                client["secret"] = (client_settings[client_name]
 
 
3369
    # Add/remove clients based on new changes made to config
 
 
3370
    for client_name in (set(old_client_settings)
 
 
3371
                        - set(client_settings)):
 
 
3372
        del clients_data[client_name]
 
 
3373
    for client_name in (set(client_settings)
 
 
3374
                        - set(old_client_settings)):
 
 
3375
        clients_data[client_name] = client_settings[client_name]
 
 
3377
    # Create all client objects
 
 
3378
    for client_name, client in clients_data.items():
 
 
3379
        tcp_server.clients[client_name] = client_class(
 
 
3382
            server_settings=server_settings)
 
2055
3384
    if not tcp_server.clients:
 
2056
3385
        logger.warning("No clients defined")
 
2062
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2065
 
            logger.error("Could not write to file %r with PID %d",
 
2068
 
            # "pidfile" was never created
 
 
3388
        if pidfile is not None:
 
 
3392
                    print(pid, file=pidfile)
 
 
3394
                logger.error("Could not write to file %r with PID %d",
 
2070
3397
        del pidfilename
 
2072
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
 
2074
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
 
2075
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
 
 
3399
    for termsig in (signal.SIGHUP, signal.SIGTERM):
 
 
3400
        GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
 
 
3401
                             lambda: main_loop.quit() and False)
 
2078
 
        class MandosDBusService(dbus.service.Object):
 
 
3405
        @alternate_dbus_interfaces(
 
 
3406
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
 
 
3407
        class MandosDBusService(DBusObjectWithObjectManager):
 
2079
3408
            """A D-Bus proxy object"""
 
2080
3410
            def __init__(self):
 
2081
3411
                dbus.service.Object.__init__(self, bus, "/")
 
2082
3413
            _interface = "se.recompile.Mandos"
 
2084
3415
            @dbus.service.signal(_interface, signature="o")
 
2085
3416
            def ClientAdded(self, objpath):
 
2089
3420
            @dbus.service.signal(_interface, signature="ss")
 
2090
 
            def ClientNotFound(self, fingerprint, address):
 
 
3421
            def ClientNotFound(self, key_id, address):
 
 
3425
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
2094
3427
            @dbus.service.signal(_interface, signature="os")
 
2095
3428
            def ClientRemoved(self, objpath, name):
 
 
3432
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
2099
3434
            @dbus.service.method(_interface, out_signature="ao")
 
2100
3435
            def GetAllClients(self):
 
2102
 
                return dbus.Array(c.dbus_object_path
 
2103
 
                                  for c in tcp_server.clients)
 
 
3437
                return dbus.Array(c.dbus_object_path for c in
 
 
3438
                                  tcp_server.clients.values())
 
 
3440
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
2105
3442
            @dbus.service.method(_interface,
 
2106
3443
                                 out_signature="a{oa{sv}}")
 
2107
3444
            def GetAllClientsWithProperties(self):
 
2109
3446
                return dbus.Dictionary(
 
2110
 
                    ((c.dbus_object_path, c.GetAll(""))
 
2111
 
                     for c in tcp_server.clients),
 
 
3447
                    {c.dbus_object_path: c.GetAll(
 
 
3448
                        "se.recompile.Mandos.Client")
 
 
3449
                     for c in tcp_server.clients.values()},
 
2112
3450
                    signature="oa{sv}")
 
2114
3452
            @dbus.service.method(_interface, in_signature="o")
 
2115
3453
            def RemoveClient(self, object_path):
 
2117
 
                for c in tcp_server.clients:
 
 
3455
                for c in tcp_server.clients.values():
 
2118
3456
                    if c.dbus_object_path == object_path:
 
2119
 
                        tcp_server.clients.remove(c)
 
 
3457
                        del tcp_server.clients[c.name]
 
2120
3458
                        c.remove_from_connection()
 
2121
 
                        # Don't signal anything except ClientRemoved
 
 
3459
                        # Don't signal the disabling
 
2122
3460
                        c.disable(quiet=True)
 
2124
 
                        self.ClientRemoved(object_path, c.name)
 
 
3461
                        # Emit D-Bus signal for removal
 
 
3462
                        self.client_removed_signal(c)
 
2126
3464
                raise KeyError(object_path)
 
2130
 
        class MandosDBusServiceTransitional(MandosDBusService):
 
2131
 
            __metaclass__ = AlternateDBusNamesMetaclass
 
2132
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
 
3468
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
 
3469
                                 out_signature="a{oa{sa{sv}}}")
 
 
3470
            def GetManagedObjects(self):
 
 
3472
                return dbus.Dictionary(
 
 
3473
                    {client.dbus_object_path:
 
 
3475
                         {interface: client.GetAll(interface)
 
 
3477
                          client._get_all_interface_names()})
 
 
3478
                     for client in tcp_server.clients.values()})
 
 
3480
            def client_added_signal(self, client):
 
 
3481
                """Send the new standard signal and the old signal"""
 
 
3483
                    # New standard signal
 
 
3484
                    self.InterfacesAdded(
 
 
3485
                        client.dbus_object_path,
 
 
3487
                            {interface: client.GetAll(interface)
 
 
3489
                             client._get_all_interface_names()}))
 
 
3491
                    self.ClientAdded(client.dbus_object_path)
 
 
3493
            def client_removed_signal(self, client):
 
 
3494
                """Send the new standard signal and the old signal"""
 
 
3496
                    # New standard signal
 
 
3497
                    self.InterfacesRemoved(
 
 
3498
                        client.dbus_object_path,
 
 
3499
                        client._get_all_interface_names())
 
 
3501
                    self.ClientRemoved(client.dbus_object_path,
 
 
3504
        mandos_dbus_service = MandosDBusService()
 
 
3506
    # Save modules to variables to exempt the modules from being
 
 
3507
    # unloaded before the function registered with atexit() is run.
 
 
3508
    mp = multiprocessing
 
2135
3512
        "Cleanup function; run on exit"
 
2138
 
        multiprocessing.active_children()
 
 
3516
        mp.active_children()
 
 
3518
        if not (tcp_server.clients or client_settings):
 
 
3521
        # Store client before exiting. Secrets are encrypted with key
 
 
3522
        # based on what config file has. If config file is
 
 
3523
        # removed/edited, old secret will thus be unrecovable.
 
 
3525
        with PGPEngine() as pgp:
 
 
3526
            for client in tcp_server.clients.values():
 
 
3527
                key = client_settings[client.name]["secret"]
 
 
3528
                client.encrypted_secret = pgp.encrypt(client.secret,
 
 
3532
                # A list of attributes that can not be pickled
 
 
3534
                exclude = {"bus", "changedstate", "secret",
 
 
3535
                           "checker", "server_settings"}
 
 
3536
                for name, typ in inspect.getmembers(dbus.service
 
 
3540
                client_dict["encrypted_secret"] = (client
 
 
3542
                for attr in client.client_structure:
 
 
3543
                    if attr not in exclude:
 
 
3544
                        client_dict[attr] = getattr(client, attr)
 
 
3546
                clients[client.name] = client_dict
 
 
3547
                del client_settings[client.name]["secret"]
 
 
3550
            with tempfile.NamedTemporaryFile(
 
 
3554
                    dir=os.path.dirname(stored_state_path),
 
 
3555
                    delete=False) as stored_state:
 
 
3556
                pickle.dump((clients, client_settings), stored_state,
 
 
3558
                tempname = stored_state.name
 
 
3559
            os.rename(tempname, stored_state_path)
 
 
3560
        except (IOError, OSError) as e:
 
 
3566
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
 
3567
                logger.warning("Could not save persistent state: {}"
 
 
3568
                               .format(os.strerror(e.errno)))
 
 
3570
                logger.warning("Could not save persistent state:",
 
 
3574
        # Delete all clients, and settings from config
 
2139
3575
        while tcp_server.clients:
 
2140
 
            client = tcp_server.clients.pop()
 
 
3576
            name, client = tcp_server.clients.popitem()
 
2142
3578
                client.remove_from_connection()
 
2143
 
            client.disable_hook = None
 
2144
 
            # Don't signal anything except ClientRemoved
 
 
3579
            # Don't signal the disabling
 
2145
3580
            client.disable(quiet=True)
 
 
3581
            # Emit D-Bus signal for removal
 
2148
 
                mandos_dbus_service.ClientRemoved(client
 
 
3583
                mandos_dbus_service.client_removed_signal(client)
 
 
3584
        client_settings.clear()
 
2152
3586
    atexit.register(cleanup)
 
2154
 
    for client in tcp_server.clients:
 
 
3588
    for client in tcp_server.clients.values():
 
2157
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
 
3590
            # Emit D-Bus signal for adding
 
 
3591
            mandos_dbus_service.client_added_signal(client)
 
 
3592
        # Need to initiate checking of clients
 
 
3594
            client.init_checker()
 
2160
3596
    tcp_server.enable()
 
2161
3597
    tcp_server.server_activate()
 
2163
3599
    # Find out what port we got
 
2164
 
    service.port = tcp_server.socket.getsockname()[1]
 
 
3601
        service.port = tcp_server.socket.getsockname()[1]
 
2166
3603
        logger.info("Now listening on address %r, port %d,"
 
2167
 
                    " flowinfo %d, scope_id %d"
 
2168
 
                    % tcp_server.socket.getsockname())
 
 
3604
                    " flowinfo %d, scope_id %d",
 
 
3605
                    *tcp_server.socket.getsockname())
 
2170
 
        logger.info("Now listening on address %r, port %d"
 
2171
 
                    % tcp_server.socket.getsockname())
 
2173
 
    #service.interface = tcp_server.socket.getsockname()[3]
 
 
3607
        logger.info("Now listening on address %r, port %d",
 
 
3608
                    *tcp_server.socket.getsockname())
 
 
3610
    # service.interface = tcp_server.socket.getsockname()[3]
 
2176
 
        # From the Avahi example code
 
2179
 
        except dbus.exceptions.DBusException as error:
 
2180
 
            logger.critical("DBusException: %s", error)
 
2183
 
        # End of Avahi example code
 
2185
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
2186
 
                             lambda *args, **kwargs:
 
2187
 
                             (tcp_server.handle_request
 
2188
 
                              (*args[2:], **kwargs) or True))
 
 
3614
            # From the Avahi example code
 
 
3617
            except dbus.exceptions.DBusException as error:
 
 
3618
                logger.critical("D-Bus Exception", exc_info=error)
 
 
3621
            # End of Avahi example code
 
 
3624
            GLib.IOChannel.unix_new(tcp_server.fileno()),
 
 
3625
            GLib.PRIORITY_DEFAULT, GLib.IO_IN,
 
 
3626
            lambda *args, **kwargs: (tcp_server.handle_request
 
 
3627
                                     (*args[2:], **kwargs) or True))
 
2190
3629
        logger.debug("Starting main loop")
 
2191
3630
        main_loop.run()
 
2192
3631
    except AvahiError as error:
 
2193
 
        logger.critical("AvahiError: %s", error)
 
 
3632
        logger.critical("Avahi Error", exc_info=error)
 
2196
3635
    except KeyboardInterrupt: