70
 
    import cPickle as pickle
 
 
63
import cPickle as pickle
 
73
64
import multiprocessing
 
82
67
import dbus.service
 
83
 
from gi.repository import GLib
 
84
70
from dbus.mainloop.glib import DBusGMainLoop
 
87
73
import xml.dom.minidom
 
90
 
# Try to find the value of SO_BINDTODEVICE:
 
92
 
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
 
93
 
    # newer, and it is also the most natural place for it:
 
94
77
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
 
95
78
except AttributeError:
 
97
 
        # This is where SO_BINDTODEVICE was up to and including Python
 
99
80
        from IN import SO_BINDTODEVICE
 
100
81
    except ImportError:
 
101
 
        # In Python 2.7 it seems to have been removed entirely.
 
102
 
        # Try running the C preprocessor:
 
104
 
            cc = subprocess.Popen(["cc", "--language=c", "-E",
 
106
 
                                  stdin=subprocess.PIPE,
 
107
 
                                  stdout=subprocess.PIPE)
 
108
 
            stdout = cc.communicate(
 
109
 
                "#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
 
110
 
            SO_BINDTODEVICE = int(stdout.splitlines()[-1])
 
111
 
        except (OSError, ValueError, IndexError):
 
113
 
            SO_BINDTODEVICE = None
 
115
 
if sys.version_info.major == 2:
 
119
 
stored_state_file = "clients.pickle"
 
121
 
logger = logging.getLogger()
 
125
 
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
126
 
        ctypes.util.find_library("c")).if_nametoindex
 
127
 
except (OSError, AttributeError):
 
129
 
    def if_nametoindex(interface):
 
130
 
        "Get an interface index the hard way, i.e. using fcntl()"
 
131
 
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
132
 
        with contextlib.closing(socket.socket()) as s:
 
133
 
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
134
 
                                struct.pack(b"16s16x", interface))
 
135
 
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
136
 
        return interface_index
 
139
 
def copy_function(func):
 
140
 
    """Make a copy of a function"""
 
141
 
    if sys.version_info.major == 2:
 
