104
328
    max_renames: integer; maximum number of renames
 
105
329
    rename_count: integer; counter so we only rename after collisions
 
106
330
                  a sensible number of times
 
 
331
    group: D-Bus Entry Group
 
 
333
    bus: dbus.SystemBus()
 
108
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
 
109
 
                 type = None, port = None, TXT = None, domain = "",
 
110
 
                 host = "", max_renames = 32768):
 
 
337
                 interface = avahi.IF_UNSPEC,
 
 
345
                 protocol = avahi.PROTO_UNSPEC,
 
111
347
        self.interface = interface
 
 
349
        self.type = servicetype
 
 
351
        self.TXT = TXT if TXT is not None else []
 
119
352
        self.domain = domain
 
121
354
        self.rename_count = 0
 
 
355
        self.max_renames = max_renames
 
 
356
        self.protocol = protocol
 
 
357
        self.group = None       # our entry group
 
 
360
        self.entry_group_state_changed_match = None
 
 
362
    def rename(self, remove=True):
 
123
363
        """Derived from the Avahi example code"""
 
124
364
        if self.rename_count >= self.max_renames:
 
125
 
            logger.critical(u"No suitable service name found after %i"
 
126
 
                            u" retries, exiting.", rename_count)
 
 
365
            logger.critical("No suitable Zeroconf service name found"
 
 
366
                            " after %i retries, exiting.",
 
127
368
            raise AvahiServiceError("Too many renames")
 
128
 
        name = server.GetAlternativeServiceName(name)
 
129
 
        logger.error(u"Changing name to %r ...", name)
 
130
 
        syslogger.setFormatter(logging.Formatter\
 
131
 
                               ('Mandos (%s): %%(levelname)s:'
 
132
 
                               ' %%(message)s' % name))
 
 
370
            self.server.GetAlternativeServiceName(self.name))
 
135
371
        self.rename_count += 1
 
 
372
        logger.info("Changing Zeroconf service name to %r ...",
 
 
378
        except dbus.exceptions.DBusException as error:
 
 
379
            if (error.get_dbus_name()
 
 
380
                == "org.freedesktop.Avahi.CollisionError"):
 
 
381
                logger.info("Local Zeroconf service name collision.")
 
 
382
                return self.rename(remove=False)
 
 
384
                logger.critical("D-Bus Exception", exc_info=error)
 
136
388
    def remove(self):
 
137
389
        """Derived from the Avahi example code"""
 
138
 
        if group is not None:
 
 
390
        if self.entry_group_state_changed_match is not None:
 
 
391
            self.entry_group_state_changed_match.remove()
 
 
392
            self.entry_group_state_changed_match = None
 
 
393
        if self.group is not None:
 
141
397
        """Derived from the Avahi example code"""
 
144
 
            group = dbus.Interface\
 
145
 
                    (bus.get_object(avahi.DBUS_NAME,
 
146
 
                                    server.EntryGroupNew()),
 
147
 
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
148
 
            group.connect_to_signal('StateChanged',
 
149
 
                                    entry_group_state_changed)
 
150
 
        logger.debug(u"Adding service '%s' of type '%s' ...",
 
151
 
                     service.name, service.type)
 
153
 
                self.interface,         # interface
 
154
 
                avahi.PROTO_INET6,      # protocol
 
155
 
                dbus.UInt32(0),         # flags
 
156
 
                self.name, self.type,
 
157
 
                self.domain, self.host,
 
158
 
                dbus.UInt16(self.port),
 
159
 
                avahi.string_array_to_txt_array(self.TXT))
 
162
 
# From the Avahi example code:
 
163
 
group = None                            # our entry group
 
164
 
# End of Avahi example code
 
 
399
        if self.group is None:
 
 
400
            self.group = dbus.Interface(
 
 
401
                self.bus.get_object(avahi.DBUS_NAME,
 
 
402
                                    self.server.EntryGroupNew()),
 
 
403
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
 
404
        self.entry_group_state_changed_match = (
 
 
405
            self.group.connect_to_signal(
 
 
406
                'StateChanged', self.entry_group_state_changed))
 
 
407
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
 
408
                     self.name, self.type)
 
 
409
        self.group.AddService(
 
 
412
            dbus.UInt32(0),     # flags
 
 
413
            self.name, self.type,
 
 
414
            self.domain, self.host,
 
 
415
            dbus.UInt16(self.port),
 
 
416
            avahi.string_array_to_txt_array(self.TXT))
 
 
419
    def entry_group_state_changed(self, state, error):
 
 
420
        """Derived from the Avahi example code"""
 
 
421
        logger.debug("Avahi entry group state change: %i", state)
 
 
423
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
 
 
424
            logger.debug("Zeroconf service established.")
 
 
425
        elif state == avahi.ENTRY_GROUP_COLLISION:
 
 
426
            logger.info("Zeroconf service name collision.")
 
 
428
        elif state == avahi.ENTRY_GROUP_FAILURE:
 
 
429
            logger.critical("Avahi: Error in group state changed %s",
 
 
431
            raise AvahiGroupError("State changed: {!s}".format(error))
 
 
434
        """Derived from the Avahi example code"""
 
 
435
        if self.group is not None:
 
 
438
            except (dbus.exceptions.UnknownMethodException,
 
 
439
                    dbus.exceptions.DBusException):
 
 
444
    def server_state_changed(self, state, error=None):
 
 
445
        """Derived from the Avahi example code"""
 
 
446
        logger.debug("Avahi server state change: %i", state)
 
 
448
            avahi.SERVER_INVALID: "Zeroconf server invalid",
 
 
449
            avahi.SERVER_REGISTERING: None,
 
 
450
            avahi.SERVER_COLLISION: "Zeroconf server name collision",
 
 
451
            avahi.SERVER_FAILURE: "Zeroconf server failure",
 
 
453
        if state in bad_states:
 
 
454
            if bad_states[state] is not None:
 
 
456
                    logger.error(bad_states[state])
 
 
458
                    logger.error(bad_states[state] + ": %r", error)
 
 
460
        elif state == avahi.SERVER_RUNNING:
 
 
463
            except dbus.exceptions.DBusException as error:
 
 
464
                if (error.get_dbus_name()
 
 
465
                    == "org.freedesktop.Avahi.CollisionError"):
 
 
466
                    logger.info("Local Zeroconf service name"
 
 
468
                    return self.rename(remove=False)
 
 
470
                    logger.critical("D-Bus Exception", exc_info=error)
 
 
475
                logger.debug("Unknown state: %r", state)
 
 
477
                logger.debug("Unknown state: %r: %r", state, error)
 
 
480
        """Derived from the Avahi example code"""
 
 
481
        if self.server is None:
 
 
482
            self.server = dbus.Interface(
 
 
483
                self.bus.get_object(avahi.DBUS_NAME,
 
 
484
                                    avahi.DBUS_PATH_SERVER,
 
 
485
                                    follow_name_owner_changes=True),
 
 
486
                avahi.DBUS_INTERFACE_SERVER)
 
 
487
        self.server.connect_to_signal("StateChanged",
 
 
488
                                      self.server_state_changed)
 
 
489
        self.server_state_changed(self.server.GetState())
 
 
492
class AvahiServiceToSyslog(AvahiService):
 
 
493
    def rename(self, *args, **kwargs):
 
 
494
        """Add the new name to the syslog messages"""
 
 
495
        ret = AvahiService.rename(self, *args, **kwargs)
 
 
496
        syslogger.setFormatter(logging.Formatter(
 
 
497
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
 
501
# Pretend that we have a GnuTLS module
 
 
502
class GnuTLS(object):
 
 
503
    """This isn't so much a class as it is a module-like namespace.
 
 
504
    It is instantiated once, and simulates having a GnuTLS module."""
 
 
506
    _library = ctypes.cdll.LoadLibrary(
 
 
507
        ctypes.util.find_library("gnutls"))
 
 
508
    _need_version = b"3.3.0"
 
 
510
        # Need to use class name "GnuTLS" here, since this method is
 
 
511
        # called before the assignment to the "gnutls" global variable
 
 
513
        if GnuTLS.check_version(self._need_version) is None:
 
 
514
            raise GnuTLS.Error("Needs GnuTLS {} or later"
 
 
515
                               .format(self._need_version))
 
 
517
    # Unless otherwise indicated, the constants and types below are
 
 
518
    # all from the gnutls/gnutls.h C header file.
 
 
528
    E_NO_CERTIFICATE_FOUND = -49
 
 
529
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
 
 
532
    class session_int(ctypes.Structure):
 
 
534
    session_t = ctypes.POINTER(session_int)
 
 
535
    class certificate_credentials_st(ctypes.Structure):
 
 
537
    certificate_credentials_t = ctypes.POINTER(
 
 
538
        certificate_credentials_st)
 
 
539
    certificate_type_t = ctypes.c_int
 
 
540
    class datum_t(ctypes.Structure):
 
 
541
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
 
542
                    ('size', ctypes.c_uint)]
 
 
543
    class openpgp_crt_int(ctypes.Structure):
 
 
545
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
 
546
    openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
 
 
547
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
 
 
548
    credentials_type_t = ctypes.c_int
 
 
549
    transport_ptr_t = ctypes.c_void_p
 
 
550
    close_request_t = ctypes.c_int
 
 
553
    class Error(Exception):
 
 
554
        # We need to use the class name "GnuTLS" here, since this
 
 
555
        # exception might be raised from within GnuTLS.__init__,
 
 
556
        # which is called before the assignment to the "gnutls"
 
 
557
        # global variable has happened.
 
 
558
        def __init__(self, message = None, code = None, args=()):
 
 
559
            # Default usage is by a message string, but if a return
 
 
560
            # code is passed, convert it to a string with
 
 
563
            if message is None and code is not None:
 
 
564
                message = GnuTLS.strerror(code)
 
 
565
            return super(GnuTLS.Error, self).__init__(
 
 
568
    class CertificateSecurityError(Error):
 
 
572
    class Credentials(object):
 
 
574
            self._c_object = gnutls.certificate_credentials_t()
 
 
575
            gnutls.certificate_allocate_credentials(
 
 
576
                ctypes.byref(self._c_object))
 
 
577
            self.type = gnutls.CRD_CERTIFICATE
 
 
580
            gnutls.certificate_free_credentials(self._c_object)
 
 
582
    class ClientSession(object):
 
 
583
        def __init__(self, socket, credentials = None):
 
 
584
            self._c_object = gnutls.session_t()
 
 
585
            gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
 
 
586
            gnutls.set_default_priority(self._c_object)
 
 
587
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
 
588
            gnutls.handshake_set_private_extensions(self._c_object,
 
 
591
            if credentials is None:
 
 
592
                credentials = gnutls.Credentials()
 
 
593
            gnutls.credentials_set(self._c_object, credentials.type,
 
 
594
                                   ctypes.cast(credentials._c_object,
 
 
596
            self.credentials = credentials
 
 
599
            gnutls.deinit(self._c_object)
 
 
602
            return gnutls.handshake(self._c_object)
 
 
604
        def send(self, data):
 
 
608
                data_len -= gnutls.record_send(self._c_object,
 
 
613
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
 
615
    # Error handling functions
 
 
616
    def _error_code(result):
 
 
617
        """A function to raise exceptions on errors, suitable
 
 
618
        for the 'restype' attribute on ctypes functions"""
 
 
621
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
 
 
622
            raise gnutls.CertificateSecurityError(code = result)
 
 
623
        raise gnutls.Error(code = result)
 
 
625
    def _retry_on_error(result, func, arguments):
 
 
626
        """A function to retry on some errors, suitable
 
 
627
        for the 'errcheck' attribute on ctypes functions"""
 
 
629
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
 
 
630
                return _error_code(result)
 
 
631
            result = func(*arguments)
 
 
634
    # Unless otherwise indicated, the function declarations below are
 
 
635
    # all from the gnutls/gnutls.h C header file.
 
 
638
    priority_set_direct = _library.gnutls_priority_set_direct
 
 
639
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
 
640
                                    ctypes.POINTER(ctypes.c_char_p)]
 
 
641
    priority_set_direct.restype = _error_code
 
 
643
    init = _library.gnutls_init
 
 
644
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
 
645
    init.restype = _error_code
 
 
647
    set_default_priority = _library.gnutls_set_default_priority
 
 
648
    set_default_priority.argtypes = [session_t]
 
 
649
    set_default_priority.restype = _error_code
 
 
651
    record_send = _library.gnutls_record_send
 
 
652
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
 
654
    record_send.restype = ctypes.c_ssize_t
 
 
655
    record_send.errcheck = _retry_on_error
 
 
657
    certificate_allocate_credentials = (
 
 
658
        _library.gnutls_certificate_allocate_credentials)
 
 
659
    certificate_allocate_credentials.argtypes = [
 
 
660
        ctypes.POINTER(certificate_credentials_t)]
 
 
661
    certificate_allocate_credentials.restype = _error_code
 
 
663
    certificate_free_credentials = (
 
 
664
        _library.gnutls_certificate_free_credentials)
 
 
665
    certificate_free_credentials.argtypes = [certificate_credentials_t]
 
 
666
    certificate_free_credentials.restype = None
 
 
668
    handshake_set_private_extensions = (
 
 
669
        _library.gnutls_handshake_set_private_extensions)
 
 
670
    handshake_set_private_extensions.argtypes = [session_t,
 
 
672
    handshake_set_private_extensions.restype = None
 
 
674
    credentials_set = _library.gnutls_credentials_set
 
 
675
    credentials_set.argtypes = [session_t, credentials_type_t,
 
 
677
    credentials_set.restype = _error_code
 
 
679
    strerror = _library.gnutls_strerror
 
 
680
    strerror.argtypes = [ctypes.c_int]
 
 
681
    strerror.restype = ctypes.c_char_p
 
 
683
    certificate_type_get = _library.gnutls_certificate_type_get
 
 
684
    certificate_type_get.argtypes = [session_t]
 
 
685
    certificate_type_get.restype = _error_code
 
 
687
    certificate_get_peers = _library.gnutls_certificate_get_peers
 
 
688
    certificate_get_peers.argtypes = [session_t,
 
 
689
                                      ctypes.POINTER(ctypes.c_uint)]
 
 
690
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
 
 
692
    global_set_log_level = _library.gnutls_global_set_log_level
 
 
693
    global_set_log_level.argtypes = [ctypes.c_int]
 
 
694
    global_set_log_level.restype = None
 
 
696
    global_set_log_function = _library.gnutls_global_set_log_function
 
 
697
    global_set_log_function.argtypes = [log_func]
 
 
698
    global_set_log_function.restype = None
 
 
700
    deinit = _library.gnutls_deinit
 
 
701
    deinit.argtypes = [session_t]
 
 
702
    deinit.restype = None
 
 
704
    handshake = _library.gnutls_handshake
 
 
705
    handshake.argtypes = [session_t]
 
 
706
    handshake.restype = _error_code
 
 
707
    handshake.errcheck = _retry_on_error
 
 
709
    transport_set_ptr = _library.gnutls_transport_set_ptr
 
 
710
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
 
711
    transport_set_ptr.restype = None
 
 
713
    bye = _library.gnutls_bye
 
 
714
    bye.argtypes = [session_t, close_request_t]
 
 
715
    bye.restype = _error_code
 
 
716
    bye.errcheck = _retry_on_error
 
 
718
    check_version = _library.gnutls_check_version
 
 
719
    check_version.argtypes = [ctypes.c_char_p]
 
 
720
    check_version.restype = ctypes.c_char_p
 
 
722
    # All the function declarations below are from gnutls/openpgp.h
 
 
724
    openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
 
725
    openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
 
726
    openpgp_crt_init.restype = _error_code
 
 
728
    openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
 
729
    openpgp_crt_import.argtypes = [openpgp_crt_t,
 
 
730
                                   ctypes.POINTER(datum_t),
 
 
732
    openpgp_crt_import.restype = _error_code
 
 
734
    openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
 
735
    openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
 
736
                                        ctypes.POINTER(ctypes.c_uint)]
 
 
737
    openpgp_crt_verify_self.restype = _error_code
 
 
739
    openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
 
740
    openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
 
741
    openpgp_crt_deinit.restype = None
 
 
743
    openpgp_crt_get_fingerprint = (
 
 
744
        _library.gnutls_openpgp_crt_get_fingerprint)
 
 
745
    openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
 
749
    openpgp_crt_get_fingerprint.restype = _error_code
 
 
751
    # Remove non-public functions
 
 
752
    del _error_code, _retry_on_error
 
 
753
# Create the global "gnutls" object, simulating a module
 
 
756
def call_pipe(connection,       # : multiprocessing.Connection
 
 
757
              func, *args, **kwargs):
 
 
758
    """This function is meant to be called by multiprocessing.Process
 
 
760
    This function runs func(*args, **kwargs), and writes the resulting
 
 
761
    return value on the provided multiprocessing.Connection.
 
 
763
    connection.send(func(*args, **kwargs))
 
167
766
class Client(object):
 
168
767
    """A representation of a client host served by this server.
 
170
 
    name:      string; from the config file, used in log messages
 
 
770
    approved:   bool(); 'None' if not yet approved/disapproved
 
 
771
    approval_delay: datetime.timedelta(); Time to wait for approval
 
 
772
    approval_duration: datetime.timedelta(); Duration of one approval
 
 
773
    checker:    subprocess.Popen(); a running checker process used
 
 
774
                                    to see if the client lives.
 
 
775
                                    'None' if no process is running.
 
 
776
    checker_callback_tag: a GLib event source tag, or None
 
 
777
    checker_command: string; External command which is run to check
 
 
778
                     if client lives.  %() expansions are done at
 
 
779
                     runtime with vars(self) as dict, so that for
 
 
780
                     instance %(name)s can be used in the command.
 
 
781
    checker_initiator_tag: a GLib event source tag, or None
 
 
782
    created:    datetime.datetime(); (UTC) object creation
 
 
783
    client_structure: Object describing what attributes a client has
 
 
784
                      and is used for storing the client at exit
 
 
785
    current_checker_command: string; current running checker_command
 
 
786
    disable_initiator_tag: a GLib event source tag, or None
 
171
788
    fingerprint: string (40 or 32 hexadecimal digits); used to
 
172
789
                 uniquely identify the client
 
173
 
    secret:    bytestring; sent verbatim (over TLS) to client
 
174
 
    host:      string; available for use by the checker command
 
175
 
    created:   datetime.datetime(); object creation, not client host
 
176
 
    last_checked_ok: datetime.datetime() or None if not yet checked OK
 
177
 
    timeout:   datetime.timedelta(); How long from last_checked_ok
 
178
 
                                     until this client is invalid
 
179
 
    interval:  datetime.timedelta(); How often to start a new checker
 
180
 
    stop_hook: If set, called by stop() as stop_hook(self)
 
181
 
    checker:   subprocess.Popen(); a running checker process used
 
182
 
                                   to see if the client lives.
 
183
 
                                   'None' if no process is running.
 
184
 
    checker_initiator_tag: a gobject event source tag, or None
 
185
 
    stop_initiator_tag:    - '' -
 
186
 
    checker_callback_tag:  - '' -
 
187
 
    checker_command: string; External command which is run to check if
 
188
 
                     client lives.  %() expansions are done at
 
189
 
                     runtime with vars(self) as dict, so that for
 
190
 
                     instance %(name)s can be used in the command.
 
192
 
    _timeout: Real variable for 'timeout'
 
193
 
    _interval: Real variable for 'interval'
 
194
 
    _timeout_milliseconds: Used when calling gobject.timeout_add()
 
195
 
    _interval_milliseconds: - '' -
 
 
790
    host:       string; available for use by the checker command
 
 
791
    interval:   datetime.timedelta(); How often to start a new checker
 
 
792
    last_approval_request: datetime.datetime(); (UTC) or None
 
 
793
    last_checked_ok: datetime.datetime(); (UTC) or None
 
 
794
    last_checker_status: integer between 0 and 255 reflecting exit
 
 
795
                         status of last checker. -1 reflects crashed
 
 
796
                         checker, -2 means no checker completed yet.
 
 
797
    last_checker_signal: The signal which killed the last checker, if
 
 
798
                         last_checker_status is -1
 
 
799
    last_enabled: datetime.datetime(); (UTC) or None
 
 
800
    name:       string; from the config file, used in log messages and
 
 
802
    secret:     bytestring; sent verbatim (over TLS) to client
 
 
803
    timeout:    datetime.timedelta(); How long from last_checked_ok
 
 
804
                                      until this client is disabled
 
 
805
    extended_timeout:   extra long timeout when secret has been sent
 
 
806
    runtime_expansions: Allowed attributes for runtime expansion.
 
 
807
    expires:    datetime.datetime(); time (UTC) when a client will be
 
 
809
    server_settings: The server_settings dict from main()
 
197
 
    def _set_timeout(self, timeout):
 
198
 
        "Setter function for 'timeout' attribute"
 
199
 
        self._timeout = timeout
 
200
 
        self._timeout_milliseconds = ((self.timeout.days
 
201
 
                                       * 24 * 60 * 60 * 1000)
 
202
 
                                      + (self.timeout.seconds * 1000)
 
203
 
                                      + (self.timeout.microseconds
 
205
 
    timeout = property(lambda self: self._timeout,
 
208
 
    def _set_interval(self, interval):
 
209
 
        "Setter function for 'interval' attribute"
 
210
 
        self._interval = interval
 
211
 
        self._interval_milliseconds = ((self.interval.days
 
212
 
                                        * 24 * 60 * 60 * 1000)
 
213
 
                                       + (self.interval.seconds
 
215
 
                                       + (self.interval.microseconds
 
217
 
    interval = property(lambda self: self._interval,
 
220
 
    def __init__(self, name = None, stop_hook=None, config={}):
 
221
 
        """Note: the 'checker' key in 'config' sets the
 
222
 
        'checker_command' attribute and *not* the 'checker'
 
 
812
    runtime_expansions = ("approval_delay", "approval_duration",
 
 
813
                          "created", "enabled", "expires",
 
 
814
                          "fingerprint", "host", "interval",
 
 
815
                          "last_approval_request", "last_checked_ok",
 
 
816
                          "last_enabled", "name", "timeout")
 
 
819
        "extended_timeout": "PT15M",
 
 
821
        "checker": "fping -q -- %%(host)s",
 
 
823
        "approval_delay": "PT0S",
 
 
824
        "approval_duration": "PT1S",
 
 
825
        "approved_by_default": "True",
 
 
830
    def config_parser(config):
 
 
831
        """Construct a new dict of client settings of this form:
 
 
832
        { client_name: {setting_name: value, ...}, ...}
 
 
833
        with exceptions for any special settings as defined above.
 
 
834
        NOTE: Must be a pure function. Must return the same result
 
 
835
        value given the same arguments.
 
 
838
        for client_name in config.sections():
 
 
839
            section = dict(config.items(client_name))
 
 
840
            client = settings[client_name] = {}
 
 
842
            client["host"] = section["host"]
 
 
843
            # Reformat values from string types to Python types
 
 
844
            client["approved_by_default"] = config.getboolean(
 
 
845
                client_name, "approved_by_default")
 
 
846
            client["enabled"] = config.getboolean(client_name,
 
 
849
            # Uppercase and remove spaces from fingerprint for later
 
 
850
            # comparison purposes with return value from the
 
 
851
            # fingerprint() function
 
 
852
            client["fingerprint"] = (section["fingerprint"].upper()
 
 
854
            if "secret" in section:
 
 
855
                client["secret"] = codecs.decode(section["secret"]
 
 
858
            elif "secfile" in section:
 
 
859
                with open(os.path.expanduser(os.path.expandvars
 
 
860
                                             (section["secfile"])),
 
 
862
                    client["secret"] = secfile.read()
 
 
864
                raise TypeError("No secret or secfile for section {}"
 
 
866
            client["timeout"] = string_to_delta(section["timeout"])
 
 
867
            client["extended_timeout"] = string_to_delta(
 
 
868
                section["extended_timeout"])
 
 
869
            client["interval"] = string_to_delta(section["interval"])
 
 
870
            client["approval_delay"] = string_to_delta(
 
 
871
                section["approval_delay"])
 
 
872
            client["approval_duration"] = string_to_delta(
 
 
873
                section["approval_duration"])
 
 
874
            client["checker_command"] = section["checker"]
 
 
875
            client["last_approval_request"] = None
 
 
876
            client["last_checked_ok"] = None
 
 
877
            client["last_checker_status"] = -2
 
 
881
    def __init__(self, settings, name = None, server_settings=None):
 
225
 
        logger.debug(u"Creating client %r", self.name)
 
226
 
        # Uppercase and remove spaces from fingerprint for later
 
227
 
        # comparison purposes with return value from the fingerprint()
 
229
 
        self.fingerprint = config["fingerprint"].upper()\
 
231
 
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
 
232
 
        if "secret" in config:
 
233
 
            self.secret = config["secret"].decode(u"base64")
 
234
 
        elif "secfile" in config:
 
235
 
            sf = open(config["secfile"])
 
236
 
            self.secret = sf.read()
 
 
883
        if server_settings is None:
 
 
885
        self.server_settings = server_settings
 
 
886
        # adding all client settings
 
 
887
        for setting, value in settings.items():
 
 
888
            setattr(self, setting, value)
 
 
891
            if not hasattr(self, "last_enabled"):
 
 
892
                self.last_enabled = datetime.datetime.utcnow()
 
 
893
            if not hasattr(self, "expires"):
 
 
894
                self.expires = (datetime.datetime.utcnow()
 
239
 
            raise TypeError(u"No secret or secfile for client %s"
 
241
 
        self.host = config.get("host", "")
 
242
 
        self.created = datetime.datetime.now()
 
243
 
        self.last_checked_ok = None
 
244
 
        self.timeout = string_to_delta(config["timeout"])
 
245
 
        self.interval = string_to_delta(config["interval"])
 
246
 
        self.stop_hook = stop_hook
 
 
897
            self.last_enabled = None
 
 
900
        logger.debug("Creating client %r", self.name)
 
 
901
        logger.debug("  Fingerprint: %s", self.fingerprint)
 
 
902
        self.created = settings.get("created",
 
 
903
                                    datetime.datetime.utcnow())
 
 
905
        # attributes specific for this server instance
 
247
906
        self.checker = None
 
248
907
        self.checker_initiator_tag = None
 
249
 
        self.stop_initiator_tag = None
 
 
908
        self.disable_initiator_tag = None
 
250
909
        self.checker_callback_tag = None
 
251
 
        self.check_command = config["checker"]
 
 
910
        self.current_checker_command = None
 
 
912
        self.approvals_pending = 0
 
 
913
        self.changedstate = multiprocessing_manager.Condition(
 
 
914
            multiprocessing_manager.Lock())
 
 
915
        self.client_structure = [attr
 
 
916
                                 for attr in self.__dict__.keys()
 
 
917
                                 if not attr.startswith("_")]
 
 
918
        self.client_structure.append("client_structure")
 
 
920
        for name, t in inspect.getmembers(
 
 
921
                type(self), lambda obj: isinstance(obj, property)):
 
 
922
            if not name.startswith("_"):
 
 
923
                self.client_structure.append(name)
 
 
925
    # Send notice to process children that client state has changed
 
 
926
    def send_changedstate(self):
 
 
927
        with self.changedstate:
 
 
928
            self.changedstate.notify_all()
 
253
931
        """Start this client's checker and timeout hooks"""
 
 
932
        if getattr(self, "enabled", False):
 
 
935
        self.expires = datetime.datetime.utcnow() + self.timeout
 
 
937
        self.last_enabled = datetime.datetime.utcnow()
 
 
939
        self.send_changedstate()
 
 
941
    def disable(self, quiet=True):
 
 
942
        """Disable this client."""
 
 
943
        if not getattr(self, "enabled", False):
 
 
946
            logger.info("Disabling client %s", self.name)
 
 
947
        if getattr(self, "disable_initiator_tag", None) is not None:
 
 
948
            GLib.source_remove(self.disable_initiator_tag)
 
 
949
            self.disable_initiator_tag = None
 
 
951
        if getattr(self, "checker_initiator_tag", None) is not None:
 
 
952
            GLib.source_remove(self.checker_initiator_tag)
 
 
953
            self.checker_initiator_tag = None
 
 
957
            self.send_changedstate()
 
 
958
        # Do not run this again if called by a GLib.timeout_add
 
 
964
    def init_checker(self):
 
254
965
        # Schedule a new checker to be started an 'interval' from now,
 
255
966
        # and every interval from then on.
 
256
 
        self.checker_initiator_tag = gobject.timeout_add\
 
257
 
                                     (self._interval_milliseconds,
 
 
967
        if self.checker_initiator_tag is not None:
 
 
968
            GLib.source_remove(self.checker_initiator_tag)
 
 
969
        self.checker_initiator_tag = GLib.timeout_add(
 
 
970
            int(self.interval.total_seconds() * 1000),
 
 
972
        # Schedule a disable() when 'timeout' has passed
 
 
973
        if self.disable_initiator_tag is not None:
 
 
974
            GLib.source_remove(self.disable_initiator_tag)
 
 
975
        self.disable_initiator_tag = GLib.timeout_add(
 
 
976
            int(self.timeout.total_seconds() * 1000), self.disable)
 
259
977
        # Also start a new checker *right now*.
 
260
978
        self.start_checker()
 
261
 
        # Schedule a stop() when 'timeout' has passed
 
262
 
        self.stop_initiator_tag = gobject.timeout_add\
 
263
 
                                  (self._timeout_milliseconds,
 
267
 
        The possibility that a client might be restarted is left open,
 
268
 
        but not currently used."""
 
269
 
        # If this client doesn't have a secret, it is already stopped.
 
270
 
        if hasattr(self, "secret") and self.secret:
 
271
 
            logger.info(u"Stopping client %s", self.name)
 
275
 
        if getattr(self, "stop_initiator_tag", False):
 
276
 
            gobject.source_remove(self.stop_initiator_tag)
 
277
 
            self.stop_initiator_tag = None
 
278
 
        if getattr(self, "checker_initiator_tag", False):
 
279
 
            gobject.source_remove(self.checker_initiator_tag)
 
280
 
            self.checker_initiator_tag = None
 
284
 
        # Do not run this again if called by a gobject.timeout_add
 
287
 
        self.stop_hook = None
 
289
 
    def checker_callback(self, pid, condition):
 
 
980
    def checker_callback(self, source, condition, connection,
 
290
982
        """The checker has completed, so take appropriate actions."""
 
291
 
        now = datetime.datetime.now()
 
292
983
        self.checker_callback_tag = None
 
293
984
        self.checker = None
 
294
 
        if os.WIFEXITED(condition) \
 
295
 
               and (os.WEXITSTATUS(condition) == 0):
 
296
 
            logger.info(u"Checker for %(name)s succeeded",
 
298
 
            self.last_checked_ok = now
 
299
 
            gobject.source_remove(self.stop_initiator_tag)
 
300
 
            self.stop_initiator_tag = gobject.timeout_add\
 
301
 
                                      (self._timeout_milliseconds,
 
303
 
        elif not os.WIFEXITED(condition):
 
304
 
            logger.warning(u"Checker for %(name)s crashed?",
 
 
985
        # Read return code from connection (see call_pipe)
 
 
986
        returncode = connection.recv()
 
 
990
            self.last_checker_status = returncode
 
 
991
            self.last_checker_signal = None
 
 
992
            if self.last_checker_status == 0:
 
 
993
                logger.info("Checker for %(name)s succeeded",
 
 
997
                logger.info("Checker for %(name)s failed", vars(self))
 
 
999
            self.last_checker_status = -1
 
 
1000
            self.last_checker_signal = -returncode
 
 
1001
            logger.warning("Checker for %(name)s crashed?",
 
307
 
            logger.info(u"Checker for %(name)s failed",
 
 
1005
    def checked_ok(self):
 
 
1006
        """Assert that the client has been seen, alive and well."""
 
 
1007
        self.last_checked_ok = datetime.datetime.utcnow()
 
 
1008
        self.last_checker_status = 0
 
 
1009
        self.last_checker_signal = None
 
 
1012
    def bump_timeout(self, timeout=None):
 
 
1013
        """Bump up the timeout for this client."""
 
 
1015
            timeout = self.timeout
 
 
1016
        if self.disable_initiator_tag is not None:
 
 
1017
            GLib.source_remove(self.disable_initiator_tag)
 
 
1018
            self.disable_initiator_tag = None
 
 
1019
        if getattr(self, "enabled", False):
 
 
1020
            self.disable_initiator_tag = GLib.timeout_add(
 
 
1021
                int(timeout.total_seconds() * 1000), self.disable)
 
 
1022
            self.expires = datetime.datetime.utcnow() + timeout
 
 
1024
    def need_approval(self):
 
 
1025
        self.last_approval_request = datetime.datetime.utcnow()
 
309
1027
    def start_checker(self):
 
310
1028
        """Start a new checker subprocess if one is not running.
 
311
1030
        If a checker already exists, leave it running and do
 
313
1032
        # The reason for not killing a running checker is that if we
 
314
 
        # did that, then if a checker (for some reason) started
 
315
 
        # running slowly and taking more than 'interval' time, the
 
316
 
        # client would inevitably timeout, since no checker would get
 
317
 
        # a chance to run to completion.  If we instead leave running
 
 
1033
        # did that, and if a checker (for some reason) started running
 
 
1034
        # slowly and taking more than 'interval' time, then the client
 
 
1035
        # would inevitably timeout, since no checker would get a
 
 
1036
        # chance to run to completion.  If we instead leave running
 
318
1037
        # checkers alone, the checker would have to take more time
 
319
 
        # than 'timeout' for the client to be declared invalid, which
 
320
 
        # is as it should be.
 
 
1038
        # than 'timeout' for the client to be disabled, which is as it
 
 
1041
        if self.checker is not None and not self.checker.is_alive():
 
 
1042
            logger.warning("Checker was not alive; joining")
 
 
1045
        # Start a new checker if needed
 
321
1046
        if self.checker is None:
 
323
 
                # In case check_command has exactly one % operator
 
324
 
                command = self.check_command % self.host
 
326
 
                # Escape attributes for the shell
 
327
 
                escaped_attrs = dict((key, re.escape(str(val)))
 
329
 
                                     vars(self).iteritems())
 
331
 
                    command = self.check_command % escaped_attrs
 
332
 
                except TypeError, error:
 
333
 
                    logger.error(u'Could not format string "%s":'
 
334
 
                                 u' %s', self.check_command, error)
 
335
 
                    return True # Try again later
 
337
 
                logger.info(u"Starting checker %r for %s",
 
339
 
                self.checker = subprocess.Popen(command,
 
342
 
                self.checker_callback_tag = gobject.child_watch_add\
 
344
 
                                             self.checker_callback)
 
345
 
            except subprocess.OSError, error:
 
346
 
                logger.error(u"Failed to start subprocess: %s",
 
348
 
        # Re-run this periodically if run by gobject.timeout_add
 
 
1047
            # Escape attributes for the shell
 
 
1049
                attr: re.escape(str(getattr(self, attr)))
 
 
1050
                for attr in self.runtime_expansions }
 
 
1052
                command = self.checker_command % escaped_attrs
 
 
1053
            except TypeError as error:
 
 
1054
                logger.error('Could not format string "%s"',
 
 
1055
                             self.checker_command,
 
 
1057
                return True     # Try again later
 
 
1058
            self.current_checker_command = command
 
 
1059
            logger.info("Starting checker %r for %s", command,
 
 
1061
            # We don't need to redirect stdout and stderr, since
 
 
1062
            # in normal mode, that is already done by daemon(),
 
 
1063
            # and in debug mode we don't want to.  (Stdin is
 
 
1064
            # always replaced by /dev/null.)
 
 
1065
            # The exception is when not debugging but nevertheless
 
 
1066
            # running in the foreground; use the previously
 
 
1068
            popen_args = { "close_fds": True,
 
 
1071
            if (not self.server_settings["debug"]
 
 
1072
                and self.server_settings["foreground"]):
 
 
1073
                popen_args.update({"stdout": wnull,
 
 
1075
            pipe = multiprocessing.Pipe(duplex = False)
 
 
1076
            self.checker = multiprocessing.Process(
 
 
1078
                args = (pipe[1], subprocess.call, command),
 
 
1079
                kwargs = popen_args)
 
 
1080
            self.checker.start()
 
 
1081
            self.checker_callback_tag = GLib.io_add_watch(
 
 
1082
                pipe[0].fileno(), GLib.IO_IN,
 
 
1083
                self.checker_callback, pipe[0], command)
 
 
1084
        # Re-run this periodically if run by GLib.timeout_add
 
350
1087
    def stop_checker(self):
 
351
1088
        """Force the checker process, if any, to stop."""
 
352
1089
        if self.checker_callback_tag:
 
353
 
            gobject.source_remove(self.checker_callback_tag)
 
 
1090
            GLib.source_remove(self.checker_callback_tag)
 
354
1091
            self.checker_callback_tag = None
 
355
1092
        if getattr(self, "checker", None) is None:
 
357
 
        logger.debug(u"Stopping checker for %(name)s", vars(self))
 
359
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
361
 
            #if self.checker.poll() is None:
 
362
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
363
 
        except OSError, error:
 
364
 
            if error.errno != errno.ESRCH: # No such process
 
 
1094
        logger.debug("Stopping checker for %(name)s", vars(self))
 
 
1095
        self.checker.terminate()
 
366
1096
        self.checker = None
 
367
 
    def still_valid(self):
 
368
 
        """Has the timeout not yet passed for this client?"""
 
369
 
        now = datetime.datetime.now()
 
370
 
        if self.last_checked_ok is None:
 
371
 
            return now < (self.created + self.timeout)
 
373
 
            return now < (self.last_checked_ok + self.timeout)
 
376
 
def peer_certificate(session):
 
377
 
    "Return the peer's OpenPGP certificate as a bytestring"
 
378
 
    # If not an OpenPGP certificate...
 
379
 
    if gnutls.library.functions.gnutls_certificate_type_get\
 
380
 
            (session._c_object) \
 
381
 
           != gnutls.library.constants.GNUTLS_CRT_OPENPGP:
 
382
 
        # ...do the normal thing
 
383
 
        return session.peer_certificate
 
384
 
    list_size = ctypes.c_uint()
 
385
 
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
 
386
 
        (session._c_object, ctypes.byref(list_size))
 
387
 
    if list_size.value == 0:
 
390
 
    return ctypes.string_at(cert.data, cert.size)
 
393
 
def fingerprint(openpgp):
 
394
 
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
 
395
 
    # New GnuTLS "datum" with the OpenPGP public key
 
396
 
    datum = gnutls.library.types.gnutls_datum_t\
 
397
 
        (ctypes.cast(ctypes.c_char_p(openpgp),
 
398
 
                     ctypes.POINTER(ctypes.c_ubyte)),
 
399
 
         ctypes.c_uint(len(openpgp)))
 
400
 
    # New empty GnuTLS certificate
 
401
 
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
402
 
    gnutls.library.functions.gnutls_openpgp_crt_init\
 
404
 
    # Import the OpenPGP public key into the certificate
 
405
 
    gnutls.library.functions.gnutls_openpgp_crt_import\
 
406
 
                    (crt, ctypes.byref(datum),
 
407
 
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
408
 
    # New buffer for the fingerprint
 
409
 
    buffer = ctypes.create_string_buffer(20)
 
410
 
    buffer_length = ctypes.c_size_t()
 
411
 
    # Get the fingerprint from the certificate into the buffer
 
412
 
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
 
413
 
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
 
414
 
    # Deinit the certificate
 
415
 
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
416
 
    # Convert the buffer to a Python bytestring
 
417
 
    fpr = ctypes.string_at(buffer, buffer_length.value)
 
418
 
    # Convert the bytestring to hexadecimal notation
 
419
 
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
 
423
 
class tcp_handler(SocketServer.BaseRequestHandler, object):
 
424
 
    """A TCP request handler class.
 
425
 
    Instantiated by IPv6_TCPServer for each request to handle it.
 
 
1099
def dbus_service_property(dbus_interface,
 
 
1103
    """Decorators for marking methods of a DBusObjectWithProperties to
 
 
1104
    become properties on the D-Bus.
 
 
1106
    The decorated method will be called with no arguments by "Get"
 
 
1107
    and with one argument by "Set".
 
 
1109
    The parameters, where they are supported, are the same as
 
 
1110
    dbus.service.method, except there is only "signature", since the
 
 
1111
    type from Get() and the type sent to Set() is the same.
 
 
1113
    # Encoding deeply encoded byte arrays is not supported yet by the
 
 
1114
    # "Set" method, so we fail early here:
 
 
1115
    if byte_arrays and signature != "ay":
 
 
1116
        raise ValueError("Byte arrays not supported for non-'ay'"
 
 
1117
                         " signature {!r}".format(signature))
 
 
1119
    def decorator(func):
 
 
1120
        func._dbus_is_property = True
 
 
1121
        func._dbus_interface = dbus_interface
 
 
1122
        func._dbus_signature = signature
 
 
1123
        func._dbus_access = access
 
 
1124
        func._dbus_name = func.__name__
 
 
1125
        if func._dbus_name.endswith("_dbus_property"):
 
 
1126
            func._dbus_name = func._dbus_name[:-14]
 
 
1127
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
 
 
1133
def dbus_interface_annotations(dbus_interface):
 
 
1134
    """Decorator for marking functions returning interface annotations
 
 
1138
    @dbus_interface_annotations("org.example.Interface")
 
 
1139
    def _foo(self):  # Function name does not matter
 
 
1140
        return {"org.freedesktop.DBus.Deprecated": "true",
 
 
1141
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
 
1145
    def decorator(func):
 
 
1146
        func._dbus_is_interface = True
 
 
1147
        func._dbus_interface = dbus_interface
 
 
1148
        func._dbus_name = dbus_interface
 
 
1154
def dbus_annotations(annotations):
 
 
1155
    """Decorator to annotate D-Bus methods, signals or properties
 
 
1158
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
 
 
1159
                       "org.freedesktop.DBus.Property."
 
 
1160
                       "EmitsChangedSignal": "false"})
 
 
1161
    @dbus_service_property("org.example.Interface", signature="b",
 
 
1163
    def Property_dbus_property(self):
 
 
1164
        return dbus.Boolean(False)
 
 
1166
    See also the DBusObjectWithAnnotations class.
 
 
1169
    def decorator(func):
 
 
1170
        func._dbus_annotations = annotations
 
 
1176
class DBusPropertyException(dbus.exceptions.DBusException):
 
 
1177
    """A base class for D-Bus property-related exceptions
 
 
1182
class DBusPropertyAccessException(DBusPropertyException):
 
 
1183
    """A property's access permissions disallows an operation.
 
 
1188
class DBusPropertyNotFound(DBusPropertyException):
 
 
1189
    """An attempt was made to access a non-existing property.
 
 
1194
class DBusObjectWithAnnotations(dbus.service.Object):
 
 
1195
    """A D-Bus object with annotations.
 
 
1197
    Classes inheriting from this can use the dbus_annotations
 
 
1198
    decorator to add annotations to methods or signals.
 
 
1202
    def _is_dbus_thing(thing):
 
 
1203
        """Returns a function testing if an attribute is a D-Bus thing
 
 
1205
        If called like _is_dbus_thing("method") it returns a function
 
 
1206
        suitable for use as predicate to inspect.getmembers().
 
 
1208
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
 
 
1211
    def _get_all_dbus_things(self, thing):
 
 
1212
        """Returns a generator of (name, attribute) pairs
 
 
1214
        return ((getattr(athing.__get__(self), "_dbus_name", name),
 
 
1215
                 athing.__get__(self))
 
 
1216
                for cls in self.__class__.__mro__
 
 
1218
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
 
 
1220
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
 
1221
                         out_signature = "s",
 
 
1222
                         path_keyword = 'object_path',
 
 
1223
                         connection_keyword = 'connection')
 
 
1224
    def Introspect(self, object_path, connection):
 
 
1225
        """Overloading of standard D-Bus method.
 
 
1227
        Inserts annotation tags on methods and signals.
 
 
1229
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
 
1232
            document = xml.dom.minidom.parseString(xmlstring)
 
 
1234
            for if_tag in document.getElementsByTagName("interface"):
 
 
1235
                # Add annotation tags
 
 
1236
                for typ in ("method", "signal"):
 
 
1237
                    for tag in if_tag.getElementsByTagName(typ):
 
 
1239
                        for name, prop in (self.
 
 
1240
                                           _get_all_dbus_things(typ)):
 
 
1241
                            if (name == tag.getAttribute("name")
 
 
1242
                                and prop._dbus_interface
 
 
1243
                                == if_tag.getAttribute("name")):
 
 
1244
                                annots.update(getattr(
 
 
1245
                                    prop, "_dbus_annotations", {}))
 
 
1246
                        for name, value in annots.items():
 
 
1247
                            ann_tag = document.createElement(
 
 
1249
                            ann_tag.setAttribute("name", name)
 
 
1250
                            ann_tag.setAttribute("value", value)
 
 
1251
                            tag.appendChild(ann_tag)
 
 
1252
                # Add interface annotation tags
 
 
1253
                for annotation, value in dict(
 
 
1254
                    itertools.chain.from_iterable(
 
 
1255
                        annotations().items()
 
 
1256
                        for name, annotations
 
 
1257
                        in self._get_all_dbus_things("interface")
 
 
1258
                        if name == if_tag.getAttribute("name")
 
 
1260
                    ann_tag = document.createElement("annotation")
 
 
1261
                    ann_tag.setAttribute("name", annotation)
 
 
1262
                    ann_tag.setAttribute("value", value)
 
 
1263
                    if_tag.appendChild(ann_tag)
 
 
1264
                # Fix argument name for the Introspect method itself
 
 
1265
                if (if_tag.getAttribute("name")
 
 
1266
                                == dbus.INTROSPECTABLE_IFACE):
 
 
1267
                    for cn in if_tag.getElementsByTagName("method"):
 
 
1268
                        if cn.getAttribute("name") == "Introspect":
 
 
1269
                            for arg in cn.getElementsByTagName("arg"):
 
 
1270
                                if (arg.getAttribute("direction")
 
 
1272
                                    arg.setAttribute("name",
 
 
1274
            xmlstring = document.toxml("utf-8")
 
 
1276
        except (AttributeError, xml.dom.DOMException,
 
 
1277
                xml.parsers.expat.ExpatError) as error:
 
 
1278
            logger.error("Failed to override Introspection method",
 
 
1283
class DBusObjectWithProperties(DBusObjectWithAnnotations):
 
 
1284
    """A D-Bus object with properties.
 
 
1286
    Classes inheriting from this can use the dbus_service_property
 
 
1287
    decorator to expose methods as D-Bus properties.  It exposes the
 
 
1288
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
 
1291
    def _get_dbus_property(self, interface_name, property_name):
 
 
1292
        """Returns a bound method if one exists which is a D-Bus
 
 
1293
        property with the specified name and interface.
 
 
1295
        for cls in self.__class__.__mro__:
 
 
1296
            for name, value in inspect.getmembers(
 
 
1297
                    cls, self._is_dbus_thing("property")):
 
 
1298
                if (value._dbus_name == property_name
 
 
1299
                    and value._dbus_interface == interface_name):
 
 
1300
                    return value.__get__(self)
 
 
1303
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
 
1304
            self.dbus_object_path, interface_name, property_name))
 
 
1307
    def _get_all_interface_names(cls):
 
 
1308
        """Get a sequence of all interfaces supported by an object"""
 
 
1309
        return (name for name in set(getattr(getattr(x, attr),
 
 
1310
                                             "_dbus_interface", None)
 
 
1311
                                     for x in (inspect.getmro(cls))
 
 
1313
                if name is not None)
 
 
1315
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
 
1318
    def Get(self, interface_name, property_name):
 
 
1319
        """Standard D-Bus property Get() method, see D-Bus standard.
 
 
1321
        prop = self._get_dbus_property(interface_name, property_name)
 
 
1322
        if prop._dbus_access == "write":
 
 
1323
            raise DBusPropertyAccessException(property_name)
 
 
1325
        if not hasattr(value, "variant_level"):
 
 
1327
        return type(value)(value, variant_level=value.variant_level+1)
 
 
1329
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
 
 
1330
    def Set(self, interface_name, property_name, value):
 
 
1331
        """Standard D-Bus property Set() method, see D-Bus standard.
 
 
1333
        prop = self._get_dbus_property(interface_name, property_name)
 
 
1334
        if prop._dbus_access == "read":
 
 
1335
            raise DBusPropertyAccessException(property_name)
 
 
1336
        if prop._dbus_get_args_options["byte_arrays"]:
 
 
1337
            # The byte_arrays option is not supported yet on
 
 
1338
            # signatures other than "ay".
 
 
1339
            if prop._dbus_signature != "ay":
 
 
1340
                raise ValueError("Byte arrays not supported for non-"
 
 
1341
                                 "'ay' signature {!r}"
 
 
1342
                                 .format(prop._dbus_signature))
 
 
1343
            value = dbus.ByteArray(b''.join(chr(byte)
 
 
1347
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
 
1349
                         out_signature="a{sv}")
 
 
1350
    def GetAll(self, interface_name):
 
 
1351
        """Standard D-Bus property GetAll() method, see D-Bus
 
 
1354
        Note: Will not include properties with access="write".
 
 
1357
        for name, prop in self._get_all_dbus_things("property"):
 
 
1359
                and interface_name != prop._dbus_interface):
 
 
1360
                # Interface non-empty but did not match
 
 
1362
            # Ignore write-only properties
 
 
1363
            if prop._dbus_access == "write":
 
 
1366
            if not hasattr(value, "variant_level"):
 
 
1367
                properties[name] = value
 
 
1369
            properties[name] = type(value)(
 
 
1370
                value, variant_level = value.variant_level + 1)
 
 
1371
        return dbus.Dictionary(properties, signature="sv")
 
 
1373
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
 
 
1374
    def PropertiesChanged(self, interface_name, changed_properties,
 
 
1375
                          invalidated_properties):
 
 
1376
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
 
 
1381
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
 
1383
                         path_keyword='object_path',
 
 
1384
                         connection_keyword='connection')
 
 
1385
    def Introspect(self, object_path, connection):
 
 
1386
        """Overloading of standard D-Bus method.
 
 
1388
        Inserts property tags and interface annotation tags.
 
 
1390
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
 
1394
            document = xml.dom.minidom.parseString(xmlstring)
 
 
1396
            def make_tag(document, name, prop):
 
 
1397
                e = document.createElement("property")
 
 
1398
                e.setAttribute("name", name)
 
 
1399
                e.setAttribute("type", prop._dbus_signature)
 
 
1400
                e.setAttribute("access", prop._dbus_access)
 
 
1403
            for if_tag in document.getElementsByTagName("interface"):
 
 
1405
                for tag in (make_tag(document, name, prop)
 
 
1407
                            in self._get_all_dbus_things("property")
 
 
1408
                            if prop._dbus_interface
 
 
1409
                            == if_tag.getAttribute("name")):
 
 
1410
                    if_tag.appendChild(tag)
 
 
1411
                # Add annotation tags for properties
 
 
1412
                for tag in if_tag.getElementsByTagName("property"):
 
 
1414
                    for name, prop in self._get_all_dbus_things(
 
 
1416
                        if (name == tag.getAttribute("name")
 
 
1417
                            and prop._dbus_interface
 
 
1418
                            == if_tag.getAttribute("name")):
 
 
1419
                            annots.update(getattr(
 
 
1420
                                prop, "_dbus_annotations", {}))
 
 
1421
                    for name, value in annots.items():
 
 
1422
                        ann_tag = document.createElement(
 
 
1424
                        ann_tag.setAttribute("name", name)
 
 
1425
                        ann_tag.setAttribute("value", value)
 
 
1426
                        tag.appendChild(ann_tag)
 
 
1427
                # Add the names to the return values for the
 
 
1428
                # "org.freedesktop.DBus.Properties" methods
 
 
1429
                if (if_tag.getAttribute("name")
 
 
1430
                    == "org.freedesktop.DBus.Properties"):
 
 
1431
                    for cn in if_tag.getElementsByTagName("method"):
 
 
1432
                        if cn.getAttribute("name") == "Get":
 
 
1433
                            for arg in cn.getElementsByTagName("arg"):
 
 
1434
                                if (arg.getAttribute("direction")
 
 
1436
                                    arg.setAttribute("name", "value")
 
 
1437
                        elif cn.getAttribute("name") == "GetAll":
 
 
1438
                            for arg in cn.getElementsByTagName("arg"):
 
 
1439
                                if (arg.getAttribute("direction")
 
 
1441
                                    arg.setAttribute("name", "props")
 
 
1442
            xmlstring = document.toxml("utf-8")
 
 
1444
        except (AttributeError, xml.dom.DOMException,
 
 
1445
                xml.parsers.expat.ExpatError) as error:
 
 
1446
            logger.error("Failed to override Introspection method",
 
 
1451
    dbus.OBJECT_MANAGER_IFACE
 
 
1452
except AttributeError:
 
 
1453
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
 
1455
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
 
 
1456
    """A D-Bus object with an ObjectManager.
 
 
1458
    Classes inheriting from this exposes the standard
 
 
1459
    GetManagedObjects call and the InterfacesAdded and
 
 
1460
    InterfacesRemoved signals on the standard
 
 
1461
    "org.freedesktop.DBus.ObjectManager" interface.
 
 
1463
    Note: No signals are sent automatically; they must be sent
 
 
1466
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
 
1467
                         out_signature = "a{oa{sa{sv}}}")
 
 
1468
    def GetManagedObjects(self):
 
 
1469
        """This function must be overridden"""
 
 
1470
        raise NotImplementedError()
 
 
1472
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
 
 
1473
                         signature = "oa{sa{sv}}")
 
 
1474
    def InterfacesAdded(self, object_path, interfaces_and_properties):
 
 
1477
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
 
 
1478
    def InterfacesRemoved(self, object_path, interfaces):
 
 
1481
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
 
1482
                         out_signature = "s",
 
 
1483
                         path_keyword = 'object_path',
 
 
1484
                         connection_keyword = 'connection')
 
 
1485
    def Introspect(self, object_path, connection):
 
 
1486
        """Overloading of standard D-Bus method.
 
 
1488
        Override return argument name of GetManagedObjects to be
 
 
1489
        "objpath_interfaces_and_properties"
 
 
1491
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
 
1495
            document = xml.dom.minidom.parseString(xmlstring)
 
 
1497
            for if_tag in document.getElementsByTagName("interface"):
 
 
1498
                # Fix argument name for the GetManagedObjects method
 
 
1499
                if (if_tag.getAttribute("name")
 
 
1500
                                == dbus.OBJECT_MANAGER_IFACE):
 
 
1501
                    for cn in if_tag.getElementsByTagName("method"):
 
 
1502
                        if (cn.getAttribute("name")
 
 
1503
                            == "GetManagedObjects"):
 
 
1504
                            for arg in cn.getElementsByTagName("arg"):
 
 
1505
                                if (arg.getAttribute("direction")
 
 
1509
                                        "objpath_interfaces"
 
 
1511
            xmlstring = document.toxml("utf-8")
 
 
1513
        except (AttributeError, xml.dom.DOMException,
 
 
1514
                xml.parsers.expat.ExpatError) as error:
 
 
1515
            logger.error("Failed to override Introspection method",
 
 
1519
def datetime_to_dbus(dt, variant_level=0):
 
 
1520
    """Convert a UTC datetime.datetime() to a D-Bus type."""
 
 
1522
        return dbus.String("", variant_level = variant_level)
 
 
1523
    return dbus.String(dt.isoformat(), variant_level=variant_level)
 
 
1526
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
 
1527
    """A class decorator; applied to a subclass of
 
 
1528
    dbus.service.Object, it will add alternate D-Bus attributes with
 
 
1529
    interface names according to the "alt_interface_names" mapping.
 
 
1532
    @alternate_dbus_interfaces({"org.example.Interface":
 
 
1533
                                    "net.example.AlternateInterface"})
 
 
1534
    class SampleDBusObject(dbus.service.Object):
 
 
1535
        @dbus.service.method("org.example.Interface")
 
 
1536
        def SampleDBusMethod():
 
 
1539
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
 
1540
    reachable via two interfaces: "org.example.Interface" and
 
 
1541
    "net.example.AlternateInterface", the latter of which will have
 
 
1542
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
 
1543
    "true", unless "deprecate" is passed with a False value.
 
 
1545
    This works for methods and signals, and also for D-Bus properties
 
 
1546
    (from DBusObjectWithProperties) and interfaces (from the
 
 
1547
    dbus_interface_annotations decorator).
 
 
1551
        for orig_interface_name, alt_interface_name in (
 
 
1552
                alt_interface_names.items()):
 
 
1554
            interface_names = set()
 
 
1555
            # Go though all attributes of the class
 
 
1556
            for attrname, attribute in inspect.getmembers(cls):
 
 
1557
                # Ignore non-D-Bus attributes, and D-Bus attributes
 
 
1558
                # with the wrong interface name
 
 
1559
                if (not hasattr(attribute, "_dbus_interface")
 
 
1560
                    or not attribute._dbus_interface.startswith(
 
 
1561
                        orig_interface_name)):
 
 
1563
                # Create an alternate D-Bus interface name based on
 
 
1565
                alt_interface = attribute._dbus_interface.replace(
 
 
1566
                    orig_interface_name, alt_interface_name)
 
 
1567
                interface_names.add(alt_interface)
 
 
1568
                # Is this a D-Bus signal?
 
 
1569
                if getattr(attribute, "_dbus_is_signal", False):
 
 
1570
                    # Extract the original non-method undecorated
 
 
1571
                    # function by black magic
 
 
1572
                    if sys.version_info.major == 2:
 
 
1573
                        nonmethod_func = (dict(
 
 
1574
                            zip(attribute.func_code.co_freevars,
 
 
1575
                                attribute.__closure__))
 
 
1576
                                          ["func"].cell_contents)
 
 
1578
                        nonmethod_func = (dict(
 
 
1579
                            zip(attribute.__code__.co_freevars,
 
 
1580
                                attribute.__closure__))
 
 
1581
                                          ["func"].cell_contents)
 
 
1582
                    # Create a new, but exactly alike, function
 
 
1583
                    # object, and decorate it to be a new D-Bus signal
 
 
1584
                    # with the alternate D-Bus interface name
 
 
1585
                    new_function = copy_function(nonmethod_func)
 
 
1586
                    new_function = (dbus.service.signal(
 
 
1588
                        attribute._dbus_signature)(new_function))
 
 
1589
                    # Copy annotations, if any
 
 
1591
                        new_function._dbus_annotations = dict(
 
 
1592
                            attribute._dbus_annotations)
 
 
1593
                    except AttributeError:
 
 
1595
                    # Define a creator of a function to call both the
 
 
1596
                    # original and alternate functions, so both the
 
 
1597
                    # original and alternate signals gets sent when
 
 
1598
                    # the function is called
 
 
1599
                    def fixscope(func1, func2):
 
 
1600
                        """This function is a scope container to pass
 
 
1601
                        func1 and func2 to the "call_both" function
 
 
1602
                        outside of its arguments"""
 
 
1604
                        @functools.wraps(func2)
 
 
1605
                        def call_both(*args, **kwargs):
 
 
1606
                            """This function will emit two D-Bus
 
 
1607
                            signals by calling func1 and func2"""
 
 
1608
                            func1(*args, **kwargs)
 
 
1609
                            func2(*args, **kwargs)
 
 
1610
                        # Make wrapper function look like a D-Bus signal
 
 
1611
                        for name, attr in inspect.getmembers(func2):
 
 
1612
                            if name.startswith("_dbus_"):
 
 
1613
                                setattr(call_both, name, attr)
 
 
1616
                    # Create the "call_both" function and add it to
 
 
1618
                    attr[attrname] = fixscope(attribute, new_function)
 
 
1619
                # Is this a D-Bus method?
 
 
1620
                elif getattr(attribute, "_dbus_is_method", False):
 
 
1621
                    # Create a new, but exactly alike, function
 
 
1622
                    # object.  Decorate it to be a new D-Bus method
 
 
1623
                    # with the alternate D-Bus interface name.  Add it
 
 
1626
                        dbus.service.method(
 
 
1628
                            attribute._dbus_in_signature,
 
 
1629
                            attribute._dbus_out_signature)
 
 
1630
                        (copy_function(attribute)))
 
 
1631
                    # Copy annotations, if any
 
 
1633
                        attr[attrname]._dbus_annotations = dict(
 
 
1634
                            attribute._dbus_annotations)
 
 
1635
                    except AttributeError:
 
 
1637
                # Is this a D-Bus property?
 
 
1638
                elif getattr(attribute, "_dbus_is_property", False):
 
 
1639
                    # Create a new, but exactly alike, function
 
 
1640
                    # object, and decorate it to be a new D-Bus
 
 
1641
                    # property with the alternate D-Bus interface
 
 
1642
                    # name.  Add it to the class.
 
 
1643
                    attr[attrname] = (dbus_service_property(
 
 
1644
                        alt_interface, attribute._dbus_signature,
 
 
1645
                        attribute._dbus_access,
 
 
1646
                        attribute._dbus_get_args_options
 
 
1648
                                      (copy_function(attribute)))
 
 
1649
                    # Copy annotations, if any
 
 
1651
                        attr[attrname]._dbus_annotations = dict(
 
 
1652
                            attribute._dbus_annotations)
 
 
1653
                    except AttributeError:
 
 
1655
                # Is this a D-Bus interface?
 
 
1656
                elif getattr(attribute, "_dbus_is_interface", False):
 
 
1657
                    # Create a new, but exactly alike, function
 
 
1658
                    # object.  Decorate it to be a new D-Bus interface
 
 
1659
                    # with the alternate D-Bus interface name.  Add it
 
 
1662
                        dbus_interface_annotations(alt_interface)
 
 
1663
                        (copy_function(attribute)))
 
 
1665
                # Deprecate all alternate interfaces
 
 
1666
                iname="_AlternateDBusNames_interface_annotation{}"
 
 
1667
                for interface_name in interface_names:
 
 
1669
                    @dbus_interface_annotations(interface_name)
 
 
1671
                        return { "org.freedesktop.DBus.Deprecated":
 
 
1673
                    # Find an unused name
 
 
1674
                    for aname in (iname.format(i)
 
 
1675
                                  for i in itertools.count()):
 
 
1676
                        if aname not in attr:
 
 
1680
                # Replace the class with a new subclass of it with
 
 
1681
                # methods, signals, etc. as created above.
 
 
1682
                if sys.version_info.major == 2:
 
 
1683
                    cls = type(b"{}Alternate".format(cls.__name__),
 
 
1686
                    cls = type("{}Alternate".format(cls.__name__),
 
 
1693
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
 
1694
                            "se.bsnet.fukt.Mandos"})
 
 
1695
class ClientDBus(Client, DBusObjectWithProperties):
 
 
1696
    """A Client class using D-Bus
 
 
1699
    dbus_object_path: dbus.ObjectPath
 
 
1700
    bus: dbus.SystemBus()
 
 
1703
    runtime_expansions = (Client.runtime_expansions
 
 
1704
                          + ("dbus_object_path", ))
 
 
1706
    _interface = "se.recompile.Mandos.Client"
 
 
1708
    # dbus.service.Object doesn't use super(), so we can't either.
 
 
1710
    def __init__(self, bus = None, *args, **kwargs):
 
 
1712
        Client.__init__(self, *args, **kwargs)
 
 
1713
        # Only now, when this client is initialized, can it show up on
 
 
1715
        client_object_name = str(self.name).translate(
 
 
1716
            {ord("."): ord("_"),
 
 
1717
             ord("-"): ord("_")})
 
 
1718
        self.dbus_object_path = dbus.ObjectPath(
 
 
1719
            "/clients/" + client_object_name)
 
 
1720
        DBusObjectWithProperties.__init__(self, self.bus,
 
 
1721
                                          self.dbus_object_path)
 
 
1723
    def notifychangeproperty(transform_func, dbus_name,
 
 
1724
                             type_func=lambda x: x,
 
 
1726
                             invalidate_only=False,
 
 
1727
                             _interface=_interface):
 
 
1728
        """ Modify a variable so that it's a property which announces
 
 
1729
        its changes to DBus.
 
 
1731
        transform_fun: Function that takes a value and a variant_level
 
 
1732
                       and transforms it to a D-Bus type.
 
 
1733
        dbus_name: D-Bus name of the variable
 
 
1734
        type_func: Function that transform the value before sending it
 
 
1735
                   to the D-Bus.  Default: no transform
 
 
1736
        variant_level: D-Bus variant level.  Default: 1
 
 
1738
        attrname = "_{}".format(dbus_name)
 
 
1740
        def setter(self, value):
 
 
1741
            if hasattr(self, "dbus_object_path"):
 
 
1742
                if (not hasattr(self, attrname) or
 
 
1743
                    type_func(getattr(self, attrname, None))
 
 
1744
                    != type_func(value)):
 
 
1746
                        self.PropertiesChanged(
 
 
1747
                            _interface, dbus.Dictionary(),
 
 
1748
                            dbus.Array((dbus_name, )))
 
 
1750
                        dbus_value = transform_func(
 
 
1752
                            variant_level = variant_level)
 
 
1753
                        self.PropertyChanged(dbus.String(dbus_name),
 
 
1755
                        self.PropertiesChanged(
 
 
1757
                            dbus.Dictionary({ dbus.String(dbus_name):
 
 
1760
            setattr(self, attrname, value)
 
 
1762
        return property(lambda self: getattr(self, attrname), setter)
 
 
1764
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
 
 
1765
    approvals_pending = notifychangeproperty(dbus.Boolean,
 
 
1768
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
 
 
1769
    last_enabled = notifychangeproperty(datetime_to_dbus,
 
 
1771
    checker = notifychangeproperty(
 
 
1772
        dbus.Boolean, "CheckerRunning",
 
 
1773
        type_func = lambda checker: checker is not None)
 
 
1774
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
 
 
1776
    last_checker_status = notifychangeproperty(dbus.Int16,
 
 
1777
                                               "LastCheckerStatus")
 
 
1778
    last_approval_request = notifychangeproperty(
 
 
1779
        datetime_to_dbus, "LastApprovalRequest")
 
 
1780
    approved_by_default = notifychangeproperty(dbus.Boolean,
 
 
1781
                                               "ApprovedByDefault")
 
 
1782
    approval_delay = notifychangeproperty(
 
 
1783
        dbus.UInt64, "ApprovalDelay",
 
 
1784
        type_func = lambda td: td.total_seconds() * 1000)
 
 
1785
    approval_duration = notifychangeproperty(
 
 
1786
        dbus.UInt64, "ApprovalDuration",
 
 
1787
        type_func = lambda td: td.total_seconds() * 1000)
 
 
1788
    host = notifychangeproperty(dbus.String, "Host")
 
 
1789
    timeout = notifychangeproperty(
 
 
1790
        dbus.UInt64, "Timeout",
 
 
1791
        type_func = lambda td: td.total_seconds() * 1000)
 
 
1792
    extended_timeout = notifychangeproperty(
 
 
1793
        dbus.UInt64, "ExtendedTimeout",
 
 
1794
        type_func = lambda td: td.total_seconds() * 1000)
 
 
1795
    interval = notifychangeproperty(
 
 
1796
        dbus.UInt64, "Interval",
 
 
1797
        type_func = lambda td: td.total_seconds() * 1000)
 
 
1798
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
 
1799
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
 
1800
                                  invalidate_only=True)
 
 
1802
    del notifychangeproperty
 
 
1804
    def __del__(self, *args, **kwargs):
 
 
1806
            self.remove_from_connection()
 
 
1809
        if hasattr(DBusObjectWithProperties, "__del__"):
 
 
1810
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
 
 
1811
        Client.__del__(self, *args, **kwargs)
 
 
1813
    def checker_callback(self, source, condition,
 
 
1814
                         connection, command, *args, **kwargs):
 
 
1815
        ret = Client.checker_callback(self, source, condition,
 
 
1816
                                      connection, command, *args,
 
 
1818
        exitstatus = self.last_checker_status
 
 
1821
            self.CheckerCompleted(dbus.Int16(exitstatus),
 
 
1822
                                  # This is specific to GNU libC
 
 
1823
                                  dbus.Int64(exitstatus << 8),
 
 
1824
                                  dbus.String(command))
 
 
1827
            self.CheckerCompleted(dbus.Int16(-1),
 
 
1829
                                      # This is specific to GNU libC
 
 
1831
                                      | self.last_checker_signal),
 
 
1832
                                  dbus.String(command))
 
 
1835
    def start_checker(self, *args, **kwargs):
 
 
1836
        old_checker_pid = getattr(self.checker, "pid", None)
 
 
1837
        r = Client.start_checker(self, *args, **kwargs)
 
 
1838
        # Only if new checker process was started
 
 
1839
        if (self.checker is not None
 
 
1840
            and old_checker_pid != self.checker.pid):
 
 
1842
            self.CheckerStarted(self.current_checker_command)
 
 
1845
    def _reset_approved(self):
 
 
1846
        self.approved = None
 
 
1849
    def approve(self, value=True):
 
 
1850
        self.approved = value
 
 
1851
        GLib.timeout_add(int(self.approval_duration.total_seconds()
 
 
1852
                             * 1000), self._reset_approved)
 
 
1853
        self.send_changedstate()
 
 
1855
    ## D-Bus methods, signals & properties
 
 
1861
    # CheckerCompleted - signal
 
 
1862
    @dbus.service.signal(_interface, signature="nxs")
 
 
1863
    def CheckerCompleted(self, exitcode, waitstatus, command):
 
 
1867
    # CheckerStarted - signal
 
 
1868
    @dbus.service.signal(_interface, signature="s")
 
 
1869
    def CheckerStarted(self, command):
 
 
1873
    # PropertyChanged - signal
 
 
1874
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
 
 
1875
    @dbus.service.signal(_interface, signature="sv")
 
 
1876
    def PropertyChanged(self, property, value):
 
 
1880
    # GotSecret - signal
 
 
1881
    @dbus.service.signal(_interface)
 
 
1882
    def GotSecret(self):
 
 
1884
        Is sent after a successful transfer of secret from the Mandos
 
 
1885
        server to mandos-client
 
 
1890
    @dbus.service.signal(_interface, signature="s")
 
 
1891
    def Rejected(self, reason):
 
 
1895
    # NeedApproval - signal
 
 
1896
    @dbus.service.signal(_interface, signature="tb")
 
 
1897
    def NeedApproval(self, timeout, default):
 
 
1899
        return self.need_approval()
 
 
1904
    @dbus.service.method(_interface, in_signature="b")
 
 
1905
    def Approve(self, value):
 
 
1908
    # CheckedOK - method
 
 
1909
    @dbus.service.method(_interface)
 
 
1910
    def CheckedOK(self):
 
 
1914
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
 
 
1915
    @dbus.service.method(_interface)
 
 
1920
    # StartChecker - method
 
 
1921
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
 
 
1922
    @dbus.service.method(_interface)
 
 
1923
    def StartChecker(self):
 
 
1925
        self.start_checker()
 
 
1928
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
 
 
1929
    @dbus.service.method(_interface)
 
 
1934
    # StopChecker - method
 
 
1935
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
 
 
1936
    @dbus.service.method(_interface)
 
 
1937
    def StopChecker(self):
 
 
1942
    # ApprovalPending - property
 
 
1943
    @dbus_service_property(_interface, signature="b", access="read")
 
 
1944
    def ApprovalPending_dbus_property(self):
 
 
1945
        return dbus.Boolean(bool(self.approvals_pending))
 
 
1947
    # ApprovedByDefault - property
 
 
1948
    @dbus_service_property(_interface,
 
 
1951
    def ApprovedByDefault_dbus_property(self, value=None):
 
 
1952
        if value is None:       # get
 
 
1953
            return dbus.Boolean(self.approved_by_default)
 
 
1954
        self.approved_by_default = bool(value)
 
 
1956
    # ApprovalDelay - property
 
 
1957
    @dbus_service_property(_interface,
 
 
1960
    def ApprovalDelay_dbus_property(self, value=None):
 
 
1961
        if value is None:       # get
 
 
1962
            return dbus.UInt64(self.approval_delay.total_seconds()
 
 
1964
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
 
 
1966
    # ApprovalDuration - property
 
 
1967
    @dbus_service_property(_interface,
 
 
1970
    def ApprovalDuration_dbus_property(self, value=None):
 
 
1971
        if value is None:       # get
 
 
1972
            return dbus.UInt64(self.approval_duration.total_seconds()
 
 
1974
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
 
 
1978
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
 
 
1979
    @dbus_service_property(_interface, signature="s", access="read")
 
 
1980
    def Name_dbus_property(self):
 
 
1981
        return dbus.String(self.name)
 
 
1983
    # Fingerprint - property
 
 
1985
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
 
 
1986
    @dbus_service_property(_interface, signature="s", access="read")
 
 
1987
    def Fingerprint_dbus_property(self):
 
 
1988
        return dbus.String(self.fingerprint)
 
 
1991
    @dbus_service_property(_interface,
 
 
1994
    def Host_dbus_property(self, value=None):
 
 
1995
        if value is None:       # get
 
 
1996
            return dbus.String(self.host)
 
 
1997
        self.host = str(value)
 
 
1999
    # Created - property
 
 
2001
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
 
 
2002
    @dbus_service_property(_interface, signature="s", access="read")
 
 
2003
    def Created_dbus_property(self):
 
 
2004
        return datetime_to_dbus(self.created)
 
 
2006
    # LastEnabled - property
 
 
2007
    @dbus_service_property(_interface, signature="s", access="read")
 
 
2008
    def LastEnabled_dbus_property(self):
 
 
2009
        return datetime_to_dbus(self.last_enabled)
 
 
2011
    # Enabled - property
 
 
2012
    @dbus_service_property(_interface,
 
 
2015
    def Enabled_dbus_property(self, value=None):
 
 
2016
        if value is None:       # get
 
 
2017
            return dbus.Boolean(self.enabled)
 
 
2023
    # LastCheckedOK - property
 
 
2024
    @dbus_service_property(_interface,
 
 
2027
    def LastCheckedOK_dbus_property(self, value=None):
 
 
2028
        if value is not None:
 
 
2031
        return datetime_to_dbus(self.last_checked_ok)
 
 
2033
    # LastCheckerStatus - property
 
 
2034
    @dbus_service_property(_interface, signature="n", access="read")
 
 
2035
    def LastCheckerStatus_dbus_property(self):
 
 
2036
        return dbus.Int16(self.last_checker_status)
 
 
2038
    # Expires - property
 
 
2039
    @dbus_service_property(_interface, signature="s", access="read")
 
 
2040
    def Expires_dbus_property(self):
 
 
2041
        return datetime_to_dbus(self.expires)
 
 
2043
    # LastApprovalRequest - property
 
 
2044
    @dbus_service_property(_interface, signature="s", access="read")
 
 
2045
    def LastApprovalRequest_dbus_property(self):
 
 
2046
        return datetime_to_dbus(self.last_approval_request)
 
 
2048
    # Timeout - property
 
 
2049
    @dbus_service_property(_interface,
 
 
2052
    def Timeout_dbus_property(self, value=None):
 
 
2053
        if value is None:       # get
 
 
2054
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
 
2055
        old_timeout = self.timeout
 
 
2056
        self.timeout = datetime.timedelta(0, 0, 0, value)
 
 
2057
        # Reschedule disabling
 
 
2059
            now = datetime.datetime.utcnow()
 
 
2060
            self.expires += self.timeout - old_timeout
 
 
2061
            if self.expires <= now:
 
 
2062
                # The timeout has passed
 
 
2065
                if (getattr(self, "disable_initiator_tag", None)
 
 
2068
                GLib.source_remove(self.disable_initiator_tag)
 
 
2069
                self.disable_initiator_tag = GLib.timeout_add(
 
 
2070
                    int((self.expires - now).total_seconds() * 1000),
 
 
2073
    # ExtendedTimeout - property
 
 
2074
    @dbus_service_property(_interface,
 
 
2077
    def ExtendedTimeout_dbus_property(self, value=None):
 
 
2078
        if value is None:       # get
 
 
2079
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
 
2081
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
 
 
2083
    # Interval - property
 
 
2084
    @dbus_service_property(_interface,
 
 
2087
    def Interval_dbus_property(self, value=None):
 
 
2088
        if value is None:       # get
 
 
2089
            return dbus.UInt64(self.interval.total_seconds() * 1000)
 
 
2090
        self.interval = datetime.timedelta(0, 0, 0, value)
 
 
2091
        if getattr(self, "checker_initiator_tag", None) is None:
 
 
2094
            # Reschedule checker run
 
 
2095
            GLib.source_remove(self.checker_initiator_tag)
 
 
2096
            self.checker_initiator_tag = GLib.timeout_add(
 
 
2097
                value, self.start_checker)
 
 
2098
            self.start_checker() # Start one now, too
 
 
2100
    # Checker - property
 
 
2101
    @dbus_service_property(_interface,
 
 
2104
    def Checker_dbus_property(self, value=None):
 
 
2105
        if value is None:       # get
 
 
2106
            return dbus.String(self.checker_command)
 
 
2107
        self.checker_command = str(value)
 
 
2109
    # CheckerRunning - property
 
 
2110
    @dbus_service_property(_interface,
 
 
2113
    def CheckerRunning_dbus_property(self, value=None):
 
 
2114
        if value is None:       # get
 
 
2115
            return dbus.Boolean(self.checker is not None)
 
 
2117
            self.start_checker()
 
 
2121
    # ObjectPath - property
 
 
2123
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
 
2124
         "org.freedesktop.DBus.Deprecated": "true"})
 
 
2125
    @dbus_service_property(_interface, signature="o", access="read")
 
 
2126
    def ObjectPath_dbus_property(self):
 
 
2127
        return self.dbus_object_path # is already a dbus.ObjectPath
 
 
2131
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
 
 
2133
    @dbus_service_property(_interface,
 
 
2137
    def Secret_dbus_property(self, value):
 
 
2138
        self.secret = bytes(value)
 
 
2143
class ProxyClient(object):
 
 
2144
    def __init__(self, child_pipe, fpr, address):
 
 
2145
        self._pipe = child_pipe
 
 
2146
        self._pipe.send(('init', fpr, address))
 
 
2147
        if not self._pipe.recv():
 
 
2150
    def __getattribute__(self, name):
 
 
2152
            return super(ProxyClient, self).__getattribute__(name)
 
 
2153
        self._pipe.send(('getattr', name))
 
 
2154
        data = self._pipe.recv()
 
 
2155
        if data[0] == 'data':
 
 
2157
        if data[0] == 'function':
 
 
2159
            def func(*args, **kwargs):
 
 
2160
                self._pipe.send(('funcall', name, args, kwargs))
 
 
2161
                return self._pipe.recv()[1]
 
 
2165
    def __setattr__(self, name, value):
 
 
2167
            return super(ProxyClient, self).__setattr__(name, value)
 
 
2168
        self._pipe.send(('setattr', name, value))
 
 
2171
class ClientHandler(socketserver.BaseRequestHandler, object):
 
 
2172
    """A class to handle client connections.
 
 
2174
    Instantiated once for each connection to handle it.
 
426
2175
    Note: This will run in its own forked process."""
 
428
2177
    def handle(self):
 
429
 
        logger.info(u"TCP connection from: %s",
 
430
 
                     unicode(self.client_address))
 
431
 
        session = gnutls.connection.ClientSession\
 
432
 
                  (self.request, gnutls.connection.X509Credentials())
 
434
 
        line = self.request.makefile().readline()
 
435
 
        logger.debug(u"Protocol version: %r", line)
 
437
 
            if int(line.strip().split()[0]) > 1:
 
439
 
        except (ValueError, IndexError, RuntimeError), error:
 
440
 
            logger.error(u"Unknown protocol version: %s", error)
 
443
 
        # Note: gnutls.connection.X509Credentials is really a generic
 
444
 
        # GnuTLS certificate credentials object so long as no X.509
 
445
 
        # keys are added to it.  Therefore, we can use it here despite
 
446
 
        # using OpenPGP certificates.
 
448
 
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
 
449
 
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
 
451
 
        priority = "NORMAL"             # Fallback default, since this
 
453
 
        if self.server.settings["priority"]:
 
454
 
            priority = self.server.settings["priority"]
 
455
 
        gnutls.library.functions.gnutls_priority_set_direct\
 
456
 
            (session._c_object, priority, None);
 
460
 
        except gnutls.errors.GNUTLSError, error:
 
461
 
            logger.warning(u"Handshake failed: %s", error)
 
462
 
            # Do not run session.bye() here: the session is not
 
463
 
            # established.  Just abandon the request.
 
466
 
            fpr = fingerprint(peer_certificate(session))
 
467
 
        except (TypeError, gnutls.errors.GNUTLSError), error:
 
468
 
            logger.warning(u"Bad certificate: %s", error)
 
471
 
        logger.debug(u"Fingerprint: %s", fpr)
 
473
 
        for c in self.server.clients:
 
474
 
            if c.fingerprint == fpr:
 
478
 
            logger.warning(u"Client not found for fingerprint: %s",
 
482
 
        # Have to check if client.still_valid(), since it is possible
 
483
 
        # that the client timed out while establishing the GnuTLS
 
485
 
        if not client.still_valid():
 
486
 
            logger.warning(u"Client %(name)s is invalid",
 
491
 
        while sent_size < len(client.secret):
 
492
 
            sent = session.send(client.secret[sent_size:])
 
493
 
            logger.debug(u"Sent: %d, remaining: %d",
 
494
 
                         sent, len(client.secret)
 
495
 
                         - (sent_size + sent))
 
500
 
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
 
501
 
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
 
 
2178
        with contextlib.closing(self.server.child_pipe) as child_pipe:
 
 
2179
            logger.info("TCP connection from: %s",
 
 
2180
                        str(self.client_address))
 
 
2181
            logger.debug("Pipe FD: %d",
 
 
2182
                         self.server.child_pipe.fileno())
 
 
2184
            session = gnutls.ClientSession(self.request)
 
 
2186
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
 
2187
            #                      "+AES-256-CBC", "+SHA1",
 
 
2188
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
 
 
2190
            # Use a fallback default, since this MUST be set.
 
 
2191
            priority = self.server.gnutls_priority
 
 
2192
            if priority is None:
 
 
2194
            gnutls.priority_set_direct(session._c_object,
 
 
2195
                                       priority.encode("utf-8"),
 
 
2198
            # Start communication using the Mandos protocol
 
 
2199
            # Get protocol number
 
 
2200
            line = self.request.makefile().readline()
 
 
2201
            logger.debug("Protocol version: %r", line)
 
 
2203
                if int(line.strip().split()[0]) > 1:
 
 
2204
                    raise RuntimeError(line)
 
 
2205
            except (ValueError, IndexError, RuntimeError) as error:
 
 
2206
                logger.error("Unknown protocol version: %s", error)
 
 
2209
            # Start GnuTLS connection
 
 
2212
            except gnutls.Error as error:
 
 
2213
                logger.warning("Handshake failed: %s", error)
 
 
2214
                # Do not run session.bye() here: the session is not
 
 
2215
                # established.  Just abandon the request.
 
 
2217
            logger.debug("Handshake succeeded")
 
 
2219
            approval_required = False
 
 
2222
                    fpr = self.fingerprint(
 
 
2223
                        self.peer_certificate(session))
 
 
2224
                except (TypeError, gnutls.Error) as error:
 
 
2225
                    logger.warning("Bad certificate: %s", error)
 
 
2227
                logger.debug("Fingerprint: %s", fpr)
 
 
2230
                    client = ProxyClient(child_pipe, fpr,
 
 
2231
                                         self.client_address)
 
 
2235
                if client.approval_delay:
 
 
2236
                    delay = client.approval_delay
 
 
2237
                    client.approvals_pending += 1
 
 
2238
                    approval_required = True
 
 
2241
                    if not client.enabled:
 
 
2242
                        logger.info("Client %s is disabled",
 
 
2244
                        if self.server.use_dbus:
 
 
2246
                            client.Rejected("Disabled")
 
 
2249
                    if client.approved or not client.approval_delay:
 
 
2250
                        #We are approved or approval is disabled
 
 
2252
                    elif client.approved is None:
 
 
2253
                        logger.info("Client %s needs approval",
 
 
2255
                        if self.server.use_dbus:
 
 
2257
                            client.NeedApproval(
 
 
2258
                                client.approval_delay.total_seconds()
 
 
2259
                                * 1000, client.approved_by_default)
 
 
2261
                        logger.warning("Client %s was not approved",
 
 
2263
                        if self.server.use_dbus:
 
 
2265
                            client.Rejected("Denied")
 
 
2268
                    #wait until timeout or approved
 
 
2269
                    time = datetime.datetime.now()
 
 
2270
                    client.changedstate.acquire()
 
 
2271
                    client.changedstate.wait(delay.total_seconds())
 
 
2272
                    client.changedstate.release()
 
 
2273
                    time2 = datetime.datetime.now()
 
 
2274
                    if (time2 - time) >= delay:
 
 
2275
                        if not client.approved_by_default:
 
 
2276
                            logger.warning("Client %s timed out while"
 
 
2277
                                           " waiting for approval",
 
 
2279
                            if self.server.use_dbus:
 
 
2281
                                client.Rejected("Approval timed out")
 
 
2286
                        delay -= time2 - time
 
 
2289
                    session.send(client.secret)
 
 
2290
                except gnutls.Error as error:
 
 
2291
                    logger.warning("gnutls send failed",
 
 
2295
                logger.info("Sending secret to %s", client.name)
 
 
2296
                # bump the timeout using extended_timeout
 
 
2297
                client.bump_timeout(client.extended_timeout)
 
 
2298
                if self.server.use_dbus:
 
 
2303
                if approval_required:
 
 
2304
                    client.approvals_pending -= 1
 
 
2307
                except gnutls.Error as error:
 
 
2308
                    logger.warning("GnuTLS bye failed",
 
 
2312
    def peer_certificate(session):
 
 
2313
        "Return the peer's OpenPGP certificate as a bytestring"
 
 
2314
        # If not an OpenPGP certificate...
 
 
2315
        if (gnutls.certificate_type_get(session._c_object)
 
 
2316
            != gnutls.CRT_OPENPGP):
 
 
2317
            # ...return invalid data
 
 
2319
        list_size = ctypes.c_uint(1)
 
 
2320
        cert_list = (gnutls.certificate_get_peers
 
 
2321
                     (session._c_object, ctypes.byref(list_size)))
 
 
2322
        if not bool(cert_list) and list_size.value != 0:
 
 
2323
            raise gnutls.Error("error getting peer certificate")
 
 
2324
        if list_size.value == 0:
 
 
2327
        return ctypes.string_at(cert.data, cert.size)
 
 
2330
    def fingerprint(openpgp):
 
 
2331
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
 
 
2332
        # New GnuTLS "datum" with the OpenPGP public key
 
 
2333
        datum = gnutls.datum_t(
 
 
2334
            ctypes.cast(ctypes.c_char_p(openpgp),
 
 
2335
                        ctypes.POINTER(ctypes.c_ubyte)),
 
 
2336
            ctypes.c_uint(len(openpgp)))
 
 
2337
        # New empty GnuTLS certificate
 
 
2338
        crt = gnutls.openpgp_crt_t()
 
 
2339
        gnutls.openpgp_crt_init(ctypes.byref(crt))
 
 
2340
        # Import the OpenPGP public key into the certificate
 
 
2341
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
 
2342
                                  gnutls.OPENPGP_FMT_RAW)
 
 
2343
        # Verify the self signature in the key
 
 
2344
        crtverify = ctypes.c_uint()
 
 
2345
        gnutls.openpgp_crt_verify_self(crt, 0,
 
 
2346
                                       ctypes.byref(crtverify))
 
 
2347
        if crtverify.value != 0:
 
 
2348
            gnutls.openpgp_crt_deinit(crt)
 
 
2349
            raise gnutls.CertificateSecurityError("Verify failed")
 
 
2350
        # New buffer for the fingerprint
 
 
2351
        buf = ctypes.create_string_buffer(20)
 
 
2352
        buf_len = ctypes.c_size_t()
 
 
2353
        # Get the fingerprint from the certificate into the buffer
 
 
2354
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
 
2355
                                           ctypes.byref(buf_len))
 
 
2356
        # Deinit the certificate
 
 
2357
        gnutls.openpgp_crt_deinit(crt)
 
 
2358
        # Convert the buffer to a Python bytestring
 
 
2359
        fpr = ctypes.string_at(buf, buf_len.value)
 
 
2360
        # Convert the bytestring to hexadecimal notation
 
 
2361
        hex_fpr = binascii.hexlify(fpr).upper()
 
 
2365
class MultiprocessingMixIn(object):
 
 
2366
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
 
2368
    def sub_process_main(self, request, address):
 
 
2370
            self.finish_request(request, address)
 
 
2372
            self.handle_error(request, address)
 
 
2373
        self.close_request(request)
 
 
2375
    def process_request(self, request, address):
 
 
2376
        """Start a new process to process the request."""
 
 
2377
        proc = multiprocessing.Process(target = self.sub_process_main,
 
 
2378
                                       args = (request, address))
 
 
2383
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
 
 
2384
    """ adds a pipe to the MixIn """
 
 
2386
    def process_request(self, request, client_address):
 
 
2387
        """Overrides and wraps the original process_request().
 
 
2389
        This function creates a new pipe in self.pipe
 
 
2391
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
 
 
2393
        proc = MultiprocessingMixIn.process_request(self, request,
 
 
2395
        self.child_pipe.close()
 
 
2396
        self.add_pipe(parent_pipe, proc)
 
 
2398
    def add_pipe(self, parent_pipe, proc):
 
 
2399
        """Dummy function; override as necessary"""
 
 
2400
        raise NotImplementedError()
 
 
2403
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
 
 
2404
                     socketserver.TCPServer, object):
 
 
2405
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
 
503
 
        settings:       Server settings
 
504
 
        clients:        Set() of Client objects
 
 
2408
        enabled:        Boolean; whether this server is activated yet
 
 
2409
        interface:      None or a network interface name (string)
 
 
2410
        use_ipv6:       Boolean; to use IPv6 or not
 
506
 
    address_family = socket.AF_INET6
 
507
 
    def __init__(self, *args, **kwargs):
 
508
 
        if "settings" in kwargs:
 
509
 
            self.settings = kwargs["settings"]
 
510
 
            del kwargs["settings"]
 
511
 
        if "clients" in kwargs:
 
512
 
            self.clients = kwargs["clients"]
 
513
 
            del kwargs["clients"]
 
514
 
        return super(type(self), self).__init__(*args, **kwargs)
 
 
2413
    def __init__(self, server_address, RequestHandlerClass,
 
 
2417
        """If socketfd is set, use that file descriptor instead of
 
 
2418
        creating a new one with socket.socket().
 
 
2420
        self.interface = interface
 
 
2422
            self.address_family = socket.AF_INET6
 
 
2423
        if socketfd is not None:
 
 
2424
            # Save the file descriptor
 
 
2425
            self.socketfd = socketfd
 
 
2426
            # Save the original socket.socket() function
 
 
2427
            self.socket_socket = socket.socket
 
 
2428
            # To implement --socket, we monkey patch socket.socket.
 
 
2430
            # (When socketserver.TCPServer is a new-style class, we
 
 
2431
            # could make self.socket into a property instead of monkey
 
 
2432
            # patching socket.socket.)
 
 
2434
            # Create a one-time-only replacement for socket.socket()
 
 
2435
            @functools.wraps(socket.socket)
 
 
2436
            def socket_wrapper(*args, **kwargs):
 
 
2437
                # Restore original function so subsequent calls are
 
 
2439
                socket.socket = self.socket_socket
 
 
2440
                del self.socket_socket
 
 
2441
                # This time only, return a new socket object from the
 
 
2442
                # saved file descriptor.
 
 
2443
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
 
2444
            # Replace socket.socket() function with wrapper
 
 
2445
            socket.socket = socket_wrapper
 
 
2446
        # The socketserver.TCPServer.__init__ will call
 
 
2447
        # socket.socket(), which might be our replacement,
 
 
2448
        # socket_wrapper(), if socketfd was set.
 
 
2449
        socketserver.TCPServer.__init__(self, server_address,
 
 
2450
                                        RequestHandlerClass)
 
515
2452
    def server_bind(self):
 
516
2453
        """This overrides the normal server_bind() function
 
517
2454
        to bind to an interface if one was specified, and also NOT to
 
518
2455
        bind to an address or port if they were not specified."""
 
519
 
        if self.settings["interface"]:
 
520
 
            # 25 is from /usr/include/asm-i486/socket.h
 
521
 
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
 
 
2456
        global SO_BINDTODEVICE
 
 
2457
        if self.interface is not None:
 
 
2458
            if SO_BINDTODEVICE is None:
 
 
2459
                # Fall back to a hard-coded value which seems to be
 
 
2461
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
 
2462
                SO_BINDTODEVICE = 25
 
523
 
                self.socket.setsockopt(socket.SOL_SOCKET,
 
525
 
                                       self.settings["interface"])
 
526
 
            except socket.error, error:
 
527
 
                if error[0] == errno.EPERM:
 
528
 
                    logger.error(u"No permission to"
 
529
 
                                 u" bind to interface %s",
 
530
 
                                 self.settings["interface"])
 
 
2464
                self.socket.setsockopt(
 
 
2465
                    socket.SOL_SOCKET, SO_BINDTODEVICE,
 
 
2466
                    (self.interface + "\0").encode("utf-8"))
 
 
2467
            except socket.error as error:
 
 
2468
                if error.errno == errno.EPERM:
 
 
2469
                    logger.error("No permission to bind to"
 
 
2470
                                 " interface %s", self.interface)
 
 
2471
                elif error.errno == errno.ENOPROTOOPT:
 
 
2472
                    logger.error("SO_BINDTODEVICE not available;"
 
 
2473
                                 " cannot bind to interface %s",
 
 
2475
                elif error.errno == errno.ENODEV:
 
 
2476
                    logger.error("Interface %s does not exist,"
 
 
2477
                                 " cannot bind", self.interface)
 
533
2480
        # Only bind(2) the socket if we really need to.
 
534
2481
        if self.server_address[0] or self.server_address[1]:
 
535
2482
            if not self.server_address[0]:
 
537
 
                self.server_address = (in6addr_any,
 
 
2483
                if self.address_family == socket.AF_INET6:
 
 
2484
                    any_address = "::" # in6addr_any
 
 
2486
                    any_address = "0.0.0.0" # INADDR_ANY
 
 
2487
                self.server_address = (any_address,
 
538
2488
                                       self.server_address[1])
 
539
2489
            elif not self.server_address[1]:
 
540
 
                self.server_address = (self.server_address[0],
 
542
 
#                 if self.settings["interface"]:
 
 
2490
                self.server_address = (self.server_address[0], 0)
 
 
2491
#                 if self.interface:
 
543
2492
#                     self.server_address = (self.server_address[0],
 
546
2495
#                                            if_nametoindex
 
549
 
            return super(type(self), self).server_bind()
 
 
2497
            return socketserver.TCPServer.server_bind(self)
 
 
2500
class MandosServer(IPv6_TCPServer):
 
 
2504
        clients:        set of Client objects
 
 
2505
        gnutls_priority GnuTLS priority string
 
 
2506
        use_dbus:       Boolean; to emit D-Bus signals or not
 
 
2508
    Assumes a GLib.MainLoop event loop.
 
 
2511
    def __init__(self, server_address, RequestHandlerClass,
 
 
2515
                 gnutls_priority=None,
 
 
2518
        self.enabled = False
 
 
2519
        self.clients = clients
 
 
2520
        if self.clients is None:
 
 
2522
        self.use_dbus = use_dbus
 
 
2523
        self.gnutls_priority = gnutls_priority
 
 
2524
        IPv6_TCPServer.__init__(self, server_address,
 
 
2525
                                RequestHandlerClass,
 
 
2526
                                interface = interface,
 
 
2527
                                use_ipv6 = use_ipv6,
 
 
2528
                                socketfd = socketfd)
 
 
2530
    def server_activate(self):
 
 
2532
            return socketserver.TCPServer.server_activate(self)
 
 
2537
    def add_pipe(self, parent_pipe, proc):
 
 
2538
        # Call "handle_ipc" for both data and EOF events
 
 
2540
            parent_pipe.fileno(),
 
 
2541
            GLib.IO_IN | GLib.IO_HUP,
 
 
2542
            functools.partial(self.handle_ipc,
 
 
2543
                              parent_pipe = parent_pipe,
 
 
2546
    def handle_ipc(self, source, condition,
 
 
2549
                   client_object=None):
 
 
2550
        # error, or the other end of multiprocessing.Pipe has closed
 
 
2551
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
 
 
2552
            # Wait for other process to exit
 
 
2556
        # Read a request from the child
 
 
2557
        request = parent_pipe.recv()
 
 
2558
        command = request[0]
 
 
2560
        if command == 'init':
 
 
2562
            address = request[2]
 
 
2564
            for c in self.clients.values():
 
 
2565
                if c.fingerprint == fpr:
 
 
2569
                logger.info("Client not found for fingerprint: %s, ad"
 
 
2570
                            "dress: %s", fpr, address)
 
 
2573
                    mandos_dbus_service.ClientNotFound(fpr,
 
 
2575
                parent_pipe.send(False)
 
 
2579
                parent_pipe.fileno(),
 
 
2580
                GLib.IO_IN | GLib.IO_HUP,
 
 
2581
                functools.partial(self.handle_ipc,
 
 
2582
                                  parent_pipe = parent_pipe,
 
 
2584
                                  client_object = client))
 
 
2585
            parent_pipe.send(True)
 
 
2586
            # remove the old hook in favor of the new above hook on
 
 
2589
        if command == 'funcall':
 
 
2590
            funcname = request[1]
 
 
2594
            parent_pipe.send(('data', getattr(client_object,
 
 
2598
        if command == 'getattr':
 
 
2599
            attrname = request[1]
 
 
2600
            if isinstance(client_object.__getattribute__(attrname),
 
 
2601
                          collections.Callable):
 
 
2602
                parent_pipe.send(('function', ))
 
 
2605
                    'data', client_object.__getattribute__(attrname)))
 
 
2607
        if command == 'setattr':
 
 
2608
            attrname = request[1]
 
 
2610
            setattr(client_object, attrname, value)
 
 
2615
def rfc3339_duration_to_delta(duration):
 
 
2616
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
 
2618
    >>> rfc3339_duration_to_delta("P7D")
 
 
2619
    datetime.timedelta(7)
 
 
2620
    >>> rfc3339_duration_to_delta("PT60S")
 
 
2621
    datetime.timedelta(0, 60)
 
 
2622
    >>> rfc3339_duration_to_delta("PT60M")
 
 
2623
    datetime.timedelta(0, 3600)
 
 
2624
    >>> rfc3339_duration_to_delta("PT24H")
 
 
2625
    datetime.timedelta(1)
 
 
2626
    >>> rfc3339_duration_to_delta("P1W")
 
 
2627
    datetime.timedelta(7)
 
 
2628
    >>> rfc3339_duration_to_delta("PT5M30S")
 
 
2629
    datetime.timedelta(0, 330)
 
 
2630
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
 
2631
    datetime.timedelta(1, 200)
 
 
2634
    # Parsing an RFC 3339 duration with regular expressions is not
 
 
2635
    # possible - there would have to be multiple places for the same
 
 
2636
    # values, like seconds.  The current code, while more esoteric, is
 
 
2637
    # cleaner without depending on a parsing library.  If Python had a
 
 
2638
    # built-in library for parsing we would use it, but we'd like to
 
 
2639
    # avoid excessive use of external libraries.
 
 
2641
    # New type for defining tokens, syntax, and semantics all-in-one
 
 
2642
    Token = collections.namedtuple("Token", (
 
 
2643
        "regexp",  # To match token; if "value" is not None, must have
 
 
2644
                   # a "group" containing digits
 
 
2645
        "value",   # datetime.timedelta or None
 
 
2646
        "followers"))           # Tokens valid after this token
 
 
2647
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
 
2648
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
 
2649
    token_end = Token(re.compile(r"$"), None, frozenset())
 
 
2650
    token_second = Token(re.compile(r"(\d+)S"),
 
 
2651
                         datetime.timedelta(seconds=1),
 
 
2652
                         frozenset((token_end, )))
 
 
2653
    token_minute = Token(re.compile(r"(\d+)M"),
 
 
2654
                         datetime.timedelta(minutes=1),
 
 
2655
                         frozenset((token_second, token_end)))
 
 
2656
    token_hour = Token(re.compile(r"(\d+)H"),
 
 
2657
                       datetime.timedelta(hours=1),
 
 
2658
                       frozenset((token_minute, token_end)))
 
 
2659
    token_time = Token(re.compile(r"T"),
 
 
2661
                       frozenset((token_hour, token_minute,
 
 
2663
    token_day = Token(re.compile(r"(\d+)D"),
 
 
2664
                      datetime.timedelta(days=1),
 
 
2665
                      frozenset((token_time, token_end)))
 
 
2666
    token_month = Token(re.compile(r"(\d+)M"),
 
 
2667
                        datetime.timedelta(weeks=4),
 
 
2668
                        frozenset((token_day, token_end)))
 
 
2669
    token_year = Token(re.compile(r"(\d+)Y"),
 
 
2670
                       datetime.timedelta(weeks=52),
 
 
2671
                       frozenset((token_month, token_end)))
 
 
2672
    token_week = Token(re.compile(r"(\d+)W"),
 
 
2673
                       datetime.timedelta(weeks=1),
 
 
2674
                       frozenset((token_end, )))
 
 
2675
    token_duration = Token(re.compile(r"P"), None,
 
 
2676
                           frozenset((token_year, token_month,
 
 
2677
                                      token_day, token_time,
 
 
2679
    # Define starting values
 
 
2680
    value = datetime.timedelta() # Value so far
 
 
2682
    followers = frozenset((token_duration, )) # Following valid tokens
 
 
2683
    s = duration                # String left to parse
 
 
2684
    # Loop until end token is found
 
 
2685
    while found_token is not token_end:
 
 
2686
        # Search for any currently valid tokens
 
 
2687
        for token in followers:
 
 
2688
            match = token.regexp.match(s)
 
 
2689
            if match is not None:
 
 
2691
                if token.value is not None:
 
 
2692
                    # Value found, parse digits
 
 
2693
                    factor = int(match.group(1), 10)
 
 
2694
                    # Add to value so far
 
 
2695
                    value += factor * token.value
 
 
2696
                # Strip token from string
 
 
2697
                s = token.regexp.sub("", s, 1)
 
 
2700
                # Set valid next tokens
 
 
2701
                followers = found_token.followers
 
 
2704
            # No currently valid tokens were found
 
 
2705
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
552
2711
def string_to_delta(interval):
 
553
2712
    """Parse a string and return a datetime.timedelta
 
555
2714
    >>> string_to_delta('7d')
 
556
2715
    datetime.timedelta(7)
 
557
2716
    >>> string_to_delta('60s')
 
 
692
2842
                        "debug": "False",
 
694
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
 
2844
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
 
2845
                        ":+SIGN-DSA-SHA256",
 
695
2846
                        "servicename": "Mandos",
 
 
2852
                        "statedir": "/var/lib/mandos",
 
 
2853
                        "foreground": "False",
 
698
2857
    # Parse config file for server-global settings
 
699
 
    server_config = ConfigParser.SafeConfigParser(server_defaults)
 
 
2858
    server_config = configparser.SafeConfigParser(server_defaults)
 
700
2859
    del server_defaults
 
701
2860
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
702
 
    server_section = "server"
 
703
2861
    # Convert the SafeConfigParser object to a dict
 
704
 
    server_settings = dict(server_config.items(server_section))
 
705
 
    # Use getboolean on the boolean config option
 
706
 
    server_settings["debug"] = server_config.getboolean\
 
707
 
                               (server_section, "debug")
 
 
2862
    server_settings = server_config.defaults()
 
 
2863
    # Use the appropriate methods on the non-string config options
 
 
2864
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
 
2865
        server_settings[option] = server_config.getboolean("DEFAULT",
 
 
2867
    if server_settings["port"]:
 
 
2868
        server_settings["port"] = server_config.getint("DEFAULT",
 
 
2870
    if server_settings["socket"]:
 
 
2871
        server_settings["socket"] = server_config.getint("DEFAULT",
 
 
2873
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
 
2874
        # over with an opened os.devnull.  But we don't want this to
 
 
2875
        # happen with a supplied network socket.
 
 
2876
        if 0 <= server_settings["socket"] <= 2:
 
 
2877
            server_settings["socket"] = os.dup(server_settings
 
708
2879
    del server_config
 
710
2881
    # Override the settings from the config file with command line
 
711
2882
    # options, if set.
 
712
2883
    for option in ("interface", "address", "port", "debug",
 
713
 
                   "priority", "servicename", "configdir"):
 
 
2884
                   "priority", "servicename", "configdir", "use_dbus",
 
 
2885
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
 
2886
                   "socket", "foreground", "zeroconf"):
 
714
2887
        value = getattr(options, option)
 
715
2888
        if value is not None:
 
716
2889
            server_settings[option] = value
 
 
2891
    # Force all strings to be unicode
 
 
2892
    for option in server_settings.keys():
 
 
2893
        if isinstance(server_settings[option], bytes):
 
 
2894
            server_settings[option] = (server_settings[option]
 
 
2896
    # Force all boolean options to be boolean
 
 
2897
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
 
2898
                   "foreground", "zeroconf"):
 
 
2899
        server_settings[option] = bool(server_settings[option])
 
 
2900
    # Debug implies foreground
 
 
2901
    if server_settings["debug"]:
 
 
2902
        server_settings["foreground"] = True
 
718
2903
    # Now we have our good server settings in "server_settings"
 
 
2905
    ##################################################################
 
 
2907
    if (not server_settings["zeroconf"]
 
 
2908
        and not (server_settings["port"]
 
 
2909
                 or server_settings["socket"] != "")):
 
 
2910
        parser.error("Needs port or socket to work without Zeroconf")
 
720
2913
    debug = server_settings["debug"]
 
 
2914
    debuglevel = server_settings["debuglevel"]
 
 
2915
    use_dbus = server_settings["use_dbus"]
 
 
2916
    use_ipv6 = server_settings["use_ipv6"]
 
 
2917
    stored_state_path = os.path.join(server_settings["statedir"],
 
 
2919
    foreground = server_settings["foreground"]
 
 
2920
    zeroconf = server_settings["zeroconf"]
 
723
 
        syslogger.setLevel(logging.WARNING)
 
724
 
        console.setLevel(logging.WARNING)
 
 
2923
        initlogger(debug, logging.DEBUG)
 
 
2928
            level = getattr(logging, debuglevel.upper())
 
 
2929
            initlogger(debug, level)
 
726
2931
    if server_settings["servicename"] != "Mandos":
 
727
 
        syslogger.setFormatter(logging.Formatter\
 
728
 
                               ('Mandos (%s): %%(levelname)s:'
 
730
 
                                % server_settings["servicename"]))
 
 
2932
        syslogger.setFormatter(
 
 
2933
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
 
2934
                              ' %(levelname)s: %(message)s'.format(
 
 
2935
                                  server_settings["servicename"])))
 
732
2937
    # Parse config file with clients
 
733
 
    client_defaults = { "timeout": "1h",
 
735
 
                        "checker": "fping -q -- %%(host)s",
 
737
 
    client_config = ConfigParser.SafeConfigParser(client_defaults)
 
 
2938
    client_config = configparser.SafeConfigParser(Client
 
738
2940
    client_config.read(os.path.join(server_settings["configdir"],
 
739
2941
                                    "clients.conf"))
 
742
 
    service = AvahiService(name = server_settings["servicename"],
 
743
 
                           type = "_mandos._tcp", );
 
744
 
    if server_settings["interface"]:
 
745
 
        service.interface = if_nametoindex(server_settings["interface"])
 
 
2943
    global mandos_dbus_service
 
 
2944
    mandos_dbus_service = None
 
 
2947
    if server_settings["socket"] != "":
 
 
2948
        socketfd = server_settings["socket"]
 
 
2949
    tcp_server = MandosServer(
 
 
2950
        (server_settings["address"], server_settings["port"]),
 
 
2952
        interface=(server_settings["interface"] or None),
 
 
2954
        gnutls_priority=server_settings["priority"],
 
 
2958
        pidfilename = "/run/mandos.pid"
 
 
2959
        if not os.path.isdir("/run/."):
 
 
2960
            pidfilename = "/var/run/mandos.pid"
 
 
2963
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
 
 
2964
        except IOError as e:
 
 
2965
            logger.error("Could not open file %r", pidfilename,
 
 
2968
    for name, group in (("_mandos", "_mandos"),
 
 
2969
                        ("mandos", "mandos"),
 
 
2970
                        ("nobody", "nogroup")):
 
 
2972
            uid = pwd.getpwnam(name).pw_uid
 
 
2973
            gid = pwd.getpwnam(group).pw_gid
 
 
2984
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
 
2986
    except OSError as error:
 
 
2987
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
 
2988
                       .format(uid, gid, os.strerror(error.errno)))
 
 
2989
        if error.errno != errno.EPERM:
 
 
2993
        # Enable all possible GnuTLS debugging
 
 
2995
        # "Use a log level over 10 to enable all debugging options."
 
 
2997
        gnutls.global_set_log_level(11)
 
 
3000
        def debug_gnutls(level, string):
 
 
3001
            logger.debug("GnuTLS: %s", string[:-1])
 
 
3003
        gnutls.global_set_log_function(debug_gnutls)
 
 
3005
        # Redirect stdin so all checkers get /dev/null
 
 
3006
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
 
3007
        os.dup2(null, sys.stdin.fileno())
 
 
3011
    # Need to fork before connecting to D-Bus
 
 
3013
        # Close all input and output, do double fork, etc.
 
 
3016
    # multiprocessing will use threads, so before we use GLib we need
 
 
3017
    # to inform GLib that threads will be used.
 
747
3020
    global main_loop
 
750
3021
    # From the Avahi example code
 
751
 
    DBusGMainLoop(set_as_default=True )
 
752
 
    main_loop = gobject.MainLoop()
 
 
3022
    DBusGMainLoop(set_as_default=True)
 
 
3023
    main_loop = GLib.MainLoop()
 
753
3024
    bus = dbus.SystemBus()
 
754
 
    server = dbus.Interface(
 
755
 
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
 
756
 
            avahi.DBUS_INTERFACE_SERVER )
 
757
3025
    # End of Avahi example code
 
760
 
    def remove_from_clients(client):
 
761
 
        clients.remove(client)
 
763
 
            logger.critical(u"No clients left, exiting")
 
766
 
    clients.update(Set(Client(name = section,
 
767
 
                              stop_hook = remove_from_clients,
 
769
 
                              = dict(client_config.items(section)))
 
770
 
                       for section in client_config.sections()))
 
772
 
        logger.critical(u"No clients defined")
 
776
 
        logger.removeHandler(console)
 
779
 
    pidfilename = "/var/run/mandos/mandos.pid"
 
782
 
        pidfile = open(pidfilename, "w")
 
783
 
        pidfile.write(str(pid) + "\n")
 
 
3028
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
 
3031
            old_bus_name = dbus.service.BusName(
 
 
3032
                "se.bsnet.fukt.Mandos", bus,
 
 
3034
        except dbus.exceptions.DBusException as e:
 
 
3035
            logger.error("Disabling D-Bus:", exc_info=e)
 
 
3037
            server_settings["use_dbus"] = False
 
 
3038
            tcp_server.use_dbus = False
 
 
3040
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
 
3041
        service = AvahiServiceToSyslog(
 
 
3042
            name = server_settings["servicename"],
 
 
3043
            servicetype = "_mandos._tcp",
 
 
3044
            protocol = protocol,
 
 
3046
        if server_settings["interface"]:
 
 
3047
            service.interface = if_nametoindex(
 
 
3048
                server_settings["interface"].encode("utf-8"))
 
 
3050
    global multiprocessing_manager
 
 
3051
    multiprocessing_manager = multiprocessing.Manager()
 
 
3053
    client_class = Client
 
 
3055
        client_class = functools.partial(ClientDBus, bus = bus)
 
 
3057
    client_settings = Client.config_parser(client_config)
 
 
3058
    old_client_settings = {}
 
 
3061
    # This is used to redirect stdout and stderr for checker processes
 
 
3063
    wnull = open(os.devnull, "w") # A writable /dev/null
 
 
3064
    # Only used if server is running in foreground but not in debug
 
 
3066
    if debug or not foreground:
 
 
3069
    # Get client data and settings from last running state.
 
 
3070
    if server_settings["restore"]:
 
 
3072
            with open(stored_state_path, "rb") as stored_state:
 
 
3073
                if sys.version_info.major == 2:                
 
 
3074
                    clients_data, old_client_settings = pickle.load(
 
 
3077
                    bytes_clients_data, bytes_old_client_settings = (
 
 
3078
                        pickle.load(stored_state, encoding = "bytes"))
 
 
3079
                    ### Fix bytes to strings
 
 
3082
                    clients_data = { (key.decode("utf-8")
 
 
3083
                                      if isinstance(key, bytes)
 
 
3086
                                     bytes_clients_data.items() }
 
 
3087
                    del bytes_clients_data
 
 
3088
                    for key in clients_data:
 
 
3089
                        value = { (k.decode("utf-8")
 
 
3090
                                   if isinstance(k, bytes) else k): v
 
 
3092
                                  clients_data[key].items() }
 
 
3093
                        clients_data[key] = value
 
 
3095
                        value["client_structure"] = [
 
 
3097
                             if isinstance(s, bytes)
 
 
3099
                            value["client_structure"] ]
 
 
3101
                        for k in ("name", "host"):
 
 
3102
                            if isinstance(value[k], bytes):
 
 
3103
                                value[k] = value[k].decode("utf-8")
 
 
3104
                    ## old_client_settings
 
 
3106
                    old_client_settings = {
 
 
3107
                        (key.decode("utf-8")
 
 
3108
                         if isinstance(key, bytes)
 
 
3111
                        bytes_old_client_settings.items() }
 
 
3112
                    del bytes_old_client_settings
 
 
3114
                    for value in old_client_settings.values():
 
 
3115
                        if isinstance(value["host"], bytes):
 
 
3116
                            value["host"] = (value["host"]
 
 
3118
            os.remove(stored_state_path)
 
 
3119
        except IOError as e:
 
 
3120
            if e.errno == errno.ENOENT:
 
 
3121
                logger.warning("Could not load persistent state:"
 
 
3122
                               " {}".format(os.strerror(e.errno)))
 
 
3124
                logger.critical("Could not load persistent state:",
 
 
3127
        except EOFError as e:
 
 
3128
            logger.warning("Could not load persistent state: "
 
 
3132
    with PGPEngine() as pgp:
 
 
3133
        for client_name, client in clients_data.items():
 
 
3134
            # Skip removed clients
 
 
3135
            if client_name not in client_settings:
 
 
3138
            # Decide which value to use after restoring saved state.
 
 
3139
            # We have three different values: Old config file,
 
 
3140
            # new config file, and saved state.
 
 
3141
            # New config value takes precedence if it differs from old
 
 
3142
            # config value, otherwise use saved state.
 
 
3143
            for name, value in client_settings[client_name].items():
 
 
3145
                    # For each value in new config, check if it
 
 
3146
                    # differs from the old config value (Except for
 
 
3147
                    # the "secret" attribute)
 
 
3148
                    if (name != "secret"
 
 
3150
                             old_client_settings[client_name][name])):
 
 
3151
                        client[name] = value
 
 
3155
            # Clients who has passed its expire date can still be
 
 
3156
            # enabled if its last checker was successful.  A Client
 
 
3157
            # whose checker succeeded before we stored its state is
 
 
3158
            # assumed to have successfully run all checkers during
 
 
3160
            if client["enabled"]:
 
 
3161
                if datetime.datetime.utcnow() >= client["expires"]:
 
 
3162
                    if not client["last_checked_ok"]:
 
 
3164
                            "disabling client {} - Client never "
 
 
3165
                            "performed a successful checker".format(
 
 
3167
                        client["enabled"] = False
 
 
3168
                    elif client["last_checker_status"] != 0:
 
 
3170
                            "disabling client {} - Client last"
 
 
3171
                            " checker failed with error code"
 
 
3174
                                client["last_checker_status"]))
 
 
3175
                        client["enabled"] = False
 
 
3177
                        client["expires"] = (
 
 
3178
                            datetime.datetime.utcnow()
 
 
3179
                            + client["timeout"])
 
 
3180
                        logger.debug("Last checker succeeded,"
 
 
3181
                                     " keeping {} enabled".format(
 
 
3184
                client["secret"] = pgp.decrypt(
 
 
3185
                    client["encrypted_secret"],
 
 
3186
                    client_settings[client_name]["secret"])
 
 
3188
                # If decryption fails, we use secret from new settings
 
 
3189
                logger.debug("Failed to decrypt {} old secret".format(
 
 
3191
                client["secret"] = (client_settings[client_name]
 
 
3194
    # Add/remove clients based on new changes made to config
 
 
3195
    for client_name in (set(old_client_settings)
 
 
3196
                        - set(client_settings)):
 
 
3197
        del clients_data[client_name]
 
 
3198
    for client_name in (set(client_settings)
 
 
3199
                        - set(old_client_settings)):
 
 
3200
        clients_data[client_name] = client_settings[client_name]
 
 
3202
    # Create all client objects
 
 
3203
    for client_name, client in clients_data.items():
 
 
3204
        tcp_server.clients[client_name] = client_class(
 
 
3207
            server_settings = server_settings)
 
 
3209
    if not tcp_server.clients:
 
 
3210
        logger.warning("No clients defined")
 
 
3213
        if pidfile is not None:
 
 
3217
                    print(pid, file=pidfile)
 
 
3219
                logger.error("Could not write to file %r with PID %d",
 
787
 
        logger.error(u"Could not write %s file with PID %d",
 
788
 
                     pidfilename, os.getpid())
 
 
3224
    for termsig in (signal.SIGHUP, signal.SIGTERM):
 
 
3225
        GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
 
 
3226
                             lambda: main_loop.quit() and False)
 
 
3230
        @alternate_dbus_interfaces(
 
 
3231
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
 
3232
        class MandosDBusService(DBusObjectWithObjectManager):
 
 
3233
            """A D-Bus proxy object"""
 
 
3236
                dbus.service.Object.__init__(self, bus, "/")
 
 
3238
            _interface = "se.recompile.Mandos"
 
 
3240
            @dbus.service.signal(_interface, signature="o")
 
 
3241
            def ClientAdded(self, objpath):
 
 
3245
            @dbus.service.signal(_interface, signature="ss")
 
 
3246
            def ClientNotFound(self, fingerprint, address):
 
 
3250
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
 
3252
            @dbus.service.signal(_interface, signature="os")
 
 
3253
            def ClientRemoved(self, objpath, name):
 
 
3257
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
 
3259
            @dbus.service.method(_interface, out_signature="ao")
 
 
3260
            def GetAllClients(self):
 
 
3262
                return dbus.Array(c.dbus_object_path for c in
 
 
3263
                                  tcp_server.clients.values())
 
 
3265
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
 
3267
            @dbus.service.method(_interface,
 
 
3268
                                 out_signature="a{oa{sv}}")
 
 
3269
            def GetAllClientsWithProperties(self):
 
 
3271
                return dbus.Dictionary(
 
 
3272
                    { c.dbus_object_path: c.GetAll(
 
 
3273
                        "se.recompile.Mandos.Client")
 
 
3274
                      for c in tcp_server.clients.values() },
 
 
3277
            @dbus.service.method(_interface, in_signature="o")
 
 
3278
            def RemoveClient(self, object_path):
 
 
3280
                for c in tcp_server.clients.values():
 
 
3281
                    if c.dbus_object_path == object_path:
 
 
3282
                        del tcp_server.clients[c.name]
 
 
3283
                        c.remove_from_connection()
 
 
3284
                        # Don't signal the disabling
 
 
3285
                        c.disable(quiet=True)
 
 
3286
                        # Emit D-Bus signal for removal
 
 
3287
                        self.client_removed_signal(c)
 
 
3289
                raise KeyError(object_path)
 
 
3293
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
 
3294
                                 out_signature = "a{oa{sa{sv}}}")
 
 
3295
            def GetManagedObjects(self):
 
 
3297
                return dbus.Dictionary(
 
 
3298
                    { client.dbus_object_path:
 
 
3300
                          { interface: client.GetAll(interface)
 
 
3302
                                 client._get_all_interface_names()})
 
 
3303
                      for client in tcp_server.clients.values()})
 
 
3305
            def client_added_signal(self, client):
 
 
3306
                """Send the new standard signal and the old signal"""
 
 
3308
                    # New standard signal
 
 
3309
                    self.InterfacesAdded(
 
 
3310
                        client.dbus_object_path,
 
 
3312
                            { interface: client.GetAll(interface)
 
 
3314
                              client._get_all_interface_names()}))
 
 
3316
                    self.ClientAdded(client.dbus_object_path)
 
 
3318
            def client_removed_signal(self, client):
 
 
3319
                """Send the new standard signal and the old signal"""
 
 
3321
                    # New standard signal
 
 
3322
                    self.InterfacesRemoved(
 
 
3323
                        client.dbus_object_path,
 
 
3324
                        client._get_all_interface_names())
 
 
3326
                    self.ClientRemoved(client.dbus_object_path,
 
 
3329
        mandos_dbus_service = MandosDBusService()
 
 
3331
    # Save modules to variables to exempt the modules from being
 
 
3332
    # unloaded before the function registered with atexit() is run.
 
 
3333
    mp = multiprocessing
 
791
3336
        "Cleanup function; run on exit"
 
793
 
        # From the Avahi example code
 
794
 
        if not group is None:
 
797
 
        # End of Avahi example code
 
800
 
            client = clients.pop()
 
801
 
            client.stop_hook = None
 
 
3340
        mp.active_children()
 
 
3342
        if not (tcp_server.clients or client_settings):
 
 
3345
        # Store client before exiting. Secrets are encrypted with key
 
 
3346
        # based on what config file has. If config file is
 
 
3347
        # removed/edited, old secret will thus be unrecovable.
 
 
3349
        with PGPEngine() as pgp:
 
 
3350
            for client in tcp_server.clients.values():
 
 
3351
                key = client_settings[client.name]["secret"]
 
 
3352
                client.encrypted_secret = pgp.encrypt(client.secret,
 
 
3356
                # A list of attributes that can not be pickled
 
 
3358
                exclude = { "bus", "changedstate", "secret",
 
 
3359
                            "checker", "server_settings" }
 
 
3360
                for name, typ in inspect.getmembers(dbus.service
 
 
3364
                client_dict["encrypted_secret"] = (client
 
 
3366
                for attr in client.client_structure:
 
 
3367
                    if attr not in exclude:
 
 
3368
                        client_dict[attr] = getattr(client, attr)
 
 
3370
                clients[client.name] = client_dict
 
 
3371
                del client_settings[client.name]["secret"]
 
 
3374
            with tempfile.NamedTemporaryFile(
 
 
3378
                    dir=os.path.dirname(stored_state_path),
 
 
3379
                    delete=False) as stored_state:
 
 
3380
                pickle.dump((clients, client_settings), stored_state,
 
 
3382
                tempname = stored_state.name
 
 
3383
            os.rename(tempname, stored_state_path)
 
 
3384
        except (IOError, OSError) as e:
 
 
3390
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
 
3391
                logger.warning("Could not save persistent state: {}"
 
 
3392
                               .format(os.strerror(e.errno)))
 
 
3394
                logger.warning("Could not save persistent state:",
 
 
3398
        # Delete all clients, and settings from config
 
 
3399
        while tcp_server.clients:
 
 
3400
            name, client = tcp_server.clients.popitem()
 
 
3402
                client.remove_from_connection()
 
 
3403
            # Don't signal the disabling
 
 
3404
            client.disable(quiet=True)
 
 
3405
            # Emit D-Bus signal for removal
 
 
3407
                mandos_dbus_service.client_removed_signal(client)
 
 
3408
        client_settings.clear()
 
804
3410
    atexit.register(cleanup)
 
807
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
 
808
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
 
809
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
 
811
 
    for client in clients:
 
814
 
    tcp_server = IPv6_TCPServer((server_settings["address"],
 
815
 
                                 server_settings["port"]),
 
817
 
                                settings=server_settings,
 
 
3412
    for client in tcp_server.clients.values():
 
 
3414
            # Emit D-Bus signal for adding
 
 
3415
            mandos_dbus_service.client_added_signal(client)
 
 
3416
        # Need to initiate checking of clients
 
 
3418
            client.init_checker()
 
 
3421
    tcp_server.server_activate()
 
819
3423
    # Find out what port we got
 
820
 
    service.port = tcp_server.socket.getsockname()[1]
 
821
 
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
 
822
 
                u" scope_id %d" % tcp_server.socket.getsockname())
 
 
3425
        service.port = tcp_server.socket.getsockname()[1]
 
 
3427
        logger.info("Now listening on address %r, port %d,"
 
 
3428
                    " flowinfo %d, scope_id %d",
 
 
3429
                    *tcp_server.socket.getsockname())
 
 
3431
        logger.info("Now listening on address %r, port %d",
 
 
3432
                    *tcp_server.socket.getsockname())
 
824
3434
    #service.interface = tcp_server.socket.getsockname()[3]
 
827
 
        # From the Avahi example code
 
828
 
        server.connect_to_signal("StateChanged", server_state_changed)
 
830
 
            server_state_changed(server.GetState())
 
831
 
        except dbus.exceptions.DBusException, error:
 
832
 
            logger.critical(u"DBusException: %s", error)
 
834
 
        # End of Avahi example code
 
836
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
837
 
                             lambda *args, **kwargs:
 
838
 
                             tcp_server.handle_request\
 
839
 
                             (*args[2:], **kwargs) or True)
 
841
 
        logger.debug(u"Starting main loop")
 
842
 
        main_loop_started = True
 
 
3438
            # From the Avahi example code
 
 
3441
            except dbus.exceptions.DBusException as error:
 
 
3442
                logger.critical("D-Bus Exception", exc_info=error)
 
 
3445
            # End of Avahi example code
 
 
3447
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
 
3448
                          lambda *args, **kwargs:
 
 
3449
                          (tcp_server.handle_request
 
 
3450
                           (*args[2:], **kwargs) or True))
 
 
3452
        logger.debug("Starting main loop")
 
844
 
    except AvahiError, error:
 
845
 
        logger.critical(u"AvahiError: %s" + unicode(error))
 
 
3454
    except AvahiError as error:
 
 
3455
        logger.critical("Avahi Error", exc_info=error)
 
847
3458
    except KeyboardInterrupt:
 
 
3460
            print("", file=sys.stderr)
 
 
3461
        logger.debug("Server received KeyboardInterrupt")
 
 
3462
    logger.debug("Server exiting")
 
 
3463
    # Must run before the D-Bus bus name gets deregistered
 
851
3467
if __name__ == '__main__':