70
 
    import cPickle as pickle
 
 
62
import cPickle as pickle
 
73
63
import multiprocessing
 
82
66
import dbus.service
 
83
 
from gi.repository import GLib
 
84
69
from dbus.mainloop.glib import DBusGMainLoop
 
87
72
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
76
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
 
95
77
except AttributeError:
 
97
 
        # This is where SO_BINDTODEVICE was up to and including Python
 
99
79
        from IN import SO_BINDTODEVICE
 
100
80
    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
 
    It is instantiated once, and simulates having an Avahi module."""
 
281
 
    IF_UNSPEC = -1               # avahi-common/address.h
 
282
 
    PROTO_UNSPEC = -1            # avahi-common/address.h
 
283
 
    PROTO_INET = 0               # avahi-common/address.h
 
284
 
    PROTO_INET6 = 1              # avahi-common/address.h
 
285
 
    DBUS_NAME = "org.freedesktop.Avahi"
 
286
 
    DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
 
287
 
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
 
288
 
    DBUS_PATH_SERVER = "/"
 
290
 
    def string_array_to_txt_array(self, 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
 
 
81
        SO_BINDTODEVICE = None
 
 
86
#logger = logging.getLogger(u'mandos')
 
 
87
logger = logging.Logger(u'mandos')
 
 
88
syslogger = (logging.handlers.SysLogHandler
 
 
89
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
 
90
              address = "/dev/log"))
 
 
91
syslogger.setFormatter(logging.Formatter
 
 
92
                       (u'Mandos [%(process)d]: %(levelname)s:'
 
 
94
logger.addHandler(syslogger)
 
 
96
console = logging.StreamHandler()
 
 
97
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
 
 
100
logger.addHandler(console)
 
304
102
class AvahiError(Exception):
 
305
103
    def __init__(self, value, *args, **kwargs):
 
306
104
        self.value = value
 
307
 
        return super(AvahiError, self).__init__(value, *args,
 
 
105
        super(AvahiError, self).__init__(value, *args, **kwargs)
 
 
106
    def __unicode__(self):
 
 
107
        return unicode(repr(self.value))
 
311
109
class AvahiServiceError(AvahiError):
 
315
112
class AvahiGroupError(AvahiError):
 
319
116
class AvahiService(object):
 
320
117
    """An Avahi (Zeroconf) service.
 
323
120
    interface: integer; avahi.IF_UNSPEC or an interface index.
 
324
121
               Used to optionally bind to the specified interface.
 
325
 
    name: string; Example: 'Mandos'
 
326
 
    type: string; Example: '_mandos._tcp'.
 
327
 
     See <https://www.iana.org/assignments/service-names-port-numbers>
 
 
122
    name: string; Example: u'Mandos'
 
 
123
    type: string; Example: u'_mandos._tcp'.
 
 
124
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
328
125
    port: integer; what port to announce
 
329
126
    TXT: list of strings; TXT record for the service
 
330
127
    domain: string; Domain to publish on, default to .local if empty.
 
 
419
197
            dbus.UInt16(self.port),
 
420
198
            avahi.string_array_to_txt_array(self.TXT))
 
421
199
        self.group.Commit()
 
423
200
    def entry_group_state_changed(self, state, error):
 
424
201
        """Derived from the Avahi example code"""
 
425
 
        logger.debug("Avahi entry group state change: %i", state)
 
 
202
        logger.debug(u"Avahi entry group state change: %i", state)
 
427
204
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
 
428
 
            logger.debug("Zeroconf service established.")
 
 
205
            logger.debug(u"Zeroconf service established.")
 
429
206
        elif state == avahi.ENTRY_GROUP_COLLISION:
 
430
 
            logger.info("Zeroconf service name collision.")
 
 
207
            logger.warning(u"Zeroconf service name collision.")
 
432
209
        elif state == avahi.ENTRY_GROUP_FAILURE:
 
433
 
            logger.critical("Avahi: Error in group state changed %s",
 
435
 
            raise AvahiGroupError("State changed: {!s}".format(error))
 
 
210
            logger.critical(u"Avahi: Error in group state changed %s",
 
 
212
            raise AvahiGroupError(u"State changed: %s"
 
437
214
    def cleanup(self):
 
438
215
        """Derived from the Avahi example code"""
 
439
216
        if self.group is not None:
 
442
 
            except (dbus.exceptions.UnknownMethodException,
 
443
 
                    dbus.exceptions.DBusException):
 
445
218
            self.group = None
 
448
 
    def server_state_changed(self, state, error=None):
 
 
219
    def server_state_changed(self, state):
 
449
220
        """Derived from the Avahi example code"""
 
450
 
        logger.debug("Avahi server state change: %i", state)
 
452
 
            avahi.SERVER_INVALID: "Zeroconf server invalid",
 
453
 
            avahi.SERVER_REGISTERING: None,
 
454
 
            avahi.SERVER_COLLISION: "Zeroconf server name collision",
 
455
 
            avahi.SERVER_FAILURE: "Zeroconf server failure",
 
457
 
        if state in bad_states:
 
458
 
            if bad_states[state] is not None:
 
460
 
                    logger.error(bad_states[state])
 
462
 
                    logger.error(bad_states[state] + ": %r", error)
 
 
221
        logger.debug(u"Avahi server state change: %i", state)
 
 
222
        if state == avahi.SERVER_COLLISION:
 
 
223
            logger.error(u"Zeroconf server name collision")
 
464
225
        elif state == avahi.SERVER_RUNNING:
 
467
 
            except dbus.exceptions.DBusException as error:
 
468
 
                if (error.get_dbus_name()
 
469
 
                    == "org.freedesktop.Avahi.CollisionError"):
 
470
 
                    logger.info("Local Zeroconf service name"
 
472
 
                    return self.rename(remove=False)
 
474
 
                    logger.critical("D-Bus Exception", exc_info=error)
 
479
 
                logger.debug("Unknown state: %r", state)
 
481
 
                logger.debug("Unknown state: %r: %r", state, error)
 
483
227
    def activate(self):
 
484
228
        """Derived from the Avahi example code"""
 
485
229
        if self.server is None:
 
486
230
            self.server = dbus.Interface(
 
487
231
                self.bus.get_object(avahi.DBUS_NAME,
 
488
 
                                    avahi.DBUS_PATH_SERVER,
 
489
 
                                    follow_name_owner_changes=True),
 
 
232
                                    avahi.DBUS_PATH_SERVER),
 
490
233
                avahi.DBUS_INTERFACE_SERVER)
 
491
 
        self.server.connect_to_signal("StateChanged",
 
492
 
                                      self.server_state_changed)
 
 
234
        self.server.connect_to_signal(u"StateChanged",
 
 
235
                                 self.server_state_changed)
 
493
236
        self.server_state_changed(self.server.GetState())
 
496
 
class AvahiServiceToSyslog(AvahiService):
 
497
 
    def rename(self, *args, **kwargs):
 
498
 
        """Add the new name to the syslog messages"""
 
499
 
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
 
500
 
        syslogger.setFormatter(logging.Formatter(
 
501
 
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
506
 
# Pretend that we have a GnuTLS module
 
507
 
class GnuTLS(object):
 
508
 
    """This isn't so much a class as it is a module-like namespace.
 
509
 
    It is instantiated once, and simulates having a GnuTLS module."""
 
511
 
    library = ctypes.util.find_library("gnutls")
 
513
 
        library = ctypes.util.find_library("gnutls-deb0")
 
514
 
    _library = ctypes.cdll.LoadLibrary(library)
 
516
 
    _need_version = b"3.3.0"
 
519
 
        # Need to use "self" here, since this method is called before
 
520
 
        # the assignment to the "gnutls" global variable happens.
 
521
 
        if self.check_version(self._need_version) is None:
 
522
 
            raise self.Error("Needs GnuTLS {} or later"
 
523
 
                             .format(self._need_version))
 
525
 
    # Unless otherwise indicated, the constants and types below are
 
526
 
    # all from the gnutls/gnutls.h C header file.
 
536
 
    E_NO_CERTIFICATE_FOUND = -49
 
537
 
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
 
540
 
    class session_int(ctypes.Structure):
 
542
 
    session_t = ctypes.POINTER(session_int)
 
544
 
    class certificate_credentials_st(ctypes.Structure):
 
546
 
    certificate_credentials_t = ctypes.POINTER(
 
547
 
        certificate_credentials_st)
 
548
 
    certificate_type_t = ctypes.c_int
 
550
 
    class datum_t(ctypes.Structure):
 
551
 
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
552
 
                    ('size', ctypes.c_uint)]
 
554
 
    class openpgp_crt_int(ctypes.Structure):
 
556
 
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
557
 
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
 
558
 
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
 
559
 
    credentials_type_t = ctypes.c_int
 
560
 
    transport_ptr_t = ctypes.c_void_p
 
561
 
    close_request_t = ctypes.c_int
 
564
 
    class Error(Exception):
 
565
 
        # We need to use the class name "GnuTLS" here, since this
 
566
 
        # exception might be raised from within GnuTLS.__init__,
 
567
 
        # which is called before the assignment to the "gnutls"
 
568
 
        # global variable has happened.
 
569
 
        def __init__(self, message=None, code=None, args=()):
 
570
 
            # Default usage is by a message string, but if a return
 
571
 
            # code is passed, convert it to a string with
 
574
 
            if message is None and code is not None:
 
575
 
                message = GnuTLS.strerror(code)
 
576
 
            return super(GnuTLS.Error, self).__init__(
 
579
 
    class CertificateSecurityError(Error):
 
583
 
    class Credentials(object):
 
585
 
            self._c_object = gnutls.certificate_credentials_t()
 
586
 
            gnutls.certificate_allocate_credentials(
 
587
 
                ctypes.byref(self._c_object))
 
588
 
            self.type = gnutls.CRD_CERTIFICATE
 
591
 
            gnutls.certificate_free_credentials(self._c_object)
 
593
 
    class ClientSession(object):
 
594
 
        def __init__(self, socket, credentials=None):
 
595
 
            self._c_object = gnutls.session_t()
 
596
 
            gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
 
597
 
            gnutls.set_default_priority(self._c_object)
 
598
 
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
599
 
            gnutls.handshake_set_private_extensions(self._c_object,
 
602
 
            if credentials is None:
 
603
 
                credentials = gnutls.Credentials()
 
604
 
            gnutls.credentials_set(self._c_object, credentials.type,
 
605
 
                                   ctypes.cast(credentials._c_object,
 
607
 
            self.credentials = credentials
 
610
 
            gnutls.deinit(self._c_object)
 
613
 
            return gnutls.handshake(self._c_object)
 
615
 
        def send(self, data):
 
619
 
                data_len -= gnutls.record_send(self._c_object,
 
624
 
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
626
 
    # Error handling functions
 
627
 
    def _error_code(result):
 
628
 
        """A function to raise exceptions on errors, suitable
 
629
 
        for the 'restype' attribute on ctypes functions"""
 
632
 
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
 
633
 
            raise gnutls.CertificateSecurityError(code=result)
 
634
 
        raise gnutls.Error(code=result)
 
636
 
    def _retry_on_error(result, func, arguments):
 
637
 
        """A function to retry on some errors, suitable
 
638
 
        for the 'errcheck' attribute on ctypes functions"""
 
640
 
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
 
641
 
                return _error_code(result)
 
642
 
            result = func(*arguments)
 
645
 
    # Unless otherwise indicated, the function declarations below are
 
646
 
    # all from the gnutls/gnutls.h C header file.
 
649
 
    priority_set_direct = _library.gnutls_priority_set_direct
 
650
 
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
651
 
                                    ctypes.POINTER(ctypes.c_char_p)]
 
652
 
    priority_set_direct.restype = _error_code
 
654
 
    init = _library.gnutls_init
 
655
 
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
656
 
    init.restype = _error_code
 
658
 
    set_default_priority = _library.gnutls_set_default_priority
 
659
 
    set_default_priority.argtypes = [session_t]
 
660
 
    set_default_priority.restype = _error_code
 
662
 
    record_send = _library.gnutls_record_send
 
663
 
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
665
 
    record_send.restype = ctypes.c_ssize_t
 
666
 
    record_send.errcheck = _retry_on_error
 
668
 
    certificate_allocate_credentials = (
 
669
 
        _library.gnutls_certificate_allocate_credentials)
 
670
 
    certificate_allocate_credentials.argtypes = [
 
671
 
        ctypes.POINTER(certificate_credentials_t)]
 
672
 
    certificate_allocate_credentials.restype = _error_code
 
674
 
    certificate_free_credentials = (
 
675
 
        _library.gnutls_certificate_free_credentials)
 
676
 
    certificate_free_credentials.argtypes = [
 
677
 
        certificate_credentials_t]
 
678
 
    certificate_free_credentials.restype = None
 
680
 
    handshake_set_private_extensions = (
 
681
 
        _library.gnutls_handshake_set_private_extensions)
 
682
 
    handshake_set_private_extensions.argtypes = [session_t,
 
684
 
    handshake_set_private_extensions.restype = None
 
686
 
    credentials_set = _library.gnutls_credentials_set
 
687
 
    credentials_set.argtypes = [session_t, credentials_type_t,
 
689
 
    credentials_set.restype = _error_code
 
691
 
    strerror = _library.gnutls_strerror
 
692
 
    strerror.argtypes = [ctypes.c_int]
 
693
 
    strerror.restype = ctypes.c_char_p
 
695
 
    certificate_type_get = _library.gnutls_certificate_type_get
 
696
 
    certificate_type_get.argtypes = [session_t]
 
697
 
    certificate_type_get.restype = _error_code
 
699
 
    certificate_get_peers = _library.gnutls_certificate_get_peers
 
700
 
    certificate_get_peers.argtypes = [session_t,
 
701
 
                                      ctypes.POINTER(ctypes.c_uint)]
 
702
 
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
 
704
 
    global_set_log_level = _library.gnutls_global_set_log_level
 
705
 
    global_set_log_level.argtypes = [ctypes.c_int]
 
706
 
    global_set_log_level.restype = None
 
708
 
    global_set_log_function = _library.gnutls_global_set_log_function
 
709
 
    global_set_log_function.argtypes = [log_func]
 
710
 
    global_set_log_function.restype = None
 
712
 
    deinit = _library.gnutls_deinit
 
713
 
    deinit.argtypes = [session_t]
 
714
 
    deinit.restype = None
 
716
 
    handshake = _library.gnutls_handshake
 
717
 
    handshake.argtypes = [session_t]
 
718
 
    handshake.restype = _error_code
 
719
 
    handshake.errcheck = _retry_on_error
 
721
 
    transport_set_ptr = _library.gnutls_transport_set_ptr
 
722
 
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
723
 
    transport_set_ptr.restype = None
 
725
 
    bye = _library.gnutls_bye
 
726
 
    bye.argtypes = [session_t, close_request_t]
 
727
 
    bye.restype = _error_code
 
728
 
    bye.errcheck = _retry_on_error
 
730
 
    check_version = _library.gnutls_check_version
 
731
 
    check_version.argtypes = [ctypes.c_char_p]
 
732
 
    check_version.restype = ctypes.c_char_p
 
734
 
    # All the function declarations below are from gnutls/openpgp.h
 
736
 
    openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
737
 
    openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
738
 
    openpgp_crt_init.restype = _error_code
 
740
 
    openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
741
 
    openpgp_crt_import.argtypes = [openpgp_crt_t,
 
742
 
                                   ctypes.POINTER(datum_t),
 
744
 
    openpgp_crt_import.restype = _error_code
 
746
 
    openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
747
 
    openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
748
 
                                        ctypes.POINTER(ctypes.c_uint)]
 
749
 
    openpgp_crt_verify_self.restype = _error_code
 
751
 
    openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
752
 
    openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
753
 
    openpgp_crt_deinit.restype = None
 
755
 
    openpgp_crt_get_fingerprint = (
 
756
 
        _library.gnutls_openpgp_crt_get_fingerprint)
 
757
 
    openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
761
 
    openpgp_crt_get_fingerprint.restype = _error_code
 
763
 
    # Remove non-public functions
 
764
 
    del _error_code, _retry_on_error
 
765
 
# Create the global "gnutls" object, simulating a module
 
769
 
def call_pipe(connection,       # : multiprocessing.Connection
 
770
 
              func, *args, **kwargs):
 
771
 
    """This function is meant to be called by multiprocessing.Process
 
773
 
    This function runs func(*args, **kwargs), and writes the resulting
 
774
 
    return value on the provided multiprocessing.Connection.
 
776
 
    connection.send(func(*args, **kwargs))
 
780
239
class Client(object):
 
781
240
    """A representation of a client host served by this server.
 
784
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
 
243
    _approved:   bool(); 'None' if not yet approved/disapproved
 
785
244
    approval_delay: datetime.timedelta(); Time to wait for approval
 
786
245
    approval_duration: datetime.timedelta(); Duration of one approval
 
787
246
    checker:    subprocess.Popen(); a running checker process used
 
788
247
                                    to see if the client lives.
 
789
248
                                    'None' if no process is running.
 
790
 
    checker_callback_tag: a GLib event source tag, or None
 
 
249
    checker_callback_tag: a gobject event source tag, or None
 
791
250
    checker_command: string; External command which is run to check
 
792
251
                     if client lives.  %() expansions are done at
 
793
252
                     runtime with vars(self) as dict, so that for
 
794
253
                     instance %(name)s can be used in the command.
 
795
 
    checker_initiator_tag: a GLib event source tag, or None
 
 
254
    checker_initiator_tag: a gobject event source tag, or None
 
796
255
    created:    datetime.datetime(); (UTC) object creation
 
797
 
    client_structure: Object describing what attributes a client has
 
798
 
                      and is used for storing the client at exit
 
799
256
    current_checker_command: string; current running checker_command
 
800
 
    disable_initiator_tag: a GLib event source tag, or None
 
 
257
    disable_hook:  If set, called by disable() as disable_hook(self)
 
 
258
    disable_initiator_tag: a gobject event source tag, or None
 
802
260
    fingerprint: string (40 or 32 hexadecimal digits); used to
 
803
261
                 uniquely identify the client
 
 
805
263
    interval:   datetime.timedelta(); How often to start a new checker
 
806
264
    last_approval_request: datetime.datetime(); (UTC) or None
 
807
265
    last_checked_ok: datetime.datetime(); (UTC) or None
 
808
 
    last_checker_status: integer between 0 and 255 reflecting exit
 
809
 
                         status of last checker. -1 reflects crashed
 
810
 
                         checker, -2 means no checker completed yet.
 
811
 
    last_checker_signal: The signal which killed the last checker, if
 
812
 
                         last_checker_status is -1
 
813
 
    last_enabled: datetime.datetime(); (UTC) or None
 
 
266
    last_enabled: datetime.datetime(); (UTC)
 
814
267
    name:       string; from the config file, used in log messages and
 
815
268
                        D-Bus identifiers
 
816
269
    secret:     bytestring; sent verbatim (over TLS) to client
 
817
270
    timeout:    datetime.timedelta(); How long from last_checked_ok
 
818
271
                                      until this client is disabled
 
819
 
    extended_timeout:   extra long timeout when secret has been sent
 
820
272
    runtime_expansions: Allowed attributes for runtime expansion.
 
821
 
    expires:    datetime.datetime(); time (UTC) when a client will be
 
823
 
    server_settings: The server_settings dict from main()
 
826
 
    runtime_expansions = ("approval_delay", "approval_duration",
 
827
 
                          "created", "enabled", "expires",
 
828
 
                          "fingerprint", "host", "interval",
 
829
 
                          "last_approval_request", "last_checked_ok",
 
830
 
                          "last_enabled", "name", "timeout")
 
833
 
        "extended_timeout": "PT15M",
 
835
 
        "checker": "fping -q -- %%(host)s",
 
837
 
        "approval_delay": "PT0S",
 
838
 
        "approval_duration": "PT1S",
 
839
 
        "approved_by_default": "True",
 
 
275
    runtime_expansions = (u"approval_delay", u"approval_duration",
 
 
276
                          u"created", u"enabled", u"fingerprint",
 
 
277
                          u"host", u"interval", u"last_checked_ok",
 
 
278
                          u"last_enabled", u"name", u"timeout")
 
844
 
    def config_parser(config):
 
845
 
        """Construct a new dict of client settings of this form:
 
846
 
        { client_name: {setting_name: value, ...}, ...}
 
847
 
        with exceptions for any special settings as defined above.
 
848
 
        NOTE: Must be a pure function. Must return the same result
 
849
 
        value given the same arguments.
 
852
 
        for client_name in config.sections():
 
853
 
            section = dict(config.items(client_name))
 
854
 
            client = settings[client_name] = {}
 
856
 
            client["host"] = section["host"]
 
857
 
            # Reformat values from string types to Python types
 
858
 
            client["approved_by_default"] = config.getboolean(
 
859
 
                client_name, "approved_by_default")
 
860
 
            client["enabled"] = config.getboolean(client_name,
 
863
 
            # Uppercase and remove spaces from fingerprint for later
 
864
 
            # comparison purposes with return value from the
 
865
 
            # fingerprint() function
 
866
 
            client["fingerprint"] = (section["fingerprint"].upper()
 
868
 
            if "secret" in section:
 
869
 
                client["secret"] = codecs.decode(section["secret"]
 
872
 
            elif "secfile" in section:
 
873
 
                with open(os.path.expanduser(os.path.expandvars
 
874
 
                                             (section["secfile"])),
 
876
 
                    client["secret"] = secfile.read()
 
878
 
                raise TypeError("No secret or secfile for section {}"
 
880
 
            client["timeout"] = string_to_delta(section["timeout"])
 
881
 
            client["extended_timeout"] = string_to_delta(
 
882
 
                section["extended_timeout"])
 
883
 
            client["interval"] = string_to_delta(section["interval"])
 
884
 
            client["approval_delay"] = string_to_delta(
 
885
 
                section["approval_delay"])
 
886
 
            client["approval_duration"] = string_to_delta(
 
887
 
                section["approval_duration"])
 
888
 
            client["checker_command"] = section["checker"]
 
889
 
            client["last_approval_request"] = None
 
890
 
            client["last_checked_ok"] = None
 
891
 
            client["last_checker_status"] = -2
 
895
 
    def __init__(self, settings, name=None, server_settings=None):
 
 
281
    def _timedelta_to_milliseconds(td):
 
 
282
        "Convert a datetime.timedelta() to milliseconds"
 
 
283
        return ((td.days * 24 * 60 * 60 * 1000)
 
 
284
                + (td.seconds * 1000)
 
 
285
                + (td.microseconds // 1000))
 
 
287
    def timeout_milliseconds(self):
 
 
288
        "Return the 'timeout' attribute in milliseconds"
 
 
289
        return self._timedelta_to_milliseconds(self.timeout)
 
 
291
    def interval_milliseconds(self):
 
 
292
        "Return the 'interval' attribute in milliseconds"
 
 
293
        return self._timedelta_to_milliseconds(self.interval)
 
 
295
    def approval_delay_milliseconds(self):
 
 
296
        return self._timedelta_to_milliseconds(self.approval_delay)
 
 
298
    def __init__(self, name = None, disable_hook=None, config=None):
 
 
299
        """Note: the 'checker' key in 'config' sets the
 
 
300
        'checker_command' attribute and *not* the 'checker'
 
897
 
        if server_settings is None:
 
899
 
        self.server_settings = server_settings
 
900
 
        # adding all client settings
 
901
 
        for setting, value in settings.items():
 
902
 
            setattr(self, setting, value)
 
905
 
            if not hasattr(self, "last_enabled"):
 
906
 
                self.last_enabled = datetime.datetime.utcnow()
 
907
 
            if not hasattr(self, "expires"):
 
908
 
                self.expires = (datetime.datetime.utcnow()
 
 
305
        logger.debug(u"Creating client %r", self.name)
 
 
306
        # Uppercase and remove spaces from fingerprint for later
 
 
307
        # comparison purposes with return value from the fingerprint()
 
 
309
        self.fingerprint = (config[u"fingerprint"].upper()
 
 
311
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
 
 
312
        if u"secret" in config:
 
 
313
            self.secret = config[u"secret"].decode(u"base64")
 
 
314
        elif u"secfile" in config:
 
 
315
            with open(os.path.expanduser(os.path.expandvars
 
 
316
                                         (config[u"secfile"])),
 
 
318
                self.secret = secfile.read()
 
911
 
            self.last_enabled = None
 
914
 
        logger.debug("Creating client %r", self.name)
 
915
 
        logger.debug("  Fingerprint: %s", self.fingerprint)
 
916
 
        self.created = settings.get("created",
 
917
 
                                    datetime.datetime.utcnow())
 
919
 
        # attributes specific for this server instance
 
 
320
            raise TypeError(u"No secret or secfile for client %s"
 
 
322
        self.host = config.get(u"host", u"")
 
 
323
        self.created = datetime.datetime.utcnow()
 
 
325
        self.last_approval_request = None
 
 
326
        self.last_enabled = None
 
 
327
        self.last_checked_ok = None
 
 
328
        self.timeout = string_to_delta(config[u"timeout"])
 
 
329
        self.interval = string_to_delta(config[u"interval"])
 
 
330
        self.disable_hook = disable_hook
 
920
331
        self.checker = None
 
921
332
        self.checker_initiator_tag = None
 
922
333
        self.disable_initiator_tag = None
 
923
334
        self.checker_callback_tag = None
 
 
335
        self.checker_command = config[u"checker"]
 
924
336
        self.current_checker_command = None
 
 
337
        self.last_connect = None
 
 
338
        self._approved = None
 
 
339
        self.approved_by_default = config.get(u"approved_by_default",
 
926
341
        self.approvals_pending = 0
 
927
 
        self.changedstate = multiprocessing_manager.Condition(
 
928
 
            multiprocessing_manager.Lock())
 
929
 
        self.client_structure = [attr
 
930
 
                                 for attr in self.__dict__.keys()
 
931
 
                                 if not attr.startswith("_")]
 
932
 
        self.client_structure.append("client_structure")
 
934
 
        for name, t in inspect.getmembers(
 
935
 
                type(self), lambda obj: isinstance(obj, property)):
 
936
 
            if not name.startswith("_"):
 
937
 
                self.client_structure.append(name)
 
939
 
    # Send notice to process children that client state has changed
 
 
342
        self.approval_delay = string_to_delta(
 
 
343
            config[u"approval_delay"])
 
 
344
        self.approval_duration = string_to_delta(
 
 
345
            config[u"approval_duration"])
 
 
346
        self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
 
940
348
    def send_changedstate(self):
 
941
 
        with self.changedstate:
 
942
 
            self.changedstate.notify_all()
 
 
349
        self.changedstate.acquire()
 
 
350
        self.changedstate.notify_all()
 
 
351
        self.changedstate.release()
 
944
353
    def enable(self):
 
945
354
        """Start this client's checker and timeout hooks"""
 
946
 
        if getattr(self, "enabled", False):
 
 
355
        if getattr(self, u"enabled", False):
 
947
356
            # Already enabled
 
949
 
        self.expires = datetime.datetime.utcnow() + self.timeout
 
 
358
        self.send_changedstate()
 
951
359
        self.last_enabled = datetime.datetime.utcnow()
 
953
 
        self.send_changedstate()
 
 
360
        # Schedule a new checker to be started an 'interval' from now,
 
 
361
        # and every interval from then on.
 
 
362
        self.checker_initiator_tag = (gobject.timeout_add
 
 
363
                                      (self.interval_milliseconds(),
 
 
365
        # Schedule a disable() when 'timeout' has passed
 
 
366
        self.disable_initiator_tag = (gobject.timeout_add
 
 
367
                                   (self.timeout_milliseconds(),
 
 
370
        # Also start a new checker *right now*.
 
955
373
    def disable(self, quiet=True):
 
956
374
        """Disable this client."""
 
957
375
        if not getattr(self, "enabled", False):
 
960
 
            logger.info("Disabling client %s", self.name)
 
961
 
        if getattr(self, "disable_initiator_tag", None) is not None:
 
962
 
            GLib.source_remove(self.disable_initiator_tag)
 
 
378
            self.send_changedstate()
 
 
380
            logger.info(u"Disabling client %s", self.name)
 
 
381
        if getattr(self, u"disable_initiator_tag", False):
 
 
382
            gobject.source_remove(self.disable_initiator_tag)
 
963
383
            self.disable_initiator_tag = None
 
965
 
        if getattr(self, "checker_initiator_tag", None) is not None:
 
966
 
            GLib.source_remove(self.checker_initiator_tag)
 
 
384
        if getattr(self, u"checker_initiator_tag", False):
 
 
385
            gobject.source_remove(self.checker_initiator_tag)
 
967
386
            self.checker_initiator_tag = None
 
968
387
        self.stop_checker()
 
 
388
        if self.disable_hook:
 
 
389
            self.disable_hook(self)
 
969
390
        self.enabled = False
 
971
 
            self.send_changedstate()
 
972
 
        # Do not run this again if called by a GLib.timeout_add
 
 
391
        # Do not run this again if called by a gobject.timeout_add
 
975
394
    def __del__(self):
 
 
395
        self.disable_hook = None
 
978
 
    def init_checker(self):
 
979
 
        # Schedule a new checker to be started an 'interval' from now,
 
980
 
        # and every interval from then on.
 
981
 
        if self.checker_initiator_tag is not None:
 
982
 
            GLib.source_remove(self.checker_initiator_tag)
 
983
 
        self.checker_initiator_tag = GLib.timeout_add(
 
984
 
            int(self.interval.total_seconds() * 1000),
 
986
 
        # Schedule a disable() when 'timeout' has passed
 
987
 
        if self.disable_initiator_tag is not None:
 
988
 
            GLib.source_remove(self.disable_initiator_tag)
 
989
 
        self.disable_initiator_tag = GLib.timeout_add(
 
990
 
            int(self.timeout.total_seconds() * 1000), self.disable)
 
991
 
        # Also start a new checker *right now*.
 
994
 
    def checker_callback(self, source, condition, connection,
 
 
398
    def checker_callback(self, pid, condition, command):
 
996
399
        """The checker has completed, so take appropriate actions."""
 
997
400
        self.checker_callback_tag = None
 
998
401
        self.checker = None
 
999
 
        # Read return code from connection (see call_pipe)
 
1000
 
        returncode = connection.recv()
 
1004
 
            self.last_checker_status = returncode
 
1005
 
            self.last_checker_signal = None
 
1006
 
            if self.last_checker_status == 0:
 
1007
 
                logger.info("Checker for %(name)s succeeded",
 
 
402
        if os.WIFEXITED(condition):
 
 
403
            exitstatus = os.WEXITSTATUS(condition)
 
 
405
                logger.info(u"Checker for %(name)s succeeded",
 
1009
407
                self.checked_ok()
 
1011
 
                logger.info("Checker for %(name)s failed", vars(self))
 
 
409
                logger.info(u"Checker for %(name)s failed",
 
1013
 
            self.last_checker_status = -1
 
1014
 
            self.last_checker_signal = -returncode
 
1015
 
            logger.warning("Checker for %(name)s crashed?",
 
 
412
            logger.warning(u"Checker for %(name)s crashed?",
 
1019
415
    def checked_ok(self):
 
1020
 
        """Assert that the client has been seen, alive and well."""
 
 
416
        """Bump up the timeout for this client.
 
 
418
        This should only be called when the client has been seen,
 
1021
421
        self.last_checked_ok = datetime.datetime.utcnow()
 
1022
 
        self.last_checker_status = 0
 
1023
 
        self.last_checker_signal = None
 
1026
 
    def bump_timeout(self, timeout=None):
 
1027
 
        """Bump up the timeout for this client."""
 
1029
 
            timeout = self.timeout
 
1030
 
        if self.disable_initiator_tag is not None:
 
1031
 
            GLib.source_remove(self.disable_initiator_tag)
 
1032
 
            self.disable_initiator_tag = None
 
1033
 
        if getattr(self, "enabled", False):
 
1034
 
            self.disable_initiator_tag = GLib.timeout_add(
 
1035
 
                int(timeout.total_seconds() * 1000), self.disable)
 
1036
 
            self.expires = datetime.datetime.utcnow() + timeout
 
 
422
        gobject.source_remove(self.disable_initiator_tag)
 
 
423
        self.disable_initiator_tag = (gobject.timeout_add
 
 
424
                                      (self.timeout_milliseconds(),
 
1038
427
    def need_approval(self):
 
1039
428
        self.last_approval_request = datetime.datetime.utcnow()
 
1041
430
    def start_checker(self):
 
1042
431
        """Start a new checker subprocess if one is not running.
 
1044
433
        If a checker already exists, leave it running and do
 
1046
435
        # The reason for not killing a running checker is that if we
 
1047
 
        # did that, and if a checker (for some reason) started running
 
1048
 
        # slowly and taking more than 'interval' time, then the client
 
1049
 
        # would inevitably timeout, since no checker would get a
 
1050
 
        # chance to run to completion.  If we instead leave running
 
 
436
        # did that, then if a checker (for some reason) started
 
 
437
        # running slowly and taking more than 'interval' time, the
 
 
438
        # client would inevitably timeout, since no checker would get
 
 
439
        # a chance to run to completion.  If we instead leave running
 
1051
440
        # checkers alone, the checker would have to take more time
 
1052
441
        # than 'timeout' for the client to be disabled, which is as it
 
1055
 
        if self.checker is not None and not self.checker.is_alive():
 
1056
 
            logger.warning("Checker was not alive; joining")
 
 
444
        # If a checker exists, make sure it is not a zombie
 
 
446
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
 
447
        except (AttributeError, OSError), error:
 
 
448
            if (isinstance(error, OSError)
 
 
449
                and error.errno != errno.ECHILD):
 
 
453
                logger.warning(u"Checker was a zombie")
 
 
454
                gobject.source_remove(self.checker_callback_tag)
 
 
455
                self.checker_callback(pid, status,
 
 
456
                                      self.current_checker_command)
 
1059
457
        # Start a new checker if needed
 
1060
458
        if self.checker is None:
 
1061
 
            # Escape attributes for the shell
 
1063
 
                attr: re.escape(str(getattr(self, attr)))
 
1064
 
                for attr in self.runtime_expansions}
 
1066
 
                command = self.checker_command % escaped_attrs
 
1067
 
            except TypeError as error:
 
1068
 
                logger.error('Could not format string "%s"',
 
1069
 
                             self.checker_command,
 
1071
 
                return True     # Try again later
 
 
460
                # In case checker_command has exactly one % operator
 
 
461
                command = self.checker_command % self.host
 
 
463
                # Escape attributes for the shell
 
 
464
                escaped_attrs = dict(
 
 
466
                     re.escape(unicode(str(getattr(self, attr, u"")),
 
 
470
                    self.runtime_expansions)
 
 
473
                    command = self.checker_command % escaped_attrs
 
 
474
                except TypeError, error:
 
 
475
                    logger.error(u'Could not format string "%s":'
 
 
476
                                 u' %s', self.checker_command, error)
 
 
477
                    return True # Try again later
 
1072
478
            self.current_checker_command = command
 
1073
 
            logger.info("Starting checker %r for %s", command,
 
1075
 
            # We don't need to redirect stdout and stderr, since
 
1076
 
            # in normal mode, that is already done by daemon(),
 
1077
 
            # and in debug mode we don't want to.  (Stdin is
 
1078
 
            # always replaced by /dev/null.)
 
1079
 
            # The exception is when not debugging but nevertheless
 
1080
 
            # running in the foreground; use the previously
 
1082
 
            popen_args = {"close_fds": True,
 
1085
 
            if (not self.server_settings["debug"]
 
1086
 
                and self.server_settings["foreground"]):
 
1087
 
                popen_args.update({"stdout": wnull,
 
1089
 
            pipe = multiprocessing.Pipe(duplex=False)
 
1090
 
            self.checker = multiprocessing.Process(
 
1092
 
                args=(pipe[1], subprocess.call, command),
 
1094
 
            self.checker.start()
 
1095
 
            self.checker_callback_tag = GLib.io_add_watch(
 
1096
 
                pipe[0].fileno(), GLib.IO_IN,
 
1097
 
                self.checker_callback, pipe[0], command)
 
1098
 
        # Re-run this periodically if run by GLib.timeout_add
 
 
480
                logger.info(u"Starting checker %r for %s",
 
 
482
                # We don't need to redirect stdout and stderr, since
 
 
483
                # in normal mode, that is already done by daemon(),
 
 
484
                # and in debug mode we don't want to.  (Stdin is
 
 
485
                # always replaced by /dev/null.)
 
 
486
                self.checker = subprocess.Popen(command,
 
 
488
                                                shell=True, cwd=u"/")
 
 
489
                self.checker_callback_tag = (gobject.child_watch_add
 
 
491
                                              self.checker_callback,
 
 
493
                # The checker may have completed before the gobject
 
 
494
                # watch was added.  Check for this.
 
 
495
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
 
497
                    gobject.source_remove(self.checker_callback_tag)
 
 
498
                    self.checker_callback(pid, status, command)
 
 
499
            except OSError, error:
 
 
500
                logger.error(u"Failed to start subprocess: %s",
 
 
502
        # Re-run this periodically if run by gobject.timeout_add
 
1101
505
    def stop_checker(self):
 
1102
506
        """Force the checker process, if any, to stop."""
 
1103
507
        if self.checker_callback_tag:
 
1104
 
            GLib.source_remove(self.checker_callback_tag)
 
 
508
            gobject.source_remove(self.checker_callback_tag)
 
1105
509
            self.checker_callback_tag = None
 
1106
 
        if getattr(self, "checker", None) is None:
 
 
510
        if getattr(self, u"checker", None) is None:
 
1108
 
        logger.debug("Stopping checker for %(name)s", vars(self))
 
1109
 
        self.checker.terminate()
 
 
512
        logger.debug(u"Stopping checker for %(name)s", vars(self))
 
 
514
            os.kill(self.checker.pid, signal.SIGTERM)
 
 
516
            #if self.checker.poll() is None:
 
 
517
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
 
518
        except OSError, error:
 
 
519
            if error.errno != errno.ESRCH: # No such process
 
1110
521
        self.checker = None
 
1113
 
def dbus_service_property(dbus_interface,
 
 
523
def dbus_service_property(dbus_interface, signature=u"v",
 
 
524
                          access=u"readwrite", byte_arrays=False):
 
1117
525
    """Decorators for marking methods of a DBusObjectWithProperties to
 
1118
526
    become properties on the D-Bus.
 
1120
528
    The decorated method will be called with no arguments by "Get"
 
1121
529
    and with one argument by "Set".
 
1123
531
    The parameters, where they are supported, are the same as
 
1124
532
    dbus.service.method, except there is only "signature", since the
 
1125
533
    type from Get() and the type sent to Set() is the same.
 
1127
535
    # Encoding deeply encoded byte arrays is not supported yet by the
 
1128
536
    # "Set" method, so we fail early here:
 
1129
 
    if byte_arrays and signature != "ay":
 
1130
 
        raise ValueError("Byte arrays not supported for non-'ay'"
 
1131
 
                         " signature {!r}".format(signature))
 
 
537
    if byte_arrays and signature != u"ay":
 
 
538
        raise ValueError(u"Byte arrays not supported for non-'ay'"
 
 
539
                         u" signature %r" % signature)
 
1133
540
    def decorator(func):
 
1134
541
        func._dbus_is_property = True
 
1135
542
        func._dbus_interface = dbus_interface
 
1136
543
        func._dbus_signature = signature
 
1137
544
        func._dbus_access = access
 
1138
545
        func._dbus_name = func.__name__
 
1139
 
        if func._dbus_name.endswith("_dbus_property"):
 
 
546
        if func._dbus_name.endswith(u"_dbus_property"):
 
1140
547
            func._dbus_name = func._dbus_name[:-14]
 
1141
 
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
 
1147
 
def dbus_interface_annotations(dbus_interface):
 
1148
 
    """Decorator for marking functions returning interface annotations
 
1152
 
    @dbus_interface_annotations("org.example.Interface")
 
1153
 
    def _foo(self):  # Function name does not matter
 
1154
 
        return {"org.freedesktop.DBus.Deprecated": "true",
 
1155
 
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1159
 
    def decorator(func):
 
1160
 
        func._dbus_is_interface = True
 
1161
 
        func._dbus_interface = dbus_interface
 
1162
 
        func._dbus_name = dbus_interface
 
1168
 
def dbus_annotations(annotations):
 
1169
 
    """Decorator to annotate D-Bus methods, signals or properties
 
1172
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
 
1173
 
                       "org.freedesktop.DBus.Property."
 
1174
 
                       "EmitsChangedSignal": "false"})
 
1175
 
    @dbus_service_property("org.example.Interface", signature="b",
 
1177
 
    def Property_dbus_property(self):
 
1178
 
        return dbus.Boolean(False)
 
1180
 
    See also the DBusObjectWithAnnotations class.
 
1183
 
    def decorator(func):
 
1184
 
        func._dbus_annotations = annotations
 
 
548
        func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
 
1187
550
    return decorator
 
1190
553
class DBusPropertyException(dbus.exceptions.DBusException):
 
1191
554
    """A base class for D-Bus property-related exceptions
 
 
556
    def __unicode__(self):
 
 
557
        return unicode(str(self))
 
1196
560
class DBusPropertyAccessException(DBusPropertyException):
 
 
1208
 
class DBusObjectWithAnnotations(dbus.service.Object):
 
1209
 
    """A D-Bus object with annotations.
 
1211
 
    Classes inheriting from this can use the dbus_annotations
 
1212
 
    decorator to add annotations to methods or signals.
 
1216
 
    def _is_dbus_thing(thing):
 
1217
 
        """Returns a function testing if an attribute is a D-Bus thing
 
1219
 
        If called like _is_dbus_thing("method") it returns a function
 
1220
 
        suitable for use as predicate to inspect.getmembers().
 
1222
 
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
 
1225
 
    def _get_all_dbus_things(self, thing):
 
1226
 
        """Returns a generator of (name, attribute) pairs
 
1228
 
        return ((getattr(athing.__get__(self), "_dbus_name", name),
 
1229
 
                 athing.__get__(self))
 
1230
 
                for cls in self.__class__.__mro__
 
1232
 
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
 
1234
 
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1236
 
                         path_keyword='object_path',
 
1237
 
                         connection_keyword='connection')
 
1238
 
    def Introspect(self, object_path, connection):
 
1239
 
        """Overloading of standard D-Bus method.
 
1241
 
        Inserts annotation tags on methods and signals.
 
1243
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
1246
 
            document = xml.dom.minidom.parseString(xmlstring)
 
1248
 
            for if_tag in document.getElementsByTagName("interface"):
 
1249
 
                # Add annotation tags
 
1250
 
                for typ in ("method", "signal"):
 
1251
 
                    for tag in if_tag.getElementsByTagName(typ):
 
1253
 
                        for name, prop in (self.
 
1254
 
                                           _get_all_dbus_things(typ)):
 
1255
 
                            if (name == tag.getAttribute("name")
 
1256
 
                                and prop._dbus_interface
 
1257
 
                                == if_tag.getAttribute("name")):
 
1258
 
                                annots.update(getattr(
 
1259
 
                                    prop, "_dbus_annotations", {}))
 
1260
 
                        for name, value in annots.items():
 
1261
 
                            ann_tag = document.createElement(
 
1263
 
                            ann_tag.setAttribute("name", name)
 
1264
 
                            ann_tag.setAttribute("value", value)
 
1265
 
                            tag.appendChild(ann_tag)
 
1266
 
                # Add interface annotation tags
 
1267
 
                for annotation, value in dict(
 
1268
 
                    itertools.chain.from_iterable(
 
1269
 
                        annotations().items()
 
1270
 
                        for name, annotations
 
1271
 
                        in self._get_all_dbus_things("interface")
 
1272
 
                        if name == if_tag.getAttribute("name")
 
1274
 
                    ann_tag = document.createElement("annotation")
 
1275
 
                    ann_tag.setAttribute("name", annotation)
 
1276
 
                    ann_tag.setAttribute("value", value)
 
1277
 
                    if_tag.appendChild(ann_tag)
 
1278
 
                # Fix argument name for the Introspect method itself
 
1279
 
                if (if_tag.getAttribute("name")
 
1280
 
                    == dbus.INTROSPECTABLE_IFACE):
 
1281
 
                    for cn in if_tag.getElementsByTagName("method"):
 
1282
 
                        if cn.getAttribute("name") == "Introspect":
 
1283
 
                            for arg in cn.getElementsByTagName("arg"):
 
1284
 
                                if (arg.getAttribute("direction")
 
1286
 
                                    arg.setAttribute("name",
 
1288
 
            xmlstring = document.toxml("utf-8")
 
1290
 
        except (AttributeError, xml.dom.DOMException,
 
1291
 
                xml.parsers.expat.ExpatError) as error:
 
1292
 
            logger.error("Failed to override Introspection method",
 
1297
 
class DBusObjectWithProperties(DBusObjectWithAnnotations):
 
 
572
class DBusObjectWithProperties(dbus.service.Object):
 
1298
573
    """A D-Bus object with properties.
 
1300
575
    Classes inheriting from this can use the dbus_service_property
 
1301
576
    decorator to expose methods as D-Bus properties.  It exposes the
 
1302
577
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
 
581
    def _is_dbus_property(obj):
 
 
582
        return getattr(obj, u"_dbus_is_property", False)
 
 
584
    def _get_all_dbus_properties(self):
 
 
585
        """Returns a generator of (name, attribute) pairs
 
 
587
        return ((prop._dbus_name, prop)
 
 
589
                inspect.getmembers(self, self._is_dbus_property))
 
1305
591
    def _get_dbus_property(self, interface_name, property_name):
 
1306
592
        """Returns a bound method if one exists which is a D-Bus
 
1307
593
        property with the specified name and interface.
 
1309
 
        for cls in self.__class__.__mro__:
 
1310
 
            for name, value in inspect.getmembers(
 
1311
 
                    cls, self._is_dbus_thing("property")):
 
1312
 
                if (value._dbus_name == property_name
 
1313
 
                    and value._dbus_interface == interface_name):
 
1314
 
                    return value.__get__(self)
 
 
595
        for name in (property_name,
 
 
596
                     property_name + u"_dbus_property"):
 
 
597
            prop = getattr(self, name, None)
 
 
599
                or not self._is_dbus_property(prop)
 
 
600
                or prop._dbus_name != property_name
 
 
601
                or (interface_name and prop._dbus_interface
 
 
602
                    and interface_name != prop._dbus_interface)):
 
1316
605
        # No such property
 
1317
 
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
1318
 
            self.dbus_object_path, interface_name, property_name))
 
1321
 
    def _get_all_interface_names(cls):
 
1322
 
        """Get a sequence of all interfaces supported by an object"""
 
1323
 
        return (name for name in set(getattr(getattr(x, attr),
 
1324
 
                                             "_dbus_interface", None)
 
1325
 
                                     for x in (inspect.getmro(cls))
 
1327
 
                if name is not None)
 
1329
 
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
 
606
        raise DBusPropertyNotFound(self.dbus_object_path + u":"
 
 
607
                                   + interface_name + u"."
 
 
610
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
 
1332
612
    def Get(self, interface_name, property_name):
 
1333
613
        """Standard D-Bus property Get() method, see D-Bus standard.
 
1335
615
        prop = self._get_dbus_property(interface_name, property_name)
 
1336
 
        if prop._dbus_access == "write":
 
 
616
        if prop._dbus_access == u"write":
 
1337
617
            raise DBusPropertyAccessException(property_name)
 
1339
 
        if not hasattr(value, "variant_level"):
 
 
619
        if not hasattr(value, u"variant_level"):
 
1341
621
        return type(value)(value, variant_level=value.variant_level+1)
 
1343
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
 
 
623
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
 
1344
624
    def Set(self, interface_name, property_name, value):
 
1345
625
        """Standard D-Bus property Set() method, see D-Bus standard.
 
1347
627
        prop = self._get_dbus_property(interface_name, property_name)
 
1348
 
        if prop._dbus_access == "read":
 
 
628
        if prop._dbus_access == u"read":
 
1349
629
            raise DBusPropertyAccessException(property_name)
 
1350
 
        if prop._dbus_get_args_options["byte_arrays"]:
 
 
630
        if prop._dbus_get_args_options[u"byte_arrays"]:
 
1351
631
            # The byte_arrays option is not supported yet on
 
1352
632
            # signatures other than "ay".
 
1353
 
            if prop._dbus_signature != "ay":
 
1354
 
                raise ValueError("Byte arrays not supported for non-"
 
1355
 
                                 "'ay' signature {!r}"
 
1356
 
                                 .format(prop._dbus_signature))
 
1357
 
            value = dbus.ByteArray(b''.join(chr(byte)
 
 
633
            if prop._dbus_signature != u"ay":
 
 
635
            value = dbus.ByteArray(''.join(unichr(byte)
 
1361
 
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1363
 
                         out_signature="a{sv}")
 
 
639
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
 
 
640
                         out_signature=u"a{sv}")
 
1364
641
    def GetAll(self, interface_name):
 
1365
642
        """Standard D-Bus property GetAll() method, see D-Bus
 
1368
645
        Note: Will not include properties with access="write".
 
1371
 
        for name, prop in self._get_all_dbus_things("property"):
 
 
648
        for name, prop in self._get_all_dbus_properties():
 
1372
649
            if (interface_name
 
1373
650
                and interface_name != prop._dbus_interface):
 
1374
651
                # Interface non-empty but did not match
 
1376
653
            # Ignore write-only properties
 
1377
 
            if prop._dbus_access == "write":
 
 
654
            if prop._dbus_access == u"write":
 
1380
 
            if not hasattr(value, "variant_level"):
 
1381
 
                properties[name] = value
 
 
657
            if not hasattr(value, u"variant_level"):
 
1383
 
            properties[name] = type(value)(
 
1384
 
                value, variant_level=value.variant_level + 1)
 
1385
 
        return dbus.Dictionary(properties, signature="sv")
 
1387
 
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
 
1388
 
    def PropertiesChanged(self, interface_name, changed_properties,
 
1389
 
                          invalidated_properties):
 
1390
 
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
 
 
660
            all[name] = type(value)(value, variant_level=
 
 
661
                                    value.variant_level+1)
 
 
662
        return dbus.Dictionary(all, signature=u"sv")
 
1395
664
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1397
666
                         path_keyword='object_path',
 
1398
667
                         connection_keyword='connection')
 
1399
668
    def Introspect(self, object_path, connection):
 
1400
 
        """Overloading of standard D-Bus method.
 
1402
 
        Inserts property tags and interface annotation tags.
 
 
669
        """Standard D-Bus method, overloaded to insert property tags.
 
1404
 
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
 
671
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
1408
674
            document = xml.dom.minidom.parseString(xmlstring)
 
1410
675
            def make_tag(document, name, prop):
 
1411
 
                e = document.createElement("property")
 
1412
 
                e.setAttribute("name", name)
 
1413
 
                e.setAttribute("type", prop._dbus_signature)
 
1414
 
                e.setAttribute("access", prop._dbus_access)
 
 
676
                e = document.createElement(u"property")
 
 
677
                e.setAttribute(u"name", name)
 
 
678
                e.setAttribute(u"type", prop._dbus_signature)
 
 
679
                e.setAttribute(u"access", prop._dbus_access)
 
1417
 
            for if_tag in document.getElementsByTagName("interface"):
 
 
681
            for if_tag in document.getElementsByTagName(u"interface"):
 
1419
682
                for tag in (make_tag(document, name, prop)
 
1421
 
                            in self._get_all_dbus_things("property")
 
 
684
                            in self._get_all_dbus_properties()
 
1422
685
                            if prop._dbus_interface
 
1423
 
                            == if_tag.getAttribute("name")):
 
 
686
                            == if_tag.getAttribute(u"name")):
 
1424
687
                    if_tag.appendChild(tag)
 
1425
 
                # Add annotation tags for properties
 
1426
 
                for tag in if_tag.getElementsByTagName("property"):
 
1428
 
                    for name, prop in self._get_all_dbus_things(
 
1430
 
                        if (name == tag.getAttribute("name")
 
1431
 
                            and prop._dbus_interface
 
1432
 
                            == if_tag.getAttribute("name")):
 
1433
 
                            annots.update(getattr(
 
1434
 
                                prop, "_dbus_annotations", {}))
 
1435
 
                    for name, value in annots.items():
 
1436
 
                        ann_tag = document.createElement(
 
1438
 
                        ann_tag.setAttribute("name", name)
 
1439
 
                        ann_tag.setAttribute("value", value)
 
1440
 
                        tag.appendChild(ann_tag)
 
1441
688
                # Add the names to the return values for the
 
1442
689
                # "org.freedesktop.DBus.Properties" methods
 
1443
 
                if (if_tag.getAttribute("name")
 
1444
 
                    == "org.freedesktop.DBus.Properties"):
 
1445
 
                    for cn in if_tag.getElementsByTagName("method"):
 
1446
 
                        if cn.getAttribute("name") == "Get":
 
1447
 
                            for arg in cn.getElementsByTagName("arg"):
 
1448
 
                                if (arg.getAttribute("direction")
 
1450
 
                                    arg.setAttribute("name", "value")
 
1451
 
                        elif cn.getAttribute("name") == "GetAll":
 
1452
 
                            for arg in cn.getElementsByTagName("arg"):
 
1453
 
                                if (arg.getAttribute("direction")
 
1455
 
                                    arg.setAttribute("name", "props")
 
1456
 
            xmlstring = document.toxml("utf-8")
 
1458
 
        except (AttributeError, xml.dom.DOMException,
 
1459
 
                xml.parsers.expat.ExpatError) as error:
 
1460
 
            logger.error("Failed to override Introspection method",
 
1466
 
    dbus.OBJECT_MANAGER_IFACE
 
1467
 
except AttributeError:
 
1468
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
1471
 
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
 
1472
 
    """A D-Bus object with an ObjectManager.
 
1474
 
    Classes inheriting from this exposes the standard
 
1475
 
    GetManagedObjects call and the InterfacesAdded and
 
1476
 
    InterfacesRemoved signals on the standard
 
1477
 
    "org.freedesktop.DBus.ObjectManager" interface.
 
1479
 
    Note: No signals are sent automatically; they must be sent
 
1482
 
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
1483
 
                         out_signature="a{oa{sa{sv}}}")
 
1484
 
    def GetManagedObjects(self):
 
1485
 
        """This function must be overridden"""
 
1486
 
        raise NotImplementedError()
 
1488
 
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
 
1489
 
                         signature="oa{sa{sv}}")
 
1490
 
    def InterfacesAdded(self, object_path, interfaces_and_properties):
 
1493
 
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
 
1494
 
    def InterfacesRemoved(self, object_path, interfaces):
 
1497
 
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1499
 
                         path_keyword='object_path',
 
1500
 
                         connection_keyword='connection')
 
1501
 
    def Introspect(self, object_path, connection):
 
1502
 
        """Overloading of standard D-Bus method.
 
1504
 
        Override return argument name of GetManagedObjects to be
 
1505
 
        "objpath_interfaces_and_properties"
 
1507
 
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1511
 
            document = xml.dom.minidom.parseString(xmlstring)
 
1513
 
            for if_tag in document.getElementsByTagName("interface"):
 
1514
 
                # Fix argument name for the GetManagedObjects method
 
1515
 
                if (if_tag.getAttribute("name")
 
1516
 
                    == dbus.OBJECT_MANAGER_IFACE):
 
1517
 
                    for cn in if_tag.getElementsByTagName("method"):
 
1518
 
                        if (cn.getAttribute("name")
 
1519
 
                            == "GetManagedObjects"):
 
1520
 
                            for arg in cn.getElementsByTagName("arg"):
 
1521
 
                                if (arg.getAttribute("direction")
 
1525
 
                                        "objpath_interfaces"
 
1527
 
            xmlstring = document.toxml("utf-8")
 
1529
 
        except (AttributeError, xml.dom.DOMException,
 
1530
 
                xml.parsers.expat.ExpatError) as error:
 
1531
 
            logger.error("Failed to override Introspection method",
 
1536
 
def datetime_to_dbus(dt, variant_level=0):
 
1537
 
    """Convert a UTC datetime.datetime() to a D-Bus type."""
 
1539
 
        return dbus.String("", variant_level=variant_level)
 
1540
 
    return dbus.String(dt.isoformat(), variant_level=variant_level)
 
1543
 
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1544
 
    """A class decorator; applied to a subclass of
 
1545
 
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1546
 
    interface names according to the "alt_interface_names" mapping.
 
1549
 
    @alternate_dbus_interfaces({"org.example.Interface":
 
1550
 
                                    "net.example.AlternateInterface"})
 
1551
 
    class SampleDBusObject(dbus.service.Object):
 
1552
 
        @dbus.service.method("org.example.Interface")
 
1553
 
        def SampleDBusMethod():
 
1556
 
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1557
 
    reachable via two interfaces: "org.example.Interface" and
 
1558
 
    "net.example.AlternateInterface", the latter of which will have
 
1559
 
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1560
 
    "true", unless "deprecate" is passed with a False value.
 
1562
 
    This works for methods and signals, and also for D-Bus properties
 
1563
 
    (from DBusObjectWithProperties) and interfaces (from the
 
1564
 
    dbus_interface_annotations decorator).
 
1568
 
        for orig_interface_name, alt_interface_name in (
 
1569
 
                alt_interface_names.items()):
 
1571
 
            interface_names = set()
 
1572
 
            # Go though all attributes of the class
 
1573
 
            for attrname, attribute in inspect.getmembers(cls):
 
1574
 
                # Ignore non-D-Bus attributes, and D-Bus attributes
 
1575
 
                # with the wrong interface name
 
1576
 
                if (not hasattr(attribute, "_dbus_interface")
 
1577
 
                    or not attribute._dbus_interface.startswith(
 
1578
 
                        orig_interface_name)):
 
1580
 
                # Create an alternate D-Bus interface name based on
 
1582
 
                alt_interface = attribute._dbus_interface.replace(
 
1583
 
                    orig_interface_name, alt_interface_name)
 
1584
 
                interface_names.add(alt_interface)
 
1585
 
                # Is this a D-Bus signal?
 
1586
 
                if getattr(attribute, "_dbus_is_signal", False):
 
1587
 
                    # Extract the original non-method undecorated
 
1588
 
                    # function by black magic
 
1589
 
                    if sys.version_info.major == 2:
 
1590
 
                        nonmethod_func = (dict(
 
1591
 
                            zip(attribute.func_code.co_freevars,
 
1592
 
                                attribute.__closure__))
 
1593
 
                                          ["func"].cell_contents)
 
1595
 
                        nonmethod_func = (dict(
 
1596
 
                            zip(attribute.__code__.co_freevars,
 
1597
 
                                attribute.__closure__))
 
1598
 
                                          ["func"].cell_contents)
 
1599
 
                    # Create a new, but exactly alike, function
 
1600
 
                    # object, and decorate it to be a new D-Bus signal
 
1601
 
                    # with the alternate D-Bus interface name
 
1602
 
                    new_function = copy_function(nonmethod_func)
 
1603
 
                    new_function = (dbus.service.signal(
 
1605
 
                        attribute._dbus_signature)(new_function))
 
1606
 
                    # Copy annotations, if any
 
1608
 
                        new_function._dbus_annotations = dict(
 
1609
 
                            attribute._dbus_annotations)
 
1610
 
                    except AttributeError:
 
1613
 
                    # Define a creator of a function to call both the
 
1614
 
                    # original and alternate functions, so both the
 
1615
 
                    # original and alternate signals gets sent when
 
1616
 
                    # the function is called
 
1617
 
                    def fixscope(func1, func2):
 
1618
 
                        """This function is a scope container to pass
 
1619
 
                        func1 and func2 to the "call_both" function
 
1620
 
                        outside of its arguments"""
 
1622
 
                        @functools.wraps(func2)
 
1623
 
                        def call_both(*args, **kwargs):
 
1624
 
                            """This function will emit two D-Bus
 
1625
 
                            signals by calling func1 and func2"""
 
1626
 
                            func1(*args, **kwargs)
 
1627
 
                            func2(*args, **kwargs)
 
1628
 
                        # Make wrapper function look like a D-Bus
 
1630
 
                        for name, attr in inspect.getmembers(func2):
 
1631
 
                            if name.startswith("_dbus_"):
 
1632
 
                                setattr(call_both, name, attr)
 
1635
 
                    # Create the "call_both" function and add it to
 
1637
 
                    attr[attrname] = fixscope(attribute, new_function)
 
1638
 
                # Is this a D-Bus method?
 
1639
 
                elif getattr(attribute, "_dbus_is_method", False):
 
1640
 
                    # Create a new, but exactly alike, function
 
1641
 
                    # object.  Decorate it to be a new D-Bus method
 
1642
 
                    # with the alternate D-Bus interface name.  Add it
 
1645
 
                        dbus.service.method(
 
1647
 
                            attribute._dbus_in_signature,
 
1648
 
                            attribute._dbus_out_signature)
 
1649
 
                        (copy_function(attribute)))
 
1650
 
                    # Copy annotations, if any
 
1652
 
                        attr[attrname]._dbus_annotations = dict(
 
1653
 
                            attribute._dbus_annotations)
 
1654
 
                    except AttributeError:
 
1656
 
                # Is this a D-Bus property?
 
1657
 
                elif getattr(attribute, "_dbus_is_property", False):
 
1658
 
                    # Create a new, but exactly alike, function
 
1659
 
                    # object, and decorate it to be a new D-Bus
 
1660
 
                    # property with the alternate D-Bus interface
 
1661
 
                    # name.  Add it to the class.
 
1662
 
                    attr[attrname] = (dbus_service_property(
 
1663
 
                        alt_interface, attribute._dbus_signature,
 
1664
 
                        attribute._dbus_access,
 
1665
 
                        attribute._dbus_get_args_options
 
1667
 
                                      (copy_function(attribute)))
 
1668
 
                    # Copy annotations, if any
 
1670
 
                        attr[attrname]._dbus_annotations = dict(
 
1671
 
                            attribute._dbus_annotations)
 
1672
 
                    except AttributeError:
 
1674
 
                # Is this a D-Bus interface?
 
1675
 
                elif getattr(attribute, "_dbus_is_interface", False):
 
1676
 
                    # Create a new, but exactly alike, function
 
1677
 
                    # object.  Decorate it to be a new D-Bus interface
 
1678
 
                    # with the alternate D-Bus interface name.  Add it
 
1681
 
                        dbus_interface_annotations(alt_interface)
 
1682
 
                        (copy_function(attribute)))
 
1684
 
                # Deprecate all alternate interfaces
 
1685
 
                iname = "_AlternateDBusNames_interface_annotation{}"
 
1686
 
                for interface_name in interface_names:
 
1688
 
                    @dbus_interface_annotations(interface_name)
 
1690
 
                        return {"org.freedesktop.DBus.Deprecated":
 
1692
 
                    # Find an unused name
 
1693
 
                    for aname in (iname.format(i)
 
1694
 
                                  for i in itertools.count()):
 
1695
 
                        if aname not in attr:
 
1699
 
                # Replace the class with a new subclass of it with
 
1700
 
                # methods, signals, etc. as created above.
 
1701
 
                if sys.version_info.major == 2:
 
1702
 
                    cls = type(b"{}Alternate".format(cls.__name__),
 
1705
 
                    cls = type("{}Alternate".format(cls.__name__),
 
1712
 
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1713
 
                            "se.bsnet.fukt.Mandos"})
 
 
690
                if (if_tag.getAttribute(u"name")
 
 
691
                    == u"org.freedesktop.DBus.Properties"):
 
 
692
                    for cn in if_tag.getElementsByTagName(u"method"):
 
 
693
                        if cn.getAttribute(u"name") == u"Get":
 
 
694
                            for arg in cn.getElementsByTagName(u"arg"):
 
 
695
                                if (arg.getAttribute(u"direction")
 
 
697
                                    arg.setAttribute(u"name", u"value")
 
 
698
                        elif cn.getAttribute(u"name") == u"GetAll":
 
 
699
                            for arg in cn.getElementsByTagName(u"arg"):
 
 
700
                                if (arg.getAttribute(u"direction")
 
 
702
                                    arg.setAttribute(u"name", u"props")
 
 
703
            xmlstring = document.toxml(u"utf-8")
 
 
705
        except (AttributeError, xml.dom.DOMException,
 
 
706
                xml.parsers.expat.ExpatError), error:
 
 
707
            logger.error(u"Failed to override Introspection method",
 
1714
712
class ClientDBus(Client, DBusObjectWithProperties):
 
1715
713
    """A Client class using D-Bus
 
1718
716
    dbus_object_path: dbus.ObjectPath
 
1719
717
    bus: dbus.SystemBus()
 
1722
720
    runtime_expansions = (Client.runtime_expansions
 
1723
 
                          + ("dbus_object_path", ))
 
1725
 
    _interface = "se.recompile.Mandos.Client"
 
 
721
                          + (u"dbus_object_path",))
 
1727
723
    # dbus.service.Object doesn't use super(), so we can't either.
 
1729
 
    def __init__(self, bus=None, *args, **kwargs):
 
 
725
    def __init__(self, bus = None, *args, **kwargs):
 
 
726
        self._approvals_pending = 0
 
1731
728
        Client.__init__(self, *args, **kwargs)
 
1732
729
        # Only now, when this client is initialized, can it show up on
 
1734
 
        client_object_name = str(self.name).translate(
 
1735
 
            {ord("."): ord("_"),
 
1736
 
             ord("-"): ord("_")})
 
1737
 
        self.dbus_object_path = dbus.ObjectPath(
 
1738
 
            "/clients/" + client_object_name)
 
 
731
        client_object_name = unicode(self.name).translate(
 
 
732
            {ord(u"."): ord(u"_"),
 
 
733
             ord(u"-"): ord(u"_")})
 
 
734
        self.dbus_object_path = (dbus.ObjectPath
 
 
735
                                 (u"/clients/" + client_object_name))
 
1739
736
        DBusObjectWithProperties.__init__(self, self.bus,
 
1740
737
                                          self.dbus_object_path)
 
1742
 
    def notifychangeproperty(transform_func, dbus_name,
 
1743
 
                             type_func=lambda x: x,
 
1745
 
                             invalidate_only=False,
 
1746
 
                             _interface=_interface):
 
1747
 
        """ Modify a variable so that it's a property which announces
 
1748
 
        its changes to DBus.
 
1750
 
        transform_fun: Function that takes a value and a variant_level
 
1751
 
                       and transforms it to a D-Bus type.
 
1752
 
        dbus_name: D-Bus name of the variable
 
1753
 
        type_func: Function that transform the value before sending it
 
1754
 
                   to the D-Bus.  Default: no transform
 
1755
 
        variant_level: D-Bus variant level.  Default: 1
 
1757
 
        attrname = "_{}".format(dbus_name)
 
1759
 
        def setter(self, value):
 
1760
 
            if hasattr(self, "dbus_object_path"):
 
1761
 
                if (not hasattr(self, attrname) or
 
1762
 
                    type_func(getattr(self, attrname, None))
 
1763
 
                    != type_func(value)):
 
1765
 
                        self.PropertiesChanged(
 
1766
 
                            _interface, dbus.Dictionary(),
 
1767
 
                            dbus.Array((dbus_name, )))
 
1769
 
                        dbus_value = transform_func(
 
1771
 
                            variant_level=variant_level)
 
1772
 
                        self.PropertyChanged(dbus.String(dbus_name),
 
1774
 
                        self.PropertiesChanged(
 
1776
 
                            dbus.Dictionary({dbus.String(dbus_name):
 
1779
 
            setattr(self, attrname, value)
 
1781
 
        return property(lambda self: getattr(self, attrname), setter)
 
1783
 
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
 
1784
 
    approvals_pending = notifychangeproperty(dbus.Boolean,
 
1787
 
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
 
1788
 
    last_enabled = notifychangeproperty(datetime_to_dbus,
 
1790
 
    checker = notifychangeproperty(
 
1791
 
        dbus.Boolean, "CheckerRunning",
 
1792
 
        type_func=lambda checker: checker is not None)
 
1793
 
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
 
1795
 
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1796
 
                                               "LastCheckerStatus")
 
1797
 
    last_approval_request = notifychangeproperty(
 
1798
 
        datetime_to_dbus, "LastApprovalRequest")
 
1799
 
    approved_by_default = notifychangeproperty(dbus.Boolean,
 
1800
 
                                               "ApprovedByDefault")
 
1801
 
    approval_delay = notifychangeproperty(
 
1802
 
        dbus.UInt64, "ApprovalDelay",
 
1803
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1804
 
    approval_duration = notifychangeproperty(
 
1805
 
        dbus.UInt64, "ApprovalDuration",
 
1806
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1807
 
    host = notifychangeproperty(dbus.String, "Host")
 
1808
 
    timeout = notifychangeproperty(
 
1809
 
        dbus.UInt64, "Timeout",
 
1810
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1811
 
    extended_timeout = notifychangeproperty(
 
1812
 
        dbus.UInt64, "ExtendedTimeout",
 
1813
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1814
 
    interval = notifychangeproperty(
 
1815
 
        dbus.UInt64, "Interval",
 
1816
 
        type_func=lambda td: td.total_seconds() * 1000)
 
1817
 
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1818
 
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1819
 
                                  invalidate_only=True)
 
1821
 
    del notifychangeproperty
 
 
739
    def _get_approvals_pending(self):
 
 
740
        return self._approvals_pending
 
 
741
    def _set_approvals_pending(self, value):
 
 
742
        old_value = self._approvals_pending
 
 
743
        self._approvals_pending = value
 
 
745
        if (hasattr(self, "dbus_object_path")
 
 
746
            and bval is not bool(old_value)):
 
 
747
            dbus_bool = dbus.Boolean(bval, variant_level=1)
 
 
748
            self.PropertyChanged(dbus.String(u"ApprovalPending"),
 
 
751
    approvals_pending = property(_get_approvals_pending,
 
 
752
                                 _set_approvals_pending)
 
 
753
    del _get_approvals_pending, _set_approvals_pending
 
 
756
    def _datetime_to_dbus(dt, variant_level=0):
 
 
757
        """Convert a UTC datetime.datetime() to a D-Bus type."""
 
 
758
        return dbus.String(dt.isoformat(),
 
 
759
                           variant_level=variant_level)
 
 
762
        oldstate = getattr(self, u"enabled", False)
 
 
763
        r = Client.enable(self)
 
 
764
        if oldstate != self.enabled:
 
 
766
            self.PropertyChanged(dbus.String(u"Enabled"),
 
 
767
                                 dbus.Boolean(True, variant_level=1))
 
 
768
            self.PropertyChanged(
 
 
769
                dbus.String(u"LastEnabled"),
 
 
770
                self._datetime_to_dbus(self.last_enabled,
 
 
774
    def disable(self, quiet = False):
 
 
775
        oldstate = getattr(self, u"enabled", False)
 
 
776
        r = Client.disable(self, quiet=quiet)
 
 
777
        if not quiet and oldstate != self.enabled:
 
 
779
            self.PropertyChanged(dbus.String(u"Enabled"),
 
 
780
                                 dbus.Boolean(False, variant_level=1))
 
1823
783
    def __del__(self, *args, **kwargs):
 
1825
785
            self.remove_from_connection()
 
1826
786
        except LookupError:
 
1828
 
        if hasattr(DBusObjectWithProperties, "__del__"):
 
 
788
        if hasattr(DBusObjectWithProperties, u"__del__"):
 
1829
789
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
 
1830
790
        Client.__del__(self, *args, **kwargs)
 
1832
 
    def checker_callback(self, source, condition,
 
1833
 
                         connection, command, *args, **kwargs):
 
1834
 
        ret = Client.checker_callback(self, source, condition,
 
1835
 
                                      connection, command, *args,
 
1837
 
        exitstatus = self.last_checker_status
 
 
792
    def checker_callback(self, pid, condition, command,
 
 
794
        self.checker_callback_tag = None
 
 
797
        self.PropertyChanged(dbus.String(u"CheckerRunning"),
 
 
798
                             dbus.Boolean(False, variant_level=1))
 
 
799
        if os.WIFEXITED(condition):
 
 
800
            exitstatus = os.WEXITSTATUS(condition)
 
1839
801
            # Emit D-Bus signal
 
1840
802
            self.CheckerCompleted(dbus.Int16(exitstatus),
 
1841
 
                                  # This is specific to GNU libC
 
1842
 
                                  dbus.Int64(exitstatus << 8),
 
 
803
                                  dbus.Int64(condition),
 
1843
804
                                  dbus.String(command))
 
1845
806
            # Emit D-Bus signal
 
1846
807
            self.CheckerCompleted(dbus.Int16(-1),
 
1848
 
                                      # This is specific to GNU libC
 
1850
 
                                      | self.last_checker_signal),
 
 
808
                                  dbus.Int64(condition),
 
1851
809
                                  dbus.String(command))
 
 
811
        return Client.checker_callback(self, pid, condition, command,
 
 
814
    def checked_ok(self, *args, **kwargs):
 
 
815
        r = Client.checked_ok(self, *args, **kwargs)
 
 
817
        self.PropertyChanged(
 
 
818
            dbus.String(u"LastCheckedOK"),
 
 
819
            (self._datetime_to_dbus(self.last_checked_ok,
 
 
823
    def need_approval(self, *args, **kwargs):
 
 
824
        r = Client.need_approval(self, *args, **kwargs)
 
 
826
        self.PropertyChanged(
 
 
827
            dbus.String(u"LastApprovalRequest"),
 
 
828
            (self._datetime_to_dbus(self.last_approval_request,
 
1854
832
    def start_checker(self, *args, **kwargs):
 
1855
 
        old_checker_pid = getattr(self.checker, "pid", None)
 
 
833
        old_checker = self.checker
 
 
834
        if self.checker is not None:
 
 
835
            old_checker_pid = self.checker.pid
 
 
837
            old_checker_pid = None
 
1856
838
        r = Client.start_checker(self, *args, **kwargs)
 
1857
839
        # Only if new checker process was started
 
1858
840
        if (self.checker is not None
 
1859
841
            and old_checker_pid != self.checker.pid):
 
1860
842
            # Emit D-Bus signal
 
1861
843
            self.CheckerStarted(self.current_checker_command)
 
 
844
            self.PropertyChanged(
 
 
845
                dbus.String(u"CheckerRunning"),
 
 
846
                dbus.Boolean(True, variant_level=1))
 
 
849
    def stop_checker(self, *args, **kwargs):
 
 
850
        old_checker = getattr(self, u"checker", None)
 
 
851
        r = Client.stop_checker(self, *args, **kwargs)
 
 
852
        if (old_checker is not None
 
 
853
            and getattr(self, u"checker", None) is None):
 
 
854
            self.PropertyChanged(dbus.String(u"CheckerRunning"),
 
 
855
                                 dbus.Boolean(False, variant_level=1))
 
1864
858
    def _reset_approved(self):
 
1865
 
        self.approved = None
 
 
859
        self._approved = None
 
1868
862
    def approve(self, value=True):
 
1869
 
        self.approved = value
 
1870
 
        GLib.timeout_add(int(self.approval_duration.total_seconds()
 
1871
 
                             * 1000), self._reset_approved)
 
1872
863
        self.send_changedstate()
 
1874
 
    #  D-Bus methods, signals & properties
 
 
864
        self._approved = value
 
 
865
        gobject.timeout_add(self._timedelta_to_milliseconds
 
 
866
                            (self.approval_duration),
 
 
867
                            self._reset_approved)
 
 
870
    ## D-Bus methods, signals & properties
 
 
871
    _interface = u"se.bsnet.fukt.Mandos.Client"
 
1880
875
    # CheckerCompleted - signal
 
1881
 
    @dbus.service.signal(_interface, signature="nxs")
 
 
876
    @dbus.service.signal(_interface, signature=u"nxs")
 
1882
877
    def CheckerCompleted(self, exitcode, waitstatus, command):
 
1886
881
    # CheckerStarted - signal
 
1887
 
    @dbus.service.signal(_interface, signature="s")
 
 
882
    @dbus.service.signal(_interface, signature=u"s")
 
1888
883
    def CheckerStarted(self, command):
 
1892
887
    # PropertyChanged - signal
 
1893
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
 
1894
 
    @dbus.service.signal(_interface, signature="sv")
 
 
888
    @dbus.service.signal(_interface, signature=u"sv")
 
1895
889
    def PropertyChanged(self, property, value):
 
1899
893
    # GotSecret - signal
 
1900
894
    @dbus.service.signal(_interface)
 
1901
895
    def GotSecret(self):
 
 
2164
1140
        self._pipe = child_pipe
 
2165
1141
        self._pipe.send(('init', fpr, address))
 
2166
1142
        if not self._pipe.recv():
 
2169
1145
    def __getattribute__(self, name):
 
 
1146
        if(name == '_pipe'):
 
2171
1147
            return super(ProxyClient, self).__getattribute__(name)
 
2172
1148
        self._pipe.send(('getattr', name))
 
2173
1149
        data = self._pipe.recv()
 
2174
1150
        if data[0] == 'data':
 
2176
1152
        if data[0] == 'function':
 
2178
1153
            def func(*args, **kwargs):
 
2179
1154
                self._pipe.send(('funcall', name, args, kwargs))
 
2180
1155
                return self._pipe.recv()[1]
 
2184
1158
    def __setattr__(self, name, value):
 
 
1159
        if(name == '_pipe'):
 
2186
1160
            return super(ProxyClient, self).__setattr__(name, value)
 
2187
1161
        self._pipe.send(('setattr', name, value))
 
2190
1164
class ClientHandler(socketserver.BaseRequestHandler, object):
 
2191
1165
    """A class to handle client connections.
 
2193
1167
    Instantiated once for each connection to handle it.
 
2194
1168
    Note: This will run in its own forked process."""
 
2196
1170
    def handle(self):
 
2197
1171
        with contextlib.closing(self.server.child_pipe) as child_pipe:
 
2198
 
            logger.info("TCP connection from: %s",
 
2199
 
                        str(self.client_address))
 
2200
 
            logger.debug("Pipe FD: %d",
 
 
1172
            logger.info(u"TCP connection from: %s",
 
 
1173
                        unicode(self.client_address))
 
 
1174
            logger.debug(u"Pipe FD: %d",
 
2201
1175
                         self.server.child_pipe.fileno())
 
2203
 
            session = gnutls.ClientSession(self.request)
 
2205
 
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
2206
 
            #                       "+AES-256-CBC", "+SHA1",
 
2207
 
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
 
 
1177
            session = (gnutls.connection
 
 
1178
                       .ClientSession(self.request,
 
 
1180
                                      .X509Credentials()))
 
 
1182
            # Note: gnutls.connection.X509Credentials is really a
 
 
1183
            # generic GnuTLS certificate credentials object so long as
 
 
1184
            # no X.509 keys are added to it.  Therefore, we can use it
 
 
1185
            # here despite using OpenPGP certificates.
 
 
1187
            #priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
 
 
1188
            #                      u"+AES-256-CBC", u"+SHA1",
 
 
1189
            #                      u"+COMP-NULL", u"+CTYPE-OPENPGP",
 
2209
1191
            # Use a fallback default, since this MUST be set.
 
2210
1192
            priority = self.server.gnutls_priority
 
2211
1193
            if priority is None:
 
2213
 
            gnutls.priority_set_direct(session._c_object,
 
2214
 
                                       priority.encode("utf-8"),
 
 
1194
                priority = u"NORMAL"
 
 
1195
            (gnutls.library.functions
 
 
1196
             .gnutls_priority_set_direct(session._c_object,
 
2217
1199
            # Start communication using the Mandos protocol
 
2218
1200
            # Get protocol number
 
2219
1201
            line = self.request.makefile().readline()
 
2220
 
            logger.debug("Protocol version: %r", line)
 
 
1202
            logger.debug(u"Protocol version: %r", line)
 
2222
1204
                if int(line.strip().split()[0]) > 1:
 
2223
 
                    raise RuntimeError(line)
 
2224
 
            except (ValueError, IndexError, RuntimeError) as error:
 
2225
 
                logger.error("Unknown protocol version: %s", error)
 
 
1206
            except (ValueError, IndexError, RuntimeError), error:
 
 
1207
                logger.error(u"Unknown protocol version: %s", error)
 
2228
1210
            # Start GnuTLS connection
 
2230
1212
                session.handshake()
 
2231
 
            except gnutls.Error as error:
 
2232
 
                logger.warning("Handshake failed: %s", error)
 
 
1213
            except gnutls.errors.GNUTLSError, error:
 
 
1214
                logger.warning(u"Handshake failed: %s", error)
 
2233
1215
                # Do not run session.bye() here: the session is not
 
2234
1216
                # established.  Just abandon the request.
 
2236
 
            logger.debug("Handshake succeeded")
 
 
1218
            logger.debug(u"Handshake succeeded")
 
2238
1220
            approval_required = False
 
2241
 
                    fpr = self.fingerprint(
 
2242
 
                        self.peer_certificate(session))
 
2243
 
                except (TypeError, gnutls.Error) as error:
 
2244
 
                    logger.warning("Bad certificate: %s", error)
 
 
1223
                    fpr = self.fingerprint(self.peer_certificate
 
 
1225
                except (TypeError, gnutls.errors.GNUTLSError), error:
 
 
1226
                    logger.warning(u"Bad certificate: %s", error)
 
2246
 
                logger.debug("Fingerprint: %s", fpr)
 
 
1228
                logger.debug(u"Fingerprint: %s", fpr)
 
2249
1231
                    client = ProxyClient(child_pipe, fpr,
 
2250
1232
                                         self.client_address)
 
2251
1233
                except KeyError:
 
2254
1236
                if client.approval_delay:
 
2255
1237
                    delay = client.approval_delay
 
2256
1238
                    client.approvals_pending += 1
 
2257
1239
                    approval_required = True
 
2260
1242
                    if not client.enabled:
 
2261
 
                        logger.info("Client %s is disabled",
 
 
1243
                        logger.warning(u"Client %s is disabled",
 
2263
1245
                        if self.server.use_dbus:
 
2264
1246
                            # Emit D-Bus signal
 
2265
 
                            client.Rejected("Disabled")
 
 
1247
                            client.Rejected("Disabled")                    
 
2268
 
                    if client.approved or not client.approval_delay:
 
2269
 
                        # We are approved or approval is disabled
 
 
1250
                    if client._approved or not client.approval_delay:
 
 
1251
                        #We are approved or approval is disabled
 
2271
 
                    elif client.approved is None:
 
2272
 
                        logger.info("Client %s needs approval",
 
 
1253
                    elif client._approved is None:
 
 
1254
                        logger.info(u"Client %s needs approval",
 
2274
1256
                        if self.server.use_dbus:
 
2275
1257
                            # Emit D-Bus signal
 
2276
1258
                            client.NeedApproval(
 
2277
 
                                client.approval_delay.total_seconds()
 
2278
 
                                * 1000, client.approved_by_default)
 
 
1259
                                client.approval_delay_milliseconds(),
 
 
1260
                                client.approved_by_default)
 
2280
 
                        logger.warning("Client %s was not approved",
 
 
1262
                        logger.warning(u"Client %s was not approved",
 
2282
1264
                        if self.server.use_dbus:
 
2283
1265
                            # Emit D-Bus signal
 
2284
1266
                            client.Rejected("Denied")
 
2287
 
                    # wait until timeout or approved
 
 
1269
                    #wait until timeout or approved
 
 
1270
                    #x = float(client._timedelta_to_milliseconds(delay))
 
2288
1271
                    time = datetime.datetime.now()
 
2289
1272
                    client.changedstate.acquire()
 
2290
 
                    client.changedstate.wait(delay.total_seconds())
 
 
1273
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
 
2291
1274
                    client.changedstate.release()
 
2292
1275
                    time2 = datetime.datetime.now()
 
2293
1276
                    if (time2 - time) >= delay:
 
 
2305
1288
                        delay -= time2 - time
 
2308
 
                    session.send(client.secret)
 
2309
 
                except gnutls.Error as error:
 
2310
 
                    logger.warning("gnutls send failed",
 
2314
 
                logger.info("Sending secret to %s", client.name)
 
2315
 
                # bump the timeout using extended_timeout
 
2316
 
                client.bump_timeout(client.extended_timeout)
 
 
1291
                while sent_size < len(client.secret):
 
 
1293
                        sent = session.send(client.secret[sent_size:])
 
 
1294
                    except (gnutls.errors.GNUTLSError), error:
 
 
1295
                        logger.warning("gnutls send failed")
 
 
1297
                    logger.debug(u"Sent: %d, remaining: %d",
 
 
1298
                                 sent, len(client.secret)
 
 
1299
                                 - (sent_size + sent))
 
 
1302
                logger.info(u"Sending secret to %s", client.name)
 
 
1303
                # bump the timeout as if seen
 
2317
1305
                if self.server.use_dbus:
 
2318
1306
                    # Emit D-Bus signal
 
2319
1307
                    client.GotSecret()
 
2322
1310
                if approval_required:
 
2323
1311
                    client.approvals_pending -= 1
 
2326
 
                except gnutls.Error as error:
 
2327
 
                    logger.warning("GnuTLS bye failed",
 
 
1314
                except (gnutls.errors.GNUTLSError), error:
 
 
1315
                    logger.warning("GnuTLS bye failed")
 
2331
1318
    def peer_certificate(session):
 
2332
1319
        "Return the peer's OpenPGP certificate as a bytestring"
 
2333
1320
        # If not an OpenPGP certificate...
 
2334
 
        if (gnutls.certificate_type_get(session._c_object)
 
2335
 
            != gnutls.CRT_OPENPGP):
 
2336
 
            # ...return invalid data
 
 
1321
        if (gnutls.library.functions
 
 
1322
            .gnutls_certificate_type_get(session._c_object)
 
 
1323
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
 
 
1324
            # ...do the normal thing
 
 
1325
            return session.peer_certificate
 
2338
1326
        list_size = ctypes.c_uint(1)
 
2339
 
        cert_list = (gnutls.certificate_get_peers
 
 
1327
        cert_list = (gnutls.library.functions
 
 
1328
                     .gnutls_certificate_get_peers
 
2340
1329
                     (session._c_object, ctypes.byref(list_size)))
 
2341
1330
        if not bool(cert_list) and list_size.value != 0:
 
2342
 
            raise gnutls.Error("error getting peer certificate")
 
 
1331
            raise gnutls.errors.GNUTLSError(u"error getting peer"
 
2343
1333
        if list_size.value == 0:
 
2345
1335
        cert = cert_list[0]
 
2346
1336
        return ctypes.string_at(cert.data, cert.size)
 
2349
1339
    def fingerprint(openpgp):
 
2350
1340
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
 
2351
1341
        # New GnuTLS "datum" with the OpenPGP public key
 
2352
 
        datum = gnutls.datum_t(
 
2353
 
            ctypes.cast(ctypes.c_char_p(openpgp),
 
2354
 
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2355
 
            ctypes.c_uint(len(openpgp)))
 
 
1342
        datum = (gnutls.library.types
 
 
1343
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
 
 
1346
                                 ctypes.c_uint(len(openpgp))))
 
2356
1347
        # New empty GnuTLS certificate
 
2357
 
        crt = gnutls.openpgp_crt_t()
 
2358
 
        gnutls.openpgp_crt_init(ctypes.byref(crt))
 
 
1348
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
 
1349
        (gnutls.library.functions
 
 
1350
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
2359
1351
        # Import the OpenPGP public key into the certificate
 
2360
 
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2361
 
                                  gnutls.OPENPGP_FMT_RAW)
 
 
1352
        (gnutls.library.functions
 
 
1353
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
 
1354
                                    gnutls.library.constants
 
 
1355
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
2362
1356
        # Verify the self signature in the key
 
2363
1357
        crtverify = ctypes.c_uint()
 
2364
 
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2365
 
                                       ctypes.byref(crtverify))
 
 
1358
        (gnutls.library.functions
 
 
1359
         .gnutls_openpgp_crt_verify_self(crt, 0,
 
 
1360
                                         ctypes.byref(crtverify)))
 
2366
1361
        if crtverify.value != 0:
 
2367
 
            gnutls.openpgp_crt_deinit(crt)
 
2368
 
            raise gnutls.CertificateSecurityError(code
 
 
1362
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
 
1363
            raise (gnutls.errors.CertificateSecurityError
 
2370
1365
        # New buffer for the fingerprint
 
2371
1366
        buf = ctypes.create_string_buffer(20)
 
2372
1367
        buf_len = ctypes.c_size_t()
 
2373
1368
        # Get the fingerprint from the certificate into the buffer
 
2374
 
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2375
 
                                           ctypes.byref(buf_len))
 
 
1369
        (gnutls.library.functions
 
 
1370
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
 
1371
                                             ctypes.byref(buf_len)))
 
2376
1372
        # Deinit the certificate
 
2377
 
        gnutls.openpgp_crt_deinit(crt)
 
 
1373
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2378
1374
        # Convert the buffer to a Python bytestring
 
2379
1375
        fpr = ctypes.string_at(buf, buf_len.value)
 
2380
1376
        # Convert the bytestring to hexadecimal notation
 
2381
 
        hex_fpr = binascii.hexlify(fpr).upper()
 
 
1377
        hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
 
2385
1381
class MultiprocessingMixIn(object):
 
2386
1382
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
2388
1383
    def sub_process_main(self, request, address):
 
2390
1385
            self.finish_request(request, address)
 
2392
1387
            self.handle_error(request, address)
 
2393
1388
        self.close_request(request)
 
2395
1390
    def process_request(self, request, address):
 
2396
1391
        """Start a new process to process the request."""
 
2397
 
        proc = multiprocessing.Process(target=self.sub_process_main,
 
2398
 
                                       args=(request, address))
 
 
1392
        multiprocessing.Process(target = self.sub_process_main,
 
 
1393
                                args = (request, address)).start()
 
2403
1395
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
 
2404
1396
    """ adds a pipe to the MixIn """
 
2406
1397
    def process_request(self, request, client_address):
 
2407
1398
        """Overrides and wraps the original process_request().
 
2409
1400
        This function creates a new pipe in self.pipe
 
2411
1402
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
 
2413
 
        proc = MultiprocessingMixIn.process_request(self, request,
 
 
1404
        super(MultiprocessingMixInWithPipe,
 
 
1405
              self).process_request(request, client_address)
 
2415
1406
        self.child_pipe.close()
 
2416
 
        self.add_pipe(parent_pipe, proc)
 
 
1407
        self.add_pipe(parent_pipe)
 
2418
 
    def add_pipe(self, parent_pipe, proc):
 
 
1409
    def add_pipe(self, parent_pipe):
 
2419
1410
        """Dummy function; override as necessary"""
 
2420
 
        raise NotImplementedError()
 
2423
1413
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
 
2424
1414
                     socketserver.TCPServer, object):
 
2425
1415
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
 
2428
1418
        enabled:        Boolean; whether this server is activated yet
 
2429
1419
        interface:      None or a network interface name (string)
 
2430
1420
        use_ipv6:       Boolean; to use IPv6 or not
 
2433
1422
    def __init__(self, server_address, RequestHandlerClass,
 
2437
 
        """If socketfd is set, use that file descriptor instead of
 
2438
 
        creating a new one with socket.socket().
 
 
1423
                 interface=None, use_ipv6=True):
 
2440
1424
        self.interface = interface
 
2442
1426
            self.address_family = socket.AF_INET6
 
2443
 
        if socketfd is not None:
 
2444
 
            # Save the file descriptor
 
2445
 
            self.socketfd = socketfd
 
2446
 
            # Save the original socket.socket() function
 
2447
 
            self.socket_socket = socket.socket
 
2449
 
            # To implement --socket, we monkey patch socket.socket.
 
2451
 
            # (When socketserver.TCPServer is a new-style class, we
 
2452
 
            # could make self.socket into a property instead of monkey
 
2453
 
            # patching socket.socket.)
 
2455
 
            # Create a one-time-only replacement for socket.socket()
 
2456
 
            @functools.wraps(socket.socket)
 
2457
 
            def socket_wrapper(*args, **kwargs):
 
2458
 
                # Restore original function so subsequent calls are
 
2460
 
                socket.socket = self.socket_socket
 
2461
 
                del self.socket_socket
 
2462
 
                # This time only, return a new socket object from the
 
2463
 
                # saved file descriptor.
 
2464
 
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
2465
 
            # Replace socket.socket() function with wrapper
 
2466
 
            socket.socket = socket_wrapper
 
2467
 
        # The socketserver.TCPServer.__init__ will call
 
2468
 
        # socket.socket(), which might be our replacement,
 
2469
 
        # socket_wrapper(), if socketfd was set.
 
2470
1427
        socketserver.TCPServer.__init__(self, server_address,
 
2471
1428
                                        RequestHandlerClass)
 
2473
1429
    def server_bind(self):
 
2474
1430
        """This overrides the normal server_bind() function
 
2475
1431
        to bind to an interface if one was specified, and also NOT to
 
2476
1432
        bind to an address or port if they were not specified."""
 
2477
 
        global SO_BINDTODEVICE
 
2478
1433
        if self.interface is not None:
 
2479
1434
            if SO_BINDTODEVICE is None:
 
2480
 
                # Fall back to a hard-coded value which seems to be
 
2482
 
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
2483
 
                SO_BINDTODEVICE = 25
 
2485
 
                self.socket.setsockopt(
 
2486
 
                    socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2487
 
                    (self.interface + "\0").encode("utf-8"))
 
2488
 
            except socket.error as error:
 
2489
 
                if error.errno == errno.EPERM:
 
2490
 
                    logger.error("No permission to bind to"
 
2491
 
                                 " interface %s", self.interface)
 
2492
 
                elif error.errno == errno.ENOPROTOOPT:
 
2493
 
                    logger.error("SO_BINDTODEVICE not available;"
 
2494
 
                                 " cannot bind to interface %s",
 
2496
 
                elif error.errno == errno.ENODEV:
 
2497
 
                    logger.error("Interface %s does not exist,"
 
2498
 
                                 " cannot bind", self.interface)
 
 
1435
                logger.error(u"SO_BINDTODEVICE does not exist;"
 
 
1436
                             u" cannot bind to interface %s",
 
 
1440
                    self.socket.setsockopt(socket.SOL_SOCKET,
 
 
1444
                except socket.error, error:
 
 
1445
                    if error[0] == errno.EPERM:
 
 
1446
                        logger.error(u"No permission to"
 
 
1447
                                     u" bind to interface %s",
 
 
1449
                    elif error[0] == errno.ENOPROTOOPT:
 
 
1450
                        logger.error(u"SO_BINDTODEVICE not available;"
 
 
1451
                                     u" cannot bind to interface %s",
 
2501
1455
        # Only bind(2) the socket if we really need to.
 
2502
1456
        if self.server_address[0] or self.server_address[1]:
 
2503
1457
            if not self.server_address[0]:
 
2504
1458
                if self.address_family == socket.AF_INET6:
 
2505
 
                    any_address = "::"  # in6addr_any
 
 
1459
                    any_address = u"::" # in6addr_any
 
2507
 
                    any_address = "0.0.0.0"  # INADDR_ANY
 
 
1461
                    any_address = socket.INADDR_ANY
 
2508
1462
                self.server_address = (any_address,
 
2509
1463
                                       self.server_address[1])
 
2510
1464
            elif not self.server_address[1]:
 
2511
 
                self.server_address = (self.server_address[0], 0)
 
 
1465
                self.server_address = (self.server_address[0],
 
2512
1467
#                 if self.interface:
 
2513
1468
#                     self.server_address = (self.server_address[0],
 
 
2636
 
def rfc3339_duration_to_delta(duration):
 
2637
 
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2639
 
    >>> rfc3339_duration_to_delta("P7D")
 
2640
 
    datetime.timedelta(7)
 
2641
 
    >>> rfc3339_duration_to_delta("PT60S")
 
2642
 
    datetime.timedelta(0, 60)
 
2643
 
    >>> rfc3339_duration_to_delta("PT60M")
 
2644
 
    datetime.timedelta(0, 3600)
 
2645
 
    >>> rfc3339_duration_to_delta("PT24H")
 
2646
 
    datetime.timedelta(1)
 
2647
 
    >>> rfc3339_duration_to_delta("P1W")
 
2648
 
    datetime.timedelta(7)
 
2649
 
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2650
 
    datetime.timedelta(0, 330)
 
2651
 
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2652
 
    datetime.timedelta(1, 200)
 
2655
 
    # Parsing an RFC 3339 duration with regular expressions is not
 
2656
 
    # possible - there would have to be multiple places for the same
 
2657
 
    # values, like seconds.  The current code, while more esoteric, is
 
2658
 
    # cleaner without depending on a parsing library.  If Python had a
 
2659
 
    # built-in library for parsing we would use it, but we'd like to
 
2660
 
    # avoid excessive use of external libraries.
 
2662
 
    # New type for defining tokens, syntax, and semantics all-in-one
 
2663
 
    Token = collections.namedtuple("Token", (
 
2664
 
        "regexp",  # To match token; if "value" is not None, must have
 
2665
 
                   # a "group" containing digits
 
2666
 
        "value",   # datetime.timedelta or None
 
2667
 
        "followers"))           # Tokens valid after this token
 
2668
 
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2669
 
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2670
 
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2671
 
    token_second = Token(re.compile(r"(\d+)S"),
 
2672
 
                         datetime.timedelta(seconds=1),
 
2673
 
                         frozenset((token_end, )))
 
2674
 
    token_minute = Token(re.compile(r"(\d+)M"),
 
2675
 
                         datetime.timedelta(minutes=1),
 
2676
 
                         frozenset((token_second, token_end)))
 
2677
 
    token_hour = Token(re.compile(r"(\d+)H"),
 
2678
 
                       datetime.timedelta(hours=1),
 
2679
 
                       frozenset((token_minute, token_end)))
 
2680
 
    token_time = Token(re.compile(r"T"),
 
2682
 
                       frozenset((token_hour, token_minute,
 
2684
 
    token_day = Token(re.compile(r"(\d+)D"),
 
2685
 
                      datetime.timedelta(days=1),
 
2686
 
                      frozenset((token_time, token_end)))
 
2687
 
    token_month = Token(re.compile(r"(\d+)M"),
 
2688
 
                        datetime.timedelta(weeks=4),
 
2689
 
                        frozenset((token_day, token_end)))
 
2690
 
    token_year = Token(re.compile(r"(\d+)Y"),
 
2691
 
                       datetime.timedelta(weeks=52),
 
2692
 
                       frozenset((token_month, token_end)))
 
2693
 
    token_week = Token(re.compile(r"(\d+)W"),
 
2694
 
                       datetime.timedelta(weeks=1),
 
2695
 
                       frozenset((token_end, )))
 
2696
 
    token_duration = Token(re.compile(r"P"), None,
 
2697
 
                           frozenset((token_year, token_month,
 
2698
 
                                      token_day, token_time,
 
2700
 
    # Define starting values:
 
2702
 
    value = datetime.timedelta()
 
2704
 
    # Following valid tokens
 
2705
 
    followers = frozenset((token_duration, ))
 
2706
 
    # String left to parse
 
2708
 
    # Loop until end token is found
 
2709
 
    while found_token is not token_end:
 
2710
 
        # Search for any currently valid tokens
 
2711
 
        for token in followers:
 
2712
 
            match = token.regexp.match(s)
 
2713
 
            if match is not None:
 
2715
 
                if token.value is not None:
 
2716
 
                    # Value found, parse digits
 
2717
 
                    factor = int(match.group(1), 10)
 
2718
 
                    # Add to value so far
 
2719
 
                    value += factor * token.value
 
2720
 
                # Strip token from string
 
2721
 
                s = token.regexp.sub("", s, 1)
 
2724
 
                # Set valid next tokens
 
2725
 
                followers = found_token.followers
 
2728
 
            # No currently valid tokens were found
 
2729
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2735
1582
def string_to_delta(interval):
 
2736
1583
    """Parse a string and return a datetime.timedelta
 
2738
 
    >>> string_to_delta('7d')
 
 
1585
    >>> string_to_delta(u'7d')
 
2739
1586
    datetime.timedelta(7)
 
2740
 
    >>> string_to_delta('60s')
 
 
1587
    >>> string_to_delta(u'60s')
 
2741
1588
    datetime.timedelta(0, 60)
 
2742
 
    >>> string_to_delta('60m')
 
 
1589
    >>> string_to_delta(u'60m')
 
2743
1590
    datetime.timedelta(0, 3600)
 
2744
 
    >>> string_to_delta('24h')
 
 
1591
    >>> string_to_delta(u'24h')
 
2745
1592
    datetime.timedelta(1)
 
2746
 
    >>> string_to_delta('1w')
 
 
1593
    >>> string_to_delta(u'1w')
 
2747
1594
    datetime.timedelta(7)
 
2748
 
    >>> string_to_delta('5m 30s')
 
 
1595
    >>> string_to_delta(u'5m 30s')
 
2749
1596
    datetime.timedelta(0, 330)
 
2753
 
        return rfc3339_duration_to_delta(interval)
 
2757
1598
    timevalue = datetime.timedelta(0)
 
2758
1599
    for s in interval.split():
 
 
1601
            suffix = unicode(s[-1])
 
2761
1602
            value = int(s[:-1])
 
2763
1604
                delta = datetime.timedelta(value)
 
 
1605
            elif suffix == u"s":
 
2765
1606
                delta = datetime.timedelta(0, value)
 
 
1607
            elif suffix == u"m":
 
2767
1608
                delta = datetime.timedelta(0, 0, 0, 0, value)
 
 
1609
            elif suffix == u"h":
 
2769
1610
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
 
 
1611
            elif suffix == u"w":
 
2771
1612
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
 
2773
 
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2774
 
        except IndexError as e:
 
2775
 
            raise ValueError(*(e.args))
 
 
1614
                raise ValueError(u"Unknown suffix %r" % suffix)
 
 
1615
        except (ValueError, IndexError), e:
 
 
1616
            raise ValueError(e.message)
 
2776
1617
        timevalue += delta
 
2777
1618
    return timevalue
 
2780
 
def daemon(nochdir=False, noclose=False):
 
 
1621
def if_nametoindex(interface):
 
 
1622
    """Call the C function if_nametoindex(), or equivalent
 
 
1624
    Note: This function cannot accept a unicode string."""
 
 
1625
    global if_nametoindex
 
 
1627
        if_nametoindex = (ctypes.cdll.LoadLibrary
 
 
1628
                          (ctypes.util.find_library(u"c"))
 
 
1630
    except (OSError, AttributeError):
 
 
1631
        logger.warning(u"Doing if_nametoindex the hard way")
 
 
1632
        def if_nametoindex(interface):
 
 
1633
            "Get an interface index the hard way, i.e. using fcntl()"
 
 
1634
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
 
1635
            with contextlib.closing(socket.socket()) as s:
 
 
1636
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
 
1637
                                    struct.pack(str(u"16s16x"),
 
 
1639
            interface_index = struct.unpack(str(u"I"),
 
 
1641
            return interface_index
 
 
1642
    return if_nametoindex(interface)
 
 
1645
def daemon(nochdir = False, noclose = False):
 
2781
1646
    """See daemon(3).  Standard BSD Unix function.
 
2783
1648
    This should really exist as os.daemon, but it doesn't (yet)."""
 
2787
1652
    if not nochdir:
 
2791
1656
    if not noclose:
 
2792
1657
        # Close all standard open file descriptors
 
2793
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
 
1658
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2794
1659
        if not stat.S_ISCHR(os.fstat(null).st_mode):
 
2795
1660
            raise OSError(errno.ENODEV,
 
2796
 
                          "{} not a character device"
 
2797
 
                          .format(os.devnull))
 
 
1661
                          u"%s not a character device"
 
2798
1663
        os.dup2(null, sys.stdin.fileno())
 
2799
1664
        os.dup2(null, sys.stdout.fileno())
 
2800
1665
        os.dup2(null, sys.stderr.fileno())
 
 
2807
1672
    ##################################################################
 
2808
1673
    # Parsing of options, both command line and config file
 
2810
 
    parser = argparse.ArgumentParser()
 
2811
 
    parser.add_argument("-v", "--version", action="version",
 
2812
 
                        version="%(prog)s {}".format(version),
 
2813
 
                        help="show version number and exit")
 
2814
 
    parser.add_argument("-i", "--interface", metavar="IF",
 
2815
 
                        help="Bind to interface IF")
 
2816
 
    parser.add_argument("-a", "--address",
 
2817
 
                        help="Address to listen for requests on")
 
2818
 
    parser.add_argument("-p", "--port", type=int,
 
2819
 
                        help="Port number to receive requests on")
 
2820
 
    parser.add_argument("--check", action="store_true",
 
2821
 
                        help="Run self-test")
 
2822
 
    parser.add_argument("--debug", action="store_true",
 
2823
 
                        help="Debug mode; run in foreground and log"
 
2824
 
                        " to terminal", default=None)
 
2825
 
    parser.add_argument("--debuglevel", metavar="LEVEL",
 
2826
 
                        help="Debug level for stdout output")
 
2827
 
    parser.add_argument("--priority", help="GnuTLS"
 
2828
 
                        " priority string (see GnuTLS documentation)")
 
2829
 
    parser.add_argument("--servicename",
 
2830
 
                        metavar="NAME", help="Zeroconf service name")
 
2831
 
    parser.add_argument("--configdir",
 
2832
 
                        default="/etc/mandos", metavar="DIR",
 
2833
 
                        help="Directory to search for configuration"
 
2835
 
    parser.add_argument("--no-dbus", action="store_false",
 
2836
 
                        dest="use_dbus", help="Do not provide D-Bus"
 
2837
 
                        " system bus interface", default=None)
 
2838
 
    parser.add_argument("--no-ipv6", action="store_false",
 
2839
 
                        dest="use_ipv6", help="Do not use IPv6",
 
2841
 
    parser.add_argument("--no-restore", action="store_false",
 
2842
 
                        dest="restore", help="Do not restore stored"
 
2843
 
                        " state", default=None)
 
2844
 
    parser.add_argument("--socket", type=int,
 
2845
 
                        help="Specify a file descriptor to a network"
 
2846
 
                        " socket to use instead of creating one")
 
2847
 
    parser.add_argument("--statedir", metavar="DIR",
 
2848
 
                        help="Directory to save/restore state in")
 
2849
 
    parser.add_argument("--foreground", action="store_true",
 
2850
 
                        help="Run in foreground", default=None)
 
2851
 
    parser.add_argument("--no-zeroconf", action="store_false",
 
2852
 
                        dest="zeroconf", help="Do not use Zeroconf",
 
2855
 
    options = parser.parse_args()
 
 
1675
    parser = optparse.OptionParser(version = "%%prog %s" % version)
 
 
1676
    parser.add_option("-i", u"--interface", type=u"string",
 
 
1677
                      metavar="IF", help=u"Bind to interface IF")
 
 
1678
    parser.add_option("-a", u"--address", type=u"string",
 
 
1679
                      help=u"Address to listen for requests on")
 
 
1680
    parser.add_option("-p", u"--port", type=u"int",
 
 
1681
                      help=u"Port number to receive requests on")
 
 
1682
    parser.add_option("--check", action=u"store_true",
 
 
1683
                      help=u"Run self-test")
 
 
1684
    parser.add_option("--debug", action=u"store_true",
 
 
1685
                      help=u"Debug mode; run in foreground and log to"
 
 
1687
    parser.add_option("--debuglevel", type=u"string", metavar="LEVEL",
 
 
1688
                      help=u"Debug level for stdout output")
 
 
1689
    parser.add_option("--priority", type=u"string", help=u"GnuTLS"
 
 
1690
                      u" priority string (see GnuTLS documentation)")
 
 
1691
    parser.add_option("--servicename", type=u"string",
 
 
1692
                      metavar=u"NAME", help=u"Zeroconf service name")
 
 
1693
    parser.add_option("--configdir", type=u"string",
 
 
1694
                      default=u"/etc/mandos", metavar=u"DIR",
 
 
1695
                      help=u"Directory to search for configuration"
 
 
1697
    parser.add_option("--no-dbus", action=u"store_false",
 
 
1698
                      dest=u"use_dbus", help=u"Do not provide D-Bus"
 
 
1699
                      u" system bus interface")
 
 
1700
    parser.add_option("--no-ipv6", action=u"store_false",
 
 
1701
                      dest=u"use_ipv6", help=u"Do not use IPv6")
 
 
1702
    options = parser.parse_args()[0]
 
2857
1704
    if options.check:
 
2859
 
        fail_count, test_count = doctest.testmod()
 
2860
 
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
2862
1709
    # Default values for config file for server-global settings
 
2863
 
    server_defaults = {"interface": "",
 
2868
 
                       "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2869
 
                       ":+SIGN-DSA-SHA256",
 
2870
 
                       "servicename": "Mandos",
 
2876
 
                       "statedir": "/var/lib/mandos",
 
2877
 
                       "foreground": "False",
 
 
1710
    server_defaults = { u"interface": u"",
 
 
1715
                        u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
 
1716
                        u"servicename": u"Mandos",
 
 
1717
                        u"use_dbus": u"True",
 
 
1718
                        u"use_ipv6": u"True",
 
2881
1722
    # Parse config file for server-global settings
 
2882
1723
    server_config = configparser.SafeConfigParser(server_defaults)
 
2883
1724
    del server_defaults
 
2884
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
 
1725
    server_config.read(os.path.join(options.configdir,
 
2885
1727
    # Convert the SafeConfigParser object to a dict
 
2886
1728
    server_settings = server_config.defaults()
 
2887
1729
    # Use the appropriate methods on the non-string config options
 
2888
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2889
 
                   "foreground", "zeroconf"):
 
2890
 
        server_settings[option] = server_config.getboolean("DEFAULT",
 
 
1730
    for option in (u"debug", u"use_dbus", u"use_ipv6"):
 
 
1731
        server_settings[option] = server_config.getboolean(u"DEFAULT",
 
2892
1733
    if server_settings["port"]:
 
2893
 
        server_settings["port"] = server_config.getint("DEFAULT",
 
2895
 
    if server_settings["socket"]:
 
2896
 
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2898
 
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2899
 
        # over with an opened os.devnull.  But we don't want this to
 
2900
 
        # happen with a supplied network socket.
 
2901
 
        if 0 <= server_settings["socket"] <= 2:
 
2902
 
            server_settings["socket"] = os.dup(server_settings
 
 
1734
        server_settings["port"] = server_config.getint(u"DEFAULT",
 
2904
1736
    del server_config
 
2906
1738
    # Override the settings from the config file with command line
 
2907
1739
    # options, if set.
 
2908
 
    for option in ("interface", "address", "port", "debug",
 
2909
 
                   "priority", "servicename", "configdir", "use_dbus",
 
2910
 
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2911
 
                   "socket", "foreground", "zeroconf"):
 
 
1740
    for option in (u"interface", u"address", u"port", u"debug",
 
 
1741
                   u"priority", u"servicename", u"configdir",
 
 
1742
                   u"use_dbus", u"use_ipv6", u"debuglevel"):
 
2912
1743
        value = getattr(options, option)
 
2913
1744
        if value is not None:
 
2914
1745
            server_settings[option] = value
 
2916
1747
    # Force all strings to be unicode
 
2917
1748
    for option in server_settings.keys():
 
2918
 
        if isinstance(server_settings[option], bytes):
 
2919
 
            server_settings[option] = (server_settings[option]
 
2921
 
    # Force all boolean options to be boolean
 
2922
 
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
2923
 
                   "foreground", "zeroconf"):
 
2924
 
        server_settings[option] = bool(server_settings[option])
 
2925
 
    # Debug implies foreground
 
2926
 
    if server_settings["debug"]:
 
2927
 
        server_settings["foreground"] = True
 
 
1749
        if type(server_settings[option]) is str:
 
 
1750
            server_settings[option] = unicode(server_settings[option])
 
2928
1751
    # Now we have our good server settings in "server_settings"
 
2930
1753
    ##################################################################
 
2932
 
    if (not server_settings["zeroconf"]
 
2933
 
        and not (server_settings["port"]
 
2934
 
                 or server_settings["socket"] != "")):
 
2935
 
        parser.error("Needs port or socket to work without Zeroconf")
 
2937
1755
    # For convenience
 
2938
 
    debug = server_settings["debug"]
 
2939
 
    debuglevel = server_settings["debuglevel"]
 
2940
 
    use_dbus = server_settings["use_dbus"]
 
2941
 
    use_ipv6 = server_settings["use_ipv6"]
 
2942
 
    stored_state_path = os.path.join(server_settings["statedir"],
 
2944
 
    foreground = server_settings["foreground"]
 
2945
 
    zeroconf = server_settings["zeroconf"]
 
2948
 
        initlogger(debug, logging.DEBUG)
 
2953
 
            level = getattr(logging, debuglevel.upper())
 
2954
 
            initlogger(debug, level)
 
2956
 
    if server_settings["servicename"] != "Mandos":
 
2957
 
        syslogger.setFormatter(
 
2958
 
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2959
 
                              ' %(levelname)s: %(message)s'.format(
 
2960
 
                                  server_settings["servicename"])))
 
 
1756
    debug = server_settings[u"debug"]
 
 
1757
    debuglevel = server_settings[u"debuglevel"]
 
 
1758
    use_dbus = server_settings[u"use_dbus"]
 
 
1759
    use_ipv6 = server_settings[u"use_ipv6"]
 
 
1761
    if server_settings[u"servicename"] != u"Mandos":
 
 
1762
        syslogger.setFormatter(logging.Formatter
 
 
1763
                               (u'Mandos (%s) [%%(process)d]:'
 
 
1764
                                u' %%(levelname)s: %%(message)s'
 
 
1765
                                % server_settings[u"servicename"]))
 
2962
1767
    # Parse config file with clients
 
2963
 
    client_config = configparser.SafeConfigParser(Client
 
2965
 
    client_config.read(os.path.join(server_settings["configdir"],
 
 
1768
    client_defaults = { u"timeout": u"1h",
 
 
1770
                        u"checker": u"fping -q -- %%(host)s",
 
 
1772
                        u"approval_delay": u"0s",
 
 
1773
                        u"approval_duration": u"1s",
 
 
1775
    client_config = configparser.SafeConfigParser(client_defaults)
 
 
1776
    client_config.read(os.path.join(server_settings[u"configdir"],
 
2968
1779
    global mandos_dbus_service
 
2969
1780
    mandos_dbus_service = None
 
2972
 
    if server_settings["socket"] != "":
 
2973
 
        socketfd = server_settings["socket"]
 
2974
 
    tcp_server = MandosServer(
 
2975
 
        (server_settings["address"], server_settings["port"]),
 
2977
 
        interface=(server_settings["interface"] or None),
 
2979
 
        gnutls_priority=server_settings["priority"],
 
2983
 
        pidfilename = "/run/mandos.pid"
 
2984
 
        if not os.path.isdir("/run/."):
 
2985
 
            pidfilename = "/var/run/mandos.pid"
 
2988
 
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
 
2989
 
        except IOError as e:
 
2990
 
            logger.error("Could not open file %r", pidfilename,
 
2993
 
    for name, group in (("_mandos", "_mandos"),
 
2994
 
                        ("mandos", "mandos"),
 
2995
 
                        ("nobody", "nogroup")):
 
2997
 
            uid = pwd.getpwnam(name).pw_uid
 
2998
 
            gid = pwd.getpwnam(group).pw_gid
 
 
1782
    tcp_server = MandosServer((server_settings[u"address"],
 
 
1783
                               server_settings[u"port"]),
 
 
1785
                              interface=(server_settings[u"interface"]
 
 
1789
                              server_settings[u"priority"],
 
 
1792
        pidfilename = u"/var/run/mandos.pid"
 
 
1794
            pidfile = open(pidfilename, u"w")
 
 
1796
            logger.error(u"Could not open file %r", pidfilename)
 
 
1799
        uid = pwd.getpwnam(u"_mandos").pw_uid
 
 
1800
        gid = pwd.getpwnam(u"_mandos").pw_gid
 
 
1803
            uid = pwd.getpwnam(u"mandos").pw_uid
 
 
1804
            gid = pwd.getpwnam(u"mandos").pw_gid
 
3000
1805
        except KeyError:
 
 
1807
                uid = pwd.getpwnam(u"nobody").pw_uid
 
 
1808
                gid = pwd.getpwnam(u"nobody").pw_gid
 
3009
 
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
3011
 
    except OSError as error:
 
3012
 
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
3013
 
                       .format(uid, gid, os.strerror(error.errno)))
 
3014
 
        if error.errno != errno.EPERM:
 
 
1815
    except OSError, error:
 
 
1816
        if error[0] != errno.EPERM:
 
 
1819
    if not debug and not debuglevel:
 
 
1820
        syslogger.setLevel(logging.WARNING)
 
 
1821
        console.setLevel(logging.WARNING)
 
 
1823
        level = getattr(logging, debuglevel.upper())
 
 
1824
        syslogger.setLevel(level)
 
 
1825
        console.setLevel(level)
 
3018
1828
        # Enable all possible GnuTLS debugging
 
3020
1830
        # "Use a log level over 10 to enable all debugging options."
 
3021
1831
        # - GnuTLS manual
 
3022
 
        gnutls.global_set_log_level(11)
 
 
1832
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
 
1834
        @gnutls.library.types.gnutls_log_func
 
3025
1835
        def debug_gnutls(level, string):
 
3026
 
            logger.debug("GnuTLS: %s", string[:-1])
 
3028
 
        gnutls.global_set_log_function(debug_gnutls)
 
 
1836
            logger.debug(u"GnuTLS: %s", string[:-1])
 
 
1838
        (gnutls.library.functions
 
 
1839
         .gnutls_global_set_log_function(debug_gnutls))
 
3030
1841
        # Redirect stdin so all checkers get /dev/null
 
3031
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
 
1842
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
3032
1843
        os.dup2(null, sys.stdin.fileno())
 
 
1847
        # No console logging
 
 
1848
        logger.removeHandler(console)
 
3036
1850
    # Need to fork before connecting to D-Bus
 
3038
1852
        # Close all input and output, do double fork, etc.
 
3041
 
    # multiprocessing will use threads, so before we use GLib we need
 
3042
 
    # to inform GLib that threads will be used.
 
3045
1855
    global main_loop
 
3046
1856
    # From the Avahi example code
 
3047
 
    DBusGMainLoop(set_as_default=True)
 
3048
 
    main_loop = GLib.MainLoop()
 
 
1857
    DBusGMainLoop(set_as_default=True )
 
 
1858
    main_loop = gobject.MainLoop()
 
3049
1859
    bus = dbus.SystemBus()
 
3050
1860
    # End of Avahi example code
 
3053
 
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
3056
 
            old_bus_name = dbus.service.BusName(
 
3057
 
                "se.bsnet.fukt.Mandos", bus,
 
3059
 
        except dbus.exceptions.DBusException as e:
 
3060
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
 
1863
            bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
 
 
1864
                                            bus, do_not_queue=True)
 
 
1865
        except dbus.exceptions.NameExistsException, e:
 
 
1866
            logger.error(unicode(e) + u", disabling D-Bus")
 
3061
1867
            use_dbus = False
 
3062
 
            server_settings["use_dbus"] = False
 
 
1868
            server_settings[u"use_dbus"] = False
 
3063
1869
            tcp_server.use_dbus = False
 
3065
 
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
3066
 
        service = AvahiServiceToSyslog(
 
3067
 
            name=server_settings["servicename"],
 
3068
 
            servicetype="_mandos._tcp",
 
3071
 
        if server_settings["interface"]:
 
3072
 
            service.interface = if_nametoindex(
 
3073
 
                server_settings["interface"].encode("utf-8"))
 
 
1870
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
 
1871
    service = AvahiService(name = server_settings[u"servicename"],
 
 
1872
                           servicetype = u"_mandos._tcp",
 
 
1873
                           protocol = protocol, bus = bus)
 
 
1874
    if server_settings["interface"]:
 
 
1875
        service.interface = (if_nametoindex
 
 
1876
                             (str(server_settings[u"interface"])))
 
3075
1878
    global multiprocessing_manager
 
3076
1879
    multiprocessing_manager = multiprocessing.Manager()
 
3078
1881
    client_class = Client
 
3080
 
        client_class = functools.partial(ClientDBus, bus=bus)
 
3082
 
    client_settings = Client.config_parser(client_config)
 
3083
 
    old_client_settings = {}
 
3086
 
    # This is used to redirect stdout and stderr for checker processes
 
3088
 
    wnull = open(os.devnull, "w")  # A writable /dev/null
 
3089
 
    # Only used if server is running in foreground but not in debug
 
3091
 
    if debug or not foreground:
 
3094
 
    # Get client data and settings from last running state.
 
3095
 
    if server_settings["restore"]:
 
3097
 
            with open(stored_state_path, "rb") as stored_state:
 
3098
 
                if sys.version_info.major == 2:
 
3099
 
                    clients_data, old_client_settings = pickle.load(
 
3102
 
                    bytes_clients_data, bytes_old_client_settings = (
 
3103
 
                        pickle.load(stored_state, encoding="bytes"))
 
3104
 
                    #   Fix bytes to strings
 
3107
 
                    clients_data = {(key.decode("utf-8")
 
3108
 
                                     if isinstance(key, bytes)
 
3111
 
                                    bytes_clients_data.items()}
 
3112
 
                    del bytes_clients_data
 
3113
 
                    for key in clients_data:
 
3114
 
                        value = {(k.decode("utf-8")
 
3115
 
                                  if isinstance(k, bytes) else k): v
 
3117
 
                                 clients_data[key].items()}
 
3118
 
                        clients_data[key] = value
 
3120
 
                        value["client_structure"] = [
 
3122
 
                             if isinstance(s, bytes)
 
3124
 
                            value["client_structure"]]
 
3126
 
                        for k in ("name", "host"):
 
3127
 
                            if isinstance(value[k], bytes):
 
3128
 
                                value[k] = value[k].decode("utf-8")
 
3129
 
                    #  old_client_settings
 
3131
 
                    old_client_settings = {
 
3132
 
                        (key.decode("utf-8")
 
3133
 
                         if isinstance(key, bytes)
 
3136
 
                        bytes_old_client_settings.items()}
 
3137
 
                    del bytes_old_client_settings
 
3139
 
                    for value in old_client_settings.values():
 
3140
 
                        if isinstance(value["host"], bytes):
 
3141
 
                            value["host"] = (value["host"]
 
3143
 
            os.remove(stored_state_path)
 
3144
 
        except IOError as e:
 
3145
 
            if e.errno == errno.ENOENT:
 
3146
 
                logger.warning("Could not load persistent state:"
 
3147
 
                               " {}".format(os.strerror(e.errno)))
 
3149
 
                logger.critical("Could not load persistent state:",
 
3152
 
        except EOFError as e:
 
3153
 
            logger.warning("Could not load persistent state: "
 
3157
 
    with PGPEngine() as pgp:
 
3158
 
        for client_name, client in clients_data.items():
 
3159
 
            # Skip removed clients
 
3160
 
            if client_name not in client_settings:
 
3163
 
            # Decide which value to use after restoring saved state.
 
3164
 
            # We have three different values: Old config file,
 
3165
 
            # new config file, and saved state.
 
3166
 
            # New config value takes precedence if it differs from old
 
3167
 
            # config value, otherwise use saved state.
 
3168
 
            for name, value in client_settings[client_name].items():
 
3170
 
                    # For each value in new config, check if it
 
3171
 
                    # differs from the old config value (Except for
 
3172
 
                    # the "secret" attribute)
 
3173
 
                    if (name != "secret"
 
3175
 
                             old_client_settings[client_name][name])):
 
3176
 
                        client[name] = value
 
3180
 
            # Clients who has passed its expire date can still be
 
3181
 
            # enabled if its last checker was successful.  A Client
 
3182
 
            # whose checker succeeded before we stored its state is
 
3183
 
            # assumed to have successfully run all checkers during
 
3185
 
            if client["enabled"]:
 
3186
 
                if datetime.datetime.utcnow() >= client["expires"]:
 
3187
 
                    if not client["last_checked_ok"]:
 
3189
 
                            "disabling client {} - Client never "
 
3190
 
                            "performed a successful checker".format(
 
3192
 
                        client["enabled"] = False
 
3193
 
                    elif client["last_checker_status"] != 0:
 
3195
 
                            "disabling client {} - Client last"
 
3196
 
                            " checker failed with error code"
 
3199
 
                                client["last_checker_status"]))
 
3200
 
                        client["enabled"] = False
 
3202
 
                        client["expires"] = (
 
3203
 
                            datetime.datetime.utcnow()
 
3204
 
                            + client["timeout"])
 
3205
 
                        logger.debug("Last checker succeeded,"
 
3206
 
                                     " keeping {} enabled".format(
 
 
1883
        client_class = functools.partial(ClientDBus, bus = bus)
 
 
1884
    def client_config_items(config, section):
 
 
1885
        special_settings = {
 
 
1886
            "approved_by_default":
 
 
1887
                lambda: config.getboolean(section,
 
 
1888
                                          "approved_by_default"),
 
 
1890
        for name, value in config.items(section):
 
3209
 
                client["secret"] = pgp.decrypt(
 
3210
 
                    client["encrypted_secret"],
 
3211
 
                    client_settings[client_name]["secret"])
 
3213
 
                # If decryption fails, we use secret from new settings
 
3214
 
                logger.debug("Failed to decrypt {} old secret".format(
 
3216
 
                client["secret"] = (client_settings[client_name]
 
3219
 
    # Add/remove clients based on new changes made to config
 
3220
 
    for client_name in (set(old_client_settings)
 
3221
 
                        - set(client_settings)):
 
3222
 
        del clients_data[client_name]
 
3223
 
    for client_name in (set(client_settings)
 
3224
 
                        - set(old_client_settings)):
 
3225
 
        clients_data[client_name] = client_settings[client_name]
 
3227
 
    # Create all client objects
 
3228
 
    for client_name, client in clients_data.items():
 
3229
 
        tcp_server.clients[client_name] = client_class(
 
3232
 
            server_settings=server_settings)
 
 
1892
                yield (name, special_settings[name]())
 
 
1896
    tcp_server.clients.update(set(
 
 
1897
            client_class(name = section,
 
 
1898
                         config= dict(client_config_items(
 
 
1899
                        client_config, section)))
 
 
1900
            for section in client_config.sections()))
 
3234
1901
    if not tcp_server.clients:
 
3235
 
        logger.warning("No clients defined")
 
3238
 
        if pidfile is not None:
 
3242
 
                    print(pid, file=pidfile)
 
3244
 
                logger.error("Could not write to file %r with PID %d",
 
 
1902
        logger.warning(u"No clients defined")
 
 
1908
                pidfile.write(str(pid) + "\n")
 
 
1911
            logger.error(u"Could not write to file %r with PID %d",
 
 
1914
            # "pidfile" was never created
 
3247
1916
        del pidfilename
 
3249
 
    for termsig in (signal.SIGHUP, signal.SIGTERM):
 
3250
 
        GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
 
3251
 
                             lambda: main_loop.quit() and False)
 
 
1918
        signal.signal(signal.SIGINT, signal.SIG_IGN)
 
 
1920
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
 
 
1921
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
 
3255
 
        @alternate_dbus_interfaces(
 
3256
 
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
 
3257
 
        class MandosDBusService(DBusObjectWithObjectManager):
 
 
1924
        class MandosDBusService(dbus.service.Object):
 
3258
1925
            """A D-Bus proxy object"""
 
3260
1926
            def __init__(self):
 
3261
 
                dbus.service.Object.__init__(self, bus, "/")
 
3263
 
            _interface = "se.recompile.Mandos"
 
3265
 
            @dbus.service.signal(_interface, signature="o")
 
 
1927
                dbus.service.Object.__init__(self, bus, u"/")
 
 
1928
            _interface = u"se.bsnet.fukt.Mandos"
 
 
1930
            @dbus.service.signal(_interface, signature=u"o")
 
3266
1931
            def ClientAdded(self, objpath):
 
3270
 
            @dbus.service.signal(_interface, signature="ss")
 
 
1935
            @dbus.service.signal(_interface, signature=u"ss")
 
3271
1936
            def ClientNotFound(self, fingerprint, address):
 
3275
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3277
 
            @dbus.service.signal(_interface, signature="os")
 
 
1940
            @dbus.service.signal(_interface, signature=u"os")
 
3278
1941
            def ClientRemoved(self, objpath, name):
 
3282
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3284
 
            @dbus.service.method(_interface, out_signature="ao")
 
 
1945
            @dbus.service.method(_interface, out_signature=u"ao")
 
3285
1946
            def GetAllClients(self):
 
3287
 
                return dbus.Array(c.dbus_object_path for c in
 
3288
 
                                  tcp_server.clients.values())
 
3290
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
 
1948
                return dbus.Array(c.dbus_object_path
 
 
1949
                                  for c in tcp_server.clients)
 
3292
1951
            @dbus.service.method(_interface,
 
3293
 
                                 out_signature="a{oa{sv}}")
 
 
1952
                                 out_signature=u"a{oa{sv}}")
 
3294
1953
            def GetAllClientsWithProperties(self):
 
3296
1955
                return dbus.Dictionary(
 
3297
 
                    {c.dbus_object_path: c.GetAll(
 
3298
 
                        "se.recompile.Mandos.Client")
 
3299
 
                     for c in tcp_server.clients.values()},
 
3302
 
            @dbus.service.method(_interface, in_signature="o")
 
 
1956
                    ((c.dbus_object_path, c.GetAll(u""))
 
 
1957
                     for c in tcp_server.clients),
 
 
1958
                    signature=u"oa{sv}")
 
 
1960
            @dbus.service.method(_interface, in_signature=u"o")
 
3303
1961
            def RemoveClient(self, object_path):
 
3305
 
                for c in tcp_server.clients.values():
 
 
1963
                for c in tcp_server.clients:
 
3306
1964
                    if c.dbus_object_path == object_path:
 
3307
 
                        del tcp_server.clients[c.name]
 
 
1965
                        tcp_server.clients.remove(c)
 
3308
1966
                        c.remove_from_connection()
 
3309
 
                        # Don't signal the disabling
 
 
1967
                        # Don't signal anything except ClientRemoved
 
3310
1968
                        c.disable(quiet=True)
 
3311
 
                        # Emit D-Bus signal for removal
 
3312
 
                        self.client_removed_signal(c)
 
 
1970
                        self.ClientRemoved(object_path, c.name)
 
3314
1972
                raise KeyError(object_path)
 
3318
 
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
3319
 
                                 out_signature="a{oa{sa{sv}}}")
 
3320
 
            def GetManagedObjects(self):
 
3322
 
                return dbus.Dictionary(
 
3323
 
                    {client.dbus_object_path:
 
3325
 
                         {interface: client.GetAll(interface)
 
3327
 
                          client._get_all_interface_names()})
 
3328
 
                     for client in tcp_server.clients.values()})
 
3330
 
            def client_added_signal(self, client):
 
3331
 
                """Send the new standard signal and the old signal"""
 
3333
 
                    # New standard signal
 
3334
 
                    self.InterfacesAdded(
 
3335
 
                        client.dbus_object_path,
 
3337
 
                            {interface: client.GetAll(interface)
 
3339
 
                             client._get_all_interface_names()}))
 
3341
 
                    self.ClientAdded(client.dbus_object_path)
 
3343
 
            def client_removed_signal(self, client):
 
3344
 
                """Send the new standard signal and the old signal"""
 
3346
 
                    # New standard signal
 
3347
 
                    self.InterfacesRemoved(
 
3348
 
                        client.dbus_object_path,
 
3349
 
                        client._get_all_interface_names())
 
3351
 
                    self.ClientRemoved(client.dbus_object_path,
 
3354
1976
        mandos_dbus_service = MandosDBusService()
 
3356
 
    # Save modules to variables to exempt the modules from being
 
3357
 
    # unloaded before the function registered with atexit() is run.
 
3358
 
    mp = multiprocessing
 
3362
1979
        "Cleanup function; run on exit"
 
3366
 
        mp.active_children()
 
3368
 
        if not (tcp_server.clients or client_settings):
 
3371
 
        # Store client before exiting. Secrets are encrypted with key
 
3372
 
        # based on what config file has. If config file is
 
3373
 
        # removed/edited, old secret will thus be unrecovable.
 
3375
 
        with PGPEngine() as pgp:
 
3376
 
            for client in tcp_server.clients.values():
 
3377
 
                key = client_settings[client.name]["secret"]
 
3378
 
                client.encrypted_secret = pgp.encrypt(client.secret,
 
3382
 
                # A list of attributes that can not be pickled
 
3384
 
                exclude = {"bus", "changedstate", "secret",
 
3385
 
                           "checker", "server_settings"}
 
3386
 
                for name, typ in inspect.getmembers(dbus.service
 
3390
 
                client_dict["encrypted_secret"] = (client
 
3392
 
                for attr in client.client_structure:
 
3393
 
                    if attr not in exclude:
 
3394
 
                        client_dict[attr] = getattr(client, attr)
 
3396
 
                clients[client.name] = client_dict
 
3397
 
                del client_settings[client.name]["secret"]
 
3400
 
            with tempfile.NamedTemporaryFile(
 
3404
 
                    dir=os.path.dirname(stored_state_path),
 
3405
 
                    delete=False) as stored_state:
 
3406
 
                pickle.dump((clients, client_settings), stored_state,
 
3408
 
                tempname = stored_state.name
 
3409
 
            os.rename(tempname, stored_state_path)
 
3410
 
        except (IOError, OSError) as e:
 
3416
 
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
3417
 
                logger.warning("Could not save persistent state: {}"
 
3418
 
                               .format(os.strerror(e.errno)))
 
3420
 
                logger.warning("Could not save persistent state:",
 
3424
 
        # Delete all clients, and settings from config
 
3425
1982
        while tcp_server.clients:
 
3426
 
            name, client = tcp_server.clients.popitem()
 
 
1983
            client = tcp_server.clients.pop()
 
3428
1985
                client.remove_from_connection()
 
3429
 
            # Don't signal the disabling
 
 
1986
            client.disable_hook = None
 
 
1987
            # Don't signal anything except ClientRemoved
 
3430
1988
            client.disable(quiet=True)
 
3431
 
            # Emit D-Bus signal for removal
 
3433
 
                mandos_dbus_service.client_removed_signal(client)
 
3434
 
        client_settings.clear()
 
 
1991
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
 
3436
1994
    atexit.register(cleanup)
 
3438
 
    for client in tcp_server.clients.values():
 
 
1996
    for client in tcp_server.clients:
 
3440
 
            # Emit D-Bus signal for adding
 
3441
 
            mandos_dbus_service.client_added_signal(client)
 
3442
 
        # Need to initiate checking of clients
 
3444
 
            client.init_checker()
 
 
1999
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3446
2002
    tcp_server.enable()
 
3447
2003
    tcp_server.server_activate()
 
3449
2005
    # Find out what port we got
 
3451
 
        service.port = tcp_server.socket.getsockname()[1]
 
 
2006
    service.port = tcp_server.socket.getsockname()[1]
 
3453
 
        logger.info("Now listening on address %r, port %d,"
 
3454
 
                    " flowinfo %d, scope_id %d",
 
3455
 
                    *tcp_server.socket.getsockname())
 
 
2008
        logger.info(u"Now listening on address %r, port %d,"
 
 
2009
                    " flowinfo %d, scope_id %d"
 
 
2010
                    % tcp_server.socket.getsockname())
 
3457
 
        logger.info("Now listening on address %r, port %d",
 
3458
 
                    *tcp_server.socket.getsockname())
 
3460
 
    # service.interface = tcp_server.socket.getsockname()[3]
 
 
2012
        logger.info(u"Now listening on address %r, port %d"
 
 
2013
                    % tcp_server.socket.getsockname())
 
 
2015
    #service.interface = tcp_server.socket.getsockname()[3]
 
3464
 
            # From the Avahi example code
 
3467
 
            except dbus.exceptions.DBusException as error:
 
3468
 
                logger.critical("D-Bus Exception", exc_info=error)
 
3471
 
            # End of Avahi example code
 
3473
 
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3474
 
                          lambda *args, **kwargs:
 
3475
 
                          (tcp_server.handle_request
 
3476
 
                           (*args[2:], **kwargs) or True))
 
3478
 
        logger.debug("Starting main loop")
 
 
2018
        # From the Avahi example code
 
 
2021
        except dbus.exceptions.DBusException, error:
 
 
2022
            logger.critical(u"DBusException: %s", error)
 
 
2025
        # End of Avahi example code
 
 
2027
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
 
2028
                             lambda *args, **kwargs:
 
 
2029
                             (tcp_server.handle_request
 
 
2030
                              (*args[2:], **kwargs) or True))
 
 
2032
        logger.debug(u"Starting main loop")
 
3479
2033
        main_loop.run()
 
3480
 
    except AvahiError as error:
 
3481
 
        logger.critical("Avahi Error", exc_info=error)
 
 
2034
    except AvahiError, error:
 
 
2035
        logger.critical(u"AvahiError: %s", error)
 
3484
2038
    except KeyboardInterrupt:
 
3486
 
            print("", file=sys.stderr)
 
3487
 
        logger.debug("Server received KeyboardInterrupt")
 
3488
 
    logger.debug("Server exiting")
 
 
2041
        logger.debug(u"Server received KeyboardInterrupt")
 
 
2042
    logger.debug(u"Server exiting")
 
3489
2043
    # Must run before the D-Bus bus name gets deregistered
 
3493
2046
if __name__ == '__main__':