142
 
        return types.FunctionType(func.func_code,
 
148
 
        return types.FunctionType(func.__code__,
 
155
 
def initlogger(debug, level=logging.WARNING):
 
156
 
    """init logger and add loglevel"""
 
159
 
    syslogger = (logging.handlers.SysLogHandler(
 
160
 
        facility=logging.handlers.SysLogHandler.LOG_DAEMON,
 
162
 
    syslogger.setFormatter(logging.Formatter
 
163
 
                           ('Mandos [%(process)d]: %(levelname)s:'
 
165
 
    logger.addHandler(syslogger)
 
168
 
        console = logging.StreamHandler()
 
169
 
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
173
 
        logger.addHandler(console)
 
174
 
    logger.setLevel(level)
 
177
 
class PGPError(Exception):
 
178
 
    """Exception if encryption/decryption fails"""
 
182
 
class PGPEngine(object):
 
183
 
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
186
 
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
189
 
            output = subprocess.check_output(["gpgconf"])
 
190
 
            for line in output.splitlines():
 
191
 
                name, text, path = line.split(b":")
 
196
 
            if e.errno != errno.ENOENT:
 
198
 
        self.gnupgargs = ['--batch',
 
199
 
                          '--homedir', self.tempdir,
 
202
 
        # Only GPG version 1 has the --no-use-agent option.
 
203
 
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
 
204
 
            self.gnupgargs.append("--no-use-agent")
 
209
 
    def __exit__(self, exc_type, exc_value, traceback):
 
217
 
        if self.tempdir is not None:
 
218
 
            # Delete contents of tempdir
 
219
 
            for root, dirs, files in os.walk(self.tempdir,
 
221
 
                for filename in files:
 
222
 
                    os.remove(os.path.join(root, filename))
 
224
 
                    os.rmdir(os.path.join(root, dirname))
 
226
 
            os.rmdir(self.tempdir)
 
229
 
    def password_encode(self, password):
 
230
 
        # Passphrase can not be empty and can not contain newlines or
 
231
 
        # NUL bytes.  So we prefix it and hex encode it.
 
232
 
        encoded = b"mandos" + binascii.hexlify(password)
 
233
 
        if len(encoded) > 2048:
 
234
 
            # GnuPG can't handle long passwords, so encode differently
 
235
 
            encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
 
236
 
                       .replace(b"\n", b"\\n")
 
237
 
                       .replace(b"\0", b"\\x00"))
 
240
 
    def encrypt(self, data, password):
 
241
 
        passphrase = self.password_encode(password)
 
242
 
        with tempfile.NamedTemporaryFile(
 
243
 
                dir=self.tempdir) as passfile:
 
244
 
            passfile.write(passphrase)
 
246
 
            proc = subprocess.Popen([self.gpg, '--symmetric',
 
250
 
                                    stdin=subprocess.PIPE,
 
251
 
                                    stdout=subprocess.PIPE,
 
252
 
                                    stderr=subprocess.PIPE)
 
253
 
            ciphertext, err = proc.communicate(input=data)
 
254
 
        if proc.returncode != 0:
 
258
 
    def decrypt(self, data, password):
 
259
 
        passphrase = self.password_encode(password)
 
260
 
        with tempfile.NamedTemporaryFile(
 
261
 
                dir=self.tempdir) as passfile:
 
262
 
            passfile.write(passphrase)
 
264
 
            proc = subprocess.Popen([self.gpg, '--decrypt',
 
268
 
                                    stdin=subprocess.PIPE,
 
269
 
                                    stdout=subprocess.PIPE,
 
270
 
                                    stderr=subprocess.PIPE)
 
271
 
            decrypted_plaintext, err = proc.communicate(input=data)
 
272
 
        if proc.returncode != 0:
 
274
 
        return decrypted_plaintext
 
277
 
# Pretend that we have an Avahi module
 
279
 
    """This isn't so much a class as it is a module-like namespace."""
 
280
 
    IF_UNSPEC = -1               # avahi-common/address.h
 
281
 
    PROTO_UNSPEC = -1            # avahi-common/address.h
 
282
 
    PROTO_INET = 0               # avahi-common/address.h
 
283
 
    PROTO_INET6 = 1              # avahi-common/address.h
 
284
 
    DBUS_NAME = "org.freedesktop.Avahi"
 
285
 
    DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
 
286
 
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
 
287
 
    DBUS_PATH_SERVER = "/"
 
290
 
    def string_array_to_txt_array(t):
 
291
 
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
 
292
 
                           for s in t), signature="ay")
 
293
 
    ENTRY_GROUP_ESTABLISHED = 2  # avahi-common/defs.h
 
294
 
    ENTRY_GROUP_COLLISION = 3    # avahi-common/defs.h
 
295
 
    ENTRY_GROUP_FAILURE = 4      # avahi-common/defs.h
 
296
 
    SERVER_INVALID = 0           # avahi-common/defs.h
 
297
 
    SERVER_REGISTERING = 1       # avahi-common/defs.h
 
298
 
    SERVER_RUNNING = 2           # avahi-common/defs.h
 
299
 
    SERVER_COLLISION = 3         # avahi-common/defs.h
 
300
 
    SERVER_FAILURE = 4           # avahi-common/defs.h
 
 
82
        SO_BINDTODEVICE = None
 
 
87
#logger = logging.getLogger('mandos')
 
 
88
logger = logging.Logger('mandos')
 
 
89
syslogger = (logging.handlers.SysLogHandler
 
 
90
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
 
91
              address = str("/dev/log")))
 
 
92
syslogger.setFormatter(logging.Formatter
 
 
93
                       ('Mandos [%(process)d]: %(levelname)s:'
 
 
95
logger.addHandler(syslogger)
 
 
97
console = logging.StreamHandler()
 
 
98
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
 
 
101
logger.addHandler(console)
 
303
103
class AvahiError(Exception):
 
304
104
    def __init__(self, value, *args, **kwargs):
 
305
105
        self.value = value
 
306
 
        return super(AvahiError, self).__init__(value, *args,
 
 
106
        super(AvahiError, self).__init__(value, *args, **kwargs)
 
 
107
    def __unicode__(self):
 
 
108
        return unicode(repr(self.value))
 
310
110
class AvahiServiceError(AvahiError):
 
314
113
class AvahiGroupError(AvahiError):
 
318
117
class AvahiService(object):
 
319
118
    """An Avahi (Zeroconf) service.
 
322
121
    interface: integer; avahi.IF_UNSPEC or an interface index.
 
323
122
               Used to optionally bind to the specified interface.
 
324
123
    name: string; Example: 'Mandos'
 
325
124
    type: string; Example: '_mandos._tcp'.
 
326
 
     See <https://www.iana.org/assignments/service-names-port-numbers>
 
 
125
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
327
126
    port: integer; what port to announce
 
328
127
    TXT: list of strings; TXT record for the service
 
329
128
    domain: string; Domain to publish on, default to .local if empty.
 
 
488
260
                                    follow_name_owner_changes=True),
 
489
261
                avahi.DBUS_INTERFACE_SERVER)
 
490
262
        self.server.connect_to_signal("StateChanged",
 
491
 
                                      self.server_state_changed)
 
 
263
                                 self.server_state_changed)
 
492
264
        self.server_state_changed(self.server.GetState())
 
495
 
class AvahiServiceToSyslog(AvahiService):
 
496
 
    def rename(self, *args, **kwargs):
 
497
 
        """Add the new name to the syslog messages"""
 
498
 
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
 
499
 
        syslogger.setFormatter(logging.Formatter(
 
500
 
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
505
 
# Pretend that we have a GnuTLS module
 
506
 
class gnutls(object):
 
507
 
    """This isn't so much a class as it is a module-like namespace."""
 
509
 
    library = ctypes.util.find_library("gnutls")
 
511
 
        library = ctypes.util.find_library("gnutls-deb0")
 
512
 
    _library = ctypes.cdll.LoadLibrary(library)
 
515
 
    # Unless otherwise indicated, the constants and types below are
 
516
 
    # all from the gnutls/gnutls.h C header file.
 
527
 
    E_NO_CERTIFICATE_FOUND = -49
 
532
 
    KEYID_USE_SHA256 = 1        # gnutls/x509.h
 
533
 
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
 
536
 
    class session_int(ctypes.Structure):
 
538
 
    session_t = ctypes.POINTER(session_int)
 
540
 
    class certificate_credentials_st(ctypes.Structure):
 
542
 
    certificate_credentials_t = ctypes.POINTER(
 
543
 
        certificate_credentials_st)
 
544
 
    certificate_type_t = ctypes.c_int
 
546
 
    class datum_t(ctypes.Structure):
 
547
 
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
548
 
                    ('size', ctypes.c_uint)]
 
550
 
    class openpgp_crt_int(ctypes.Structure):
 
552
 
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
553
 
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
 
554
 
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
 
555
 
    credentials_type_t = ctypes.c_int
 
556
 
    transport_ptr_t = ctypes.c_void_p
 
557
 
    close_request_t = ctypes.c_int
 
560
 
    class Error(Exception):
 
561
 
        def __init__(self, message=None, code=None, args=()):
 
562
 
            # Default usage is by a message string, but if a return
 
563
 
            # code is passed, convert it to a string with
 
566
 
            if message is None and code is not None:
 
567
 
                message = gnutls.strerror(code)
 
568
 
            return super(gnutls.Error, self).__init__(
 
571
 
    class CertificateSecurityError(Error):
 
575
 
    class Credentials(object):
 
577
 
            self._c_object = gnutls.certificate_credentials_t()
 
578
 
            gnutls.certificate_allocate_credentials(
 
579
 
                ctypes.byref(self._c_object))
 
580
 
            self.type = gnutls.CRD_CERTIFICATE
 
583
 
            gnutls.certificate_free_credentials(self._c_object)
 
585
 
    class ClientSession(object):
 
586
 
        def __init__(self, socket, credentials=None):
 
587
 
            self._c_object = gnutls.session_t()
 
588
 
            gnutls_flags = gnutls.CLIENT
 
589
 
            if gnutls.check_version("3.5.6"):
 
590
 
                gnutls_flags |= gnutls.NO_TICKETS
 
592
 
                gnutls_flags |= gnutls.ENABLE_RAWPK
 
593
 
            gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
 
595
 
            gnutls.set_default_priority(self._c_object)
 
596
 
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
597
 
            gnutls.handshake_set_private_extensions(self._c_object,
 
600
 
            if credentials is None:
 
601
 
                credentials = gnutls.Credentials()
 
602
 
            gnutls.credentials_set(self._c_object, credentials.type,
 
603
 
                                   ctypes.cast(credentials._c_object,
 
605
 
            self.credentials = credentials
 
608
 
            gnutls.deinit(self._c_object)
 
611
 
            return gnutls.handshake(self._c_object)
 
613
 
        def send(self, data):
 
617
 
                data_len -= gnutls.record_send(self._c_object,
 
622
 
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
624
 
    # Error handling functions
 
625
 
    def _error_code(result):
 
626
 
        """A function to raise exceptions on errors, suitable
 
627
 
        for the 'restype' attribute on ctypes functions"""
 
630
 
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
 
631
 
            raise gnutls.CertificateSecurityError(code=result)
 
632
 
        raise gnutls.Error(code=result)
 
634
 
    def _retry_on_error(result, func, arguments):
 
635
 
        """A function to retry on some errors, suitable
 
636
 
        for the 'errcheck' attribute on ctypes functions"""
 
638
 
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
 
639
 
                return _error_code(result)
 
640
 
            result = func(*arguments)
 
643
 
    # Unless otherwise indicated, the function declarations below are
 
644
 
    # all from the gnutls/gnutls.h C header file.
 
647
 
    priority_set_direct = _library.gnutls_priority_set_direct
 
648
 
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
649
 
                                    ctypes.POINTER(ctypes.c_char_p)]
 
650
 
    priority_set_direct.restype = _error_code
 
652
 
    init = _library.gnutls_init
 
653
 
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
654
 
    init.restype = _error_code
 
656
 
    set_default_priority = _library.gnutls_set_default_priority
 
657
 
    set_default_priority.argtypes = [session_t]
 
658
 
    set_default_priority.restype = _error_code
 
660
 
    record_send = _library.gnutls_record_send
 
661
 
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
663
 
    record_send.restype = ctypes.c_ssize_t
 
664
 
    record_send.errcheck = _retry_on_error
 
666
 
    certificate_allocate_credentials = (
 
667
 
        _library.gnutls_certificate_allocate_credentials)
 
668
 
    certificate_allocate_credentials.argtypes = [
 
669
 
        ctypes.POINTER(certificate_credentials_t)]
 
670
 
    certificate_allocate_credentials.restype = _error_code
 
672
 
    certificate_free_credentials = (
 
673
 
        _library.gnutls_certificate_free_credentials)
 
674
 
    certificate_free_credentials.argtypes = [
 
675
 
        certificate_credentials_t]
 
676
 
    certificate_free_credentials.restype = None
 
678
 
    handshake_set_private_extensions = (
 
679
 
        _library.gnutls_handshake_set_private_extensions)
 
680
 
    handshake_set_private_extensions.argtypes = [session_t,
 
682
 
    handshake_set_private_extensions.restype = None
 
684
 
    credentials_set = _library.gnutls_credentials_set
 
685
 
    credentials_set.argtypes = [session_t, credentials_type_t,
 
687
 
    credentials_set.restype = _error_code
 
689
 
    strerror = _library.gnutls_strerror
 
690
 
    strerror.argtypes = [ctypes.c_int]
 
691
 
    strerror.restype = ctypes.c_char_p
 
693
 
    certificate_type_get = _library.gnutls_certificate_type_get
 
694
 
    certificate_type_get.argtypes = [session_t]
 
695
 
    certificate_type_get.restype = _error_code
 
697
 
    certificate_get_peers = _library.gnutls_certificate_get_peers
 
698
 
    certificate_get_peers.argtypes = [session_t,
 
699
 
                                      ctypes.POINTER(ctypes.c_uint)]
 
700
 
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
 
702
 
    global_set_log_level = _library.gnutls_global_set_log_level
 
703
 
    global_set_log_level.argtypes = [ctypes.c_int]
 
704
 
    global_set_log_level.restype = None
 
706
 
    global_set_log_function = _library.gnutls_global_set_log_function
 
707
 
    global_set_log_function.argtypes = [log_func]
 
708
 
    global_set_log_function.restype = None
 
710
 
    deinit = _library.gnutls_deinit
 
711
 
    deinit.argtypes = [session_t]
 
712
 
    deinit.restype = None
 
714
 
    handshake = _library.gnutls_handshake
 
715
 
    handshake.argtypes = [session_t]
 
716
 
    handshake.restype = _error_code
 
717
 
    handshake.errcheck = _retry_on_error
 
719
 
    transport_set_ptr = _library.gnutls_transport_set_ptr
 
720
 
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
721
 
    transport_set_ptr.restype = None
 
723
 
    bye = _library.gnutls_bye
 
724
 
    bye.argtypes = [session_t, close_request_t]
 
725
 
    bye.restype = _error_code
 
726
 
    bye.errcheck = _retry_on_error
 
728
 
    check_version = _library.gnutls_check_version
 
729
 
    check_version.argtypes = [ctypes.c_char_p]
 
730
 
    check_version.restype = ctypes.c_char_p
 
732
 
    _need_version = b"3.3.0"
 
733
 
    if check_version(_need_version) is None:
 
734
 
        raise self.Error("Needs GnuTLS {} or later"
 
735
 
                         .format(_need_version))
 
737
 
    _tls_rawpk_version = b"3.6.6"
 
738
 
    has_rawpk = bool(check_version(_tls_rawpk_version))
 
742
 
        class pubkey_st(ctypes.Structure):
 
744
 
        pubkey_t = ctypes.POINTER(pubkey_st)
 
746
 
        x509_crt_fmt_t = ctypes.c_int
 
748
 
        # All the function declarations below are from gnutls/abstract.h
 
749
 
        pubkey_init = _library.gnutls_pubkey_init
 
750
 
        pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
 
751
 
        pubkey_init.restype = _error_code
 
753
 
        pubkey_import = _library.gnutls_pubkey_import
 
754
 
        pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
 
756
 
        pubkey_import.restype = _error_code
 
758
 
        pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
 
759
 
        pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
 
760
 
                                      ctypes.POINTER(ctypes.c_ubyte),
 
761
 
                                      ctypes.POINTER(ctypes.c_size_t)]
 
762
 
        pubkey_get_key_id.restype = _error_code
 
764
 
        pubkey_deinit = _library.gnutls_pubkey_deinit
 
765
 
        pubkey_deinit.argtypes = [pubkey_t]
 
766
 
        pubkey_deinit.restype = None
 
768
 
        # All the function declarations below are from gnutls/openpgp.h
 
770
 
        openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
771
 
        openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
772
 
        openpgp_crt_init.restype = _error_code
 
774
 
        openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
775
 
        openpgp_crt_import.argtypes = [openpgp_crt_t,
 
776
 
                                       ctypes.POINTER(datum_t),
 
778
 
        openpgp_crt_import.restype = _error_code
 
780
 
        openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
781
 
        openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
782
 
                                            ctypes.POINTER(ctypes.c_uint)]
 
783
 
        openpgp_crt_verify_self.restype = _error_code
 
785
 
        openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
786
 
        openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
787
 
        openpgp_crt_deinit.restype = None
 
789
 
        openpgp_crt_get_fingerprint = (
 
790
 
            _library.gnutls_openpgp_crt_get_fingerprint)
 
791
 
        openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
795
 
        openpgp_crt_get_fingerprint.restype = _error_code
 
797
 
    if check_version("3.6.4"):
 
798
 
        certificate_type_get2 = _library.gnutls_certificate_type_get2
 
799
 
        certificate_type_get2.argtypes = [session_t, ctypes.c_int]
 
800
 
        certificate_type_get2.restype = _error_code
 
802
 
    # Remove non-public functions
 
803
 
    del _error_code, _retry_on_error
 
806
 
def call_pipe(connection,       # : multiprocessing.Connection
 
807
 
              func, *args, **kwargs):
 
808
 
    """This function is meant to be called by multiprocessing.Process
 
810
 
    This function runs func(*args, **kwargs), and writes the resulting
 
811
 
    return value on the provided multiprocessing.Connection.
 
813
 
    connection.send(func(*args, **kwargs))
 
817
267
class Client(object):
 
818
268
    """A representation of a client host served by this server.
 
821
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
 
271
    _approved:   bool(); 'None' if not yet approved/disapproved
 
822
272
    approval_delay: datetime.timedelta(); Time to wait for approval
 
823
273
    approval_duration: datetime.timedelta(); Duration of one approval
 
824
274
    checker:    subprocess.Popen(); a running checker process used
 
825
275
                                    to see if the client lives.
 
826
276
                                    'None' if no process is running.
 
827
 
    checker_callback_tag: a GLib event source tag, or None
 
 
277
    checker_callback_tag: a gobject event source tag, or None
 
828
278
    checker_command: string; External command which is run to check
 
829
279
                     if client lives.  %() expansions are done at
 
830
280
                     runtime with vars(self) as dict, so that for
 
831
281
                     instance %(name)s can be used in the command.
 
832
 
    checker_initiator_tag: a GLib event source tag, or None
 
 
282
    checker_initiator_tag: a gobject event source tag, or None
 
833
283
    created:    datetime.datetime(); (UTC) object creation
 
834
 
    client_structure: Object describing what attributes a client has
 
835
 
                      and is used for storing the client at exit
 
836
284
    current_checker_command: string; current running checker_command
 
837
 
    disable_initiator_tag: a GLib event source tag, or None
 
 
285
    disable_hook:  If set, called by disable() as disable_hook(self)
 
 
286
    disable_initiator_tag: a gobject event source tag, or None
 
839
288
    fingerprint: string (40 or 32 hexadecimal digits); used to
 
840
 
                 uniquely identify an OpenPGP client
 
841
 
    key_id: string (64 hexadecimal digits); used to uniquely identify
 
842
 
            a client using raw public keys
 
 
289
                 uniquely identify the client
 
843
290
    host:       string; available for use by the checker command
 
844
291
    interval:   datetime.timedelta(); How often to start a new checker
 
845
292
    last_approval_request: datetime.datetime(); (UTC) or None
 
846
293
    last_checked_ok: datetime.datetime(); (UTC) or None
 
847
 
    last_checker_status: integer between 0 and 255 reflecting exit
 
848
 
                         status of last checker. -1 reflects crashed
 
849
 
                         checker, -2 means no checker completed yet.
 
850
 
    last_checker_signal: The signal which killed the last checker, if
 
851
 
                         last_checker_status is -1
 
852
 
    last_enabled: datetime.datetime(); (UTC) or None
 
 
294
    last_enabled: datetime.datetime(); (UTC)
 
853
295
    name:       string; from the config file, used in log messages and
 
854
296
                        D-Bus identifiers
 
855
297
    secret:     bytestring; sent verbatim (over TLS) to client
 
856
298
    timeout:    datetime.timedelta(); How long from last_checked_ok
 
857
299
                                      until this client is disabled
 
858
 
    extended_timeout:   extra long timeout when secret has been sent
 
859
300
    runtime_expansions: Allowed attributes for runtime expansion.
 
860
 
    expires:    datetime.datetime(); time (UTC) when a client will be
 
862
 
    server_settings: The server_settings dict from main()
 
865
303
    runtime_expansions = ("approval_delay", "approval_duration",
 
866
 
                          "created", "enabled", "expires", "key_id",
 
867
 
                          "fingerprint", "host", "interval",
 
868
 
                          "last_approval_request", "last_checked_ok",
 
 
304
                          "created", "enabled", "fingerprint",
 
 
305
                          "host", "interval", "last_checked_ok",
 
869
306
                          "last_enabled", "name", "timeout")
 
872
 
        "extended_timeout": "PT15M",
 
874
 
        "checker": "fping -q -- %%(host)s",
 
876
 
        "approval_delay": "PT0S",
 
877
 
        "approval_duration": "PT1S",
 
878
 
        "approved_by_default": "True",
 
883
 
    def config_parser(config):
 
884
 
        """Construct a new dict of client settings of this form:
 
885
 
        { client_name: {setting_name: value, ...}, ...}
 
886
 
        with exceptions for any special settings as defined above.
 
887
 
        NOTE: Must be a pure function. Must return the same result
 
888
 
        value given the same arguments.
 
891
 
        for client_name in config.sections():
 
892
 
            section = dict(config.items(client_name))
 
893
 
            client = settings[client_name] = {}
 
895
 
            client["host"] = section["host"]
 
896
 
            # Reformat values from string types to Python types
 
897
 
            client["approved_by_default"] = config.getboolean(
 
898
 
                client_name, "approved_by_default")
 
899
 
            client["enabled"] = config.getboolean(client_name,
 
902
 
            # Uppercase and remove spaces from key_id and fingerprint
 
903
 
            # for later comparison purposes with return value from the
 
904
 
            # key_id() and fingerprint() functions
 
905
 
            client["key_id"] = (section.get("key_id", "").upper()
 
907
 
            client["fingerprint"] = (section["fingerprint"].upper()
 
909
 
            if "secret" in section:
 
910
 
                client["secret"] = codecs.decode(section["secret"]
 
913
 
            elif "secfile" in section:
 
914
 
                with open(os.path.expanduser(os.path.expandvars
 
915
 
                                             (section["secfile"])),
 
917
 
                    client["secret"] = secfile.read()
 
919
 
                raise TypeError("No secret or secfile for section {}"
 
921
 
            client["timeout"] = string_to_delta(section["timeout"])
 
922
 
            client["extended_timeout"] = string_to_delta(
 
923
 
                section["extended_timeout"])
 
924
 
            client["interval"] = string_to_delta(section["interval"])
 
925
 
            client["approval_delay"] = string_to_delta(
 
926
 
                section["approval_delay"])
 
927
 
            client["approval_duration"] = string_to_delta(
 
928
 
                section["approval_duration"])
 
929
 
            client["checker_command"] = section["checker"]
 
930
 
            client["last_approval_request"] = None
 
931
 
            client["last_checked_ok"] = None
 
932
 
            client["last_checker_status"] = -2
 
936
 
    def __init__(self, settings, name=None, server_settings=None):
 
 
309
    def _timedelta_to_milliseconds(td):
 
 
310
        "Convert a datetime.timedelta() to milliseconds"
 
 
311
        return ((td.days * 24 * 60 * 60 * 1000)
 
 
312
                + (td.seconds * 1000)
 
 
313
                + (td.microseconds // 1000))
 
 
315
    def timeout_milliseconds(self):
 
 
316
        "Return the 'timeout' attribute in milliseconds"
 
 
317
        return self._timedelta_to_milliseconds(self.timeout)
 
 
319
    def interval_milliseconds(self):
 
 
320
        "Return the 'interval' attribute in milliseconds"
 
 
321
        return self._timedelta_to_milliseconds(self.interval)
 
 
323
    def approval_delay_milliseconds(self):
 
 
324
        return self._timedelta_to_milliseconds(self.approval_delay)
 
 
326
    def __init__(self, name = None, disable_hook=None, config=None):
 
 
327
        """Note: the 'checker' key in 'config' sets the
 
 
328
        'checker_command' attribute and *not* the 'checker'
 
938
 
        if server_settings is None:
 
940
 
        self.server_settings = server_settings
 
941
 
        # adding all client settings
 
942
 
        for setting, value in settings.items():
 
943
 
            setattr(self, setting, value)
 
946
 
            if not hasattr(self, "last_enabled"):
 
947
 
                self.last_enabled = datetime.datetime.utcnow()
 
948
 
            if not hasattr(self, "expires"):
 
949
 
                self.expires = (datetime.datetime.utcnow()
 
952
 
            self.last_enabled = None
 
955
333
        logger.debug("Creating client %r", self.name)
 
956
 
        logger.debug("  Key ID: %s", self.key_id)
 
 
334
        # Uppercase and remove spaces from fingerprint for later
 
 
335
        # comparison purposes with return value from the fingerprint()
 
 
337
        self.fingerprint = (config["fingerprint"].upper()
 
957
339
        logger.debug("  Fingerprint: %s", self.fingerprint)
 
958
 
        self.created = settings.get("created",
 
959
 
                                    datetime.datetime.utcnow())
 
961
 
        # attributes specific for this server instance
 
 
340
        if "secret" in config:
 
 
341
            self.secret = config["secret"].decode("base64")
 
 
342
        elif "secfile" in config:
 
 
343
            with open(os.path.expanduser(os.path.expandvars
 
 
344
                                         (config["secfile"])),
 
 
346
                self.secret = secfile.read()
 
 
348
            raise TypeError("No secret or secfile for client %s"
 
 
350
        self.host = config.get("host", "")
 
 
351
        self.created = datetime.datetime.utcnow()
 
 
353
        self.last_approval_request = None
 
 
354
        self.last_enabled = None
 
 
355
        self.last_checked_ok = None
 
 
356
        self.timeout = string_to_delta(config["timeout"])
 
 
357
        self.interval = string_to_delta(config["interval"])
 
 
358
        self.disable_hook = disable_hook
 
962
359
        self.checker = None
 
963
360
        self.checker_initiator_tag = None
 
964
361
        self.disable_initiator_tag = None
 
965
362
        self.checker_callback_tag = None
 
 
363
        self.checker_command = config["checker"]
 
966
364
        self.current_checker_command = None
 
 
365
        self.last_connect = None
 
 
366
        self._approved = None
 
 
367
        self.approved_by_default = config.get("approved_by_default",
 
968
369
        self.approvals_pending = 0
 
969
 
        self.changedstate = multiprocessing_manager.Condition(
 
970
 
            multiprocessing_manager.Lock())
 
971
 
        self.client_structure = [attr
 
972
 
                                 for attr in self.__dict__.keys()
 
973
 
                                 if not attr.startswith("_")]
 
974
 
        self.client_structure.append("client_structure")
 
976
 
        for name, t in inspect.getmembers(
 
977
 
                type(self), lambda obj: isinstance(obj, property)):
 
978
 
            if not name.startswith("_"):
 
979
 
                self.client_structure.append(name)
 
981
 
    # Send notice to process children that client state has changed
 
 
370
        self.approval_delay = string_to_delta(
 
 
371
            config["approval_delay"])
 
 
372
        self.approval_duration = string_to_delta(
 
 
373
            config["approval_duration"])
 
 
374
        self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
 
982
376
    def send_changedstate(self):
 
983
 
        with self.changedstate:
 
984
 
            self.changedstate.notify_all()
 
 
377
        self.changedstate.acquire()
 
 
378
        self.changedstate.notify_all()
 
 
379
        self.changedstate.release()
 
986
381
    def enable(self):
 
987
382
        """Start this client's checker and timeout hooks"""
 
988
383
        if getattr(self, "enabled", False):
 
989
384
            # Already enabled
 
991
 
        self.expires = datetime.datetime.utcnow() + self.timeout
 
 
386
        self.send_changedstate()
 
993
387
        self.last_enabled = datetime.datetime.utcnow()
 
995
 
        self.send_changedstate()
 
 
388
        # Schedule a new checker to be started an 'interval' from now,
 
 
389
        # and every interval from then on.
 
 
390
        self.checker_initiator_tag = (gobject.timeout_add
 
 
391
                                      (self.interval_milliseconds(),
 
 
393
        # Schedule a disable() when 'timeout' has passed
 
 
394
        self.disable_initiator_tag = (gobject.timeout_add
 
 
395
                                   (self.timeout_milliseconds(),
 
 
398
        # Also start a new checker *right now*.
 
997
401
    def disable(self, quiet=True):
 
998
402
        """Disable this client."""
 
999
403
        if not getattr(self, "enabled", False):
 
 
406
            self.send_changedstate()
 
1002
408
            logger.info("Disabling client %s", self.name)
 
1003
 
        if getattr(self, "disable_initiator_tag", None) is not None:
 
1004
 
            GLib.source_remove(self.disable_initiator_tag)
 
 
409
        if getattr(self, "disable_initiator_tag", False):
 
 
410
            gobject.source_remove(self.disable_initiator_tag)
 
1005
411
            self.disable_initiator_tag = None
 
1007
 
        if getattr(self, "checker_initiator_tag", None) is not None:
 
1008
 
            GLib.source_remove(self.checker_initiator_tag)
 
 
412
        if getattr(self, "checker_initiator_tag", False):
 
 
413
            gobject.source_remove(self.checker_initiator_tag)
 
1009
414
            self.checker_initiator_tag = None
 
1010
415
        self.stop_checker()
 
 
416
        if self.disable_hook:
 
 
417
            self.disable_hook(self)
 
1011
418
        self.enabled = False
 
1013
 
            self.send_changedstate()
 
1014
 
        # Do not run this again if called by a GLib.timeout_add
 
 
419
        # Do not run this again if called by a gobject.timeout_add
 
1017
422
    def __del__(self):
 
 
423
        self.disable_hook = None
 
1020
 
    def init_checker(self):
 
1021
 
        # Schedule a new checker to be started an 'interval' from now,
 
1022
 
        # and every interval from then on.
 
1023
 
        if self.checker_initiator_tag is not None:
 
1024
 
            GLib.source_remove(self.checker_initiator_tag)
 
1025
 
        self.checker_initiator_tag = GLib.timeout_add(
 
1026
 
            int(self.interval.total_seconds() * 1000),
 
1028
 
        # Schedule a disable() when 'timeout' has passed
 
1029
 
        if self.disable_initiator_tag is not None:
 
1030
 
            GLib.source_remove(self.disable_initiator_tag)
 
1031
 
        self.disable_initiator_tag = GLib.timeout_add(
 
1032
 
            int(self.timeout.total_seconds() * 1000), self.disable)
 
1033
 
        # Also start a new checker *right now*.
 
1034
 
        self.start_checker()
 
1036
 
    def checker_callback(self, source, condition, connection,
 
 
426
    def checker_callback(self, pid, condition, command):
 
1038
427
        """The checker has completed, so take appropriate actions."""
 
1039
428
        self.checker_callback_tag = None
 
1040
429
        self.checker = None
 
1041
 
        # Read return code from connection (see call_pipe)
 
1042
 
        returncode = connection.recv()
 
1046
 
            self.last_checker_status = returncode
 
1047
 
            self.last_checker_signal = None
 
1048
 
            if self.last_checker_status == 0:
 
 
430
        if os.WIFEXITED(condition):
 
 
431
            exitstatus = os.WEXITSTATUS(condition)
 
1049
433
                logger.info("Checker for %(name)s succeeded",
 
1051
435
                self.checked_ok()
 
1053
 
                logger.info("Checker for %(name)s failed", vars(self))
 
 
437
                logger.info("Checker for %(name)s failed",
 
1055
 
            self.last_checker_status = -1
 
1056
 
            self.last_checker_signal = -returncode
 
1057
440
            logger.warning("Checker for %(name)s crashed?",
 
1061
443
    def checked_ok(self):
 
1062
 
        """Assert that the client has been seen, alive and well."""
 
 
444
        """Bump up the timeout for this client.
 
 
446
        This should only be called when the client has been seen,
 
1063
449
        self.last_checked_ok = datetime.datetime.utcnow()
 
1064
 
        self.last_checker_status = 0
 
1065
 
        self.last_checker_signal = None
 
1068
 
    def bump_timeout(self, timeout=None):
 
1069
 
        """Bump up the timeout for this client."""
 
1071
 
            timeout = self.timeout
 
1072
 
        if self.disable_initiator_tag is not None:
 
1073
 
            GLib.source_remove(self.disable_initiator_tag)
 
1074
 
            self.disable_initiator_tag = None
 
1075
 
        if getattr(self, "enabled", False):
 
1076
 
            self.disable_initiator_tag = GLib.timeout_add(
 
1077
 
                int(timeout.total_seconds() * 1000), self.disable)
 
1078
 
            self.expires = datetime.datetime.utcnow() + timeout
 
 
450
        gobject.source_remove(self.disable_initiator_tag)
 
 
451
        self.disable_initiator_tag = (gobject.timeout_add
 
 
452
                                      (self.timeout_milliseconds(),
 
1080
455
    def need_approval(self):
 
1081
456
        self.last_approval_request = datetime.datetime.utcnow()
 
1083
458
    def start_checker(self):
 
1084
459
        """Start a new checker subprocess if one is not running.
 
1086
461
        If a checker already exists, leave it running and do
 
1088
463
        # The reason for not killing a running checker is that if we
 
1089
 
        # did that, and if a checker (for some reason) started running
 
1090
 
        # slowly and taking more than 'interval' time, then the client
 
1091
 
        # would inevitably timeout, since no checker would get a
 
1092
 
        # chance to run to completion.  If we instead leave running
 
 
464
        # did that, then if a checker (for some reason) started
 
 
465
        # running slowly and taking more than 'interval' time, the
 
 
466
        # client would inevitably timeout, since no checker would get
 
 
467
        # a chance to run to completion.  If we instead leave running
 
1093
468
        # checkers alone, the checker would have to take more time
 
1094
469
        # than 'timeout' for the client to be disabled, which is as it
 
1097
 
        if self.checker is not None and not self.checker.is_alive():
 
1098
 
            logger.warning("Checker was not alive; joining")
 
 
472
        # If a checker exists, make sure it is not a zombie
 
 
474
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
 
475
        except (AttributeError, OSError) as error:
 
 
476
            if (isinstance(error, OSError)
 
 
477
                and error.errno != errno.ECHILD):
 
 
481
                logger.warning("Checker was a zombie")
 
 
482
                gobject.source_remove(self.checker_callback_tag)
 
 
483
                self.checker_callback(pid, status,
 
 
484
                                      self.current_checker_command)
 
1101
485
        # Start a new checker if needed
 
1102
486
        if self.checker is None:
 
1103
 
            # Escape attributes for the shell
 
1105
 
                attr: re.escape(str(getattr(self, attr)))
 
1106
 
                for attr in self.runtime_expansions}
 
1108
 
                command = self.checker_command % escaped_attrs
 
1109
 
            except TypeError as error:
 
1110
 
                logger.error('Could not format string "%s"',
 
1111
 
                             self.checker_command,
 
1113
 
                return True     # Try again later
 
 
488
                # In case checker_command has exactly one % operator
 
 
489
                command = self.checker_command % self.host
 
 
491
                # Escape attributes for the shell
 
 
492
                escaped_attrs = dict(
 
 
494
                     re.escape(unicode(str(getattr(self, attr, "")),
 
 
498
                    self.runtime_expansions)
 
 
501
                    command = self.checker_command % escaped_attrs
 
 
502
                except TypeError as error:
 
 
503
                    logger.error('Could not format string "%s":'
 
 
504
                                 ' %s', self.checker_command, error)
 
 
505
                    return True # Try again later
 
1114
506
            self.current_checker_command = command
 
1115
 
            logger.info("Starting checker %r for %s", command,
 
1117
 
            # We don't need to redirect stdout and stderr, since
 
1118
 
            # in normal mode, that is already done by daemon(),
 
1119
 
            # and in debug mode we don't want to.  (Stdin is
 
1120
 
            # always replaced by /dev/null.)
 
1121
 
            # The exception is when not debugging but nevertheless
 
1122
 
            # running in the foreground; use the previously
 
1124
 
            popen_args = {"close_fds": True,
 
1127
 
            if (not self.server_settings["debug"]
 
1128
 
                and self.server_settings["foreground"]):
 
1129
 
                popen_args.update({"stdout": wnull,
 
1131
 
            pipe = multiprocessing.Pipe(duplex=False)
 
1132
 
            self.checker = multiprocessing.Process(
 
1134
 
                args=(pipe[1], subprocess.call, command),
 
1136
 
            self.checker.start()
 
1137
 
            self.checker_callback_tag = GLib.io_add_watch(
 
1138
 
                pipe[0].fileno(), GLib.IO_IN,
 
1139
 
                self.checker_callback, pipe[0], command)
 
1140
 
        # Re-run this periodically if run by GLib.timeout_add
 
 
508
                logger.info("Starting checker %r for %s",
 
 
510
                # We don't need to redirect stdout and stderr, since
 
 
511
                # in normal mode, that is already done by daemon(),
 
 
512
                # and in debug mode we don't want to.  (Stdin is
 
 
513
                # always replaced by /dev/null.)
 
 
514
                self.checker = subprocess.Popen(command,
 
 
517
                self.checker_callback_tag = (gobject.child_watch_add
 
 
519
                                              self.checker_callback,
 
 
521
                # The checker may have completed before the gobject
 
 
522
                # watch was added.  Check for this.
 
 
523
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
 
525
                    gobject.source_remove(self.checker_callback_tag)
 
 
526
                    self.checker_callback(pid, status, command)
 
 
527
            except OSError as error:
 
 
528
                logger.error("Failed to start subprocess: %s",
 
 
530
        # Re-run this periodically if run by gobject.timeout_add
 
1143
533
    def stop_checker(self):
 
1144
534
        """Force the checker process, if any, to stop."""
 
1145
535
        if self.checker_callback_tag:
 
1146
 
            GLib.source_remove(self.checker_callback_tag)
 
 
536
            gobject.source_remove(self.checker_callback_tag)
 
1147
537
            self.checker_callback_tag = None
 
1148
538
        if getattr(self, "checker", None) is None:
 
1150
540
        logger.debug("Stopping checker for %(name)s", vars(self))
 
1151
 
        self.checker.terminate()
 
 
542
            os.kill(self.checker.pid, signal.SIGTERM)
 
 
544
            #if self.checker.poll() is None:
 
 
545
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
 
546
        except OSError as error:
 
 
547
            if error.errno != errno.ESRCH: # No such process
 
1152
549
        self.checker = None
 
1155
 
def dbus_service_property(dbus_interface,
 
 
551
def dbus_service_property(dbus_interface, signature="v",
 
 
552
                          access="readwrite", byte_arrays=False):
 
1159
553
    """Decorators for marking methods of a DBusObjectWithProperties to
 
1160
554
    become properties on the D-Bus.
 
1162
556
    The decorated method will be called with no arguments by "Get"
 
1163
557
    and with one argument by "Set".
 
1165
559
    The parameters, where they are supported, are the same as
 
1166
560
    dbus.service.method, except there is only "signature", since the
 
1167
561
    type from Get() and the type sent to Set() is the same.
 
 
1500
733
        except (AttributeError, xml.dom.DOMException,
 
1501
734
                xml.parsers.expat.ExpatError) as error:
 
1502
735
            logger.error("Failed to override Introspection method",
 
1508
 
    dbus.OBJECT_MANAGER_IFACE
 
1509
 
except AttributeError:
 
1510
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
1513
 
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
 
1514
 
    """A D-Bus object with an ObjectManager.
 
1516
 
    Classes inheriting from this exposes the standard
 
1517
 
    GetManagedObjects call and the InterfacesAdded and
 
1518
 
    InterfacesRemoved signals on the standard
 
1519
 
    "org.freedesktop.DBus.ObjectManager" interface.
 
1521
 
    Note: No signals are sent automatically; they must be sent
 
1524
 
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
1525
 
                         out_signature="a{oa{sa{sv}}}")
 
1526
 
    def GetManagedObjects(self):
 
1527
 
        """This function must be overridden"""
 
1528
 
        raise NotImplementedError()
 
1530
 
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
 
1531
 
                         signature="oa{sa{sv}}")
 
1532
 
    def InterfacesAdded(self, object_path, interfaces_and_properties):
 
1535
 
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
 
1536
 
    def InterfacesRemoved(self, object_path, interfaces):
 
1539
 
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1541
 
                         path_keyword='object_path',
 
1542
 
                         connection_keyword='connection')
 
1543
 
    def Introspect(self, object_path, connection):
 
1544
 
        """Overloading of standard D-Bus method.
 
1546
 
        Override return argument name of GetManagedObjects to be
 
1547
 
        "objpath_interfaces_and_properties"
 
1549
 
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1553
 
            document = xml.dom.minidom.parseString(xmlstring)
 
1555
 
            for if_tag in document.getElementsByTagName("interface"):
 
1556
 
                # Fix argument name for the GetManagedObjects method
 
1557
 
                if (if_tag.getAttribute("name")
 
1558
 
                    == dbus.OBJECT_MANAGER_IFACE):
 
1559
 
                    for cn in if_tag.getElementsByTagName("method"):
 
1560
 
                        if (cn.getAttribute("name")
 
1561
 
                            == "GetManagedObjects"):
 
1562
 
                            for arg in cn.getElementsByTagName("arg"):
 
1563
 
                                if (arg.getAttribute("direction")
 
1567
 
                                        "objpath_interfaces"
 
1569
 
            xmlstring = document.toxml("utf-8")
 
1571
 
        except (AttributeError, xml.dom.DOMException,
 
1572
 
                xml.parsers.expat.ExpatError) as error:
 
1573
 
            logger.error("Failed to override Introspection method",
 
1578
 
def datetime_to_dbus(dt, variant_level=0):
 
1579
 
    """Convert a UTC datetime.datetime() to a D-Bus type."""
 
1581
 
        return dbus.String("", variant_level=variant_level)
 
1582
 
    return dbus.String(dt.isoformat(), variant_level=variant_level)
 
1585
 
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1586
 
    """A class decorator; applied to a subclass of
 
1587
 
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1588
 
    interface names according to the "alt_interface_names" mapping.
 
1591
 
    @alternate_dbus_interfaces({"org.example.Interface":
 
1592
 
                                    "net.example.AlternateInterface"})
 
1593
 
    class SampleDBusObject(dbus.service.Object):
 
1594
 
        @dbus.service.method("org.example.Interface")
 
1595
 
        def SampleDBusMethod():
 
1598
 
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1599
 
    reachable via two interfaces: "org.example.Interface" and
 
1600
 
    "net.example.AlternateInterface", the latter of which will have
 
1601
 
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1602
 
    "true", unless "deprecate" is passed with a False value.
 
1604
 
    This works for methods and signals, and also for D-Bus properties
 
1605
 
    (from DBusObjectWithProperties) and interfaces (from the
 
1606
 
    dbus_interface_annotations decorator).
 
1610
 
        for orig_interface_name, alt_interface_name in (
 
1611
 
                alt_interface_names.items()):
 
1613
 
            interface_names = set()
 
1614
 
            # Go though all attributes of the class
 
1615
 
            for attrname, attribute in inspect.getmembers(cls):
 
1616
 
                # Ignore non-D-Bus attributes, and D-Bus attributes
 
1617
 
                # with the wrong interface name
 
1618
 
                if (not hasattr(attribute, "_dbus_interface")
 
1619
 
                    or not attribute._dbus_interface.startswith(
 
1620
 
                        orig_interface_name)):
 
1622
 
                # Create an alternate D-Bus interface name based on
 
1624
 
                alt_interface = attribute._dbus_interface.replace(
 
1625
 
                    orig_interface_name, alt_interface_name)
 
1626
 
                interface_names.add(alt_interface)
 
1627
 
                # Is this a D-Bus signal?
 
1628
 
                if getattr(attribute, "_dbus_is_signal", False):
 
1629
 
                    # Extract the original non-method undecorated
 
1630
 
                    # function by black magic
 
1631
 
                    if sys.version_info.major == 2:
 
1632
 
                        nonmethod_func = (dict(
 
1633
 
                            zip(attribute.func_code.co_freevars,
 
1634
 
                                attribute.__closure__))
 
1635
 
                                          ["func"].cell_contents)
 
1637
 
                        nonmethod_func = (dict(
 
1638
 
                            zip(attribute.__code__.co_freevars,
 
1639
 
                                attribute.__closure__))
 
1640
 
                                          ["func"].cell_contents)
 
1641
 
                    # Create a new, but exactly alike, function
 
1642
 
                    # object, and decorate it to be a new D-Bus signal
 
1643
 
                    # with the alternate D-Bus interface name
 
1644
 
                    new_function = copy_function(nonmethod_func)
 
1645
 
                    new_function = (dbus.service.signal(
 
1647
 
                        attribute._dbus_signature)(new_function))
 
1648
 
                    # Copy annotations, if any
 
1650
 
                        new_function._dbus_annotations = dict(
 
1651
 
                            attribute._dbus_annotations)
 
1652
 
                    except AttributeError:
 
1655
 
                    # Define a creator of a function to call both the
 
1656
 
                    # original and alternate functions, so both the
 
1657
 
                    # original and alternate signals gets sent when
 
1658
 
                    # the function is called
 
1659
 
                    def fixscope(func1, func2):
 
1660
 
                        """This function is a scope container to pass
 
1661
 
                        func1 and func2 to the "call_both" function
 
1662
 
                        outside of its arguments"""
 
1664
 
                        @functools.wraps(func2)
 
1665
 
                        def call_both(*args, **kwargs):
 
1666
 
                            """This function will emit two D-Bus
 
1667
 
                            signals by calling func1 and func2"""
 
1668
 
                            func1(*args, **kwargs)
 
1669
 
                            func2(*args, **kwargs)
 
1670
 
                        # Make wrapper function look like a D-Bus
 
1672
 
                        for name, attr in inspect.getmembers(func2):
 
1673
 
                            if name.startswith("_dbus_"):
 
1674
 
                                setattr(call_both, name, attr)
 
1677
 
                    # Create the "call_both" function and add it to
 
1679
 
                    attr[attrname] = fixscope(attribute, new_function)
 
1680
 
                # Is this a D-Bus method?
 
1681
 
                elif getattr(attribute, "_dbus_is_method", False):
 
1682
 
                    # Create a new, but exactly alike, function
 
1683
 
                    # object.  Decorate it to be a new D-Bus method
 
1684
 
                    # with the alternate D-Bus interface name.  Add it
 
1687
 
                        dbus.service.method(
 
1689
 
                            attribute._dbus_in_signature,
 
1690
 
                            attribute._dbus_out_signature)
 
1691
 
                        (copy_function(attribute)))
 
1692
 
                    # Copy annotations, if any
 
1694
 
                        attr[attrname]._dbus_annotations = dict(
 
1695
 
                            attribute._dbus_annotations)
 
1696
 
                    except AttributeError:
 
1698
 
                # Is this a D-Bus property?
 
1699
 
                elif getattr(attribute, "_dbus_is_property", False):
 
1700
 
                    # Create a new, but exactly alike, function
 
1701
 
                    # object, and decorate it to be a new D-Bus
 
1702
 
                    # property with the alternate D-Bus interface
 
1703
 
                    # name.  Add it to the class.
 
1704
 
                    attr[attrname] = (dbus_service_property(
 
1705
 
                        alt_interface, attribute._dbus_signature,
 
1706
 
                        attribute._dbus_access,
 
1707
 
                        attribute._dbus_get_args_options
 
1709
 
                                      (copy_function(attribute)))
 
1710
 
                    # Copy annotations, if any
 
1712
 
                        attr[attrname]._dbus_annotations = dict(
 
1713
 
                            attribute._dbus_annotations)
 
1714
 
                    except AttributeError:
 
1716
 
                # Is this a D-Bus interface?
 
1717
 
                elif getattr(attribute, "_dbus_is_interface", False):
 
1718
 
                    # Create a new, but exactly alike, function
 
1719
 
                    # object.  Decorate it to be a new D-Bus interface
 
1720
 
                    # with the alternate D-Bus interface name.  Add it
 
1723
 
                        dbus_interface_annotations(alt_interface)
 
1724
 
                        (copy_function(attribute)))
 
1726
 
                # Deprecate all alternate interfaces
 
1727
 
                iname = "_AlternateDBusNames_interface_annotation{}"
 
1728
 
                for interface_name in interface_names:
 
1730
 
                    @dbus_interface_annotations(interface_name)
 
1732
 
                        return {"org.freedesktop.DBus.Deprecated":
 
1734
 
                    # Find an unused name
 
1735
 
                    for aname in (iname.format(i)
 
1736
 
                                  for i in itertools.count()):
 
1737
 
                        if aname not in attr:
 
1741
 
                # Replace the class with a new subclass of it with
 
1742
 
                # methods, signals, etc. as created above.
 
1743
 
                if sys.version_info.major == 2:
 
1744
 
                    cls = type(b"{}Alternate".format(cls.__name__),
 
1747
 
                    cls = type("{}Alternate".format(cls.__name__),
 
1754
 
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1755
 
                            "se.bsnet.fukt.Mandos"})
 
1756
740
class ClientDBus(Client, DBusObjectWithProperties):
 
1757
741
    """A Client class using D-Bus
 
1760
744
    dbus_object_path: dbus.ObjectPath
 
1761
745
    bus: dbus.SystemBus()
 
1764
748
    runtime_expansions = (Client.runtime_expansions
 
1765
 
                          + ("dbus_object_path", ))
 
1767
 
    _interface = "se.recompile.Mandos.Client"
 
 
749
                          + ("dbus_object_path",))
 
1769
751
    # dbus.service.Object doesn't use super(), so we can't either.
 
1771
 
    def __init__(self, bus=None, *args, **kwargs):
 
 
753
    def __init__(self, bus = None, *args, **kwargs):
 
 
754
        self._approvals_pending = 0
 
1773
756
        Client.__init__(self, *args, **kwargs)
 
1774
757
        # Only now, when this client is initialized, can it show up on
 
1776
 
        client_object_name = str(self.name).translate(
 
 
759
        client_object_name = unicode(self.name).translate(
 
1777
760
            {ord("."): ord("_"),
 
1778
761
             ord("-"): ord("_")})
 
1779
 
        self.dbus_object_path = dbus.ObjectPath(
 
1780
 
            "/clients/" + client_object_name)
 
 
762
        self.dbus_object_path = (dbus.ObjectPath
 
 
763
                                 ("/clients/" + client_object_name))
 
1781
764
        DBusObjectWithProperties.__init__(self, self.bus,
 
1782
765
                                          self.dbus_object_path)
 
1784
 
    def notifychangeproperty(transform_func, dbus_name,
 
1785
 
                             type_func=lambda x: x,
 
1787
 
                             invalidate_only=False,
 
1788
 
                             _interface=_interface):
 
1789
 
        """ Modify a variable so that it's a property which announces
 
1790
 
        its changes to DBus.
 
1792
 
        transform_fun: Function that takes a value and a variant_level
 
1793
 
                       and transforms it to a D-Bus type.
 
1794
 
        dbus_name: D-Bus name of the variable
 
1795
 
        type_func: Function that transform the value before sending it
 
1796
 
                   to the D-Bus.  Default: no transform
 
1797
 
        variant_level: D-Bus variant level.  Default: 1
 
1799
 
        attrname = "_{}".format(dbus_name)
 
1801
 
        def setter(self, value):
 
1802
 
            if hasattr(self, "dbus_object_path"):
 
1803
 
                if (not hasattr(self, attrname) or
 
1804
 
                    type_func(getattr(self, attrname, None))
 
1805
 
                    != type_func(value)):
 
1807
 
                        self.PropertiesChanged(
 
1808
 
                            _interface, dbus.Dictionary(),
 
1809
 
                            dbus.Array((dbus_name, )))
 
1811
 
                        dbus_value = transform_func(
 
1813
 
                            variant_level=variant_level)
 
1814
 
                        self.PropertyChanged(dbus.String(dbus_name),
 
1816
 
                        self.PropertiesChanged(
 
1818
 
                            dbus.Dictionary({dbus.String(dbus_name):
 
1821
 
            setattr(self, attrname, value)
 
1823
 
        return property(lambda self: getattr(self, attrname), setter)
 
1825
 
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
 
1826
 
    approvals_pending = notifychangeproperty(dbus.Boolean,
 
1829
 
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
 
1830
 
    last_enabled = notifychangeproperty(datetime_to_dbus,
 
1832
 
    checker = notifychangeproperty(
 
1833
 
        dbus.Boolean, "CheckerRunning",
 
1834
 
        type_func=lambda checker: checker is not None)
 
1835
 
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
 
1837
 
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1838
 
                                               "LastCheckerStatus")
 
1839
 
    last_approval_request = notifychangeproperty(
 
1840
 
        datetime_to_dbus, "LastApprovalRequest")
 
1841
 
    approved_by_default = notifychangeproperty(dbus.Boolean,
 
1842
 
                                               "ApprovedByDefault")
 
1843
 
    approval_delay = notifychangeproperty(
 
1844
 
        dbus.UInt64, "ApprovalDelay",
 
1845
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1846
 
    approval_duration = notifychangeproperty(
 
1847
 
        dbus.UInt64, "ApprovalDuration",
 
1848
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1849
 
    host = notifychangeproperty(dbus.String, "Host")
 
1850
 
    timeout = notifychangeproperty(
 
1851
 
        dbus.UInt64, "Timeout",
 
1852
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1853
 
    extended_timeout = notifychangeproperty(
 
1854
 
        dbus.UInt64, "ExtendedTimeout",
 
1855
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1856
 
    interval = notifychangeproperty(
 
1857
 
        dbus.UInt64, "Interval",
 
1858
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1859
 
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1860
 
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1861
 
                                  invalidate_only=True)
 
1863
 
    del notifychangeproperty
 
 
767
    def _get_approvals_pending(self):
 
 
768
        return self._approvals_pending
 
 
769
    def _set_approvals_pending(self, value):
 
 
770
        old_value = self._approvals_pending
 
 
771
        self._approvals_pending = value
 
 
773
        if (hasattr(self, "dbus_object_path")
 
 
774
            and bval is not bool(old_value)):
 
 
775
            dbus_bool = dbus.Boolean(bval, variant_level=1)
 
 
776
            self.PropertyChanged(dbus.String("ApprovalPending"),
 
 
779
    approvals_pending = property(_get_approvals_pending,
 
 
780
                                 _set_approvals_pending)
 
 
781
    del _get_approvals_pending, _set_approvals_pending
 
 
784
    def _datetime_to_dbus(dt, variant_level=0):
 
 
785
        """Convert a UTC datetime.datetime() to a D-Bus type."""
 
 
786
        return dbus.String(dt.isoformat(),
 
 
787
                           variant_level=variant_level)
 
 
790
        oldstate = getattr(self, "enabled", False)
 
 
791
        r = Client.enable(self)
 
 
792
        if oldstate != self.enabled:
 
 
794
            self.PropertyChanged(dbus.String("Enabled"),
 
 
795
                                 dbus.Boolean(True, variant_level=1))
 
 
796
            self.PropertyChanged(
 
 
797
                dbus.String("LastEnabled"),
 
 
798
                self._datetime_to_dbus(self.last_enabled,
 
 
802
    def disable(self, quiet = False):
 
 
803
        oldstate = getattr(self, "enabled", False)
 
 
804
        r = Client.disable(self, quiet=quiet)
 
 
805
        if not quiet and oldstate != self.enabled:
 
 
807
            self.PropertyChanged(dbus.String("Enabled"),
 
 
808
                                 dbus.Boolean(False, variant_level=1))
 
1865
811
    def __del__(self, *args, **kwargs):
 
1867
813
            self.remove_from_connection()
 
 
2366
1316
                        delay -= time2 - time
 
2369
 
                    session.send(client.secret)
 
2370
 
                except gnutls.Error as error:
 
2371
 
                    logger.warning("gnutls send failed",
 
 
1319
                while sent_size < len(client.secret):
 
 
1321
                        sent = session.send(client.secret[sent_size:])
 
 
1322
                    except gnutls.errors.GNUTLSError as error:
 
 
1323
                        logger.warning("gnutls send failed")
 
 
1325
                    logger.debug("Sent: %d, remaining: %d",
 
 
1326
                                 sent, len(client.secret)
 
 
1327
                                 - (sent_size + sent))
 
2375
1330
                logger.info("Sending secret to %s", client.name)
 
2376
 
                # bump the timeout using extended_timeout
 
2377
 
                client.bump_timeout(client.extended_timeout)
 
 
1331
                # bump the timeout as if seen
 
2378
1333
                if self.server.use_dbus:
 
2379
1334
                    # Emit D-Bus signal
 
2380
1335
                    client.GotSecret()
 
2383
1338
                if approval_required:
 
2384
1339
                    client.approvals_pending -= 1
 
2387
 
                except gnutls.Error as error:
 
2388
 
                    logger.warning("GnuTLS bye failed",
 
 
1342
                except gnutls.errors.GNUTLSError as error:
 
 
1343
                    logger.warning("GnuTLS bye failed")
 
2392
1346
    def peer_certificate(session):
 
2393
 
        "Return the peer's certificate as a bytestring"
 
2395
 
            cert_type = gnutls.certificate_type_get2(session._c_object,
 
2397
 
        except AttributeError:
 
2398
 
            cert_type = gnutls.certificate_type_get(session._c_object)
 
2399
 
        if gnutls.has_rawpk:
 
2400
 
            valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
 
2402
 
            valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
 
2403
 
        # If not a valid certificate type...
 
2404
 
        if cert_type not in valid_cert_types:
 
2405
 
            logger.info("Cert type %r not in %r", cert_type,
 
2407
 
            # ...return invalid data
 
 
1347
        "Return the peer's OpenPGP certificate as a bytestring"
 
 
1348
        # If not an OpenPGP certificate...
 
 
1349
        if (gnutls.library.functions
 
 
1350
            .gnutls_certificate_type_get(session._c_object)
 
 
1351
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
 
 
1352
            # ...do the normal thing
 
 
1353
            return session.peer_certificate
 
2409
1354
        list_size = ctypes.c_uint(1)
 
2410
 
        cert_list = (gnutls.certificate_get_peers
 
 
1355
        cert_list = (gnutls.library.functions
 
 
1356
                     .gnutls_certificate_get_peers
 
2411
1357
                     (session._c_object, ctypes.byref(list_size)))
 
2412
1358
        if not bool(cert_list) and list_size.value != 0:
 
2413
 
            raise gnutls.Error("error getting peer certificate")
 
 
1359
            raise gnutls.errors.GNUTLSError("error getting peer"
 
2414
1361
        if list_size.value == 0:
 
2416
1363
        cert = cert_list[0]
 
2417
1364
        return ctypes.string_at(cert.data, cert.size)
 
2420
 
    def key_id(certificate):
 
2421
 
        "Convert a certificate bytestring to a hexdigit key ID"
 
2422
 
        # New GnuTLS "datum" with the public key
 
2423
 
        datum = gnutls.datum_t(
 
2424
 
            ctypes.cast(ctypes.c_char_p(certificate),
 
2425
 
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2426
 
            ctypes.c_uint(len(certificate)))
 
2427
 
        # XXX all these need to be created in the gnutls "module"
 
2428
 
        # New empty GnuTLS certificate
 
2429
 
        pubkey = gnutls.pubkey_t()
 
2430
 
        gnutls.pubkey_init(ctypes.byref(pubkey))
 
2431
 
        # Import the raw public key into the certificate
 
2432
 
        gnutls.pubkey_import(pubkey,
 
2433
 
                             ctypes.byref(datum),
 
2434
 
                             gnutls.X509_FMT_DER)
 
2435
 
        # New buffer for the key ID
 
2436
 
        buf = ctypes.create_string_buffer(32)
 
2437
 
        buf_len = ctypes.c_size_t(len(buf))
 
2438
 
        # Get the key ID from the raw public key into the buffer
 
2439
 
        gnutls.pubkey_get_key_id(pubkey,
 
2440
 
                                 gnutls.KEYID_USE_SHA256,
 
2441
 
                                 ctypes.cast(ctypes.byref(buf),
 
2442
 
                                             ctypes.POINTER(ctypes.c_ubyte)),
 
2443
 
                                 ctypes.byref(buf_len))
 
2444
 
        # Deinit the certificate
 
2445
 
        gnutls.pubkey_deinit(pubkey)
 
2447
 
        # Convert the buffer to a Python bytestring
 
2448
 
        key_id = ctypes.string_at(buf, buf_len.value)
 
2449
 
        # Convert the bytestring to hexadecimal notation
 
2450
 
        hex_key_id = binascii.hexlify(key_id).upper()
 
2454
1367
    def fingerprint(openpgp):
 
2455
1368
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
 
2456
1369
        # New GnuTLS "datum" with the OpenPGP public key
 
2457
 
        datum = gnutls.datum_t(
 
2458
 
            ctypes.cast(ctypes.c_char_p(openpgp),
 
2459
 
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2460
 
            ctypes.c_uint(len(openpgp)))
 
 
1370
        datum = (gnutls.library.types
 
 
1371
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
 
 
1374
                                 ctypes.c_uint(len(openpgp))))
 
2461
1375
        # New empty GnuTLS certificate
 
2462
 
        crt = gnutls.openpgp_crt_t()
 
2463
 
        gnutls.openpgp_crt_init(ctypes.byref(crt))
 
 
1376
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
 
1377
        (gnutls.library.functions
 
 
1378
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
2464
1379
        # Import the OpenPGP public key into the certificate
 
2465
 
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2466
 
                                  gnutls.OPENPGP_FMT_RAW)
 
 
1380
        (gnutls.library.functions
 
 
1381
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
 
1382
                                    gnutls.library.constants
 
 
1383
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
2467
1384
        # Verify the self signature in the key
 
2468
1385
        crtverify = ctypes.c_uint()
 
2469
 
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2470
 
                                       ctypes.byref(crtverify))
 
 
1386
        (gnutls.library.functions
 
 
1387
         .gnutls_openpgp_crt_verify_self(crt, 0,
 
 
1388
                                         ctypes.byref(crtverify)))
 
2471
1389
        if crtverify.value != 0:
 
2472
 
            gnutls.openpgp_crt_deinit(crt)
 
2473
 
            raise gnutls.CertificateSecurityError(code
 
 
1390
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
 
1391
            raise (gnutls.errors.CertificateSecurityError
 
2475
1393
        # New buffer for the fingerprint
 
2476
1394
        buf = ctypes.create_string_buffer(20)
 
2477
1395
        buf_len = ctypes.c_size_t()
 
2478
1396
        # Get the fingerprint from the certificate into the buffer
 
2479
 
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2480
 
                                           ctypes.byref(buf_len))
 
 
1397
        (gnutls.library.functions
 
 
1398
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
 
1399
                                             ctypes.byref(buf_len)))
 
2481
1400
        # Deinit the certificate
 
2482
 
        gnutls.openpgp_crt_deinit(crt)
 
 
1401
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2483
1402
        # Convert the buffer to a Python bytestring
 
2484
1403
        fpr = ctypes.string_at(buf, buf_len.value)
 
2485
1404
        # Convert the bytestring to hexadecimal notation
 
2486
 
        hex_fpr = binascii.hexlify(fpr).upper()
 
 
1405
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
2490
1409
class MultiprocessingMixIn(object):
 
2491
1410
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
2493
1411
    def sub_process_main(self, request, address):
 
2495
1413
            self.finish_request(request, address)
 
2497
1415
            self.handle_error(request, address)
 
2498
1416
        self.close_request(request)
 
2500
1418
    def process_request(self, request, address):
 
2501
1419
        """Start a new process to process the request."""
 
2502
 
        proc = multiprocessing.Process(target=self.sub_process_main,
 
2503
 
                                       args=(request, address))
 
 
1420
        multiprocessing.Process(target = self.sub_process_main,
 
 
1421
                                args = (request, address)).start()
 
2508
1423
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
 
2509
1424
    """ adds a pipe to the MixIn """
 
2511
1425
    def process_request(self, request, client_address):
 
2512
1426
        """Overrides and wraps the original process_request().
 
2514
1428
        This function creates a new pipe in self.pipe
 
2516
1430
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
 
2518
 
        proc = MultiprocessingMixIn.process_request(self, request,
 
 
1432
        super(MultiprocessingMixInWithPipe,
 
 
1433
              self).process_request(request, client_address)
 
2520
1434
        self.child_pipe.close()
 
2521
 
        self.add_pipe(parent_pipe, proc)
 
 
1435
        self.add_pipe(parent_pipe)
 
2523
 
    def add_pipe(self, parent_pipe, proc):
 
 
1437
    def add_pipe(self, parent_pipe):
 
2524
1438
        """Dummy function; override as necessary"""
 
2525
 
        raise NotImplementedError()
 
 
1439
        raise NotImplementedError
 
2528
1441
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
 
2529
1442
                     socketserver.TCPServer, object):
 
2530
1443
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
 
2533
1446
        enabled:        Boolean; whether this server is activated yet
 
2534
1447
        interface:      None or a network interface name (string)
 
2535
1448
        use_ipv6:       Boolean; to use IPv6 or not
 
2538
1450
    def __init__(self, server_address, RequestHandlerClass,
 
2542
 
        """If socketfd is set, use that file descriptor instead of
 
2543
 
        creating a new one with socket.socket().
 
 
1451
                 interface=None, use_ipv6=True):
 
2545
1452
        self.interface = interface
 
2547
1454
            self.address_family = socket.AF_INET6
 
2548
 
        if socketfd is not None:
 
2549
 
            # Save the file descriptor
 
2550
 
            self.socketfd = socketfd
 
2551
 
            # Save the original socket.socket() function
 
2552
 
            self.socket_socket = socket.socket
 
2554
 
            # To implement --socket, we monkey patch socket.socket.
 
2556
 
            # (When socketserver.TCPServer is a new-style class, we
 
2557
 
            # could make self.socket into a property instead of monkey
 
2558
 
            # patching socket.socket.)
 
2560
 
            # Create a one-time-only replacement for socket.socket()
 
2561
 
            @functools.wraps(socket.socket)
 
2562
 
            def socket_wrapper(*args, **kwargs):
 
2563
 
                # Restore original function so subsequent calls are
 
2565
 
                socket.socket = self.socket_socket
 
2566
 
                del self.socket_socket
 
2567
 
                # This time only, return a new socket object from the
 
2568
 
                # saved file descriptor.
 
2569
 
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
2570
 
            # Replace socket.socket() function with wrapper
 
2571
 
            socket.socket = socket_wrapper
 
2572
 
        # The socketserver.TCPServer.__init__ will call
 
2573
 
        # socket.socket(), which might be our replacement,
 
2574
 
        # socket_wrapper(), if socketfd was set.
 
2575
1455
        socketserver.TCPServer.__init__(self, server_address,
 
2576
1456
                                        RequestHandlerClass)
 
2578
1457
    def server_bind(self):
 
2579
1458
        """This overrides the normal server_bind() function
 
2580
1459
        to bind to an interface if one was specified, and also NOT to
 
2581
1460
        bind to an address or port if they were not specified."""
 
2582
 
        global SO_BINDTODEVICE
 
2583
1461
        if self.interface is not None:
 
2584
1462
            if SO_BINDTODEVICE is None:
 
2585
 
                # Fall back to a hard-coded value which seems to be
 
2587
 
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
2588
 
                SO_BINDTODEVICE = 25
 
2590
 
                self.socket.setsockopt(
 
2591
 
                    socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2592
 
                    (self.interface + "\0").encode("utf-8"))
 
2593
 
            except socket.error as error:
 
2594
 
                if error.errno == errno.EPERM:
 
2595
 
                    logger.error("No permission to bind to"
 
2596
 
                                 " interface %s", self.interface)
 
2597
 
                elif error.errno == errno.ENOPROTOOPT:
 
2598
 
                    logger.error("SO_BINDTODEVICE not available;"
 
2599
 
                                 " cannot bind to interface %s",
 
2601
 
                elif error.errno == errno.ENODEV:
 
2602
 
                    logger.error("Interface %s does not exist,"
 
2603
 
                                 " cannot bind", self.interface)
 
 
1463
                logger.error("SO_BINDTODEVICE does not exist;"
 
 
1464
                             " cannot bind to interface %s",
 
 
1468
                    self.socket.setsockopt(socket.SOL_SOCKET,
 
 
1472
                except socket.error as error:
 
 
1473
                    if error[0] == errno.EPERM:
 
 
1474
                        logger.error("No permission to"
 
 
1475
                                     " bind to interface %s",
 
 
1477
                    elif error[0] == errno.ENOPROTOOPT:
 
 
1478
                        logger.error("SO_BINDTODEVICE not available;"
 
 
1479
                                     " cannot bind to interface %s",
 
2606
1483
        # Only bind(2) the socket if we really need to.
 
2607
1484
        if self.server_address[0] or self.server_address[1]:
 
2608
 
            if self.server_address[1]:
 
2609
 
                self.allow_reuse_address = True
 
2610
1485
            if not self.server_address[0]:
 
2611
1486
                if self.address_family == socket.AF_INET6:
 
2612
 
                    any_address = "::"  # in6addr_any
 
 
1487
                    any_address = "::" # in6addr_any
 
2614
 
                    any_address = "0.0.0.0"  # INADDR_ANY
 
 
1489
                    any_address = socket.INADDR_ANY
 
2615
1490
                self.server_address = (any_address,
 
2616
1491
                                       self.server_address[1])
 
2617
1492
            elif not self.server_address[1]:
 
2618
 
                self.server_address = (self.server_address[0], 0)
 
 
1493
                self.server_address = (self.server_address[0],
 
2619
1495
#                 if self.interface:
 
2620
1496
#                     self.server_address = (self.server_address[0],
 
 
2948
1728
    parser.add_argument("--no-dbus", action="store_false",
 
2949
1729
                        dest="use_dbus", help="Do not provide D-Bus"
 
2950
 
                        " system bus interface", default=None)
 
 
1730
                        " system bus interface")
 
2951
1731
    parser.add_argument("--no-ipv6", action="store_false",
 
2952
 
                        dest="use_ipv6", help="Do not use IPv6",
 
2954
 
    parser.add_argument("--no-restore", action="store_false",
 
2955
 
                        dest="restore", help="Do not restore stored"
 
2956
 
                        " state", default=None)
 
2957
 
    parser.add_argument("--socket", type=int,
 
2958
 
                        help="Specify a file descriptor to a network"
 
2959
 
                        " socket to use instead of creating one")
 
2960
 
    parser.add_argument("--statedir", metavar="DIR",
 
2961
 
                        help="Directory to save/restore state in")
 
2962
 
    parser.add_argument("--foreground", action="store_true",
 
2963
 
                        help="Run in foreground", default=None)
 
2964
 
    parser.add_argument("--no-zeroconf", action="store_false",
 
2965
 
                        dest="zeroconf", help="Do not use Zeroconf",
 
 
1732
                        dest="use_ipv6", help="Do not use IPv6")
 
2968
1733
    options = parser.parse_args()
 
2970
1735
    if options.check:
 
2972
 
        fail_count, test_count = doctest.testmod()
 
2973
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2975
1740
    # Default values for config file for server-global settings
 
2976
 
    if gnutls.has_rawpk:
 
2977
 
        priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
 
2978
 
                    ":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
 
2980
 
        priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2981
 
                    ":+SIGN-DSA-SHA256")
 
2982
 
    server_defaults = {"interface": "",
 
2986
 
                       "priority": priority,
 
2987
 
                       "servicename": "Mandos",
 
2993
 
                       "statedir": "/var/lib/mandos",
 
2994
 
                       "foreground": "False",
 
 
1741
    server_defaults = { "interface": "",
 
 
1746
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
 
1747
                        "servicename": "Mandos",
 
2999
1753
    # Parse config file for server-global settings
 
3000
1754
    server_config = configparser.SafeConfigParser(server_defaults)
 
3001
1755
    del server_defaults
 
3002
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
 
1756
    server_config.read(os.path.join(options.configdir,
 
3003
1758
    # Convert the SafeConfigParser object to a dict
 
3004
1759
    server_settings = server_config.defaults()
 
3005
1760
    # Use the appropriate methods on the non-string config options
 
3006
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
3007
 
                   "foreground", "zeroconf"):
 
 
1761
    for option in ("debug", "use_dbus", "use_ipv6"):
 
3008
1762
        server_settings[option] = server_config.getboolean("DEFAULT",
 
3010
1764
    if server_settings["port"]:
 
3011
1765
        server_settings["port"] = server_config.getint("DEFAULT",
 
3013
 
    if server_settings["socket"]:
 
3014
 
        server_settings["socket"] = server_config.getint("DEFAULT",
 
3016
 
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
3017
 
        # over with an opened os.devnull.  But we don't want this to
 
3018
 
        # happen with a supplied network socket.
 
3019
 
        if 0 <= server_settings["socket"] <= 2:
 
3020
 
            server_settings["socket"] = os.dup(server_settings
 
3022
1767
    del server_config
 
3024
1769
    # Override the settings from the config file with command line
 
3025
1770
    # options, if set.
 
3026
1771
    for option in ("interface", "address", "port", "debug",
 
3027
 
                   "priority", "servicename", "configdir", "use_dbus",
 
3028
 
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
3029
 
                   "socket", "foreground", "zeroconf"):
 
 
1772
                   "priority", "servicename", "configdir",
 
 
1773
                   "use_dbus", "use_ipv6", "debuglevel"):
 
3030
1774
        value = getattr(options, option)
 
3031
1775
        if value is not None:
 
3032
1776
            server_settings[option] = value
 
3034
1778
    # Force all strings to be unicode
 
3035
1779
    for option in server_settings.keys():
 
3036
 
        if isinstance(server_settings[option], bytes):
 
3037
 
            server_settings[option] = (server_settings[option]
 
3039
 
    # Force all boolean options to be boolean
 
3040
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
3041
 
                   "foreground", "zeroconf"):
 
3042
 
        server_settings[option] = bool(server_settings[option])
 
3043
 
    # Debug implies foreground
 
3044
 
    if server_settings["debug"]:
 
3045
 
        server_settings["foreground"] = True
 
 
1780
        if type(server_settings[option]) is str:
 
 
1781
            server_settings[option] = unicode(server_settings[option])
 
3046
1782
    # Now we have our good server settings in "server_settings"
 
3048
1784
    ##################################################################
 
3050
 
    if (not server_settings["zeroconf"]
 
3051
 
        and not (server_settings["port"]
 
3052
 
                 or server_settings["socket"] != "")):
 
3053
 
        parser.error("Needs port or socket to work without Zeroconf")
 
3055
1786
    # For convenience
 
3056
1787
    debug = server_settings["debug"]
 
3057
1788
    debuglevel = server_settings["debuglevel"]
 
3058
1789
    use_dbus = server_settings["use_dbus"]
 
3059
1790
    use_ipv6 = server_settings["use_ipv6"]
 
3060
 
    stored_state_path = os.path.join(server_settings["statedir"],
 
3062
 
    foreground = server_settings["foreground"]
 
3063
 
    zeroconf = server_settings["zeroconf"]
 
3066
 
        initlogger(debug, logging.DEBUG)
 
3071
 
            level = getattr(logging, debuglevel.upper())
 
3072
 
            initlogger(debug, level)
 
3074
1792
    if server_settings["servicename"] != "Mandos":
 
3075
 
        syslogger.setFormatter(
 
3076
 
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
3077
 
                              ' %(levelname)s: %(message)s'.format(
 
3078
 
                                  server_settings["servicename"])))
 
 
1793
        syslogger.setFormatter(logging.Formatter
 
 
1794
                               ('Mandos (%s) [%%(process)d]:'
 
 
1795
                                ' %%(levelname)s: %%(message)s'
 
 
1796
                                % server_settings["servicename"]))
 
3080
1798
    # Parse config file with clients
 
3081
 
    client_config = configparser.SafeConfigParser(Client
 
 
1799
    client_defaults = { "timeout": "1h",
 
 
1801
                        "checker": "fping -q -- %%(host)s",
 
 
1803
                        "approval_delay": "0s",
 
 
1804
                        "approval_duration": "1s",
 
 
1806
    client_config = configparser.SafeConfigParser(client_defaults)
 
3083
1807
    client_config.read(os.path.join(server_settings["configdir"],
 
3084
1808
                                    "clients.conf"))
 
3086
1810
    global mandos_dbus_service
 
3087
1811
    mandos_dbus_service = None
 
3090
 
    if server_settings["socket"] != "":
 
3091
 
        socketfd = server_settings["socket"]
 
3092
 
    tcp_server = MandosServer(
 
3093
 
        (server_settings["address"], server_settings["port"]),
 
3095
 
        interface=(server_settings["interface"] or None),
 
3097
 
        gnutls_priority=server_settings["priority"],
 
3101
 
        pidfilename = "/run/mandos.pid"
 
3102
 
        if not os.path.isdir("/run/."):
 
3103
 
            pidfilename = "/var/run/mandos.pid"
 
3106
 
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
 
3107
 
        except IOError as e:
 
3108
 
            logger.error("Could not open file %r", pidfilename,
 
3111
 
    for name, group in (("_mandos", "_mandos"),
 
3112
 
                        ("mandos", "mandos"),
 
3113
 
                        ("nobody", "nogroup")):
 
3115
 
            uid = pwd.getpwnam(name).pw_uid
 
3116
 
            gid = pwd.getpwnam(group).pw_gid
 
 
1813
    tcp_server = MandosServer((server_settings["address"],
 
 
1814
                               server_settings["port"]),
 
 
1816
                              interface=(server_settings["interface"]
 
 
1820
                              server_settings["priority"],
 
 
1823
        pidfilename = "/var/run/mandos.pid"
 
 
1825
            pidfile = open(pidfilename, "w")
 
 
1827
            logger.error("Could not open file %r", pidfilename)
 
 
1830
        uid = pwd.getpwnam("_mandos").pw_uid
 
 
1831
        gid = pwd.getpwnam("_mandos").pw_gid
 
 
1834
            uid = pwd.getpwnam("mandos").pw_uid
 
 
1835
            gid = pwd.getpwnam("mandos").pw_gid
 
3118
1836
        except KeyError:
 
 
1838
                uid = pwd.getpwnam("nobody").pw_uid
 
 
1839
                gid = pwd.getpwnam("nobody").pw_gid
 
3127
 
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3129
1846
    except OSError as error:
 
3130
 
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3131
 
                       .format(uid, gid, os.strerror(error.errno)))
 
3132
 
        if error.errno != errno.EPERM:
 
 
1847
        if error[0] != errno.EPERM:
 
 
1850
    if not debug and not debuglevel:
 
 
1851
        syslogger.setLevel(logging.WARNING)
 
 
1852
        console.setLevel(logging.WARNING)
 
 
1854
        level = getattr(logging, debuglevel.upper())
 
 
1855
        syslogger.setLevel(level)
 
 
1856
        console.setLevel(level)
 
3136
1859
        # Enable all possible GnuTLS debugging
 
3138
1861
        # "Use a log level over 10 to enable all debugging options."
 
3139
1862
        # - GnuTLS manual
 
3140
 
        gnutls.global_set_log_level(11)
 
 
1863
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
 
1865
        @gnutls.library.types.gnutls_log_func
 
3143
1866
        def debug_gnutls(level, string):
 
3144
1867
            logger.debug("GnuTLS: %s", string[:-1])
 
3146
 
        gnutls.global_set_log_function(debug_gnutls)
 
 
1869
        (gnutls.library.functions
 
 
1870
         .gnutls_global_set_log_function(debug_gnutls))
 
3148
1872
        # Redirect stdin so all checkers get /dev/null
 
3149
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
 
1873
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
3150
1874
        os.dup2(null, sys.stdin.fileno())
 
 
1878
        # No console logging
 
 
1879
        logger.removeHandler(console)
 
3154
1881
    # Need to fork before connecting to D-Bus
 
3156
1883
        # Close all input and output, do double fork, etc.
 
3159
 
    # multiprocessing will use threads, so before we use GLib we need
 
3160
 
    # to inform GLib that threads will be used.
 
3163
1886
    global main_loop
 
3164
1887
    # From the Avahi example code
 
3165
 
    DBusGMainLoop(set_as_default=True)
 
3166
 
    main_loop = GLib.MainLoop()
 
 
1888
    DBusGMainLoop(set_as_default=True )
 
 
1889
    main_loop = gobject.MainLoop()
 
3167
1890
    bus = dbus.SystemBus()
 
3168
1891
    # End of Avahi example code
 
3171
 
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
3174
 
            old_bus_name = dbus.service.BusName(
 
3175
 
                "se.bsnet.fukt.Mandos", bus,
 
3177
 
        except dbus.exceptions.DBusException as e:
 
3178
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
 
1894
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
 
 
1895
                                            bus, do_not_queue=True)
 
 
1896
        except dbus.exceptions.NameExistsException as e:
 
 
1897
            logger.error(unicode(e) + ", disabling D-Bus")
 
3179
1898
            use_dbus = False
 
3180
1899
            server_settings["use_dbus"] = False
 
3181
1900
            tcp_server.use_dbus = False
 
3183
 
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
3184
 
        service = AvahiServiceToSyslog(
 
3185
 
            name=server_settings["servicename"],
 
3186
 
            servicetype="_mandos._tcp",
 
3189
 
        if server_settings["interface"]:
 
3190
 
            service.interface = if_nametoindex(
 
3191
 
                server_settings["interface"].encode("utf-8"))
 
 
1901
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
 
1902
    service = AvahiService(name = server_settings["servicename"],
 
 
1903
                           servicetype = "_mandos._tcp",
 
 
1904
                           protocol = protocol, bus = bus)
 
 
1905
    if server_settings["interface"]:
 
 
1906
        service.interface = (if_nametoindex
 
 
1907
                             (str(server_settings["interface"])))
 
3193
1909
    global multiprocessing_manager
 
3194
1910
    multiprocessing_manager = multiprocessing.Manager()
 
3196
1912
    client_class = Client
 
3198
 
        client_class = functools.partial(ClientDBus, bus=bus)
 
3200
 
    client_settings = Client.config_parser(client_config)
 
3201
 
    old_client_settings = {}
 
3204
 
    # This is used to redirect stdout and stderr for checker processes
 
3206
 
    wnull = open(os.devnull, "w")  # A writable /dev/null
 
3207
 
    # Only used if server is running in foreground but not in debug
 
3209
 
    if debug or not foreground:
 
3212
 
    # Get client data and settings from last running state.
 
3213
 
    if server_settings["restore"]:
 
3215
 
            with open(stored_state_path, "rb") as stored_state:
 
3216
 
                if sys.version_info.major == 2:
 
3217
 
                    clients_data, old_client_settings = pickle.load(
 
3220
 
                    bytes_clients_data, bytes_old_client_settings = (
 
3221
 
                        pickle.load(stored_state, encoding="bytes"))
 
3222
 
                    #   Fix bytes to strings
 
3225
 
                    clients_data = {(key.decode("utf-8")
 
3226
 
                                     if isinstance(key, bytes)
 
3229
 
                                    bytes_clients_data.items()}
 
3230
 
                    del bytes_clients_data
 
3231
 
                    for key in clients_data:
 
3232
 
                        value = {(k.decode("utf-8")
 
3233
 
                                  if isinstance(k, bytes) else k): v
 
3235
 
                                 clients_data[key].items()}
 
3236
 
                        clients_data[key] = value
 
3238
 
                        value["client_structure"] = [
 
3240
 
                             if isinstance(s, bytes)
 
3242
 
                            value["client_structure"]]
 
3244
 
                        for k in ("name", "host"):
 
3245
 
                            if isinstance(value[k], bytes):
 
3246
 
                                value[k] = value[k].decode("utf-8")
 
3247
 
                        if not value.has_key("key_id"):
 
3248
 
                            value["key_id"] = ""
 
3249
 
                        elif not value.has_key("fingerprint"):
 
3250
 
                            value["fingerprint"] = ""
 
3251
 
                    #  old_client_settings
 
3253
 
                    old_client_settings = {
 
3254
 
                        (key.decode("utf-8")
 
3255
 
                         if isinstance(key, bytes)
 
3258
 
                        bytes_old_client_settings.items()}
 
3259
 
                    del bytes_old_client_settings
 
3261
 
                    for value in old_client_settings.values():
 
3262
 
                        if isinstance(value["host"], bytes):
 
3263
 
                            value["host"] = (value["host"]
 
3265
 
            os.remove(stored_state_path)
 
3266
 
        except IOError as e:
 
3267
 
            if e.errno == errno.ENOENT:
 
3268
 
                logger.warning("Could not load persistent state:"
 
3269
 
                               " {}".format(os.strerror(e.errno)))
 
3271
 
                logger.critical("Could not load persistent state:",
 
3274
 
        except EOFError as e:
 
3275
 
            logger.warning("Could not load persistent state: "
 
3279
 
    with PGPEngine() as pgp:
 
3280
 
        for client_name, client in clients_data.items():
 
3281
 
            # Skip removed clients
 
3282
 
            if client_name not in client_settings:
 
3285
 
            # Decide which value to use after restoring saved state.
 
3286
 
            # We have three different values: Old config file,
 
3287
 
            # new config file, and saved state.
 
3288
 
            # New config value takes precedence if it differs from old
 
3289
 
            # config value, otherwise use saved state.
 
3290
 
            for name, value in client_settings[client_name].items():
 
3292
 
                    # For each value in new config, check if it
 
3293
 
                    # differs from the old config value (Except for
 
3294
 
                    # the "secret" attribute)
 
3295
 
                    if (name != "secret"
 
3297
 
                             old_client_settings[client_name][name])):
 
3298
 
                        client[name] = value
 
3302
 
            # Clients who has passed its expire date can still be
 
3303
 
            # enabled if its last checker was successful.  A Client
 
3304
 
            # whose checker succeeded before we stored its state is
 
3305
 
            # assumed to have successfully run all checkers during
 
3307
 
            if client["enabled"]:
 
3308
 
                if datetime.datetime.utcnow() >= client["expires"]:
 
3309
 
                    if not client["last_checked_ok"]:
 
3311
 
                            "disabling client {} - Client never "
 
3312
 
                            "performed a successful checker".format(
 
3314
 
                        client["enabled"] = False
 
3315
 
                    elif client["last_checker_status"] != 0:
 
3317
 
                            "disabling client {} - Client last"
 
3318
 
                            " checker failed with error code"
 
3321
 
                                client["last_checker_status"]))
 
3322
 
                        client["enabled"] = False
 
3324
 
                        client["expires"] = (
 
3325
 
                            datetime.datetime.utcnow()
 
3326
 
                            + client["timeout"])
 
3327
 
                        logger.debug("Last checker succeeded,"
 
3328
 
                                     " keeping {} enabled".format(
 
 
1914
        client_class = functools.partial(ClientDBus, bus = bus)
 
 
1915
    def client_config_items(config, section):
 
 
1916
        special_settings = {
 
 
1917
            "approved_by_default":
 
 
1918
                lambda: config.getboolean(section,
 
 
1919
                                          "approved_by_default"),
 
 
1921
        for name, value in config.items(section):
 
3331
 
                client["secret"] = pgp.decrypt(
 
3332
 
                    client["encrypted_secret"],
 
3333
 
                    client_settings[client_name]["secret"])
 
3335
 
                # If decryption fails, we use secret from new settings
 
3336
 
                logger.debug("Failed to decrypt {} old secret".format(
 
3338
 
                client["secret"] = (client_settings[client_name]
 
3341
 
    # Add/remove clients based on new changes made to config
 
3342
 
    for client_name in (set(old_client_settings)
 
3343
 
                        - set(client_settings)):
 
3344
 
        del clients_data[client_name]
 
3345
 
    for client_name in (set(client_settings)
 
3346
 
                        - set(old_client_settings)):
 
3347
 
        clients_data[client_name] = client_settings[client_name]
 
3349
 
    # Create all client objects
 
3350
 
    for client_name, client in clients_data.items():
 
3351
 
        tcp_server.clients[client_name] = client_class(
 
3354
 
            server_settings=server_settings)
 
 
1923
                yield (name, special_settings[name]())
 
 
1927
    tcp_server.clients.update(set(
 
 
1928
            client_class(name = section,
 
 
1929
                         config= dict(client_config_items(
 
 
1930
                        client_config, section)))
 
 
1931
            for section in client_config.sections()))
 
3356
1932
    if not tcp_server.clients:
 
3357
1933
        logger.warning("No clients defined")
 
3360
 
        if pidfile is not None:
 
3364
 
                    print(pid, file=pidfile)
 
3366
 
                logger.error("Could not write to file %r with PID %d",
 
 
1939
                pidfile.write(str(pid) + "\n".encode("utf-8"))
 
 
1942
            logger.error("Could not write to file %r with PID %d",
 
 
1945
            # "pidfile" was never created
 
3369
1947
        del pidfilename
 
3371
 
    for termsig in (signal.SIGHUP, signal.SIGTERM):
 
3372
 
        GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
 
3373
 
                             lambda: main_loop.quit() and False)
 
 
1949
        signal.signal(signal.SIGINT, signal.SIG_IGN)
 
 
1951
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
 
 
1952
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
 
3377
 
        @alternate_dbus_interfaces(
 
3378
 
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
 
3379
 
        class MandosDBusService(DBusObjectWithObjectManager):
 
 
1955
        class MandosDBusService(dbus.service.Object):
 
3380
1956
            """A D-Bus proxy object"""
 
3382
1957
            def __init__(self):
 
3383
1958
                dbus.service.Object.__init__(self, bus, "/")
 
3385
 
            _interface = "se.recompile.Mandos"
 
 
1959
            _interface = "se.bsnet.fukt.Mandos"
 
3387
1961
            @dbus.service.signal(_interface, signature="o")
 
3388
1962
            def ClientAdded(self, objpath):
 
3392
1966
            @dbus.service.signal(_interface, signature="ss")
 
3393
 
            def ClientNotFound(self, key_id, address):
 
 
1967
            def ClientNotFound(self, fingerprint, address):
 
3397
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3399
1971
            @dbus.service.signal(_interface, signature="os")
 
3400
1972
            def ClientRemoved(self, objpath, name):
 
3404
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3406
1976
            @dbus.service.method(_interface, out_signature="ao")
 
3407
1977
            def GetAllClients(self):
 
3409
 
                return dbus.Array(c.dbus_object_path for c in
 
3410
 
                                  tcp_server.clients.values())
 
3412
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
 
1979
                return dbus.Array(c.dbus_object_path
 
 
1980
                                  for c in tcp_server.clients)
 
3414
1982
            @dbus.service.method(_interface,
 
3415
1983
                                 out_signature="a{oa{sv}}")
 
3416
1984
            def GetAllClientsWithProperties(self):
 
3418
1986
                return dbus.Dictionary(
 
3419
 
                    {c.dbus_object_path: c.GetAll(
 
3420
 
                        "se.recompile.Mandos.Client")
 
3421
 
                     for c in tcp_server.clients.values()},
 
 
1987
                    ((c.dbus_object_path, c.GetAll(""))
 
 
1988
                     for c in tcp_server.clients),
 
3422
1989
                    signature="oa{sv}")
 
3424
1991
            @dbus.service.method(_interface, in_signature="o")
 
3425
1992
            def RemoveClient(self, object_path):
 
3427
 
                for c in tcp_server.clients.values():
 
 
1994
                for c in tcp_server.clients:
 
3428
1995
                    if c.dbus_object_path == object_path:
 
3429
 
                        del tcp_server.clients[c.name]
 
 
1996
                        tcp_server.clients.remove(c)
 
3430
1997
                        c.remove_from_connection()
 
3431
 
                        # Don't signal the disabling
 
 
1998
                        # Don't signal anything except ClientRemoved
 
3432
1999
                        c.disable(quiet=True)
 
3433
 
                        # Emit D-Bus signal for removal
 
3434
 
                        self.client_removed_signal(c)
 
 
2001
                        self.ClientRemoved(object_path, c.name)
 
3436
2003
                raise KeyError(object_path)
 
3440
 
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
3441
 
                                 out_signature="a{oa{sa{sv}}}")
 
3442
 
            def GetManagedObjects(self):
 
3444
 
                return dbus.Dictionary(
 
3445
 
                    {client.dbus_object_path:
 
3447
 
                         {interface: client.GetAll(interface)
 
3449
 
                          client._get_all_interface_names()})
 
3450
 
                     for client in tcp_server.clients.values()})
 
3452
 
            def client_added_signal(self, client):
 
3453
 
                """Send the new standard signal and the old signal"""
 
3455
 
                    # New standard signal
 
3456
 
                    self.InterfacesAdded(
 
3457
 
                        client.dbus_object_path,
 
3459
 
                            {interface: client.GetAll(interface)
 
3461
 
                             client._get_all_interface_names()}))
 
3463
 
                    self.ClientAdded(client.dbus_object_path)
 
3465
 
            def client_removed_signal(self, client):
 
3466
 
                """Send the new standard signal and the old signal"""
 
3468
 
                    # New standard signal
 
3469
 
                    self.InterfacesRemoved(
 
3470
 
                        client.dbus_object_path,
 
3471
 
                        client._get_all_interface_names())
 
3473
 
                    self.ClientRemoved(client.dbus_object_path,
 
3476
2007
        mandos_dbus_service = MandosDBusService()
 
3478
 
    # Save modules to variables to exempt the modules from being
 
3479
 
    # unloaded before the function registered with atexit() is run.
 
3480
 
    mp = multiprocessing
 
3484
2010
        "Cleanup function; run on exit"
 
3488
 
        mp.active_children()
 
3490
 
        if not (tcp_server.clients or client_settings):
 
3493
 
        # Store client before exiting. Secrets are encrypted with key
 
3494
 
        # based on what config file has. If config file is
 
3495
 
        # removed/edited, old secret will thus be unrecovable.
 
3497
 
        with PGPEngine() as pgp:
 
3498
 
            for client in tcp_server.clients.values():
 
3499
 
                key = client_settings[client.name]["secret"]
 
3500
 
                client.encrypted_secret = pgp.encrypt(client.secret,
 
3504
 
                # A list of attributes that can not be pickled
 
3506
 
                exclude = {"bus", "changedstate", "secret",
 
3507
 
                           "checker", "server_settings"}
 
3508
 
                for name, typ in inspect.getmembers(dbus.service
 
3512
 
                client_dict["encrypted_secret"] = (client
 
3514
 
                for attr in client.client_structure:
 
3515
 
                    if attr not in exclude:
 
3516
 
                        client_dict[attr] = getattr(client, attr)
 
3518
 
                clients[client.name] = client_dict
 
3519
 
                del client_settings[client.name]["secret"]
 
3522
 
            with tempfile.NamedTemporaryFile(
 
3526
 
                    dir=os.path.dirname(stored_state_path),
 
3527
 
                    delete=False) as stored_state:
 
3528
 
                pickle.dump((clients, client_settings), stored_state,
 
3530
 
                tempname = stored_state.name
 
3531
 
            os.rename(tempname, stored_state_path)
 
3532
 
        except (IOError, OSError) as e:
 
3538
 
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
3539
 
                logger.warning("Could not save persistent state: {}"
 
3540
 
                               .format(os.strerror(e.errno)))
 
3542
 
                logger.warning("Could not save persistent state:",
 
3546
 
        # Delete all clients, and settings from config
 
3547
2013
        while tcp_server.clients:
 
3548
 
            name, client = tcp_server.clients.popitem()
 
 
2014
            client = tcp_server.clients.pop()
 
3550
2016
                client.remove_from_connection()
 
3551
 
            # Don't signal the disabling
 
 
2017
            client.disable_hook = None
 
 
2018
            # Don't signal anything except ClientRemoved
 
3552
2019
            client.disable(quiet=True)
 
3553
 
            # Emit D-Bus signal for removal
 
3555
 
                mandos_dbus_service.client_removed_signal(client)
 
3556
 
        client_settings.clear()
 
 
2022
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
 
3558
2025
    atexit.register(cleanup)
 
3560
 
    for client in tcp_server.clients.values():
 
 
2027
    for client in tcp_server.clients:
 
3562
 
            # Emit D-Bus signal for adding
 
3563
 
            mandos_dbus_service.client_added_signal(client)
 
3564
 
        # Need to initiate checking of clients
 
3566
 
            client.init_checker()
 
 
2030
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3568
2033
    tcp_server.enable()
 
3569
2034
    tcp_server.server_activate()
 
3571
2036
    # Find out what port we got
 
3573
 
        service.port = tcp_server.socket.getsockname()[1]
 
 
2037
    service.port = tcp_server.socket.getsockname()[1]
 
3575
2039
        logger.info("Now listening on address %r, port %d,"
 
3576
 
                    " flowinfo %d, scope_id %d",
 
3577
 
                    *tcp_server.socket.getsockname())
 
 
2040
                    " flowinfo %d, scope_id %d"
 
 
2041
                    % tcp_server.socket.getsockname())
 
3579
 
        logger.info("Now listening on address %r, port %d",
 
3580
 
                    *tcp_server.socket.getsockname())
 
3582
 
    # service.interface = tcp_server.socket.getsockname()[3]
 
 
2043
        logger.info("Now listening on address %r, port %d"
 
 
2044
                    % tcp_server.socket.getsockname())
 
 
2046
    #service.interface = tcp_server.socket.getsockname()[3]
 
3586
 
            # From the Avahi example code
 
3589
 
            except dbus.exceptions.DBusException as error:
 
3590
 
                logger.critical("D-Bus Exception", exc_info=error)
 
3593
 
            # End of Avahi example code
 
3595
 
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3596
 
                          lambda *args, **kwargs:
 
3597
 
                          (tcp_server.handle_request
 
3598
 
                           (*args[2:], **kwargs) or True))
 
 
2049
        # From the Avahi example code
 
 
2052
        except dbus.exceptions.DBusException as error:
 
 
2053
            logger.critical("DBusException: %s", error)
 
 
2056
        # End of Avahi example code
 
 
2058
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
 
2059
                             lambda *args, **kwargs:
 
 
2060
                             (tcp_server.handle_request
 
 
2061
                              (*args[2:], **kwargs) or True))
 
3600
2063
        logger.debug("Starting main loop")
 
3601
2064
        main_loop.run()
 
3602
2065
    except AvahiError as error:
 
3603
 
        logger.critical("Avahi Error", exc_info=error)
 
 
2066
        logger.critical("AvahiError: %s", error)
 
3606
2069
    except KeyboardInterrupt: