104
332
    max_renames: integer; maximum number of renames
 
105
333
    rename_count: integer; counter so we only rename after collisions
 
106
334
                  a sensible number of times
 
 
335
    group: D-Bus Entry Group
 
 
337
    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):
 
 
341
                 interface=avahi.IF_UNSPEC,
 
 
349
                 protocol=avahi.PROTO_UNSPEC,
 
111
351
        self.interface = interface
 
 
353
        self.type = servicetype
 
 
355
        self.TXT = TXT if TXT is not None else []
 
119
356
        self.domain = domain
 
121
358
        self.rename_count = 0
 
122
359
        self.max_renames = max_renames
 
 
360
        self.protocol = protocol
 
 
361
        self.group = None       # our entry group
 
 
364
        self.entry_group_state_changed_match = None
 
 
366
    def rename(self, remove=True):
 
124
367
        """Derived from the Avahi example code"""
 
125
368
        if self.rename_count >= self.max_renames:
 
126
 
            logger.critical(u"No suitable service name found after %i"
 
127
 
                            u" retries, exiting.", rename_count)
 
 
369
            logger.critical("No suitable Zeroconf service name found"
 
 
370
                            " after %i retries, exiting.",
 
128
372
            raise AvahiServiceError("Too many renames")
 
129
 
        self.name = server.GetAlternativeServiceName(self.name)
 
130
 
        logger.info(u"Changing name to %r ...", str(self.name))
 
131
 
        syslogger.setFormatter(logging.Formatter\
 
132
 
                               ('Mandos (%s): %%(levelname)s:'
 
133
 
                               ' %%(message)s' % self.name))
 
 
374
            self.server.GetAlternativeServiceName(self.name))
 
136
375
        self.rename_count += 1
 
 
376
        logger.info("Changing Zeroconf service name to %r ...",
 
 
382
        except dbus.exceptions.DBusException as error:
 
 
383
            if (error.get_dbus_name()
 
 
384
                == "org.freedesktop.Avahi.CollisionError"):
 
 
385
                logger.info("Local Zeroconf service name collision.")
 
 
386
                return self.rename(remove=False)
 
 
388
                logger.critical("D-Bus Exception", exc_info=error)
 
137
392
    def remove(self):
 
138
393
        """Derived from the Avahi example code"""
 
139
 
        if group is not None:
 
 
394
        if self.entry_group_state_changed_match is not None:
 
 
395
            self.entry_group_state_changed_match.remove()
 
 
396
            self.entry_group_state_changed_match = None
 
 
397
        if self.group is not None:
 
142
401
        """Derived from the Avahi example code"""
 
145
 
            group = dbus.Interface\
 
146
 
                    (bus.get_object(avahi.DBUS_NAME,
 
147
 
                                    server.EntryGroupNew()),
 
148
 
                     avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
149
 
            group.connect_to_signal('StateChanged',
 
150
 
                                    entry_group_state_changed)
 
151
 
        logger.debug(u"Adding service '%s' of type '%s' ...",
 
152
 
                     service.name, service.type)
 
154
 
                self.interface,         # interface
 
155
 
                avahi.PROTO_INET6,      # protocol
 
156
 
                dbus.UInt32(0),         # flags
 
157
 
                self.name, self.type,
 
158
 
                self.domain, self.host,
 
159
 
                dbus.UInt16(self.port),
 
160
 
                avahi.string_array_to_txt_array(self.TXT))
 
163
 
# From the Avahi example code:
 
164
 
group = None                            # our entry group
 
165
 
# End of Avahi example code
 
 
403
        if self.group is None:
 
 
404
            self.group = dbus.Interface(
 
 
405
                self.bus.get_object(avahi.DBUS_NAME,
 
 
406
                                    self.server.EntryGroupNew()),
 
 
407
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
 
408
        self.entry_group_state_changed_match = (
 
 
409
            self.group.connect_to_signal(
 
 
410
                'StateChanged', self.entry_group_state_changed))
 
 
411
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
 
412
                     self.name, self.type)
 
 
413
        self.group.AddService(
 
 
416
            dbus.UInt32(0),     # flags
 
 
417
            self.name, self.type,
 
 
418
            self.domain, self.host,
 
 
419
            dbus.UInt16(self.port),
 
 
420
            avahi.string_array_to_txt_array(self.TXT))
 
 
423
    def entry_group_state_changed(self, state, error):
 
 
424
        """Derived from the Avahi example code"""
 
 
425
        logger.debug("Avahi entry group state change: %i", state)
 
 
427
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
 
 
428
            logger.debug("Zeroconf service established.")
 
 
429
        elif state == avahi.ENTRY_GROUP_COLLISION:
 
 
430
            logger.info("Zeroconf service name collision.")
 
 
432
        elif state == avahi.ENTRY_GROUP_FAILURE:
 
 
433
            logger.critical("Avahi: Error in group state changed %s",
 
 
435
            raise AvahiGroupError("State changed: {!s}".format(error))
 
 
438
        """Derived from the Avahi example code"""
 
 
439
        if self.group is not None:
 
 
442
            except (dbus.exceptions.UnknownMethodException,
 
 
443
                    dbus.exceptions.DBusException):
 
 
448
    def server_state_changed(self, state, error=None):
 
 
449
        """Derived from the Avahi example code"""
 
 
450
        logger.debug("Avahi server state change: %i", state)
 
 
452
            avahi.SERVER_INVALID: "Zeroconf server invalid",
 
 
453
            avahi.SERVER_REGISTERING: None,
 
 
454
            avahi.SERVER_COLLISION: "Zeroconf server name collision",
 
 
455
            avahi.SERVER_FAILURE: "Zeroconf server failure",
 
 
457
        if state in bad_states:
 
 
458
            if bad_states[state] is not None:
 
 
460
                    logger.error(bad_states[state])
 
 
462
                    logger.error(bad_states[state] + ": %r", error)
 
 
464
        elif state == avahi.SERVER_RUNNING:
 
 
467
            except dbus.exceptions.DBusException as error:
 
 
468
                if (error.get_dbus_name()
 
 
469
                    == "org.freedesktop.Avahi.CollisionError"):
 
 
470
                    logger.info("Local Zeroconf service name"
 
 
472
                    return self.rename(remove=False)
 
 
474
                    logger.critical("D-Bus Exception", exc_info=error)
 
 
479
                logger.debug("Unknown state: %r", state)
 
 
481
                logger.debug("Unknown state: %r: %r", state, error)
 
 
484
        """Derived from the Avahi example code"""
 
 
485
        if self.server is None:
 
 
486
            self.server = dbus.Interface(
 
 
487
                self.bus.get_object(avahi.DBUS_NAME,
 
 
488
                                    avahi.DBUS_PATH_SERVER,
 
 
489
                                    follow_name_owner_changes=True),
 
 
490
                avahi.DBUS_INTERFACE_SERVER)
 
 
491
        self.server.connect_to_signal("StateChanged",
 
 
492
                                      self.server_state_changed)
 
 
493
        self.server_state_changed(self.server.GetState())
 
 
496
class AvahiServiceToSyslog(AvahiService):
 
 
497
    def rename(self, *args, **kwargs):
 
 
498
        """Add the new name to the syslog messages"""
 
 
499
        ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
 
 
500
        syslogger.setFormatter(logging.Formatter(
 
 
501
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
 
506
# Pretend that we have a GnuTLS module
 
 
507
class GnuTLS(object):
 
 
508
    """This isn't so much a class as it is a module-like namespace.
 
 
509
    It is instantiated once, and simulates having a GnuTLS module."""
 
 
511
    library = ctypes.util.find_library("gnutls")
 
 
513
        library = ctypes.util.find_library("gnutls-deb0")
 
 
514
    _library = ctypes.cdll.LoadLibrary(library)
 
 
516
    _need_version = b"3.3.0"
 
 
519
        # Need to use "self" here, since this method is called before
 
 
520
        # the assignment to the "gnutls" global variable happens.
 
 
521
        if self.check_version(self._need_version) is None:
 
 
522
            raise self.Error("Needs GnuTLS {} or later"
 
 
523
                             .format(self._need_version))
 
 
525
    # Unless otherwise indicated, the constants and types below are
 
 
526
    # all from the gnutls/gnutls.h C header file.
 
 
536
    E_NO_CERTIFICATE_FOUND = -49
 
 
537
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
 
 
540
    class session_int(ctypes.Structure):
 
 
542
    session_t = ctypes.POINTER(session_int)
 
 
544
    class certificate_credentials_st(ctypes.Structure):
 
 
546
    certificate_credentials_t = ctypes.POINTER(
 
 
547
        certificate_credentials_st)
 
 
548
    certificate_type_t = ctypes.c_int
 
 
550
    class datum_t(ctypes.Structure):
 
 
551
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
 
552
                    ('size', ctypes.c_uint)]
 
 
554
    class openpgp_crt_int(ctypes.Structure):
 
 
556
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
 
557
    openpgp_crt_fmt_t = ctypes.c_int  # gnutls/openpgp.h
 
 
558
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
 
 
559
    credentials_type_t = ctypes.c_int
 
 
560
    transport_ptr_t = ctypes.c_void_p
 
 
561
    close_request_t = ctypes.c_int
 
 
564
    class Error(Exception):
 
 
565
        # We need to use the class name "GnuTLS" here, since this
 
 
566
        # exception might be raised from within GnuTLS.__init__,
 
 
567
        # which is called before the assignment to the "gnutls"
 
 
568
        # global variable has happened.
 
 
569
        def __init__(self, message=None, code=None, args=()):
 
 
570
            # Default usage is by a message string, but if a return
 
 
571
            # code is passed, convert it to a string with
 
 
574
            if message is None and code is not None:
 
 
575
                message = GnuTLS.strerror(code)
 
 
576
            return super(GnuTLS.Error, self).__init__(
 
 
579
    class CertificateSecurityError(Error):
 
 
583
    class Credentials(object):
 
 
585
            self._c_object = gnutls.certificate_credentials_t()
 
 
586
            gnutls.certificate_allocate_credentials(
 
 
587
                ctypes.byref(self._c_object))
 
 
588
            self.type = gnutls.CRD_CERTIFICATE
 
 
591
            gnutls.certificate_free_credentials(self._c_object)
 
 
593
    class ClientSession(object):
 
 
594
        def __init__(self, socket, credentials=None):
 
 
595
            self._c_object = gnutls.session_t()
 
 
596
            gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
 
 
597
            gnutls.set_default_priority(self._c_object)
 
 
598
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
 
599
            gnutls.handshake_set_private_extensions(self._c_object,
 
 
602
            if credentials is None:
 
 
603
                credentials = gnutls.Credentials()
 
 
604
            gnutls.credentials_set(self._c_object, credentials.type,
 
 
605
                                   ctypes.cast(credentials._c_object,
 
 
607
            self.credentials = credentials
 
 
610
            gnutls.deinit(self._c_object)
 
 
613
            return gnutls.handshake(self._c_object)
 
 
615
        def send(self, data):
 
 
619
                data_len -= gnutls.record_send(self._c_object,
 
 
624
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
 
626
    # Error handling functions
 
 
627
    def _error_code(result):
 
 
628
        """A function to raise exceptions on errors, suitable
 
 
629
        for the 'restype' attribute on ctypes functions"""
 
 
632
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
 
 
633
            raise gnutls.CertificateSecurityError(code=result)
 
 
634
        raise gnutls.Error(code=result)
 
 
636
    def _retry_on_error(result, func, arguments):
 
 
637
        """A function to retry on some errors, suitable
 
 
638
        for the 'errcheck' attribute on ctypes functions"""
 
 
640
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
 
 
641
                return _error_code(result)
 
 
642
            result = func(*arguments)
 
 
645
    # Unless otherwise indicated, the function declarations below are
 
 
646
    # all from the gnutls/gnutls.h C header file.
 
 
649
    priority_set_direct = _library.gnutls_priority_set_direct
 
 
650
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
 
651
                                    ctypes.POINTER(ctypes.c_char_p)]
 
 
652
    priority_set_direct.restype = _error_code
 
 
654
    init = _library.gnutls_init
 
 
655
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
 
656
    init.restype = _error_code
 
 
658
    set_default_priority = _library.gnutls_set_default_priority
 
 
659
    set_default_priority.argtypes = [session_t]
 
 
660
    set_default_priority.restype = _error_code
 
 
662
    record_send = _library.gnutls_record_send
 
 
663
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
 
665
    record_send.restype = ctypes.c_ssize_t
 
 
666
    record_send.errcheck = _retry_on_error
 
 
668
    certificate_allocate_credentials = (
 
 
669
        _library.gnutls_certificate_allocate_credentials)
 
 
670
    certificate_allocate_credentials.argtypes = [
 
 
671
        ctypes.POINTER(certificate_credentials_t)]
 
 
672
    certificate_allocate_credentials.restype = _error_code
 
 
674
    certificate_free_credentials = (
 
 
675
        _library.gnutls_certificate_free_credentials)
 
 
676
    certificate_free_credentials.argtypes = [
 
 
677
        certificate_credentials_t]
 
 
678
    certificate_free_credentials.restype = None
 
 
680
    handshake_set_private_extensions = (
 
 
681
        _library.gnutls_handshake_set_private_extensions)
 
 
682
    handshake_set_private_extensions.argtypes = [session_t,
 
 
684
    handshake_set_private_extensions.restype = None
 
 
686
    credentials_set = _library.gnutls_credentials_set
 
 
687
    credentials_set.argtypes = [session_t, credentials_type_t,
 
 
689
    credentials_set.restype = _error_code
 
 
691
    strerror = _library.gnutls_strerror
 
 
692
    strerror.argtypes = [ctypes.c_int]
 
 
693
    strerror.restype = ctypes.c_char_p
 
 
695
    certificate_type_get = _library.gnutls_certificate_type_get
 
 
696
    certificate_type_get.argtypes = [session_t]
 
 
697
    certificate_type_get.restype = _error_code
 
 
699
    certificate_get_peers = _library.gnutls_certificate_get_peers
 
 
700
    certificate_get_peers.argtypes = [session_t,
 
 
701
                                      ctypes.POINTER(ctypes.c_uint)]
 
 
702
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
 
 
704
    global_set_log_level = _library.gnutls_global_set_log_level
 
 
705
    global_set_log_level.argtypes = [ctypes.c_int]
 
 
706
    global_set_log_level.restype = None
 
 
708
    global_set_log_function = _library.gnutls_global_set_log_function
 
 
709
    global_set_log_function.argtypes = [log_func]
 
 
710
    global_set_log_function.restype = None
 
 
712
    deinit = _library.gnutls_deinit
 
 
713
    deinit.argtypes = [session_t]
 
 
714
    deinit.restype = None
 
 
716
    handshake = _library.gnutls_handshake
 
 
717
    handshake.argtypes = [session_t]
 
 
718
    handshake.restype = _error_code
 
 
719
    handshake.errcheck = _retry_on_error
 
 
721
    transport_set_ptr = _library.gnutls_transport_set_ptr
 
 
722
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
 
723
    transport_set_ptr.restype = None
 
 
725
    bye = _library.gnutls_bye
 
 
726
    bye.argtypes = [session_t, close_request_t]
 
 
727
    bye.restype = _error_code
 
 
728
    bye.errcheck = _retry_on_error
 
 
730
    check_version = _library.gnutls_check_version
 
 
731
    check_version.argtypes = [ctypes.c_char_p]
 
 
732
    check_version.restype = ctypes.c_char_p
 
 
734
    # All the function declarations below are from gnutls/openpgp.h
 
 
736
    openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
 
737
    openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
 
738
    openpgp_crt_init.restype = _error_code
 
 
740
    openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
 
741
    openpgp_crt_import.argtypes = [openpgp_crt_t,
 
 
742
                                   ctypes.POINTER(datum_t),
 
 
744
    openpgp_crt_import.restype = _error_code
 
 
746
    openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
 
747
    openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
 
748
                                        ctypes.POINTER(ctypes.c_uint)]
 
 
749
    openpgp_crt_verify_self.restype = _error_code
 
 
751
    openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
 
752
    openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
 
753
    openpgp_crt_deinit.restype = None
 
 
755
    openpgp_crt_get_fingerprint = (
 
 
756
        _library.gnutls_openpgp_crt_get_fingerprint)
 
 
757
    openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
 
761
    openpgp_crt_get_fingerprint.restype = _error_code
 
 
763
    # Remove non-public functions
 
 
764
    del _error_code, _retry_on_error
 
 
765
# Create the global "gnutls" object, simulating a module
 
 
769
def call_pipe(connection,       # : multiprocessing.Connection
 
 
770
              func, *args, **kwargs):
 
 
771
    """This function is meant to be called by multiprocessing.Process
 
 
773
    This function runs func(*args, **kwargs), and writes the resulting
 
 
774
    return value on the provided multiprocessing.Connection.
 
 
776
    connection.send(func(*args, **kwargs))
 
168
780
class Client(object):
 
169
781
    """A representation of a client host served by this server.
 
171
 
    name:      string; from the config file, used in log messages
 
 
784
    approved:   bool(); 'None' if not yet approved/disapproved
 
 
785
    approval_delay: datetime.timedelta(); Time to wait for approval
 
 
786
    approval_duration: datetime.timedelta(); Duration of one approval
 
 
787
    checker:    subprocess.Popen(); a running checker process used
 
 
788
                                    to see if the client lives.
 
 
789
                                    'None' if no process is running.
 
 
790
    checker_callback_tag: a GLib event source tag, or None
 
 
791
    checker_command: string; External command which is run to check
 
 
792
                     if client lives.  %() expansions are done at
 
 
793
                     runtime with vars(self) as dict, so that for
 
 
794
                     instance %(name)s can be used in the command.
 
 
795
    checker_initiator_tag: a GLib event source tag, or None
 
 
796
    created:    datetime.datetime(); (UTC) object creation
 
 
797
    client_structure: Object describing what attributes a client has
 
 
798
                      and is used for storing the client at exit
 
 
799
    current_checker_command: string; current running checker_command
 
 
800
    disable_initiator_tag: a GLib event source tag, or None
 
172
802
    fingerprint: string (40 or 32 hexadecimal digits); used to
 
173
803
                 uniquely identify the client
 
174
 
    secret:    bytestring; sent verbatim (over TLS) to client
 
175
 
    host:      string; available for use by the checker command
 
176
 
    created:   datetime.datetime(); object creation, not client host
 
177
 
    last_checked_ok: datetime.datetime() or None if not yet checked OK
 
178
 
    timeout:   datetime.timedelta(); How long from last_checked_ok
 
179
 
                                     until this client is invalid
 
180
 
    interval:  datetime.timedelta(); How often to start a new checker
 
181
 
    stop_hook: If set, called by stop() as stop_hook(self)
 
182
 
    checker:   subprocess.Popen(); a running checker process used
 
183
 
                                   to see if the client lives.
 
184
 
                                   'None' if no process is running.
 
185
 
    checker_initiator_tag: a gobject event source tag, or None
 
186
 
    stop_initiator_tag:    - '' -
 
187
 
    checker_callback_tag:  - '' -
 
188
 
    checker_command: string; External command which is run to check if
 
189
 
                     client lives.  %() expansions are done at
 
190
 
                     runtime with vars(self) as dict, so that for
 
191
 
                     instance %(name)s can be used in the command.
 
193
 
    _timeout: Real variable for 'timeout'
 
194
 
    _interval: Real variable for 'interval'
 
195
 
    _timeout_milliseconds: Used when calling gobject.timeout_add()
 
196
 
    _interval_milliseconds: - '' -
 
 
804
    host:       string; available for use by the checker command
 
 
805
    interval:   datetime.timedelta(); How often to start a new checker
 
 
806
    last_approval_request: datetime.datetime(); (UTC) or None
 
 
807
    last_checked_ok: datetime.datetime(); (UTC) or None
 
 
808
    last_checker_status: integer between 0 and 255 reflecting exit
 
 
809
                         status of last checker. -1 reflects crashed
 
 
810
                         checker, -2 means no checker completed yet.
 
 
811
    last_checker_signal: The signal which killed the last checker, if
 
 
812
                         last_checker_status is -1
 
 
813
    last_enabled: datetime.datetime(); (UTC) or None
 
 
814
    name:       string; from the config file, used in log messages and
 
 
816
    secret:     bytestring; sent verbatim (over TLS) to client
 
 
817
    timeout:    datetime.timedelta(); How long from last_checked_ok
 
 
818
                                      until this client is disabled
 
 
819
    extended_timeout:   extra long timeout when secret has been sent
 
 
820
    runtime_expansions: Allowed attributes for runtime expansion.
 
 
821
    expires:    datetime.datetime(); time (UTC) when a client will be
 
 
823
    server_settings: The server_settings dict from main()
 
198
 
    def _set_timeout(self, timeout):
 
199
 
        "Setter function for 'timeout' attribute"
 
200
 
        self._timeout = timeout
 
201
 
        self._timeout_milliseconds = ((self.timeout.days
 
202
 
                                       * 24 * 60 * 60 * 1000)
 
203
 
                                      + (self.timeout.seconds * 1000)
 
204
 
                                      + (self.timeout.microseconds
 
206
 
    timeout = property(lambda self: self._timeout,
 
209
 
    def _set_interval(self, interval):
 
210
 
        "Setter function for 'interval' attribute"
 
211
 
        self._interval = interval
 
212
 
        self._interval_milliseconds = ((self.interval.days
 
213
 
                                        * 24 * 60 * 60 * 1000)
 
214
 
                                       + (self.interval.seconds
 
216
 
                                       + (self.interval.microseconds
 
218
 
    interval = property(lambda self: self._interval,
 
221
 
    def __init__(self, name = None, stop_hook=None, config={}):
 
222
 
        """Note: the 'checker' key in 'config' sets the
 
223
 
        'checker_command' attribute and *not* the 'checker'
 
 
826
    runtime_expansions = ("approval_delay", "approval_duration",
 
 
827
                          "created", "enabled", "expires",
 
 
828
                          "fingerprint", "host", "interval",
 
 
829
                          "last_approval_request", "last_checked_ok",
 
 
830
                          "last_enabled", "name", "timeout")
 
 
833
        "extended_timeout": "PT15M",
 
 
835
        "checker": "fping -q -- %%(host)s",
 
 
837
        "approval_delay": "PT0S",
 
 
838
        "approval_duration": "PT1S",
 
 
839
        "approved_by_default": "True",
 
 
844
    def config_parser(config):
 
 
845
        """Construct a new dict of client settings of this form:
 
 
846
        { client_name: {setting_name: value, ...}, ...}
 
 
847
        with exceptions for any special settings as defined above.
 
 
848
        NOTE: Must be a pure function. Must return the same result
 
 
849
        value given the same arguments.
 
 
852
        for client_name in config.sections():
 
 
853
            section = dict(config.items(client_name))
 
 
854
            client = settings[client_name] = {}
 
 
856
            client["host"] = section["host"]
 
 
857
            # Reformat values from string types to Python types
 
 
858
            client["approved_by_default"] = config.getboolean(
 
 
859
                client_name, "approved_by_default")
 
 
860
            client["enabled"] = config.getboolean(client_name,
 
 
863
            # Uppercase and remove spaces from fingerprint for later
 
 
864
            # comparison purposes with return value from the
 
 
865
            # fingerprint() function
 
 
866
            client["fingerprint"] = (section["fingerprint"].upper()
 
 
868
            if "secret" in section:
 
 
869
                client["secret"] = codecs.decode(section["secret"]
 
 
872
            elif "secfile" in section:
 
 
873
                with open(os.path.expanduser(os.path.expandvars
 
 
874
                                             (section["secfile"])),
 
 
876
                    client["secret"] = secfile.read()
 
 
878
                raise TypeError("No secret or secfile for section {}"
 
 
880
            client["timeout"] = string_to_delta(section["timeout"])
 
 
881
            client["extended_timeout"] = string_to_delta(
 
 
882
                section["extended_timeout"])
 
 
883
            client["interval"] = string_to_delta(section["interval"])
 
 
884
            client["approval_delay"] = string_to_delta(
 
 
885
                section["approval_delay"])
 
 
886
            client["approval_duration"] = string_to_delta(
 
 
887
                section["approval_duration"])
 
 
888
            client["checker_command"] = section["checker"]
 
 
889
            client["last_approval_request"] = None
 
 
890
            client["last_checked_ok"] = None
 
 
891
            client["last_checker_status"] = -2
 
 
895
    def __init__(self, settings, name=None, server_settings=None):
 
226
 
        logger.debug(u"Creating client %r", self.name)
 
227
 
        # Uppercase and remove spaces from fingerprint for later
 
228
 
        # comparison purposes with return value from the fingerprint()
 
230
 
        self.fingerprint = config["fingerprint"].upper()\
 
232
 
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
 
233
 
        if "secret" in config:
 
234
 
            self.secret = config["secret"].decode(u"base64")
 
235
 
        elif "secfile" in config:
 
236
 
            sf = open(config["secfile"])
 
237
 
            self.secret = sf.read()
 
 
897
        if server_settings is None:
 
 
899
        self.server_settings = server_settings
 
 
900
        # adding all client settings
 
 
901
        for setting, value in settings.items():
 
 
902
            setattr(self, setting, value)
 
 
905
            if not hasattr(self, "last_enabled"):
 
 
906
                self.last_enabled = datetime.datetime.utcnow()
 
 
907
            if not hasattr(self, "expires"):
 
 
908
                self.expires = (datetime.datetime.utcnow()
 
240
 
            raise TypeError(u"No secret or secfile for client %s"
 
242
 
        self.host = config.get("host", "")
 
243
 
        self.created = datetime.datetime.now()
 
244
 
        self.last_checked_ok = None
 
245
 
        self.timeout = string_to_delta(config["timeout"])
 
246
 
        self.interval = string_to_delta(config["interval"])
 
247
 
        self.stop_hook = stop_hook
 
 
911
            self.last_enabled = None
 
 
914
        logger.debug("Creating client %r", self.name)
 
 
915
        logger.debug("  Fingerprint: %s", self.fingerprint)
 
 
916
        self.created = settings.get("created",
 
 
917
                                    datetime.datetime.utcnow())
 
 
919
        # attributes specific for this server instance
 
248
920
        self.checker = None
 
249
921
        self.checker_initiator_tag = None
 
250
 
        self.stop_initiator_tag = None
 
 
922
        self.disable_initiator_tag = None
 
251
923
        self.checker_callback_tag = None
 
252
 
        self.check_command = config["checker"]
 
 
924
        self.current_checker_command = None
 
 
926
        self.approvals_pending = 0
 
 
927
        self.changedstate = multiprocessing_manager.Condition(
 
 
928
            multiprocessing_manager.Lock())
 
 
929
        self.client_structure = [attr
 
 
930
                                 for attr in self.__dict__.keys()
 
 
931
                                 if not attr.startswith("_")]
 
 
932
        self.client_structure.append("client_structure")
 
 
934
        for name, t in inspect.getmembers(
 
 
935
                type(self), lambda obj: isinstance(obj, property)):
 
 
936
            if not name.startswith("_"):
 
 
937
                self.client_structure.append(name)
 
 
939
    # Send notice to process children that client state has changed
 
 
940
    def send_changedstate(self):
 
 
941
        with self.changedstate:
 
 
942
            self.changedstate.notify_all()
 
254
945
        """Start this client's checker and timeout hooks"""
 
 
946
        if getattr(self, "enabled", False):
 
 
949
        self.expires = datetime.datetime.utcnow() + self.timeout
 
 
951
        self.last_enabled = datetime.datetime.utcnow()
 
 
953
        self.send_changedstate()
 
 
955
    def disable(self, quiet=True):
 
 
956
        """Disable this client."""
 
 
957
        if not getattr(self, "enabled", False):
 
 
960
            logger.info("Disabling client %s", self.name)
 
 
961
        if getattr(self, "disable_initiator_tag", None) is not None:
 
 
962
            GLib.source_remove(self.disable_initiator_tag)
 
 
963
            self.disable_initiator_tag = None
 
 
965
        if getattr(self, "checker_initiator_tag", None) is not None:
 
 
966
            GLib.source_remove(self.checker_initiator_tag)
 
 
967
            self.checker_initiator_tag = None
 
 
971
            self.send_changedstate()
 
 
972
        # Do not run this again if called by a GLib.timeout_add
 
 
978
    def init_checker(self):
 
255
979
        # Schedule a new checker to be started an 'interval' from now,
 
256
980
        # and every interval from then on.
 
257
 
        self.checker_initiator_tag = gobject.timeout_add\
 
258
 
                                     (self._interval_milliseconds,
 
 
981
        if self.checker_initiator_tag is not None:
 
 
982
            GLib.source_remove(self.checker_initiator_tag)
 
 
983
        self.checker_initiator_tag = GLib.timeout_add(
 
 
984
            int(self.interval.total_seconds() * 1000),
 
 
986
        # Schedule a disable() when 'timeout' has passed
 
 
987
        if self.disable_initiator_tag is not None:
 
 
988
            GLib.source_remove(self.disable_initiator_tag)
 
 
989
        self.disable_initiator_tag = GLib.timeout_add(
 
 
990
            int(self.timeout.total_seconds() * 1000), self.disable)
 
260
991
        # Also start a new checker *right now*.
 
261
992
        self.start_checker()
 
262
 
        # Schedule a stop() when 'timeout' has passed
 
263
 
        self.stop_initiator_tag = gobject.timeout_add\
 
264
 
                                  (self._timeout_milliseconds,
 
268
 
        The possibility that a client might be restarted is left open,
 
269
 
        but not currently used."""
 
270
 
        # If this client doesn't have a secret, it is already stopped.
 
271
 
        if hasattr(self, "secret") and self.secret:
 
272
 
            logger.info(u"Stopping client %s", self.name)
 
276
 
        if getattr(self, "stop_initiator_tag", False):
 
277
 
            gobject.source_remove(self.stop_initiator_tag)
 
278
 
            self.stop_initiator_tag = None
 
279
 
        if getattr(self, "checker_initiator_tag", False):
 
280
 
            gobject.source_remove(self.checker_initiator_tag)
 
281
 
            self.checker_initiator_tag = None
 
285
 
        # Do not run this again if called by a gobject.timeout_add
 
288
 
        self.stop_hook = None
 
290
 
    def checker_callback(self, pid, condition):
 
 
994
    def checker_callback(self, source, condition, connection,
 
291
996
        """The checker has completed, so take appropriate actions."""
 
292
 
        now = datetime.datetime.now()
 
293
997
        self.checker_callback_tag = None
 
294
998
        self.checker = None
 
295
 
        if os.WIFEXITED(condition) \
 
296
 
               and (os.WEXITSTATUS(condition) == 0):
 
297
 
            logger.info(u"Checker for %(name)s succeeded",
 
299
 
            self.last_checked_ok = now
 
300
 
            gobject.source_remove(self.stop_initiator_tag)
 
301
 
            self.stop_initiator_tag = gobject.timeout_add\
 
302
 
                                      (self._timeout_milliseconds,
 
304
 
        elif not os.WIFEXITED(condition):
 
305
 
            logger.warning(u"Checker for %(name)s crashed?",
 
 
999
        # Read return code from connection (see call_pipe)
 
 
1000
        returncode = connection.recv()
 
 
1004
            self.last_checker_status = returncode
 
 
1005
            self.last_checker_signal = None
 
 
1006
            if self.last_checker_status == 0:
 
 
1007
                logger.info("Checker for %(name)s succeeded",
 
 
1011
                logger.info("Checker for %(name)s failed", vars(self))
 
 
1013
            self.last_checker_status = -1
 
 
1014
            self.last_checker_signal = -returncode
 
 
1015
            logger.warning("Checker for %(name)s crashed?",
 
308
 
            logger.info(u"Checker for %(name)s failed",
 
 
1019
    def checked_ok(self):
 
 
1020
        """Assert that the client has been seen, alive and well."""
 
 
1021
        self.last_checked_ok = datetime.datetime.utcnow()
 
 
1022
        self.last_checker_status = 0
 
 
1023
        self.last_checker_signal = None
 
 
1026
    def bump_timeout(self, timeout=None):
 
 
1027
        """Bump up the timeout for this client."""
 
 
1029
            timeout = self.timeout
 
 
1030
        if self.disable_initiator_tag is not None:
 
 
1031
            GLib.source_remove(self.disable_initiator_tag)
 
 
1032
            self.disable_initiator_tag = None
 
 
1033
        if getattr(self, "enabled", False):
 
 
1034
            self.disable_initiator_tag = GLib.timeout_add(
 
 
1035
                int(timeout.total_seconds() * 1000), self.disable)
 
 
1036
            self.expires = datetime.datetime.utcnow() + timeout
 
 
1038
    def need_approval(self):
 
 
1039
        self.last_approval_request = datetime.datetime.utcnow()
 
310
1041
    def start_checker(self):
 
311
1042
        """Start a new checker subprocess if one is not running.
 
312
1044
        If a checker already exists, leave it running and do
 
314
1046
        # The reason for not killing a running checker is that if we
 
315
 
        # did that, then if a checker (for some reason) started
 
316
 
        # running slowly and taking more than 'interval' time, the
 
317
 
        # client would inevitably timeout, since no checker would get
 
318
 
        # a chance to run to completion.  If we instead leave running
 
 
1047
        # did that, and if a checker (for some reason) started running
 
 
1048
        # slowly and taking more than 'interval' time, then the client
 
 
1049
        # would inevitably timeout, since no checker would get a
 
 
1050
        # chance to run to completion.  If we instead leave running
 
319
1051
        # checkers alone, the checker would have to take more time
 
320
 
        # than 'timeout' for the client to be declared invalid, which
 
321
 
        # is as it should be.
 
 
1052
        # than 'timeout' for the client to be disabled, which is as it
 
 
1055
        if self.checker is not None and not self.checker.is_alive():
 
 
1056
            logger.warning("Checker was not alive; joining")
 
 
1059
        # Start a new checker if needed
 
322
1060
        if self.checker is None:
 
324
 
                # In case check_command has exactly one % operator
 
325
 
                command = self.check_command % self.host
 
327
 
                # Escape attributes for the shell
 
328
 
                escaped_attrs = dict((key, re.escape(str(val)))
 
330
 
                                     vars(self).iteritems())
 
332
 
                    command = self.check_command % escaped_attrs
 
333
 
                except TypeError, error:
 
334
 
                    logger.error(u'Could not format string "%s":'
 
335
 
                                 u' %s', self.check_command, error)
 
336
 
                    return True # Try again later
 
338
 
                logger.info(u"Starting checker %r for %s",
 
340
 
                self.checker = subprocess.Popen(command,
 
343
 
                self.checker_callback_tag = gobject.child_watch_add\
 
345
 
                                             self.checker_callback)
 
346
 
            except subprocess.OSError, error:
 
347
 
                logger.error(u"Failed to start subprocess: %s",
 
349
 
        # Re-run this periodically if run by gobject.timeout_add
 
 
1061
            # Escape attributes for the shell
 
 
1063
                attr: re.escape(str(getattr(self, attr)))
 
 
1064
                for attr in self.runtime_expansions}
 
 
1066
                command = self.checker_command % escaped_attrs
 
 
1067
            except TypeError as error:
 
 
1068
                logger.error('Could not format string "%s"',
 
 
1069
                             self.checker_command,
 
 
1071
                return True     # Try again later
 
 
1072
            self.current_checker_command = command
 
 
1073
            logger.info("Starting checker %r for %s", command,
 
 
1075
            # We don't need to redirect stdout and stderr, since
 
 
1076
            # in normal mode, that is already done by daemon(),
 
 
1077
            # and in debug mode we don't want to.  (Stdin is
 
 
1078
            # always replaced by /dev/null.)
 
 
1079
            # The exception is when not debugging but nevertheless
 
 
1080
            # running in the foreground; use the previously
 
 
1082
            popen_args = {"close_fds": True,
 
 
1085
            if (not self.server_settings["debug"]
 
 
1086
                and self.server_settings["foreground"]):
 
 
1087
                popen_args.update({"stdout": wnull,
 
 
1089
            pipe = multiprocessing.Pipe(duplex=False)
 
 
1090
            self.checker = multiprocessing.Process(
 
 
1092
                args=(pipe[1], subprocess.call, command),
 
 
1094
            self.checker.start()
 
 
1095
            self.checker_callback_tag = GLib.io_add_watch(
 
 
1096
                pipe[0].fileno(), GLib.IO_IN,
 
 
1097
                self.checker_callback, pipe[0], command)
 
 
1098
        # Re-run this periodically if run by GLib.timeout_add
 
351
1101
    def stop_checker(self):
 
352
1102
        """Force the checker process, if any, to stop."""
 
353
1103
        if self.checker_callback_tag:
 
354
 
            gobject.source_remove(self.checker_callback_tag)
 
 
1104
            GLib.source_remove(self.checker_callback_tag)
 
355
1105
            self.checker_callback_tag = None
 
356
1106
        if getattr(self, "checker", None) is None:
 
358
 
        logger.debug(u"Stopping checker for %(name)s", vars(self))
 
360
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
362
 
            #if self.checker.poll() is None:
 
363
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
364
 
        except OSError, error:
 
365
 
            if error.errno != errno.ESRCH: # No such process
 
 
1108
        logger.debug("Stopping checker for %(name)s", vars(self))
 
 
1109
        self.checker.terminate()
 
367
1110
        self.checker = None
 
368
 
    def still_valid(self):
 
369
 
        """Has the timeout not yet passed for this client?"""
 
370
 
        now = datetime.datetime.now()
 
371
 
        if self.last_checked_ok is None:
 
372
 
            return now < (self.created + self.timeout)
 
374
 
            return now < (self.last_checked_ok + self.timeout)
 
377
 
def peer_certificate(session):
 
378
 
    "Return the peer's OpenPGP certificate as a bytestring"
 
379
 
    # If not an OpenPGP certificate...
 
380
 
    if gnutls.library.functions.gnutls_certificate_type_get\
 
381
 
            (session._c_object) \
 
382
 
           != gnutls.library.constants.GNUTLS_CRT_OPENPGP:
 
383
 
        # ...do the normal thing
 
384
 
        return session.peer_certificate
 
385
 
    list_size = ctypes.c_uint()
 
386
 
    cert_list = gnutls.library.functions.gnutls_certificate_get_peers\
 
387
 
        (session._c_object, ctypes.byref(list_size))
 
388
 
    if list_size.value == 0:
 
391
 
    return ctypes.string_at(cert.data, cert.size)
 
394
 
def fingerprint(openpgp):
 
395
 
    "Convert an OpenPGP bytestring to a hexdigit fingerprint string"
 
396
 
    # New GnuTLS "datum" with the OpenPGP public key
 
397
 
    datum = gnutls.library.types.gnutls_datum_t\
 
398
 
        (ctypes.cast(ctypes.c_char_p(openpgp),
 
399
 
                     ctypes.POINTER(ctypes.c_ubyte)),
 
400
 
         ctypes.c_uint(len(openpgp)))
 
401
 
    # New empty GnuTLS certificate
 
402
 
    crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
403
 
    gnutls.library.functions.gnutls_openpgp_crt_init\
 
405
 
    # Import the OpenPGP public key into the certificate
 
406
 
    gnutls.library.functions.gnutls_openpgp_crt_import\
 
407
 
                    (crt, ctypes.byref(datum),
 
408
 
                     gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
409
 
    # New buffer for the fingerprint
 
410
 
    buffer = ctypes.create_string_buffer(20)
 
411
 
    buffer_length = ctypes.c_size_t()
 
412
 
    # Get the fingerprint from the certificate into the buffer
 
413
 
    gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint\
 
414
 
        (crt, ctypes.byref(buffer), ctypes.byref(buffer_length))
 
415
 
    # Deinit the certificate
 
416
 
    gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
417
 
    # Convert the buffer to a Python bytestring
 
418
 
    fpr = ctypes.string_at(buffer, buffer_length.value)
 
419
 
    # Convert the bytestring to hexadecimal notation
 
420
 
    hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
 
424
 
class tcp_handler(SocketServer.BaseRequestHandler, object):
 
425
 
    """A TCP request handler class.
 
426
 
    Instantiated by IPv6_TCPServer for each request to handle it.
 
 
1113
def dbus_service_property(dbus_interface,
 
 
1117
    """Decorators for marking methods of a DBusObjectWithProperties to
 
 
1118
    become properties on the D-Bus.
 
 
1120
    The decorated method will be called with no arguments by "Get"
 
 
1121
    and with one argument by "Set".
 
 
1123
    The parameters, where they are supported, are the same as
 
 
1124
    dbus.service.method, except there is only "signature", since the
 
 
1125
    type from Get() and the type sent to Set() is the same.
 
 
1127
    # Encoding deeply encoded byte arrays is not supported yet by the
 
 
1128
    # "Set" method, so we fail early here:
 
 
1129
    if byte_arrays and signature != "ay":
 
 
1130
        raise ValueError("Byte arrays not supported for non-'ay'"
 
 
1131
                         " signature {!r}".format(signature))
 
 
1133
    def decorator(func):
 
 
1134
        func._dbus_is_property = True
 
 
1135
        func._dbus_interface = dbus_interface
 
 
1136
        func._dbus_signature = signature
 
 
1137
        func._dbus_access = access
 
 
1138
        func._dbus_name = func.__name__
 
 
1139
        if func._dbus_name.endswith("_dbus_property"):
 
 
1140
            func._dbus_name = func._dbus_name[:-14]
 
 
1141
        func._dbus_get_args_options = {'byte_arrays': byte_arrays}
 
 
1147
def dbus_interface_annotations(dbus_interface):
 
 
1148
    """Decorator for marking functions returning interface annotations
 
 
1152
    @dbus_interface_annotations("org.example.Interface")
 
 
1153
    def _foo(self):  # Function name does not matter
 
 
1154
        return {"org.freedesktop.DBus.Deprecated": "true",
 
 
1155
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
 
1159
    def decorator(func):
 
 
1160
        func._dbus_is_interface = True
 
 
1161
        func._dbus_interface = dbus_interface
 
 
1162
        func._dbus_name = dbus_interface
 
 
1168
def dbus_annotations(annotations):
 
 
1169
    """Decorator to annotate D-Bus methods, signals or properties
 
 
1172
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
 
 
1173
                       "org.freedesktop.DBus.Property."
 
 
1174
                       "EmitsChangedSignal": "false"})
 
 
1175
    @dbus_service_property("org.example.Interface", signature="b",
 
 
1177
    def Property_dbus_property(self):
 
 
1178
        return dbus.Boolean(False)
 
 
1180
    See also the DBusObjectWithAnnotations class.
 
 
1183
    def decorator(func):
 
 
1184
        func._dbus_annotations = annotations
 
 
1190
class DBusPropertyException(dbus.exceptions.DBusException):
 
 
1191
    """A base class for D-Bus property-related exceptions
 
 
1196
class DBusPropertyAccessException(DBusPropertyException):
 
 
1197
    """A property's access permissions disallows an operation.
 
 
1202
class DBusPropertyNotFound(DBusPropertyException):
 
 
1203
    """An attempt was made to access a non-existing property.
 
 
1208
class DBusObjectWithAnnotations(dbus.service.Object):
 
 
1209
    """A D-Bus object with annotations.
 
 
1211
    Classes inheriting from this can use the dbus_annotations
 
 
1212
    decorator to add annotations to methods or signals.
 
 
1216
    def _is_dbus_thing(thing):
 
 
1217
        """Returns a function testing if an attribute is a D-Bus thing
 
 
1219
        If called like _is_dbus_thing("method") it returns a function
 
 
1220
        suitable for use as predicate to inspect.getmembers().
 
 
1222
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
 
 
1225
    def _get_all_dbus_things(self, thing):
 
 
1226
        """Returns a generator of (name, attribute) pairs
 
 
1228
        return ((getattr(athing.__get__(self), "_dbus_name", name),
 
 
1229
                 athing.__get__(self))
 
 
1230
                for cls in self.__class__.__mro__
 
 
1232
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
 
 
1234
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
 
1236
                         path_keyword='object_path',
 
 
1237
                         connection_keyword='connection')
 
 
1238
    def Introspect(self, object_path, connection):
 
 
1239
        """Overloading of standard D-Bus method.
 
 
1241
        Inserts annotation tags on methods and signals.
 
 
1243
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
 
1246
            document = xml.dom.minidom.parseString(xmlstring)
 
 
1248
            for if_tag in document.getElementsByTagName("interface"):
 
 
1249
                # Add annotation tags
 
 
1250
                for typ in ("method", "signal"):
 
 
1251
                    for tag in if_tag.getElementsByTagName(typ):
 
 
1253
                        for name, prop in (self.
 
 
1254
                                           _get_all_dbus_things(typ)):
 
 
1255
                            if (name == tag.getAttribute("name")
 
 
1256
                                and prop._dbus_interface
 
 
1257
                                == if_tag.getAttribute("name")):
 
 
1258
                                annots.update(getattr(
 
 
1259
                                    prop, "_dbus_annotations", {}))
 
 
1260
                        for name, value in annots.items():
 
 
1261
                            ann_tag = document.createElement(
 
 
1263
                            ann_tag.setAttribute("name", name)
 
 
1264
                            ann_tag.setAttribute("value", value)
 
 
1265
                            tag.appendChild(ann_tag)
 
 
1266
                # Add interface annotation tags
 
 
1267
                for annotation, value in dict(
 
 
1268
                    itertools.chain.from_iterable(
 
 
1269
                        annotations().items()
 
 
1270
                        for name, annotations
 
 
1271
                        in self._get_all_dbus_things("interface")
 
 
1272
                        if name == if_tag.getAttribute("name")
 
 
1274
                    ann_tag = document.createElement("annotation")
 
 
1275
                    ann_tag.setAttribute("name", annotation)
 
 
1276
                    ann_tag.setAttribute("value", value)
 
 
1277
                    if_tag.appendChild(ann_tag)
 
 
1278
                # Fix argument name for the Introspect method itself
 
 
1279
                if (if_tag.getAttribute("name")
 
 
1280
                    == dbus.INTROSPECTABLE_IFACE):
 
 
1281
                    for cn in if_tag.getElementsByTagName("method"):
 
 
1282
                        if cn.getAttribute("name") == "Introspect":
 
 
1283
                            for arg in cn.getElementsByTagName("arg"):
 
 
1284
                                if (arg.getAttribute("direction")
 
 
1286
                                    arg.setAttribute("name",
 
 
1288
            xmlstring = document.toxml("utf-8")
 
 
1290
        except (AttributeError, xml.dom.DOMException,
 
 
1291
                xml.parsers.expat.ExpatError) as error:
 
 
1292
            logger.error("Failed to override Introspection method",
 
 
1297
class DBusObjectWithProperties(DBusObjectWithAnnotations):
 
 
1298
    """A D-Bus object with properties.
 
 
1300
    Classes inheriting from this can use the dbus_service_property
 
 
1301
    decorator to expose methods as D-Bus properties.  It exposes the
 
 
1302
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
 
1305
    def _get_dbus_property(self, interface_name, property_name):
 
 
1306
        """Returns a bound method if one exists which is a D-Bus
 
 
1307
        property with the specified name and interface.
 
 
1309
        for cls in self.__class__.__mro__:
 
 
1310
            for name, value in inspect.getmembers(
 
 
1311
                    cls, self._is_dbus_thing("property")):
 
 
1312
                if (value._dbus_name == property_name
 
 
1313
                    and value._dbus_interface == interface_name):
 
 
1314
                    return value.__get__(self)
 
 
1317
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
 
1318
            self.dbus_object_path, interface_name, property_name))
 
 
1321
    def _get_all_interface_names(cls):
 
 
1322
        """Get a sequence of all interfaces supported by an object"""
 
 
1323
        return (name for name in set(getattr(getattr(x, attr),
 
 
1324
                                             "_dbus_interface", None)
 
 
1325
                                     for x in (inspect.getmro(cls))
 
 
1327
                if name is not None)
 
 
1329
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
 
1332
    def Get(self, interface_name, property_name):
 
 
1333
        """Standard D-Bus property Get() method, see D-Bus standard.
 
 
1335
        prop = self._get_dbus_property(interface_name, property_name)
 
 
1336
        if prop._dbus_access == "write":
 
 
1337
            raise DBusPropertyAccessException(property_name)
 
 
1339
        if not hasattr(value, "variant_level"):
 
 
1341
        return type(value)(value, variant_level=value.variant_level+1)
 
 
1343
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
 
 
1344
    def Set(self, interface_name, property_name, value):
 
 
1345
        """Standard D-Bus property Set() method, see D-Bus standard.
 
 
1347
        prop = self._get_dbus_property(interface_name, property_name)
 
 
1348
        if prop._dbus_access == "read":
 
 
1349
            raise DBusPropertyAccessException(property_name)
 
 
1350
        if prop._dbus_get_args_options["byte_arrays"]:
 
 
1351
            # The byte_arrays option is not supported yet on
 
 
1352
            # signatures other than "ay".
 
 
1353
            if prop._dbus_signature != "ay":
 
 
1354
                raise ValueError("Byte arrays not supported for non-"
 
 
1355
                                 "'ay' signature {!r}"
 
 
1356
                                 .format(prop._dbus_signature))
 
 
1357
            value = dbus.ByteArray(b''.join(chr(byte)
 
 
1361
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
 
1363
                         out_signature="a{sv}")
 
 
1364
    def GetAll(self, interface_name):
 
 
1365
        """Standard D-Bus property GetAll() method, see D-Bus
 
 
1368
        Note: Will not include properties with access="write".
 
 
1371
        for name, prop in self._get_all_dbus_things("property"):
 
 
1373
                and interface_name != prop._dbus_interface):
 
 
1374
                # Interface non-empty but did not match
 
 
1376
            # Ignore write-only properties
 
 
1377
            if prop._dbus_access == "write":
 
 
1380
            if not hasattr(value, "variant_level"):
 
 
1381
                properties[name] = value
 
 
1383
            properties[name] = type(value)(
 
 
1384
                value, variant_level=value.variant_level + 1)
 
 
1385
        return dbus.Dictionary(properties, signature="sv")
 
 
1387
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
 
 
1388
    def PropertiesChanged(self, interface_name, changed_properties,
 
 
1389
                          invalidated_properties):
 
 
1390
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
 
 
1395
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
 
1397
                         path_keyword='object_path',
 
 
1398
                         connection_keyword='connection')
 
 
1399
    def Introspect(self, object_path, connection):
 
 
1400
        """Overloading of standard D-Bus method.
 
 
1402
        Inserts property tags and interface annotation tags.
 
 
1404
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
 
1408
            document = xml.dom.minidom.parseString(xmlstring)
 
 
1410
            def make_tag(document, name, prop):
 
 
1411
                e = document.createElement("property")
 
 
1412
                e.setAttribute("name", name)
 
 
1413
                e.setAttribute("type", prop._dbus_signature)
 
 
1414
                e.setAttribute("access", prop._dbus_access)
 
 
1417
            for if_tag in document.getElementsByTagName("interface"):
 
 
1419
                for tag in (make_tag(document, name, prop)
 
 
1421
                            in self._get_all_dbus_things("property")
 
 
1422
                            if prop._dbus_interface
 
 
1423
                            == if_tag.getAttribute("name")):
 
 
1424
                    if_tag.appendChild(tag)
 
 
1425
                # Add annotation tags for properties
 
 
1426
                for tag in if_tag.getElementsByTagName("property"):
 
 
1428
                    for name, prop in self._get_all_dbus_things(
 
 
1430
                        if (name == tag.getAttribute("name")
 
 
1431
                            and prop._dbus_interface
 
 
1432
                            == if_tag.getAttribute("name")):
 
 
1433
                            annots.update(getattr(
 
 
1434
                                prop, "_dbus_annotations", {}))
 
 
1435
                    for name, value in annots.items():
 
 
1436
                        ann_tag = document.createElement(
 
 
1438
                        ann_tag.setAttribute("name", name)
 
 
1439
                        ann_tag.setAttribute("value", value)
 
 
1440
                        tag.appendChild(ann_tag)
 
 
1441
                # Add the names to the return values for the
 
 
1442
                # "org.freedesktop.DBus.Properties" methods
 
 
1443
                if (if_tag.getAttribute("name")
 
 
1444
                    == "org.freedesktop.DBus.Properties"):
 
 
1445
                    for cn in if_tag.getElementsByTagName("method"):
 
 
1446
                        if cn.getAttribute("name") == "Get":
 
 
1447
                            for arg in cn.getElementsByTagName("arg"):
 
 
1448
                                if (arg.getAttribute("direction")
 
 
1450
                                    arg.setAttribute("name", "value")
 
 
1451
                        elif cn.getAttribute("name") == "GetAll":
 
 
1452
                            for arg in cn.getElementsByTagName("arg"):
 
 
1453
                                if (arg.getAttribute("direction")
 
 
1455
                                    arg.setAttribute("name", "props")
 
 
1456
            xmlstring = document.toxml("utf-8")
 
 
1458
        except (AttributeError, xml.dom.DOMException,
 
 
1459
                xml.parsers.expat.ExpatError) as error:
 
 
1460
            logger.error("Failed to override Introspection method",
 
 
1466
    dbus.OBJECT_MANAGER_IFACE
 
 
1467
except AttributeError:
 
 
1468
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
 
1471
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
 
 
1472
    """A D-Bus object with an ObjectManager.
 
 
1474
    Classes inheriting from this exposes the standard
 
 
1475
    GetManagedObjects call and the InterfacesAdded and
 
 
1476
    InterfacesRemoved signals on the standard
 
 
1477
    "org.freedesktop.DBus.ObjectManager" interface.
 
 
1479
    Note: No signals are sent automatically; they must be sent
 
 
1482
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
 
1483
                         out_signature="a{oa{sa{sv}}}")
 
 
1484
    def GetManagedObjects(self):
 
 
1485
        """This function must be overridden"""
 
 
1486
        raise NotImplementedError()
 
 
1488
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
 
 
1489
                         signature="oa{sa{sv}}")
 
 
1490
    def InterfacesAdded(self, object_path, interfaces_and_properties):
 
 
1493
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
 
 
1494
    def InterfacesRemoved(self, object_path, interfaces):
 
 
1497
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
 
1499
                         path_keyword='object_path',
 
 
1500
                         connection_keyword='connection')
 
 
1501
    def Introspect(self, object_path, connection):
 
 
1502
        """Overloading of standard D-Bus method.
 
 
1504
        Override return argument name of GetManagedObjects to be
 
 
1505
        "objpath_interfaces_and_properties"
 
 
1507
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
 
1511
            document = xml.dom.minidom.parseString(xmlstring)
 
 
1513
            for if_tag in document.getElementsByTagName("interface"):
 
 
1514
                # Fix argument name for the GetManagedObjects method
 
 
1515
                if (if_tag.getAttribute("name")
 
 
1516
                    == dbus.OBJECT_MANAGER_IFACE):
 
 
1517
                    for cn in if_tag.getElementsByTagName("method"):
 
 
1518
                        if (cn.getAttribute("name")
 
 
1519
                            == "GetManagedObjects"):
 
 
1520
                            for arg in cn.getElementsByTagName("arg"):
 
 
1521
                                if (arg.getAttribute("direction")
 
 
1525
                                        "objpath_interfaces"
 
 
1527
            xmlstring = document.toxml("utf-8")
 
 
1529
        except (AttributeError, xml.dom.DOMException,
 
 
1530
                xml.parsers.expat.ExpatError) as error:
 
 
1531
            logger.error("Failed to override Introspection method",
 
 
1536
def datetime_to_dbus(dt, variant_level=0):
 
 
1537
    """Convert a UTC datetime.datetime() to a D-Bus type."""
 
 
1539
        return dbus.String("", variant_level=variant_level)
 
 
1540
    return dbus.String(dt.isoformat(), variant_level=variant_level)
 
 
1543
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
 
1544
    """A class decorator; applied to a subclass of
 
 
1545
    dbus.service.Object, it will add alternate D-Bus attributes with
 
 
1546
    interface names according to the "alt_interface_names" mapping.
 
 
1549
    @alternate_dbus_interfaces({"org.example.Interface":
 
 
1550
                                    "net.example.AlternateInterface"})
 
 
1551
    class SampleDBusObject(dbus.service.Object):
 
 
1552
        @dbus.service.method("org.example.Interface")
 
 
1553
        def SampleDBusMethod():
 
 
1556
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
 
1557
    reachable via two interfaces: "org.example.Interface" and
 
 
1558
    "net.example.AlternateInterface", the latter of which will have
 
 
1559
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
 
1560
    "true", unless "deprecate" is passed with a False value.
 
 
1562
    This works for methods and signals, and also for D-Bus properties
 
 
1563
    (from DBusObjectWithProperties) and interfaces (from the
 
 
1564
    dbus_interface_annotations decorator).
 
 
1568
        for orig_interface_name, alt_interface_name in (
 
 
1569
                alt_interface_names.items()):
 
 
1571
            interface_names = set()
 
 
1572
            # Go though all attributes of the class
 
 
1573
            for attrname, attribute in inspect.getmembers(cls):
 
 
1574
                # Ignore non-D-Bus attributes, and D-Bus attributes
 
 
1575
                # with the wrong interface name
 
 
1576
                if (not hasattr(attribute, "_dbus_interface")
 
 
1577
                    or not attribute._dbus_interface.startswith(
 
 
1578
                        orig_interface_name)):
 
 
1580
                # Create an alternate D-Bus interface name based on
 
 
1582
                alt_interface = attribute._dbus_interface.replace(
 
 
1583
                    orig_interface_name, alt_interface_name)
 
 
1584
                interface_names.add(alt_interface)
 
 
1585
                # Is this a D-Bus signal?
 
 
1586
                if getattr(attribute, "_dbus_is_signal", False):
 
 
1587
                    # Extract the original non-method undecorated
 
 
1588
                    # function by black magic
 
 
1589
                    if sys.version_info.major == 2:
 
 
1590
                        nonmethod_func = (dict(
 
 
1591
                            zip(attribute.func_code.co_freevars,
 
 
1592
                                attribute.__closure__))
 
 
1593
                                          ["func"].cell_contents)
 
 
1595
                        nonmethod_func = (dict(
 
 
1596
                            zip(attribute.__code__.co_freevars,
 
 
1597
                                attribute.__closure__))
 
 
1598
                                          ["func"].cell_contents)
 
 
1599
                    # Create a new, but exactly alike, function
 
 
1600
                    # object, and decorate it to be a new D-Bus signal
 
 
1601
                    # with the alternate D-Bus interface name
 
 
1602
                    new_function = copy_function(nonmethod_func)
 
 
1603
                    new_function = (dbus.service.signal(
 
 
1605
                        attribute._dbus_signature)(new_function))
 
 
1606
                    # Copy annotations, if any
 
 
1608
                        new_function._dbus_annotations = dict(
 
 
1609
                            attribute._dbus_annotations)
 
 
1610
                    except AttributeError:
 
 
1613
                    # Define a creator of a function to call both the
 
 
1614
                    # original and alternate functions, so both the
 
 
1615
                    # original and alternate signals gets sent when
 
 
1616
                    # the function is called
 
 
1617
                    def fixscope(func1, func2):
 
 
1618
                        """This function is a scope container to pass
 
 
1619
                        func1 and func2 to the "call_both" function
 
 
1620
                        outside of its arguments"""
 
 
1622
                        @functools.wraps(func2)
 
 
1623
                        def call_both(*args, **kwargs):
 
 
1624
                            """This function will emit two D-Bus
 
 
1625
                            signals by calling func1 and func2"""
 
 
1626
                            func1(*args, **kwargs)
 
 
1627
                            func2(*args, **kwargs)
 
 
1628
                        # Make wrapper function look like a D-Bus
 
 
1630
                        for name, attr in inspect.getmembers(func2):
 
 
1631
                            if name.startswith("_dbus_"):
 
 
1632
                                setattr(call_both, name, attr)
 
 
1635
                    # Create the "call_both" function and add it to
 
 
1637
                    attr[attrname] = fixscope(attribute, new_function)
 
 
1638
                # Is this a D-Bus method?
 
 
1639
                elif getattr(attribute, "_dbus_is_method", False):
 
 
1640
                    # Create a new, but exactly alike, function
 
 
1641
                    # object.  Decorate it to be a new D-Bus method
 
 
1642
                    # with the alternate D-Bus interface name.  Add it
 
 
1645
                        dbus.service.method(
 
 
1647
                            attribute._dbus_in_signature,
 
 
1648
                            attribute._dbus_out_signature)
 
 
1649
                        (copy_function(attribute)))
 
 
1650
                    # Copy annotations, if any
 
 
1652
                        attr[attrname]._dbus_annotations = dict(
 
 
1653
                            attribute._dbus_annotations)
 
 
1654
                    except AttributeError:
 
 
1656
                # Is this a D-Bus property?
 
 
1657
                elif getattr(attribute, "_dbus_is_property", False):
 
 
1658
                    # Create a new, but exactly alike, function
 
 
1659
                    # object, and decorate it to be a new D-Bus
 
 
1660
                    # property with the alternate D-Bus interface
 
 
1661
                    # name.  Add it to the class.
 
 
1662
                    attr[attrname] = (dbus_service_property(
 
 
1663
                        alt_interface, attribute._dbus_signature,
 
 
1664
                        attribute._dbus_access,
 
 
1665
                        attribute._dbus_get_args_options
 
 
1667
                                      (copy_function(attribute)))
 
 
1668
                    # Copy annotations, if any
 
 
1670
                        attr[attrname]._dbus_annotations = dict(
 
 
1671
                            attribute._dbus_annotations)
 
 
1672
                    except AttributeError:
 
 
1674
                # Is this a D-Bus interface?
 
 
1675
                elif getattr(attribute, "_dbus_is_interface", False):
 
 
1676
                    # Create a new, but exactly alike, function
 
 
1677
                    # object.  Decorate it to be a new D-Bus interface
 
 
1678
                    # with the alternate D-Bus interface name.  Add it
 
 
1681
                        dbus_interface_annotations(alt_interface)
 
 
1682
                        (copy_function(attribute)))
 
 
1684
                # Deprecate all alternate interfaces
 
 
1685
                iname = "_AlternateDBusNames_interface_annotation{}"
 
 
1686
                for interface_name in interface_names:
 
 
1688
                    @dbus_interface_annotations(interface_name)
 
 
1690
                        return {"org.freedesktop.DBus.Deprecated":
 
 
1692
                    # Find an unused name
 
 
1693
                    for aname in (iname.format(i)
 
 
1694
                                  for i in itertools.count()):
 
 
1695
                        if aname not in attr:
 
 
1699
                # Replace the class with a new subclass of it with
 
 
1700
                # methods, signals, etc. as created above.
 
 
1701
                if sys.version_info.major == 2:
 
 
1702
                    cls = type(b"{}Alternate".format(cls.__name__),
 
 
1705
                    cls = type("{}Alternate".format(cls.__name__),
 
 
1712
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
 
1713
                            "se.bsnet.fukt.Mandos"})
 
 
1714
class ClientDBus(Client, DBusObjectWithProperties):
 
 
1715
    """A Client class using D-Bus
 
 
1718
    dbus_object_path: dbus.ObjectPath
 
 
1719
    bus: dbus.SystemBus()
 
 
1722
    runtime_expansions = (Client.runtime_expansions
 
 
1723
                          + ("dbus_object_path", ))
 
 
1725
    _interface = "se.recompile.Mandos.Client"
 
 
1727
    # dbus.service.Object doesn't use super(), so we can't either.
 
 
1729
    def __init__(self, bus=None, *args, **kwargs):
 
 
1731
        Client.__init__(self, *args, **kwargs)
 
 
1732
        # Only now, when this client is initialized, can it show up on
 
 
1734
        client_object_name = str(self.name).translate(
 
 
1735
            {ord("."): ord("_"),
 
 
1736
             ord("-"): ord("_")})
 
 
1737
        self.dbus_object_path = dbus.ObjectPath(
 
 
1738
            "/clients/" + client_object_name)
 
 
1739
        DBusObjectWithProperties.__init__(self, self.bus,
 
 
1740
                                          self.dbus_object_path)
 
 
1742
    def notifychangeproperty(transform_func, dbus_name,
 
 
1743
                             type_func=lambda x: x,
 
 
1745
                             invalidate_only=False,
 
 
1746
                             _interface=_interface):
 
 
1747
        """ Modify a variable so that it's a property which announces
 
 
1748
        its changes to DBus.
 
 
1750
        transform_fun: Function that takes a value and a variant_level
 
 
1751
                       and transforms it to a D-Bus type.
 
 
1752
        dbus_name: D-Bus name of the variable
 
 
1753
        type_func: Function that transform the value before sending it
 
 
1754
                   to the D-Bus.  Default: no transform
 
 
1755
        variant_level: D-Bus variant level.  Default: 1
 
 
1757
        attrname = "_{}".format(dbus_name)
 
 
1759
        def setter(self, value):
 
 
1760
            if hasattr(self, "dbus_object_path"):
 
 
1761
                if (not hasattr(self, attrname) or
 
 
1762
                    type_func(getattr(self, attrname, None))
 
 
1763
                    != type_func(value)):
 
 
1765
                        self.PropertiesChanged(
 
 
1766
                            _interface, dbus.Dictionary(),
 
 
1767
                            dbus.Array((dbus_name, )))
 
 
1769
                        dbus_value = transform_func(
 
 
1771
                            variant_level=variant_level)
 
 
1772
                        self.PropertyChanged(dbus.String(dbus_name),
 
 
1774
                        self.PropertiesChanged(
 
 
1776
                            dbus.Dictionary({dbus.String(dbus_name):
 
 
1779
            setattr(self, attrname, value)
 
 
1781
        return property(lambda self: getattr(self, attrname), setter)
 
 
1783
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
 
 
1784
    approvals_pending = notifychangeproperty(dbus.Boolean,
 
 
1787
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
 
 
1788
    last_enabled = notifychangeproperty(datetime_to_dbus,
 
 
1790
    checker = notifychangeproperty(
 
 
1791
        dbus.Boolean, "CheckerRunning",
 
 
1792
        type_func=lambda checker: checker is not None)
 
 
1793
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
 
 
1795
    last_checker_status = notifychangeproperty(dbus.Int16,
 
 
1796
                                               "LastCheckerStatus")
 
 
1797
    last_approval_request = notifychangeproperty(
 
 
1798
        datetime_to_dbus, "LastApprovalRequest")
 
 
1799
    approved_by_default = notifychangeproperty(dbus.Boolean,
 
 
1800
                                               "ApprovedByDefault")
 
 
1801
    approval_delay = notifychangeproperty(
 
 
1802
        dbus.UInt64, "ApprovalDelay",
 
 
1803
        type_func=lambda td: td.total_seconds() * 1000)
 
 
1804
    approval_duration = notifychangeproperty(
 
 
1805
        dbus.UInt64, "ApprovalDuration",
 
 
1806
        type_func=lambda td: td.total_seconds() * 1000)
 
 
1807
    host = notifychangeproperty(dbus.String, "Host")
 
 
1808
    timeout = notifychangeproperty(
 
 
1809
        dbus.UInt64, "Timeout",
 
 
1810
        type_func=lambda td: td.total_seconds() * 1000)
 
 
1811
    extended_timeout = notifychangeproperty(
 
 
1812
        dbus.UInt64, "ExtendedTimeout",
 
 
1813
        type_func=lambda td: td.total_seconds() * 1000)
 
 
1814
    interval = notifychangeproperty(
 
 
1815
        dbus.UInt64, "Interval",
 
 
1816
        type_func=lambda td: td.total_seconds() * 1000)
 
 
1817
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
 
1818
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
 
1819
                                  invalidate_only=True)
 
 
1821
    del notifychangeproperty
 
 
1823
    def __del__(self, *args, **kwargs):
 
 
1825
            self.remove_from_connection()
 
 
1828
        if hasattr(DBusObjectWithProperties, "__del__"):
 
 
1829
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
 
 
1830
        Client.__del__(self, *args, **kwargs)
 
 
1832
    def checker_callback(self, source, condition,
 
 
1833
                         connection, command, *args, **kwargs):
 
 
1834
        ret = Client.checker_callback(self, source, condition,
 
 
1835
                                      connection, command, *args,
 
 
1837
        exitstatus = self.last_checker_status
 
 
1840
            self.CheckerCompleted(dbus.Int16(exitstatus),
 
 
1841
                                  # This is specific to GNU libC
 
 
1842
                                  dbus.Int64(exitstatus << 8),
 
 
1843
                                  dbus.String(command))
 
 
1846
            self.CheckerCompleted(dbus.Int16(-1),
 
 
1848
                                      # This is specific to GNU libC
 
 
1850
                                      | self.last_checker_signal),
 
 
1851
                                  dbus.String(command))
 
 
1854
    def start_checker(self, *args, **kwargs):
 
 
1855
        old_checker_pid = getattr(self.checker, "pid", None)
 
 
1856
        r = Client.start_checker(self, *args, **kwargs)
 
 
1857
        # Only if new checker process was started
 
 
1858
        if (self.checker is not None
 
 
1859
            and old_checker_pid != self.checker.pid):
 
 
1861
            self.CheckerStarted(self.current_checker_command)
 
 
1864
    def _reset_approved(self):
 
 
1865
        self.approved = None
 
 
1868
    def approve(self, value=True):
 
 
1869
        self.approved = value
 
 
1870
        GLib.timeout_add(int(self.approval_duration.total_seconds()
 
 
1871
                             * 1000), self._reset_approved)
 
 
1872
        self.send_changedstate()
 
 
1874
    #  D-Bus methods, signals & properties
 
 
1880
    # CheckerCompleted - signal
 
 
1881
    @dbus.service.signal(_interface, signature="nxs")
 
 
1882
    def CheckerCompleted(self, exitcode, waitstatus, command):
 
 
1886
    # CheckerStarted - signal
 
 
1887
    @dbus.service.signal(_interface, signature="s")
 
 
1888
    def CheckerStarted(self, command):
 
 
1892
    # PropertyChanged - signal
 
 
1893
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
 
 
1894
    @dbus.service.signal(_interface, signature="sv")
 
 
1895
    def PropertyChanged(self, property, value):
 
 
1899
    # GotSecret - signal
 
 
1900
    @dbus.service.signal(_interface)
 
 
1901
    def GotSecret(self):
 
 
1903
        Is sent after a successful transfer of secret from the Mandos
 
 
1904
        server to mandos-client
 
 
1909
    @dbus.service.signal(_interface, signature="s")
 
 
1910
    def Rejected(self, reason):
 
 
1914
    # NeedApproval - signal
 
 
1915
    @dbus.service.signal(_interface, signature="tb")
 
 
1916
    def NeedApproval(self, timeout, default):
 
 
1918
        return self.need_approval()
 
 
1923
    @dbus.service.method(_interface, in_signature="b")
 
 
1924
    def Approve(self, value):
 
 
1927
    # CheckedOK - method
 
 
1928
    @dbus.service.method(_interface)
 
 
1929
    def CheckedOK(self):
 
 
1933
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
 
 
1934
    @dbus.service.method(_interface)
 
 
1939
    # StartChecker - method
 
 
1940
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
 
 
1941
    @dbus.service.method(_interface)
 
 
1942
    def StartChecker(self):
 
 
1944
        self.start_checker()
 
 
1947
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
 
 
1948
    @dbus.service.method(_interface)
 
 
1953
    # StopChecker - method
 
 
1954
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
 
 
1955
    @dbus.service.method(_interface)
 
 
1956
    def StopChecker(self):
 
 
1961
    # ApprovalPending - property
 
 
1962
    @dbus_service_property(_interface, signature="b", access="read")
 
 
1963
    def ApprovalPending_dbus_property(self):
 
 
1964
        return dbus.Boolean(bool(self.approvals_pending))
 
 
1966
    # ApprovedByDefault - property
 
 
1967
    @dbus_service_property(_interface,
 
 
1970
    def ApprovedByDefault_dbus_property(self, value=None):
 
 
1971
        if value is None:       # get
 
 
1972
            return dbus.Boolean(self.approved_by_default)
 
 
1973
        self.approved_by_default = bool(value)
 
 
1975
    # ApprovalDelay - property
 
 
1976
    @dbus_service_property(_interface,
 
 
1979
    def ApprovalDelay_dbus_property(self, value=None):
 
 
1980
        if value is None:       # get
 
 
1981
            return dbus.UInt64(self.approval_delay.total_seconds()
 
 
1983
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
 
 
1985
    # ApprovalDuration - property
 
 
1986
    @dbus_service_property(_interface,
 
 
1989
    def ApprovalDuration_dbus_property(self, value=None):
 
 
1990
        if value is None:       # get
 
 
1991
            return dbus.UInt64(self.approval_duration.total_seconds()
 
 
1993
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
 
 
1997
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
 
 
1998
    @dbus_service_property(_interface, signature="s", access="read")
 
 
1999
    def Name_dbus_property(self):
 
 
2000
        return dbus.String(self.name)
 
 
2002
    # Fingerprint - property
 
 
2004
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
 
 
2005
    @dbus_service_property(_interface, signature="s", access="read")
 
 
2006
    def Fingerprint_dbus_property(self):
 
 
2007
        return dbus.String(self.fingerprint)
 
 
2010
    @dbus_service_property(_interface,
 
 
2013
    def Host_dbus_property(self, value=None):
 
 
2014
        if value is None:       # get
 
 
2015
            return dbus.String(self.host)
 
 
2016
        self.host = str(value)
 
 
2018
    # Created - property
 
 
2020
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
 
 
2021
    @dbus_service_property(_interface, signature="s", access="read")
 
 
2022
    def Created_dbus_property(self):
 
 
2023
        return datetime_to_dbus(self.created)
 
 
2025
    # LastEnabled - property
 
 
2026
    @dbus_service_property(_interface, signature="s", access="read")
 
 
2027
    def LastEnabled_dbus_property(self):
 
 
2028
        return datetime_to_dbus(self.last_enabled)
 
 
2030
    # Enabled - property
 
 
2031
    @dbus_service_property(_interface,
 
 
2034
    def Enabled_dbus_property(self, value=None):
 
 
2035
        if value is None:       # get
 
 
2036
            return dbus.Boolean(self.enabled)
 
 
2042
    # LastCheckedOK - property
 
 
2043
    @dbus_service_property(_interface,
 
 
2046
    def LastCheckedOK_dbus_property(self, value=None):
 
 
2047
        if value is not None:
 
 
2050
        return datetime_to_dbus(self.last_checked_ok)
 
 
2052
    # LastCheckerStatus - property
 
 
2053
    @dbus_service_property(_interface, signature="n", access="read")
 
 
2054
    def LastCheckerStatus_dbus_property(self):
 
 
2055
        return dbus.Int16(self.last_checker_status)
 
 
2057
    # Expires - property
 
 
2058
    @dbus_service_property(_interface, signature="s", access="read")
 
 
2059
    def Expires_dbus_property(self):
 
 
2060
        return datetime_to_dbus(self.expires)
 
 
2062
    # LastApprovalRequest - property
 
 
2063
    @dbus_service_property(_interface, signature="s", access="read")
 
 
2064
    def LastApprovalRequest_dbus_property(self):
 
 
2065
        return datetime_to_dbus(self.last_approval_request)
 
 
2067
    # Timeout - property
 
 
2068
    @dbus_service_property(_interface,
 
 
2071
    def Timeout_dbus_property(self, value=None):
 
 
2072
        if value is None:       # get
 
 
2073
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
 
2074
        old_timeout = self.timeout
 
 
2075
        self.timeout = datetime.timedelta(0, 0, 0, value)
 
 
2076
        # Reschedule disabling
 
 
2078
            now = datetime.datetime.utcnow()
 
 
2079
            self.expires += self.timeout - old_timeout
 
 
2080
            if self.expires <= now:
 
 
2081
                # The timeout has passed
 
 
2084
                if (getattr(self, "disable_initiator_tag", None)
 
 
2087
                GLib.source_remove(self.disable_initiator_tag)
 
 
2088
                self.disable_initiator_tag = GLib.timeout_add(
 
 
2089
                    int((self.expires - now).total_seconds() * 1000),
 
 
2092
    # ExtendedTimeout - property
 
 
2093
    @dbus_service_property(_interface,
 
 
2096
    def ExtendedTimeout_dbus_property(self, value=None):
 
 
2097
        if value is None:       # get
 
 
2098
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
 
2100
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
 
 
2102
    # Interval - property
 
 
2103
    @dbus_service_property(_interface,
 
 
2106
    def Interval_dbus_property(self, value=None):
 
 
2107
        if value is None:       # get
 
 
2108
            return dbus.UInt64(self.interval.total_seconds() * 1000)
 
 
2109
        self.interval = datetime.timedelta(0, 0, 0, value)
 
 
2110
        if getattr(self, "checker_initiator_tag", None) is None:
 
 
2113
            # Reschedule checker run
 
 
2114
            GLib.source_remove(self.checker_initiator_tag)
 
 
2115
            self.checker_initiator_tag = GLib.timeout_add(
 
 
2116
                value, self.start_checker)
 
 
2117
            self.start_checker()  # Start one now, too
 
 
2119
    # Checker - property
 
 
2120
    @dbus_service_property(_interface,
 
 
2123
    def Checker_dbus_property(self, value=None):
 
 
2124
        if value is None:       # get
 
 
2125
            return dbus.String(self.checker_command)
 
 
2126
        self.checker_command = str(value)
 
 
2128
    # CheckerRunning - property
 
 
2129
    @dbus_service_property(_interface,
 
 
2132
    def CheckerRunning_dbus_property(self, value=None):
 
 
2133
        if value is None:       # get
 
 
2134
            return dbus.Boolean(self.checker is not None)
 
 
2136
            self.start_checker()
 
 
2140
    # ObjectPath - property
 
 
2142
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
 
2143
         "org.freedesktop.DBus.Deprecated": "true"})
 
 
2144
    @dbus_service_property(_interface, signature="o", access="read")
 
 
2145
    def ObjectPath_dbus_property(self):
 
 
2146
        return self.dbus_object_path  # is already a dbus.ObjectPath
 
 
2150
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
 
 
2152
    @dbus_service_property(_interface,
 
 
2156
    def Secret_dbus_property(self, value):
 
 
2157
        self.secret = bytes(value)
 
 
2162
class ProxyClient(object):
 
 
2163
    def __init__(self, child_pipe, fpr, address):
 
 
2164
        self._pipe = child_pipe
 
 
2165
        self._pipe.send(('init', fpr, address))
 
 
2166
        if not self._pipe.recv():
 
 
2169
    def __getattribute__(self, name):
 
 
2171
            return super(ProxyClient, self).__getattribute__(name)
 
 
2172
        self._pipe.send(('getattr', name))
 
 
2173
        data = self._pipe.recv()
 
 
2174
        if data[0] == 'data':
 
 
2176
        if data[0] == 'function':
 
 
2178
            def func(*args, **kwargs):
 
 
2179
                self._pipe.send(('funcall', name, args, kwargs))
 
 
2180
                return self._pipe.recv()[1]
 
 
2184
    def __setattr__(self, name, value):
 
 
2186
            return super(ProxyClient, self).__setattr__(name, value)
 
 
2187
        self._pipe.send(('setattr', name, value))
 
 
2190
class ClientHandler(socketserver.BaseRequestHandler, object):
 
 
2191
    """A class to handle client connections.
 
 
2193
    Instantiated once for each connection to handle it.
 
427
2194
    Note: This will run in its own forked process."""
 
429
2196
    def handle(self):
 
430
 
        logger.info(u"TCP connection from: %s",
 
431
 
                     unicode(self.client_address))
 
432
 
        session = gnutls.connection.ClientSession\
 
433
 
                  (self.request, gnutls.connection.X509Credentials())
 
435
 
        line = self.request.makefile().readline()
 
436
 
        logger.debug(u"Protocol version: %r", line)
 
438
 
            if int(line.strip().split()[0]) > 1:
 
440
 
        except (ValueError, IndexError, RuntimeError), error:
 
441
 
            logger.error(u"Unknown protocol version: %s", error)
 
444
 
        # Note: gnutls.connection.X509Credentials is really a generic
 
445
 
        # GnuTLS certificate credentials object so long as no X.509
 
446
 
        # keys are added to it.  Therefore, we can use it here despite
 
447
 
        # using OpenPGP certificates.
 
449
 
        #priority = ':'.join(("NONE", "+VERS-TLS1.1", "+AES-256-CBC",
 
450
 
        #                "+SHA1", "+COMP-NULL", "+CTYPE-OPENPGP",
 
452
 
        priority = "NORMAL"             # Fallback default, since this
 
454
 
        if self.server.settings["priority"]:
 
455
 
            priority = self.server.settings["priority"]
 
456
 
        gnutls.library.functions.gnutls_priority_set_direct\
 
457
 
            (session._c_object, priority, None);
 
461
 
        except gnutls.errors.GNUTLSError, error:
 
462
 
            logger.warning(u"Handshake failed: %s", error)
 
463
 
            # Do not run session.bye() here: the session is not
 
464
 
            # established.  Just abandon the request.
 
467
 
            fpr = fingerprint(peer_certificate(session))
 
468
 
        except (TypeError, gnutls.errors.GNUTLSError), error:
 
469
 
            logger.warning(u"Bad certificate: %s", error)
 
472
 
        logger.debug(u"Fingerprint: %s", fpr)
 
474
 
        for c in self.server.clients:
 
475
 
            if c.fingerprint == fpr:
 
479
 
            logger.warning(u"Client not found for fingerprint: %s",
 
483
 
        # Have to check if client.still_valid(), since it is possible
 
484
 
        # that the client timed out while establishing the GnuTLS
 
486
 
        if not client.still_valid():
 
487
 
            logger.warning(u"Client %(name)s is invalid",
 
492
 
        while sent_size < len(client.secret):
 
493
 
            sent = session.send(client.secret[sent_size:])
 
494
 
            logger.debug(u"Sent: %d, remaining: %d",
 
495
 
                         sent, len(client.secret)
 
496
 
                         - (sent_size + sent))
 
501
 
class IPv6_TCPServer(SocketServer.ForkingTCPServer, object):
 
502
 
    """IPv6 TCP server.  Accepts 'None' as address and/or port.
 
 
2197
        with contextlib.closing(self.server.child_pipe) as child_pipe:
 
 
2198
            logger.info("TCP connection from: %s",
 
 
2199
                        str(self.client_address))
 
 
2200
            logger.debug("Pipe FD: %d",
 
 
2201
                         self.server.child_pipe.fileno())
 
 
2203
            session = gnutls.ClientSession(self.request)
 
 
2205
            # priority = ':'.join(("NONE", "+VERS-TLS1.1",
 
 
2206
            #                       "+AES-256-CBC", "+SHA1",
 
 
2207
            #                       "+COMP-NULL", "+CTYPE-OPENPGP",
 
 
2209
            # Use a fallback default, since this MUST be set.
 
 
2210
            priority = self.server.gnutls_priority
 
 
2211
            if priority is None:
 
 
2213
            gnutls.priority_set_direct(session._c_object,
 
 
2214
                                       priority.encode("utf-8"),
 
 
2217
            # Start communication using the Mandos protocol
 
 
2218
            # Get protocol number
 
 
2219
            line = self.request.makefile().readline()
 
 
2220
            logger.debug("Protocol version: %r", line)
 
 
2222
                if int(line.strip().split()[0]) > 1:
 
 
2223
                    raise RuntimeError(line)
 
 
2224
            except (ValueError, IndexError, RuntimeError) as error:
 
 
2225
                logger.error("Unknown protocol version: %s", error)
 
 
2228
            # Start GnuTLS connection
 
 
2231
            except gnutls.Error as error:
 
 
2232
                logger.warning("Handshake failed: %s", error)
 
 
2233
                # Do not run session.bye() here: the session is not
 
 
2234
                # established.  Just abandon the request.
 
 
2236
            logger.debug("Handshake succeeded")
 
 
2238
            approval_required = False
 
 
2241
                    fpr = self.fingerprint(
 
 
2242
                        self.peer_certificate(session))
 
 
2243
                except (TypeError, gnutls.Error) as error:
 
 
2244
                    logger.warning("Bad certificate: %s", error)
 
 
2246
                logger.debug("Fingerprint: %s", fpr)
 
 
2249
                    client = ProxyClient(child_pipe, fpr,
 
 
2250
                                         self.client_address)
 
 
2254
                if client.approval_delay:
 
 
2255
                    delay = client.approval_delay
 
 
2256
                    client.approvals_pending += 1
 
 
2257
                    approval_required = True
 
 
2260
                    if not client.enabled:
 
 
2261
                        logger.info("Client %s is disabled",
 
 
2263
                        if self.server.use_dbus:
 
 
2265
                            client.Rejected("Disabled")
 
 
2268
                    if client.approved or not client.approval_delay:
 
 
2269
                        # We are approved or approval is disabled
 
 
2271
                    elif client.approved is None:
 
 
2272
                        logger.info("Client %s needs approval",
 
 
2274
                        if self.server.use_dbus:
 
 
2276
                            client.NeedApproval(
 
 
2277
                                client.approval_delay.total_seconds()
 
 
2278
                                * 1000, client.approved_by_default)
 
 
2280
                        logger.warning("Client %s was not approved",
 
 
2282
                        if self.server.use_dbus:
 
 
2284
                            client.Rejected("Denied")
 
 
2287
                    # wait until timeout or approved
 
 
2288
                    time = datetime.datetime.now()
 
 
2289
                    client.changedstate.acquire()
 
 
2290
                    client.changedstate.wait(delay.total_seconds())
 
 
2291
                    client.changedstate.release()
 
 
2292
                    time2 = datetime.datetime.now()
 
 
2293
                    if (time2 - time) >= delay:
 
 
2294
                        if not client.approved_by_default:
 
 
2295
                            logger.warning("Client %s timed out while"
 
 
2296
                                           " waiting for approval",
 
 
2298
                            if self.server.use_dbus:
 
 
2300
                                client.Rejected("Approval timed out")
 
 
2305
                        delay -= time2 - time
 
 
2308
                    session.send(client.secret)
 
 
2309
                except gnutls.Error as error:
 
 
2310
                    logger.warning("gnutls send failed",
 
 
2314
                logger.info("Sending secret to %s", client.name)
 
 
2315
                # bump the timeout using extended_timeout
 
 
2316
                client.bump_timeout(client.extended_timeout)
 
 
2317
                if self.server.use_dbus:
 
 
2322
                if approval_required:
 
 
2323
                    client.approvals_pending -= 1
 
 
2326
                except gnutls.Error as error:
 
 
2327
                    logger.warning("GnuTLS bye failed",
 
 
2331
    def peer_certificate(session):
 
 
2332
        "Return the peer's OpenPGP certificate as a bytestring"
 
 
2333
        # If not an OpenPGP certificate...
 
 
2334
        if (gnutls.certificate_type_get(session._c_object)
 
 
2335
            != gnutls.CRT_OPENPGP):
 
 
2336
            # ...return invalid data
 
 
2338
        list_size = ctypes.c_uint(1)
 
 
2339
        cert_list = (gnutls.certificate_get_peers
 
 
2340
                     (session._c_object, ctypes.byref(list_size)))
 
 
2341
        if not bool(cert_list) and list_size.value != 0:
 
 
2342
            raise gnutls.Error("error getting peer certificate")
 
 
2343
        if list_size.value == 0:
 
 
2346
        return ctypes.string_at(cert.data, cert.size)
 
 
2349
    def fingerprint(openpgp):
 
 
2350
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
 
 
2351
        # New GnuTLS "datum" with the OpenPGP public key
 
 
2352
        datum = gnutls.datum_t(
 
 
2353
            ctypes.cast(ctypes.c_char_p(openpgp),
 
 
2354
                        ctypes.POINTER(ctypes.c_ubyte)),
 
 
2355
            ctypes.c_uint(len(openpgp)))
 
 
2356
        # New empty GnuTLS certificate
 
 
2357
        crt = gnutls.openpgp_crt_t()
 
 
2358
        gnutls.openpgp_crt_init(ctypes.byref(crt))
 
 
2359
        # Import the OpenPGP public key into the certificate
 
 
2360
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
 
2361
                                  gnutls.OPENPGP_FMT_RAW)
 
 
2362
        # Verify the self signature in the key
 
 
2363
        crtverify = ctypes.c_uint()
 
 
2364
        gnutls.openpgp_crt_verify_self(crt, 0,
 
 
2365
                                       ctypes.byref(crtverify))
 
 
2366
        if crtverify.value != 0:
 
 
2367
            gnutls.openpgp_crt_deinit(crt)
 
 
2368
            raise gnutls.CertificateSecurityError("Verify failed")
 
 
2369
        # New buffer for the fingerprint
 
 
2370
        buf = ctypes.create_string_buffer(20)
 
 
2371
        buf_len = ctypes.c_size_t()
 
 
2372
        # Get the fingerprint from the certificate into the buffer
 
 
2373
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
 
2374
                                           ctypes.byref(buf_len))
 
 
2375
        # Deinit the certificate
 
 
2376
        gnutls.openpgp_crt_deinit(crt)
 
 
2377
        # Convert the buffer to a Python bytestring
 
 
2378
        fpr = ctypes.string_at(buf, buf_len.value)
 
 
2379
        # Convert the bytestring to hexadecimal notation
 
 
2380
        hex_fpr = binascii.hexlify(fpr).upper()
 
 
2384
class MultiprocessingMixIn(object):
 
 
2385
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
 
2387
    def sub_process_main(self, request, address):
 
 
2389
            self.finish_request(request, address)
 
 
2391
            self.handle_error(request, address)
 
 
2392
        self.close_request(request)
 
 
2394
    def process_request(self, request, address):
 
 
2395
        """Start a new process to process the request."""
 
 
2396
        proc = multiprocessing.Process(target=self.sub_process_main,
 
 
2397
                                       args=(request, address))
 
 
2402
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
 
 
2403
    """ adds a pipe to the MixIn """
 
 
2405
    def process_request(self, request, client_address):
 
 
2406
        """Overrides and wraps the original process_request().
 
 
2408
        This function creates a new pipe in self.pipe
 
 
2410
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
 
 
2412
        proc = MultiprocessingMixIn.process_request(self, request,
 
 
2414
        self.child_pipe.close()
 
 
2415
        self.add_pipe(parent_pipe, proc)
 
 
2417
    def add_pipe(self, parent_pipe, proc):
 
 
2418
        """Dummy function; override as necessary"""
 
 
2419
        raise NotImplementedError()
 
 
2422
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
 
 
2423
                     socketserver.TCPServer, object):
 
 
2424
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
 
504
 
        settings:       Server settings
 
505
 
        clients:        Set() of Client objects
 
 
2427
        enabled:        Boolean; whether this server is activated yet
 
 
2428
        interface:      None or a network interface name (string)
 
 
2429
        use_ipv6:       Boolean; to use IPv6 or not
 
507
 
    address_family = socket.AF_INET6
 
508
 
    def __init__(self, *args, **kwargs):
 
509
 
        if "settings" in kwargs:
 
510
 
            self.settings = kwargs["settings"]
 
511
 
            del kwargs["settings"]
 
512
 
        if "clients" in kwargs:
 
513
 
            self.clients = kwargs["clients"]
 
514
 
            del kwargs["clients"]
 
515
 
        return super(type(self), self).__init__(*args, **kwargs)
 
 
2432
    def __init__(self, server_address, RequestHandlerClass,
 
 
2436
        """If socketfd is set, use that file descriptor instead of
 
 
2437
        creating a new one with socket.socket().
 
 
2439
        self.interface = interface
 
 
2441
            self.address_family = socket.AF_INET6
 
 
2442
        if socketfd is not None:
 
 
2443
            # Save the file descriptor
 
 
2444
            self.socketfd = socketfd
 
 
2445
            # Save the original socket.socket() function
 
 
2446
            self.socket_socket = socket.socket
 
 
2448
            # To implement --socket, we monkey patch socket.socket.
 
 
2450
            # (When socketserver.TCPServer is a new-style class, we
 
 
2451
            # could make self.socket into a property instead of monkey
 
 
2452
            # patching socket.socket.)
 
 
2454
            # Create a one-time-only replacement for socket.socket()
 
 
2455
            @functools.wraps(socket.socket)
 
 
2456
            def socket_wrapper(*args, **kwargs):
 
 
2457
                # Restore original function so subsequent calls are
 
 
2459
                socket.socket = self.socket_socket
 
 
2460
                del self.socket_socket
 
 
2461
                # This time only, return a new socket object from the
 
 
2462
                # saved file descriptor.
 
 
2463
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
 
2464
            # Replace socket.socket() function with wrapper
 
 
2465
            socket.socket = socket_wrapper
 
 
2466
        # The socketserver.TCPServer.__init__ will call
 
 
2467
        # socket.socket(), which might be our replacement,
 
 
2468
        # socket_wrapper(), if socketfd was set.
 
 
2469
        socketserver.TCPServer.__init__(self, server_address,
 
 
2470
                                        RequestHandlerClass)
 
516
2472
    def server_bind(self):
 
517
2473
        """This overrides the normal server_bind() function
 
518
2474
        to bind to an interface if one was specified, and also NOT to
 
519
2475
        bind to an address or port if they were not specified."""
 
520
 
        if self.settings["interface"]:
 
521
 
            # 25 is from /usr/include/asm-i486/socket.h
 
522
 
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
 
 
2476
        global SO_BINDTODEVICE
 
 
2477
        if self.interface is not None:
 
 
2478
            if SO_BINDTODEVICE is None:
 
 
2479
                # Fall back to a hard-coded value which seems to be
 
 
2481
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
 
2482
                SO_BINDTODEVICE = 25
 
524
 
                self.socket.setsockopt(socket.SOL_SOCKET,
 
526
 
                                       self.settings["interface"])
 
527
 
            except socket.error, error:
 
528
 
                if error[0] == errno.EPERM:
 
529
 
                    logger.error(u"No permission to"
 
530
 
                                 u" bind to interface %s",
 
531
 
                                 self.settings["interface"])
 
 
2484
                self.socket.setsockopt(
 
 
2485
                    socket.SOL_SOCKET, SO_BINDTODEVICE,
 
 
2486
                    (self.interface + "\0").encode("utf-8"))
 
 
2487
            except socket.error as error:
 
 
2488
                if error.errno == errno.EPERM:
 
 
2489
                    logger.error("No permission to bind to"
 
 
2490
                                 " interface %s", self.interface)
 
 
2491
                elif error.errno == errno.ENOPROTOOPT:
 
 
2492
                    logger.error("SO_BINDTODEVICE not available;"
 
 
2493
                                 " cannot bind to interface %s",
 
 
2495
                elif error.errno == errno.ENODEV:
 
 
2496
                    logger.error("Interface %s does not exist,"
 
 
2497
                                 " cannot bind", self.interface)
 
534
2500
        # Only bind(2) the socket if we really need to.
 
535
2501
        if self.server_address[0] or self.server_address[1]:
 
536
2502
            if not self.server_address[0]:
 
538
 
                self.server_address = (in6addr_any,
 
 
2503
                if self.address_family == socket.AF_INET6:
 
 
2504
                    any_address = "::"  # in6addr_any
 
 
2506
                    any_address = "0.0.0.0"  # INADDR_ANY
 
 
2507
                self.server_address = (any_address,
 
539
2508
                                       self.server_address[1])
 
540
2509
            elif not self.server_address[1]:
 
541
 
                self.server_address = (self.server_address[0],
 
543
 
#                 if self.settings["interface"]:
 
 
2510
                self.server_address = (self.server_address[0], 0)
 
 
2511
#                 if self.interface:
 
544
2512
#                     self.server_address = (self.server_address[0],
 
547
2515
#                                            if_nametoindex
 
550
 
            return super(type(self), self).server_bind()
 
 
2517
            return socketserver.TCPServer.server_bind(self)
 
 
2520
class MandosServer(IPv6_TCPServer):
 
 
2524
        clients:        set of Client objects
 
 
2525
        gnutls_priority GnuTLS priority string
 
 
2526
        use_dbus:       Boolean; to emit D-Bus signals or not
 
 
2528
    Assumes a GLib.MainLoop event loop.
 
 
2531
    def __init__(self, server_address, RequestHandlerClass,
 
 
2535
                 gnutls_priority=None,
 
 
2538
        self.enabled = False
 
 
2539
        self.clients = clients
 
 
2540
        if self.clients is None:
 
 
2542
        self.use_dbus = use_dbus
 
 
2543
        self.gnutls_priority = gnutls_priority
 
 
2544
        IPv6_TCPServer.__init__(self, server_address,
 
 
2545
                                RequestHandlerClass,
 
 
2546
                                interface=interface,
 
 
2550
    def server_activate(self):
 
 
2552
            return socketserver.TCPServer.server_activate(self)
 
 
2557
    def add_pipe(self, parent_pipe, proc):
 
 
2558
        # Call "handle_ipc" for both data and EOF events
 
 
2560
            parent_pipe.fileno(),
 
 
2561
            GLib.IO_IN | GLib.IO_HUP,
 
 
2562
            functools.partial(self.handle_ipc,
 
 
2563
                              parent_pipe=parent_pipe,
 
 
2566
    def handle_ipc(self, source, condition,
 
 
2569
                   client_object=None):
 
 
2570
        # error, or the other end of multiprocessing.Pipe has closed
 
 
2571
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
 
 
2572
            # Wait for other process to exit
 
 
2576
        # Read a request from the child
 
 
2577
        request = parent_pipe.recv()
 
 
2578
        command = request[0]
 
 
2580
        if command == 'init':
 
 
2581
            fpr = request[1].decode("ascii")
 
 
2582
            address = request[2]
 
 
2584
            for c in self.clients.values():
 
 
2585
                if c.fingerprint == fpr:
 
 
2589
                logger.info("Client not found for fingerprint: %s, ad"
 
 
2590
                            "dress: %s", fpr, address)
 
 
2593
                    mandos_dbus_service.ClientNotFound(fpr,
 
 
2595
                parent_pipe.send(False)
 
 
2599
                parent_pipe.fileno(),
 
 
2600
                GLib.IO_IN | GLib.IO_HUP,
 
 
2601
                functools.partial(self.handle_ipc,
 
 
2602
                                  parent_pipe=parent_pipe,
 
 
2604
                                  client_object=client))
 
 
2605
            parent_pipe.send(True)
 
 
2606
            # remove the old hook in favor of the new above hook on
 
 
2609
        if command == 'funcall':
 
 
2610
            funcname = request[1]
 
 
2614
            parent_pipe.send(('data', getattr(client_object,
 
 
2618
        if command == 'getattr':
 
 
2619
            attrname = request[1]
 
 
2620
            if isinstance(client_object.__getattribute__(attrname),
 
 
2621
                          collections.Callable):
 
 
2622
                parent_pipe.send(('function', ))
 
 
2625
                    'data', client_object.__getattribute__(attrname)))
 
 
2627
        if command == 'setattr':
 
 
2628
            attrname = request[1]
 
 
2630
            setattr(client_object, attrname, value)
 
 
2635
def rfc3339_duration_to_delta(duration):
 
 
2636
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
 
2638
    >>> rfc3339_duration_to_delta("P7D")
 
 
2639
    datetime.timedelta(7)
 
 
2640
    >>> rfc3339_duration_to_delta("PT60S")
 
 
2641
    datetime.timedelta(0, 60)
 
 
2642
    >>> rfc3339_duration_to_delta("PT60M")
 
 
2643
    datetime.timedelta(0, 3600)
 
 
2644
    >>> rfc3339_duration_to_delta("PT24H")
 
 
2645
    datetime.timedelta(1)
 
 
2646
    >>> rfc3339_duration_to_delta("P1W")
 
 
2647
    datetime.timedelta(7)
 
 
2648
    >>> rfc3339_duration_to_delta("PT5M30S")
 
 
2649
    datetime.timedelta(0, 330)
 
 
2650
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
 
2651
    datetime.timedelta(1, 200)
 
 
2654
    # Parsing an RFC 3339 duration with regular expressions is not
 
 
2655
    # possible - there would have to be multiple places for the same
 
 
2656
    # values, like seconds.  The current code, while more esoteric, is
 
 
2657
    # cleaner without depending on a parsing library.  If Python had a
 
 
2658
    # built-in library for parsing we would use it, but we'd like to
 
 
2659
    # avoid excessive use of external libraries.
 
 
2661
    # New type for defining tokens, syntax, and semantics all-in-one
 
 
2662
    Token = collections.namedtuple("Token", (
 
 
2663
        "regexp",  # To match token; if "value" is not None, must have
 
 
2664
                   # a "group" containing digits
 
 
2665
        "value",   # datetime.timedelta or None
 
 
2666
        "followers"))           # Tokens valid after this token
 
 
2667
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
 
2668
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
 
2669
    token_end = Token(re.compile(r"$"), None, frozenset())
 
 
2670
    token_second = Token(re.compile(r"(\d+)S"),
 
 
2671
                         datetime.timedelta(seconds=1),
 
 
2672
                         frozenset((token_end, )))
 
 
2673
    token_minute = Token(re.compile(r"(\d+)M"),
 
 
2674
                         datetime.timedelta(minutes=1),
 
 
2675
                         frozenset((token_second, token_end)))
 
 
2676
    token_hour = Token(re.compile(r"(\d+)H"),
 
 
2677
                       datetime.timedelta(hours=1),
 
 
2678
                       frozenset((token_minute, token_end)))
 
 
2679
    token_time = Token(re.compile(r"T"),
 
 
2681
                       frozenset((token_hour, token_minute,
 
 
2683
    token_day = Token(re.compile(r"(\d+)D"),
 
 
2684
                      datetime.timedelta(days=1),
 
 
2685
                      frozenset((token_time, token_end)))
 
 
2686
    token_month = Token(re.compile(r"(\d+)M"),
 
 
2687
                        datetime.timedelta(weeks=4),
 
 
2688
                        frozenset((token_day, token_end)))
 
 
2689
    token_year = Token(re.compile(r"(\d+)Y"),
 
 
2690
                       datetime.timedelta(weeks=52),
 
 
2691
                       frozenset((token_month, token_end)))
 
 
2692
    token_week = Token(re.compile(r"(\d+)W"),
 
 
2693
                       datetime.timedelta(weeks=1),
 
 
2694
                       frozenset((token_end, )))
 
 
2695
    token_duration = Token(re.compile(r"P"), None,
 
 
2696
                           frozenset((token_year, token_month,
 
 
2697
                                      token_day, token_time,
 
 
2699
    # Define starting values:
 
 
2701
    value = datetime.timedelta()
 
 
2703
    # Following valid tokens
 
 
2704
    followers = frozenset((token_duration, ))
 
 
2705
    # String left to parse
 
 
2707
    # Loop until end token is found
 
 
2708
    while found_token is not token_end:
 
 
2709
        # Search for any currently valid tokens
 
 
2710
        for token in followers:
 
 
2711
            match = token.regexp.match(s)
 
 
2712
            if match is not None:
 
 
2714
                if token.value is not None:
 
 
2715
                    # Value found, parse digits
 
 
2716
                    factor = int(match.group(1), 10)
 
 
2717
                    # Add to value so far
 
 
2718
                    value += factor * token.value
 
 
2719
                # Strip token from string
 
 
2720
                s = token.regexp.sub("", s, 1)
 
 
2723
                # Set valid next tokens
 
 
2724
                followers = found_token.followers
 
 
2727
            # No currently valid tokens were found
 
 
2728
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
553
2734
def string_to_delta(interval):
 
 
659
 
    global main_loop_started
 
660
 
    main_loop_started = False
 
662
 
    parser = OptionParser(version = "%%prog %s" % version)
 
663
 
    parser.add_option("-i", "--interface", type="string",
 
664
 
                      metavar="IF", help="Bind to interface IF")
 
665
 
    parser.add_option("-a", "--address", type="string",
 
666
 
                      help="Address to listen for requests on")
 
667
 
    parser.add_option("-p", "--port", type="int",
 
668
 
                      help="Port number to receive requests on")
 
669
 
    parser.add_option("--check", action="store_true", default=False,
 
670
 
                      help="Run self-test")
 
671
 
    parser.add_option("--debug", action="store_true",
 
672
 
                      help="Debug mode; run in foreground and log to"
 
674
 
    parser.add_option("--priority", type="string", help="GnuTLS"
 
675
 
                      " priority string (see GnuTLS documentation)")
 
676
 
    parser.add_option("--servicename", type="string", metavar="NAME",
 
677
 
                      help="Zeroconf service name")
 
678
 
    parser.add_option("--configdir", type="string",
 
679
 
                      default="/etc/mandos", metavar="DIR",
 
680
 
                      help="Directory to search for configuration"
 
682
 
    (options, args) = parser.parse_args()
 
 
2806
    ##################################################################
 
 
2807
    # Parsing of options, both command line and config file
 
 
2809
    parser = argparse.ArgumentParser()
 
 
2810
    parser.add_argument("-v", "--version", action="version",
 
 
2811
                        version="%(prog)s {}".format(version),
 
 
2812
                        help="show version number and exit")
 
 
2813
    parser.add_argument("-i", "--interface", metavar="IF",
 
 
2814
                        help="Bind to interface IF")
 
 
2815
    parser.add_argument("-a", "--address",
 
 
2816
                        help="Address to listen for requests on")
 
 
2817
    parser.add_argument("-p", "--port", type=int,
 
 
2818
                        help="Port number to receive requests on")
 
 
2819
    parser.add_argument("--check", action="store_true",
 
 
2820
                        help="Run self-test")
 
 
2821
    parser.add_argument("--debug", action="store_true",
 
 
2822
                        help="Debug mode; run in foreground and log"
 
 
2823
                        " to terminal", default=None)
 
 
2824
    parser.add_argument("--debuglevel", metavar="LEVEL",
 
 
2825
                        help="Debug level for stdout output")
 
 
2826
    parser.add_argument("--priority", help="GnuTLS"
 
 
2827
                        " priority string (see GnuTLS documentation)")
 
 
2828
    parser.add_argument("--servicename",
 
 
2829
                        metavar="NAME", help="Zeroconf service name")
 
 
2830
    parser.add_argument("--configdir",
 
 
2831
                        default="/etc/mandos", metavar="DIR",
 
 
2832
                        help="Directory to search for configuration"
 
 
2834
    parser.add_argument("--no-dbus", action="store_false",
 
 
2835
                        dest="use_dbus", help="Do not provide D-Bus"
 
 
2836
                        " system bus interface", default=None)
 
 
2837
    parser.add_argument("--no-ipv6", action="store_false",
 
 
2838
                        dest="use_ipv6", help="Do not use IPv6",
 
 
2840
    parser.add_argument("--no-restore", action="store_false",
 
 
2841
                        dest="restore", help="Do not restore stored"
 
 
2842
                        " state", default=None)
 
 
2843
    parser.add_argument("--socket", type=int,
 
 
2844
                        help="Specify a file descriptor to a network"
 
 
2845
                        " socket to use instead of creating one")
 
 
2846
    parser.add_argument("--statedir", metavar="DIR",
 
 
2847
                        help="Directory to save/restore state in")
 
 
2848
    parser.add_argument("--foreground", action="store_true",
 
 
2849
                        help="Run in foreground", default=None)
 
 
2850
    parser.add_argument("--no-zeroconf", action="store_false",
 
 
2851
                        dest="zeroconf", help="Do not use Zeroconf",
 
 
2854
    options = parser.parse_args()
 
684
2856
    if options.check:
 
 
2858
        fail_count, test_count = doctest.testmod()
 
 
2859
        sys.exit(os.EX_OK if fail_count == 0 else 1)
 
689
2861
    # Default values for config file for server-global settings
 
690
 
    server_defaults = { "interface": "",
 
695
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
696
 
                        "servicename": "Mandos",
 
 
2862
    server_defaults = {"interface": "",
 
 
2867
                       "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
 
2868
                       ":+SIGN-DSA-SHA256",
 
 
2869
                       "servicename": "Mandos",
 
 
2875
                       "statedir": "/var/lib/mandos",
 
 
2876
                       "foreground": "False",
 
699
2880
    # Parse config file for server-global settings
 
700
 
    server_config = ConfigParser.SafeConfigParser(server_defaults)
 
 
2881
    server_config = configparser.SafeConfigParser(server_defaults)
 
701
2882
    del server_defaults
 
702
2883
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
703
 
    server_section = "server"
 
704
2884
    # Convert the SafeConfigParser object to a dict
 
705
 
    server_settings = dict(server_config.items(server_section))
 
706
 
    # Use getboolean on the boolean config option
 
707
 
    server_settings["debug"] = server_config.getboolean\
 
708
 
                               (server_section, "debug")
 
 
2885
    server_settings = server_config.defaults()
 
 
2886
    # Use the appropriate methods on the non-string config options
 
 
2887
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
 
2888
                   "foreground", "zeroconf"):
 
 
2889
        server_settings[option] = server_config.getboolean("DEFAULT",
 
 
2891
    if server_settings["port"]:
 
 
2892
        server_settings["port"] = server_config.getint("DEFAULT",
 
 
2894
    if server_settings["socket"]:
 
 
2895
        server_settings["socket"] = server_config.getint("DEFAULT",
 
 
2897
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
 
2898
        # over with an opened os.devnull.  But we don't want this to
 
 
2899
        # happen with a supplied network socket.
 
 
2900
        if 0 <= server_settings["socket"] <= 2:
 
 
2901
            server_settings["socket"] = os.dup(server_settings
 
709
2903
    del server_config
 
711
2905
    # Override the settings from the config file with command line
 
712
2906
    # options, if set.
 
713
2907
    for option in ("interface", "address", "port", "debug",
 
714
 
                   "priority", "servicename", "configdir"):
 
 
2908
                   "priority", "servicename", "configdir", "use_dbus",
 
 
2909
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
 
2910
                   "socket", "foreground", "zeroconf"):
 
715
2911
        value = getattr(options, option)
 
716
2912
        if value is not None:
 
717
2913
            server_settings[option] = value
 
 
2915
    # Force all strings to be unicode
 
 
2916
    for option in server_settings.keys():
 
 
2917
        if isinstance(server_settings[option], bytes):
 
 
2918
            server_settings[option] = (server_settings[option]
 
 
2920
    # Force all boolean options to be boolean
 
 
2921
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
 
 
2922
                   "foreground", "zeroconf"):
 
 
2923
        server_settings[option] = bool(server_settings[option])
 
 
2924
    # Debug implies foreground
 
 
2925
    if server_settings["debug"]:
 
 
2926
        server_settings["foreground"] = True
 
719
2927
    # Now we have our good server settings in "server_settings"
 
 
2929
    ##################################################################
 
 
2931
    if (not server_settings["zeroconf"]
 
 
2932
        and not (server_settings["port"]
 
 
2933
                 or server_settings["socket"] != "")):
 
 
2934
        parser.error("Needs port or socket to work without Zeroconf")
 
721
2937
    debug = server_settings["debug"]
 
724
 
        syslogger.setLevel(logging.WARNING)
 
725
 
        console.setLevel(logging.WARNING)
 
 
2938
    debuglevel = server_settings["debuglevel"]
 
 
2939
    use_dbus = server_settings["use_dbus"]
 
 
2940
    use_ipv6 = server_settings["use_ipv6"]
 
 
2941
    stored_state_path = os.path.join(server_settings["statedir"],
 
 
2943
    foreground = server_settings["foreground"]
 
 
2944
    zeroconf = server_settings["zeroconf"]
 
 
2947
        initlogger(debug, logging.DEBUG)
 
 
2952
            level = getattr(logging, debuglevel.upper())
 
 
2953
            initlogger(debug, level)
 
727
2955
    if server_settings["servicename"] != "Mandos":
 
728
 
        syslogger.setFormatter(logging.Formatter\
 
729
 
                               ('Mandos (%s): %%(levelname)s:'
 
731
 
                                % server_settings["servicename"]))
 
 
2956
        syslogger.setFormatter(
 
 
2957
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
 
2958
                              ' %(levelname)s: %(message)s'.format(
 
 
2959
                                  server_settings["servicename"])))
 
733
2961
    # Parse config file with clients
 
734
 
    client_defaults = { "timeout": "1h",
 
736
 
                        "checker": "fping -q -- %%(host)s",
 
738
 
    client_config = ConfigParser.SafeConfigParser(client_defaults)
 
 
2962
    client_config = configparser.SafeConfigParser(Client
 
739
2964
    client_config.read(os.path.join(server_settings["configdir"],
 
740
2965
                                    "clients.conf"))
 
743
 
    service = AvahiService(name = server_settings["servicename"],
 
744
 
                           type = "_mandos._tcp", );
 
745
 
    if server_settings["interface"]:
 
746
 
        service.interface = if_nametoindex(server_settings["interface"])
 
 
2967
    global mandos_dbus_service
 
 
2968
    mandos_dbus_service = None
 
 
2971
    if server_settings["socket"] != "":
 
 
2972
        socketfd = server_settings["socket"]
 
 
2973
    tcp_server = MandosServer(
 
 
2974
        (server_settings["address"], server_settings["port"]),
 
 
2976
        interface=(server_settings["interface"] or None),
 
 
2978
        gnutls_priority=server_settings["priority"],
 
 
2982
        pidfilename = "/run/mandos.pid"
 
 
2983
        if not os.path.isdir("/run/."):
 
 
2984
            pidfilename = "/var/run/mandos.pid"
 
 
2987
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
 
 
2988
        except IOError as e:
 
 
2989
            logger.error("Could not open file %r", pidfilename,
 
 
2992
    for name, group in (("_mandos", "_mandos"),
 
 
2993
                        ("mandos", "mandos"),
 
 
2994
                        ("nobody", "nogroup")):
 
 
2996
            uid = pwd.getpwnam(name).pw_uid
 
 
2997
            gid = pwd.getpwnam(group).pw_gid
 
 
3008
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
 
3010
    except OSError as error:
 
 
3011
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
 
3012
                       .format(uid, gid, os.strerror(error.errno)))
 
 
3013
        if error.errno != errno.EPERM:
 
 
3017
        # Enable all possible GnuTLS debugging
 
 
3019
        # "Use a log level over 10 to enable all debugging options."
 
 
3021
        gnutls.global_set_log_level(11)
 
 
3024
        def debug_gnutls(level, string):
 
 
3025
            logger.debug("GnuTLS: %s", string[:-1])
 
 
3027
        gnutls.global_set_log_function(debug_gnutls)
 
 
3029
        # Redirect stdin so all checkers get /dev/null
 
 
3030
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
 
3031
        os.dup2(null, sys.stdin.fileno())
 
 
3035
    # Need to fork before connecting to D-Bus
 
 
3037
        # Close all input and output, do double fork, etc.
 
 
3040
    # multiprocessing will use threads, so before we use GLib we need
 
 
3041
    # to inform GLib that threads will be used.
 
748
3044
    global main_loop
 
751
3045
    # From the Avahi example code
 
752
 
    DBusGMainLoop(set_as_default=True )
 
753
 
    main_loop = gobject.MainLoop()
 
 
3046
    DBusGMainLoop(set_as_default=True)
 
 
3047
    main_loop = GLib.MainLoop()
 
754
3048
    bus = dbus.SystemBus()
 
755
 
    server = dbus.Interface(
 
756
 
            bus.get_object( avahi.DBUS_NAME, avahi.DBUS_PATH_SERVER ),
 
757
 
            avahi.DBUS_INTERFACE_SERVER )
 
758
3049
    # End of Avahi example code
 
761
 
    def remove_from_clients(client):
 
762
 
        clients.remove(client)
 
764
 
            logger.critical(u"No clients left, exiting")
 
767
 
    clients.update(Set(Client(name = section,
 
768
 
                              stop_hook = remove_from_clients,
 
770
 
                              = dict(client_config.items(section)))
 
771
 
                       for section in client_config.sections()))
 
773
 
        logger.critical(u"No clients defined")
 
777
 
        logger.removeHandler(console)
 
780
 
    pidfilename = "/var/run/mandos/mandos.pid"
 
783
 
        pidfile = open(pidfilename, "w")
 
784
 
        pidfile.write(str(pid) + "\n")
 
 
3052
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
 
3055
            old_bus_name = dbus.service.BusName(
 
 
3056
                "se.bsnet.fukt.Mandos", bus,
 
 
3058
        except dbus.exceptions.DBusException as e:
 
 
3059
            logger.error("Disabling D-Bus:", exc_info=e)
 
 
3061
            server_settings["use_dbus"] = False
 
 
3062
            tcp_server.use_dbus = False
 
 
3064
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
 
3065
        service = AvahiServiceToSyslog(
 
 
3066
            name=server_settings["servicename"],
 
 
3067
            servicetype="_mandos._tcp",
 
 
3070
        if server_settings["interface"]:
 
 
3071
            service.interface = if_nametoindex(
 
 
3072
                server_settings["interface"].encode("utf-8"))
 
 
3074
    global multiprocessing_manager
 
 
3075
    multiprocessing_manager = multiprocessing.Manager()
 
 
3077
    client_class = Client
 
 
3079
        client_class = functools.partial(ClientDBus, bus=bus)
 
 
3081
    client_settings = Client.config_parser(client_config)
 
 
3082
    old_client_settings = {}
 
 
3085
    # This is used to redirect stdout and stderr for checker processes
 
 
3087
    wnull = open(os.devnull, "w")  # A writable /dev/null
 
 
3088
    # Only used if server is running in foreground but not in debug
 
 
3090
    if debug or not foreground:
 
 
3093
    # Get client data and settings from last running state.
 
 
3094
    if server_settings["restore"]:
 
 
3096
            with open(stored_state_path, "rb") as stored_state:
 
 
3097
                if sys.version_info.major == 2:
 
 
3098
                    clients_data, old_client_settings = pickle.load(
 
 
3101
                    bytes_clients_data, bytes_old_client_settings = (
 
 
3102
                        pickle.load(stored_state, encoding="bytes"))
 
 
3103
                    #   Fix bytes to strings
 
 
3106
                    clients_data = {(key.decode("utf-8")
 
 
3107
                                     if isinstance(key, bytes)
 
 
3110
                                    bytes_clients_data.items()}
 
 
3111
                    del bytes_clients_data
 
 
3112
                    for key in clients_data:
 
 
3113
                        value = {(k.decode("utf-8")
 
 
3114
                                  if isinstance(k, bytes) else k): v
 
 
3116
                                 clients_data[key].items()}
 
 
3117
                        clients_data[key] = value
 
 
3119
                        value["client_structure"] = [
 
 
3121
                             if isinstance(s, bytes)
 
 
3123
                            value["client_structure"]]
 
 
3125
                        for k in ("name", "host"):
 
 
3126
                            if isinstance(value[k], bytes):
 
 
3127
                                value[k] = value[k].decode("utf-8")
 
 
3128
                    #  old_client_settings
 
 
3130
                    old_client_settings = {
 
 
3131
                        (key.decode("utf-8")
 
 
3132
                         if isinstance(key, bytes)
 
 
3135
                        bytes_old_client_settings.items()}
 
 
3136
                    del bytes_old_client_settings
 
 
3138
                    for value in old_client_settings.values():
 
 
3139
                        if isinstance(value["host"], bytes):
 
 
3140
                            value["host"] = (value["host"]
 
 
3142
            os.remove(stored_state_path)
 
 
3143
        except IOError as e:
 
 
3144
            if e.errno == errno.ENOENT:
 
 
3145
                logger.warning("Could not load persistent state:"
 
 
3146
                               " {}".format(os.strerror(e.errno)))
 
 
3148
                logger.critical("Could not load persistent state:",
 
 
3151
        except EOFError as e:
 
 
3152
            logger.warning("Could not load persistent state: "
 
 
3156
    with PGPEngine() as pgp:
 
 
3157
        for client_name, client in clients_data.items():
 
 
3158
            # Skip removed clients
 
 
3159
            if client_name not in client_settings:
 
 
3162
            # Decide which value to use after restoring saved state.
 
 
3163
            # We have three different values: Old config file,
 
 
3164
            # new config file, and saved state.
 
 
3165
            # New config value takes precedence if it differs from old
 
 
3166
            # config value, otherwise use saved state.
 
 
3167
            for name, value in client_settings[client_name].items():
 
 
3169
                    # For each value in new config, check if it
 
 
3170
                    # differs from the old config value (Except for
 
 
3171
                    # the "secret" attribute)
 
 
3172
                    if (name != "secret"
 
 
3174
                             old_client_settings[client_name][name])):
 
 
3175
                        client[name] = value
 
 
3179
            # Clients who has passed its expire date can still be
 
 
3180
            # enabled if its last checker was successful.  A Client
 
 
3181
            # whose checker succeeded before we stored its state is
 
 
3182
            # assumed to have successfully run all checkers during
 
 
3184
            if client["enabled"]:
 
 
3185
                if datetime.datetime.utcnow() >= client["expires"]:
 
 
3186
                    if not client["last_checked_ok"]:
 
 
3188
                            "disabling client {} - Client never "
 
 
3189
                            "performed a successful checker".format(
 
 
3191
                        client["enabled"] = False
 
 
3192
                    elif client["last_checker_status"] != 0:
 
 
3194
                            "disabling client {} - Client last"
 
 
3195
                            " checker failed with error code"
 
 
3198
                                client["last_checker_status"]))
 
 
3199
                        client["enabled"] = False
 
 
3201
                        client["expires"] = (
 
 
3202
                            datetime.datetime.utcnow()
 
 
3203
                            + client["timeout"])
 
 
3204
                        logger.debug("Last checker succeeded,"
 
 
3205
                                     " keeping {} enabled".format(
 
 
3208
                client["secret"] = pgp.decrypt(
 
 
3209
                    client["encrypted_secret"],
 
 
3210
                    client_settings[client_name]["secret"])
 
 
3212
                # If decryption fails, we use secret from new settings
 
 
3213
                logger.debug("Failed to decrypt {} old secret".format(
 
 
3215
                client["secret"] = (client_settings[client_name]
 
 
3218
    # Add/remove clients based on new changes made to config
 
 
3219
    for client_name in (set(old_client_settings)
 
 
3220
                        - set(client_settings)):
 
 
3221
        del clients_data[client_name]
 
 
3222
    for client_name in (set(client_settings)
 
 
3223
                        - set(old_client_settings)):
 
 
3224
        clients_data[client_name] = client_settings[client_name]
 
 
3226
    # Create all client objects
 
 
3227
    for client_name, client in clients_data.items():
 
 
3228
        tcp_server.clients[client_name] = client_class(
 
 
3231
            server_settings=server_settings)
 
 
3233
    if not tcp_server.clients:
 
 
3234
        logger.warning("No clients defined")
 
 
3237
        if pidfile is not None:
 
 
3241
                    print(pid, file=pidfile)
 
 
3243
                logger.error("Could not write to file %r with PID %d",
 
788
 
        logger.error(u"Could not write %s file with PID %d",
 
789
 
                     pidfilename, os.getpid())
 
 
3248
    for termsig in (signal.SIGHUP, signal.SIGTERM):
 
 
3249
        GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
 
 
3250
                             lambda: main_loop.quit() and False)
 
 
3254
        @alternate_dbus_interfaces(
 
 
3255
            {"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
 
 
3256
        class MandosDBusService(DBusObjectWithObjectManager):
 
 
3257
            """A D-Bus proxy object"""
 
 
3260
                dbus.service.Object.__init__(self, bus, "/")
 
 
3262
            _interface = "se.recompile.Mandos"
 
 
3264
            @dbus.service.signal(_interface, signature="o")
 
 
3265
            def ClientAdded(self, objpath):
 
 
3269
            @dbus.service.signal(_interface, signature="ss")
 
 
3270
            def ClientNotFound(self, fingerprint, address):
 
 
3274
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
 
3276
            @dbus.service.signal(_interface, signature="os")
 
 
3277
            def ClientRemoved(self, objpath, name):
 
 
3281
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
 
3283
            @dbus.service.method(_interface, out_signature="ao")
 
 
3284
            def GetAllClients(self):
 
 
3286
                return dbus.Array(c.dbus_object_path for c in
 
 
3287
                                  tcp_server.clients.values())
 
 
3289
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
 
3291
            @dbus.service.method(_interface,
 
 
3292
                                 out_signature="a{oa{sv}}")
 
 
3293
            def GetAllClientsWithProperties(self):
 
 
3295
                return dbus.Dictionary(
 
 
3296
                    {c.dbus_object_path: c.GetAll(
 
 
3297
                        "se.recompile.Mandos.Client")
 
 
3298
                     for c in tcp_server.clients.values()},
 
 
3301
            @dbus.service.method(_interface, in_signature="o")
 
 
3302
            def RemoveClient(self, object_path):
 
 
3304
                for c in tcp_server.clients.values():
 
 
3305
                    if c.dbus_object_path == object_path:
 
 
3306
                        del tcp_server.clients[c.name]
 
 
3307
                        c.remove_from_connection()
 
 
3308
                        # Don't signal the disabling
 
 
3309
                        c.disable(quiet=True)
 
 
3310
                        # Emit D-Bus signal for removal
 
 
3311
                        self.client_removed_signal(c)
 
 
3313
                raise KeyError(object_path)
 
 
3317
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
 
3318
                                 out_signature="a{oa{sa{sv}}}")
 
 
3319
            def GetManagedObjects(self):
 
 
3321
                return dbus.Dictionary(
 
 
3322
                    {client.dbus_object_path:
 
 
3324
                         {interface: client.GetAll(interface)
 
 
3326
                          client._get_all_interface_names()})
 
 
3327
                     for client in tcp_server.clients.values()})
 
 
3329
            def client_added_signal(self, client):
 
 
3330
                """Send the new standard signal and the old signal"""
 
 
3332
                    # New standard signal
 
 
3333
                    self.InterfacesAdded(
 
 
3334
                        client.dbus_object_path,
 
 
3336
                            {interface: client.GetAll(interface)
 
 
3338
                             client._get_all_interface_names()}))
 
 
3340
                    self.ClientAdded(client.dbus_object_path)
 
 
3342
            def client_removed_signal(self, client):
 
 
3343
                """Send the new standard signal and the old signal"""
 
 
3345
                    # New standard signal
 
 
3346
                    self.InterfacesRemoved(
 
 
3347
                        client.dbus_object_path,
 
 
3348
                        client._get_all_interface_names())
 
 
3350
                    self.ClientRemoved(client.dbus_object_path,
 
 
3353
        mandos_dbus_service = MandosDBusService()
 
 
3355
    # Save modules to variables to exempt the modules from being
 
 
3356
    # unloaded before the function registered with atexit() is run.
 
 
3357
    mp = multiprocessing
 
792
3361
        "Cleanup function; run on exit"
 
794
 
        # From the Avahi example code
 
795
 
        if not group is None:
 
798
 
        # End of Avahi example code
 
801
 
            client = clients.pop()
 
802
 
            client.stop_hook = None
 
 
3365
        mp.active_children()
 
 
3367
        if not (tcp_server.clients or client_settings):
 
 
3370
        # Store client before exiting. Secrets are encrypted with key
 
 
3371
        # based on what config file has. If config file is
 
 
3372
        # removed/edited, old secret will thus be unrecovable.
 
 
3374
        with PGPEngine() as pgp:
 
 
3375
            for client in tcp_server.clients.values():
 
 
3376
                key = client_settings[client.name]["secret"]
 
 
3377
                client.encrypted_secret = pgp.encrypt(client.secret,
 
 
3381
                # A list of attributes that can not be pickled
 
 
3383
                exclude = {"bus", "changedstate", "secret",
 
 
3384
                           "checker", "server_settings"}
 
 
3385
                for name, typ in inspect.getmembers(dbus.service
 
 
3389
                client_dict["encrypted_secret"] = (client
 
 
3391
                for attr in client.client_structure:
 
 
3392
                    if attr not in exclude:
 
 
3393
                        client_dict[attr] = getattr(client, attr)
 
 
3395
                clients[client.name] = client_dict
 
 
3396
                del client_settings[client.name]["secret"]
 
 
3399
            with tempfile.NamedTemporaryFile(
 
 
3403
                    dir=os.path.dirname(stored_state_path),
 
 
3404
                    delete=False) as stored_state:
 
 
3405
                pickle.dump((clients, client_settings), stored_state,
 
 
3407
                tempname = stored_state.name
 
 
3408
            os.rename(tempname, stored_state_path)
 
 
3409
        except (IOError, OSError) as e:
 
 
3415
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
 
3416
                logger.warning("Could not save persistent state: {}"
 
 
3417
                               .format(os.strerror(e.errno)))
 
 
3419
                logger.warning("Could not save persistent state:",
 
 
3423
        # Delete all clients, and settings from config
 
 
3424
        while tcp_server.clients:
 
 
3425
            name, client = tcp_server.clients.popitem()
 
 
3427
                client.remove_from_connection()
 
 
3428
            # Don't signal the disabling
 
 
3429
            client.disable(quiet=True)
 
 
3430
            # Emit D-Bus signal for removal
 
 
3432
                mandos_dbus_service.client_removed_signal(client)
 
 
3433
        client_settings.clear()
 
805
3435
    atexit.register(cleanup)
 
808
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
 
809
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
 
810
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
 
812
 
    for client in clients:
 
815
 
    tcp_server = IPv6_TCPServer((server_settings["address"],
 
816
 
                                 server_settings["port"]),
 
818
 
                                settings=server_settings,
 
 
3437
    for client in tcp_server.clients.values():
 
 
3439
            # Emit D-Bus signal for adding
 
 
3440
            mandos_dbus_service.client_added_signal(client)
 
 
3441
        # Need to initiate checking of clients
 
 
3443
            client.init_checker()
 
 
3446
    tcp_server.server_activate()
 
820
3448
    # Find out what port we got
 
821
 
    service.port = tcp_server.socket.getsockname()[1]
 
822
 
    logger.info(u"Now listening on address %r, port %d, flowinfo %d,"
 
823
 
                u" scope_id %d" % tcp_server.socket.getsockname())
 
825
 
    #service.interface = tcp_server.socket.getsockname()[3]
 
 
3450
        service.port = tcp_server.socket.getsockname()[1]
 
 
3452
        logger.info("Now listening on address %r, port %d,"
 
 
3453
                    " flowinfo %d, scope_id %d",
 
 
3454
                    *tcp_server.socket.getsockname())
 
 
3456
        logger.info("Now listening on address %r, port %d",
 
 
3457
                    *tcp_server.socket.getsockname())
 
 
3459
    # service.interface = tcp_server.socket.getsockname()[3]
 
828
 
        # From the Avahi example code
 
829
 
        server.connect_to_signal("StateChanged", server_state_changed)
 
831
 
            server_state_changed(server.GetState())
 
832
 
        except dbus.exceptions.DBusException, error:
 
833
 
            logger.critical(u"DBusException: %s", error)
 
835
 
        # End of Avahi example code
 
837
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
838
 
                             lambda *args, **kwargs:
 
839
 
                             tcp_server.handle_request\
 
840
 
                             (*args[2:], **kwargs) or True)
 
842
 
        logger.debug(u"Starting main loop")
 
843
 
        main_loop_started = True
 
 
3463
            # From the Avahi example code
 
 
3466
            except dbus.exceptions.DBusException as error:
 
 
3467
                logger.critical("D-Bus Exception", exc_info=error)
 
 
3470
            # End of Avahi example code
 
 
3472
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
 
3473
                          lambda *args, **kwargs:
 
 
3474
                          (tcp_server.handle_request
 
 
3475
                           (*args[2:], **kwargs) or True))
 
 
3477
        logger.debug("Starting main loop")
 
845
 
    except AvahiError, error:
 
846
 
        logger.critical(u"AvahiError: %s" + unicode(error))
 
 
3479
    except AvahiError as error:
 
 
3480
        logger.critical("Avahi Error", exc_info=error)
 
848
3483
    except KeyboardInterrupt:
 
 
3485
            print("", file=sys.stderr)
 
 
3486
        logger.debug("Server received KeyboardInterrupt")
 
 
3487
    logger.debug("Server exiting")
 
 
3488
    # Must run before the D-Bus bus name gets deregistered
 
852
3492
if __name__ == '__main__':