/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-03-05 21:46:00 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 335.
  • Revision ID: teddy@recompile.se-20160305214600-2d7peg8qb5xhpi64
Fix incorrect documentation of minor limitation

* mandos-monitor.xml (BUGS): The name which is hard-coded is the D-Bus
                             *bus* name, not the service name.  Fix
                             the documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python2.7
 
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
4
4
# Mandos server - give out binary blobs to connecting clients.
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2015 Teddy Hogeborn
15
 
# Copyright © 2008-2015 Björn Påhlsson
 
14
# Copyright © 2008-2016 Teddy Hogeborn
 
15
# Copyright © 2008-2016 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
44
44
import argparse
45
45
import datetime
46
46
import errno
47
 
import gnutls.crypto
48
 
import gnutls.connection
49
 
import gnutls.errors
50
 
import gnutls.library.functions
51
 
import gnutls.library.constants
52
 
import gnutls.library.types
53
47
try:
54
48
    import ConfigParser as configparser
55
49
except ImportError:
83
77
import dbus
84
78
import dbus.service
85
79
try:
86
 
    import gobject
 
80
    from gi.repository import GObject
87
81
except ImportError:
88
 
    from gi.repository import GObject as gobject
 
82
    import gobject as GObject
89
83
import avahi
90
84
from dbus.mainloop.glib import DBusGMainLoop
91
85
import ctypes
104
98
if sys.version_info.major == 2:
105
99
    str = unicode
106
100
 
107
 
version = "1.6.9"
 
101
version = "1.7.3"
108
102
stored_state_file = "clients.pickle"
109
103
 
110
104
logger = logging.getLogger()
157
151
    
158
152
    def __init__(self):
159
153
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
154
        self.gpg = "gpg"
 
155
        try:
 
156
            output = subprocess.check_output(["gpgconf"])
 
157
            for line in output.splitlines():
 
158
                name, text, path = line.split(":")
 
159
                if name == "gpg":
 
160
                    self.gpg = path
 
161
                    break
 
162
        except OSError as e:
 
163
            if e.errno != errno.ENOENT:
 
164
                raise
160
165
        self.gnupgargs = ['--batch',
161
 
                          '--home', self.tempdir,
 
166
                          '--homedir', self.tempdir,
162
167
                          '--force-mdc',
163
168
                          '--quiet',
164
169
                          '--no-use-agent']
203
208
                dir=self.tempdir) as passfile:
204
209
            passfile.write(passphrase)
205
210
            passfile.flush()
206
 
            proc = subprocess.Popen(['gpg', '--symmetric',
 
211
            proc = subprocess.Popen([self.gpg, '--symmetric',
207
212
                                     '--passphrase-file',
208
213
                                     passfile.name]
209
214
                                    + self.gnupgargs,
221
226
                dir = self.tempdir) as passfile:
222
227
            passfile.write(passphrase)
223
228
            passfile.flush()
224
 
            proc = subprocess.Popen(['gpg', '--decrypt',
 
229
            proc = subprocess.Popen([self.gpg, '--decrypt',
225
230
                                     '--passphrase-file',
226
231
                                     passfile.name]
227
232
                                    + self.gnupgargs,
395
400
                    logger.error(bad_states[state] + ": %r", error)
396
401
            self.cleanup()
397
402
        elif state == avahi.SERVER_RUNNING:
398
 
            self.add()
 
403
            try:
 
404
                self.add()
 
405
            except dbus.exceptions.DBusException as error:
 
406
                if (error.get_dbus_name()
 
407
                    == "org.freedesktop.Avahi.CollisionError"):
 
408
                    logger.info("Local Zeroconf service name"
 
409
                                " collision.")
 
410
                    return self.rename(remove=False)
 
411
                else:
 
412
                    logger.critical("D-Bus Exception", exc_info=error)
 
413
                    self.cleanup()
 
414
                    os._exit(1)
399
415
        else:
400
416
            if error is None:
401
417
                logger.debug("Unknown state: %r", state)
424
440
            .format(self.name)))
425
441
        return ret
426
442
 
 
443
# Pretend that we have a GnuTLS module
 
444
class GnuTLS(object):
 
445
    """This isn't so much a class as it is a module-like namespace.
 
446
    It is instantiated once, and simulates having a GnuTLS module."""
 
447
    
 
448
    _library = ctypes.cdll.LoadLibrary(
 
449
        ctypes.util.find_library("gnutls"))
 
450
    _need_version = "3.3.0"
 
451
    def __init__(self):
 
452
        # Need to use class name "GnuTLS" here, since this method is
 
453
        # called before the assignment to the "gnutls" global variable
 
454
        # happens.
 
455
        if GnuTLS.check_version(self._need_version) is None:
 
456
            raise GnuTLS.Error("Needs GnuTLS {} or later"
 
457
                               .format(self._need_version))
 
458
    
 
459
    # Unless otherwise indicated, the constants and types below are
 
460
    # all from the gnutls/gnutls.h C header file.
 
461
    
 
462
    # Constants
 
463
    E_SUCCESS = 0
 
464
    E_INTERRUPTED = -52
 
465
    E_AGAIN = -28
 
466
    CRT_OPENPGP = 2
 
467
    CLIENT = 2
 
468
    SHUT_RDWR = 0
 
469
    CRD_CERTIFICATE = 1
 
470
    E_NO_CERTIFICATE_FOUND = -49
 
471
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
 
472
    
 
473
    # Types
 
474
    class session_int(ctypes.Structure):
 
475
        _fields_ = []
 
476
    session_t = ctypes.POINTER(session_int)
 
477
    class certificate_credentials_st(ctypes.Structure):
 
478
        _fields_ = []
 
479
    certificate_credentials_t = ctypes.POINTER(
 
480
        certificate_credentials_st)
 
481
    certificate_type_t = ctypes.c_int
 
482
    class datum_t(ctypes.Structure):
 
483
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
484
                    ('size', ctypes.c_uint)]
 
485
    class openpgp_crt_int(ctypes.Structure):
 
486
        _fields_ = []
 
487
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
488
    openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
 
489
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
 
490
    credentials_type_t = ctypes.c_int # 
 
491
    transport_ptr_t = ctypes.c_void_p
 
492
    close_request_t = ctypes.c_int
 
493
    
 
494
    # Exceptions
 
495
    class Error(Exception):
 
496
        # We need to use the class name "GnuTLS" here, since this
 
497
        # exception might be raised from within GnuTLS.__init__,
 
498
        # which is called before the assignment to the "gnutls"
 
499
        # global variable has happened.
 
500
        def __init__(self, message = None, code = None, args=()):
 
501
            # Default usage is by a message string, but if a return
 
502
            # code is passed, convert it to a string with
 
503
            # gnutls.strerror()
 
504
            self.code = code
 
505
            if message is None and code is not None:
 
506
                message = GnuTLS.strerror(code)
 
507
            return super(GnuTLS.Error, self).__init__(
 
508
                message, *args)
 
509
    
 
510
    class CertificateSecurityError(Error):
 
511
        pass
 
512
    
 
513
    # Classes
 
514
    class Credentials(object):
 
515
        def __init__(self):
 
516
            self._c_object = gnutls.certificate_credentials_t()
 
517
            gnutls.certificate_allocate_credentials(
 
518
                ctypes.byref(self._c_object))
 
519
            self.type = gnutls.CRD_CERTIFICATE
 
520
        
 
521
        def __del__(self):
 
522
            gnutls.certificate_free_credentials(self._c_object)
 
523
    
 
524
    class ClientSession(object):
 
525
        def __init__(self, socket, credentials = None):
 
526
            self._c_object = gnutls.session_t()
 
527
            gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
 
528
            gnutls.set_default_priority(self._c_object)
 
529
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
530
            gnutls.handshake_set_private_extensions(self._c_object,
 
531
                                                    True)
 
532
            self.socket = socket
 
533
            if credentials is None:
 
534
                credentials = gnutls.Credentials()
 
535
            gnutls.credentials_set(self._c_object, credentials.type,
 
536
                                   ctypes.cast(credentials._c_object,
 
537
                                               ctypes.c_void_p))
 
538
            self.credentials = credentials
 
539
        
 
540
        def __del__(self):
 
541
            gnutls.deinit(self._c_object)
 
542
        
 
543
        def handshake(self):
 
544
            return gnutls.handshake(self._c_object)
 
545
        
 
546
        def send(self, data):
 
547
            data = bytes(data)
 
548
            data_len = len(data)
 
549
            while data_len > 0:
 
550
                data_len -= gnutls.record_send(self._c_object,
 
551
                                               data[-data_len:],
 
552
                                               data_len)
 
553
        
 
554
        def bye(self):
 
555
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
556
    
 
557
    # Error handling functions
 
558
    def _error_code(result):
 
559
        """A function to raise exceptions on errors, suitable
 
560
        for the 'restype' attribute on ctypes functions"""
 
561
        if result >= 0:
 
562
            return result
 
563
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
 
564
            raise gnutls.CertificateSecurityError(code = result)
 
565
        raise gnutls.Error(code = result)
 
566
    
 
567
    def _retry_on_error(result, func, arguments):
 
568
        """A function to retry on some errors, suitable
 
569
        for the 'errcheck' attribute on ctypes functions"""
 
570
        while result < 0:
 
571
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
 
572
                return _error_code(result)
 
573
            result = func(*arguments)
 
574
        return result
 
575
    
 
576
    # Unless otherwise indicated, the function declarations below are
 
577
    # all from the gnutls/gnutls.h C header file.
 
578
    
 
579
    # Functions
 
580
    priority_set_direct = _library.gnutls_priority_set_direct
 
581
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
582
                                    ctypes.POINTER(ctypes.c_char_p)]
 
583
    priority_set_direct.restype = _error_code
 
584
    
 
585
    init = _library.gnutls_init
 
586
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
587
    init.restype = _error_code
 
588
    
 
589
    set_default_priority = _library.gnutls_set_default_priority
 
590
    set_default_priority.argtypes = [session_t]
 
591
    set_default_priority.restype = _error_code
 
592
    
 
593
    record_send = _library.gnutls_record_send
 
594
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
595
                            ctypes.c_size_t]
 
596
    record_send.restype = ctypes.c_ssize_t
 
597
    record_send.errcheck = _retry_on_error
 
598
    
 
599
    certificate_allocate_credentials = (
 
600
        _library.gnutls_certificate_allocate_credentials)
 
601
    certificate_allocate_credentials.argtypes = [
 
602
        ctypes.POINTER(certificate_credentials_t)]
 
603
    certificate_allocate_credentials.restype = _error_code
 
604
    
 
605
    certificate_free_credentials = (
 
606
        _library.gnutls_certificate_free_credentials)
 
607
    certificate_free_credentials.argtypes = [certificate_credentials_t]
 
608
    certificate_free_credentials.restype = None
 
609
    
 
610
    handshake_set_private_extensions = (
 
611
        _library.gnutls_handshake_set_private_extensions)
 
612
    handshake_set_private_extensions.argtypes = [session_t,
 
613
                                                 ctypes.c_int]
 
614
    handshake_set_private_extensions.restype = None
 
615
    
 
616
    credentials_set = _library.gnutls_credentials_set
 
617
    credentials_set.argtypes = [session_t, credentials_type_t,
 
618
                                ctypes.c_void_p]
 
619
    credentials_set.restype = _error_code
 
620
    
 
621
    strerror = _library.gnutls_strerror
 
622
    strerror.argtypes = [ctypes.c_int]
 
623
    strerror.restype = ctypes.c_char_p
 
624
    
 
625
    certificate_type_get = _library.gnutls_certificate_type_get
 
626
    certificate_type_get.argtypes = [session_t]
 
627
    certificate_type_get.restype = _error_code
 
628
    
 
629
    certificate_get_peers = _library.gnutls_certificate_get_peers
 
630
    certificate_get_peers.argtypes = [session_t,
 
631
                                      ctypes.POINTER(ctypes.c_uint)]
 
632
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
 
633
    
 
634
    global_set_log_level = _library.gnutls_global_set_log_level
 
635
    global_set_log_level.argtypes = [ctypes.c_int]
 
636
    global_set_log_level.restype = None
 
637
    
 
638
    global_set_log_function = _library.gnutls_global_set_log_function
 
639
    global_set_log_function.argtypes = [log_func]
 
640
    global_set_log_function.restype = None
 
641
    
 
642
    deinit = _library.gnutls_deinit
 
643
    deinit.argtypes = [session_t]
 
644
    deinit.restype = None
 
645
    
 
646
    handshake = _library.gnutls_handshake
 
647
    handshake.argtypes = [session_t]
 
648
    handshake.restype = _error_code
 
649
    handshake.errcheck = _retry_on_error
 
650
    
 
651
    transport_set_ptr = _library.gnutls_transport_set_ptr
 
652
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
653
    transport_set_ptr.restype = None
 
654
    
 
655
    bye = _library.gnutls_bye
 
656
    bye.argtypes = [session_t, close_request_t]
 
657
    bye.restype = _error_code
 
658
    bye.errcheck = _retry_on_error
 
659
    
 
660
    check_version = _library.gnutls_check_version
 
661
    check_version.argtypes = [ctypes.c_char_p]
 
662
    check_version.restype = ctypes.c_char_p
 
663
    
 
664
    # All the function declarations below are from gnutls/openpgp.h
 
665
    
 
666
    openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
667
    openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
668
    openpgp_crt_init.restype = _error_code
 
669
    
 
670
    openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
671
    openpgp_crt_import.argtypes = [openpgp_crt_t,
 
672
                                   ctypes.POINTER(datum_t),
 
673
                                   openpgp_crt_fmt_t]
 
674
    openpgp_crt_import.restype = _error_code
 
675
    
 
676
    openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
677
    openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
678
                                        ctypes.POINTER(ctypes.c_uint)]
 
679
    openpgp_crt_verify_self.restype = _error_code
 
680
    
 
681
    openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
682
    openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
683
    openpgp_crt_deinit.restype = None
 
684
    
 
685
    openpgp_crt_get_fingerprint = (
 
686
        _library.gnutls_openpgp_crt_get_fingerprint)
 
687
    openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
688
                                            ctypes.c_void_p,
 
689
                                            ctypes.POINTER(
 
690
                                                ctypes.c_size_t)]
 
691
    openpgp_crt_get_fingerprint.restype = _error_code
 
692
    
 
693
    # Remove non-public functions
 
694
    del _error_code, _retry_on_error
 
695
# Create the global "gnutls" object, simulating a module
 
696
gnutls = GnuTLS()
 
697
 
 
698
def call_pipe(connection,       # : multiprocessing.Connection
 
699
              func, *args, **kwargs):
 
700
    """This function is meant to be called by multiprocessing.Process
 
701
    
 
702
    This function runs func(*args, **kwargs), and writes the resulting
 
703
    return value on the provided multiprocessing.Connection.
 
704
    """
 
705
    connection.send(func(*args, **kwargs))
 
706
    connection.close()
427
707
 
428
708
class Client(object):
429
709
    """A representation of a client host served by this server.
435
715
    checker:    subprocess.Popen(); a running checker process used
436
716
                                    to see if the client lives.
437
717
                                    'None' if no process is running.
438
 
    checker_callback_tag: a gobject event source tag, or None
 
718
    checker_callback_tag: a GObject event source tag, or None
439
719
    checker_command: string; External command which is run to check
440
720
                     if client lives.  %() expansions are done at
441
721
                     runtime with vars(self) as dict, so that for
442
722
                     instance %(name)s can be used in the command.
443
 
    checker_initiator_tag: a gobject event source tag, or None
 
723
    checker_initiator_tag: a GObject event source tag, or None
444
724
    created:    datetime.datetime(); (UTC) object creation
445
725
    client_structure: Object describing what attributes a client has
446
726
                      and is used for storing the client at exit
447
727
    current_checker_command: string; current running checker_command
448
 
    disable_initiator_tag: a gobject event source tag, or None
 
728
    disable_initiator_tag: a GObject event source tag, or None
449
729
    enabled:    bool()
450
730
    fingerprint: string (40 or 32 hexadecimal digits); used to
451
731
                 uniquely identify the client
456
736
    last_checker_status: integer between 0 and 255 reflecting exit
457
737
                         status of last checker. -1 reflects crashed
458
738
                         checker, -2 means no checker completed yet.
 
739
    last_checker_signal: The signal which killed the last checker, if
 
740
                         last_checker_status is -1
459
741
    last_enabled: datetime.datetime(); (UTC) or None
460
742
    name:       string; from the config file, used in log messages and
461
743
                        D-Bus identifiers
603
885
        if not quiet:
604
886
            logger.info("Disabling client %s", self.name)
605
887
        if getattr(self, "disable_initiator_tag", None) is not None:
606
 
            gobject.source_remove(self.disable_initiator_tag)
 
888
            GObject.source_remove(self.disable_initiator_tag)
607
889
            self.disable_initiator_tag = None
608
890
        self.expires = None
609
891
        if getattr(self, "checker_initiator_tag", None) is not None:
610
 
            gobject.source_remove(self.checker_initiator_tag)
 
892
            GObject.source_remove(self.checker_initiator_tag)
611
893
            self.checker_initiator_tag = None
612
894
        self.stop_checker()
613
895
        self.enabled = False
614
896
        if not quiet:
615
897
            self.send_changedstate()
616
 
        # Do not run this again if called by a gobject.timeout_add
 
898
        # Do not run this again if called by a GObject.timeout_add
617
899
        return False
618
900
    
619
901
    def __del__(self):
623
905
        # Schedule a new checker to be started an 'interval' from now,
624
906
        # and every interval from then on.
625
907
        if self.checker_initiator_tag is not None:
626
 
            gobject.source_remove(self.checker_initiator_tag)
627
 
        self.checker_initiator_tag = gobject.timeout_add(
 
908
            GObject.source_remove(self.checker_initiator_tag)
 
909
        self.checker_initiator_tag = GObject.timeout_add(
628
910
            int(self.interval.total_seconds() * 1000),
629
911
            self.start_checker)
630
912
        # Schedule a disable() when 'timeout' has passed
631
913
        if self.disable_initiator_tag is not None:
632
 
            gobject.source_remove(self.disable_initiator_tag)
633
 
        self.disable_initiator_tag = gobject.timeout_add(
 
914
            GObject.source_remove(self.disable_initiator_tag)
 
915
        self.disable_initiator_tag = GObject.timeout_add(
634
916
            int(self.timeout.total_seconds() * 1000), self.disable)
635
917
        # Also start a new checker *right now*.
636
918
        self.start_checker()
637
919
    
638
 
    def checker_callback(self, pid, condition, command):
 
920
    def checker_callback(self, source, condition, connection,
 
921
                         command):
639
922
        """The checker has completed, so take appropriate actions."""
640
923
        self.checker_callback_tag = None
641
924
        self.checker = None
642
 
        if os.WIFEXITED(condition):
643
 
            self.last_checker_status = os.WEXITSTATUS(condition)
 
925
        # Read return code from connection (see call_pipe)
 
926
        returncode = connection.recv()
 
927
        connection.close()
 
928
        
 
929
        if returncode >= 0:
 
930
            self.last_checker_status = returncode
 
931
            self.last_checker_signal = None
644
932
            if self.last_checker_status == 0:
645
933
                logger.info("Checker for %(name)s succeeded",
646
934
                            vars(self))
649
937
                logger.info("Checker for %(name)s failed", vars(self))
650
938
        else:
651
939
            self.last_checker_status = -1
 
940
            self.last_checker_signal = -returncode
652
941
            logger.warning("Checker for %(name)s crashed?",
653
942
                           vars(self))
 
943
        return False
654
944
    
655
945
    def checked_ok(self):
656
946
        """Assert that the client has been seen, alive and well."""
657
947
        self.last_checked_ok = datetime.datetime.utcnow()
658
948
        self.last_checker_status = 0
 
949
        self.last_checker_signal = None
659
950
        self.bump_timeout()
660
951
    
661
952
    def bump_timeout(self, timeout=None):
663
954
        if timeout is None:
664
955
            timeout = self.timeout
665
956
        if self.disable_initiator_tag is not None:
666
 
            gobject.source_remove(self.disable_initiator_tag)
 
957
            GObject.source_remove(self.disable_initiator_tag)
667
958
            self.disable_initiator_tag = None
668
959
        if getattr(self, "enabled", False):
669
 
            self.disable_initiator_tag = gobject.timeout_add(
 
960
            self.disable_initiator_tag = GObject.timeout_add(
670
961
                int(timeout.total_seconds() * 1000), self.disable)
671
962
            self.expires = datetime.datetime.utcnow() + timeout
672
963
    
687
978
        # than 'timeout' for the client to be disabled, which is as it
688
979
        # should be.
689
980
        
690
 
        # If a checker exists, make sure it is not a zombie
691
 
        try:
692
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
693
 
        except AttributeError:
694
 
            pass
695
 
        except OSError as error:
696
 
            if error.errno != errno.ECHILD:
697
 
                raise
698
 
        else:
699
 
            if pid:
700
 
                logger.warning("Checker was a zombie")
701
 
                gobject.source_remove(self.checker_callback_tag)
702
 
                self.checker_callback(pid, status,
703
 
                                      self.current_checker_command)
 
981
        if self.checker is not None and not self.checker.is_alive():
 
982
            logger.warning("Checker was not alive; joining")
 
983
            self.checker.join()
 
984
            self.checker = None
704
985
        # Start a new checker if needed
705
986
        if self.checker is None:
706
987
            # Escape attributes for the shell
715
996
                             exc_info=error)
716
997
                return True     # Try again later
717
998
            self.current_checker_command = command
718
 
            try:
719
 
                logger.info("Starting checker %r for %s", command,
720
 
                            self.name)
721
 
                # We don't need to redirect stdout and stderr, since
722
 
                # in normal mode, that is already done by daemon(),
723
 
                # and in debug mode we don't want to.  (Stdin is
724
 
                # always replaced by /dev/null.)
725
 
                # The exception is when not debugging but nevertheless
726
 
                # running in the foreground; use the previously
727
 
                # created wnull.
728
 
                popen_args = {}
729
 
                if (not self.server_settings["debug"]
730
 
                    and self.server_settings["foreground"]):
731
 
                    popen_args.update({"stdout": wnull,
732
 
                                       "stderr": wnull })
733
 
                self.checker = subprocess.Popen(command,
734
 
                                                close_fds=True,
735
 
                                                shell=True,
736
 
                                                cwd="/",
737
 
                                                **popen_args)
738
 
            except OSError as error:
739
 
                logger.error("Failed to start subprocess",
740
 
                             exc_info=error)
741
 
                return True
742
 
            self.checker_callback_tag = gobject.child_watch_add(
743
 
                self.checker.pid, self.checker_callback, data=command)
744
 
            # The checker may have completed before the gobject
745
 
            # watch was added.  Check for this.
746
 
            try:
747
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
748
 
            except OSError as error:
749
 
                if error.errno == errno.ECHILD:
750
 
                    # This should never happen
751
 
                    logger.error("Child process vanished",
752
 
                                 exc_info=error)
753
 
                    return True
754
 
                raise
755
 
            if pid:
756
 
                gobject.source_remove(self.checker_callback_tag)
757
 
                self.checker_callback(pid, status, command)
758
 
        # Re-run this periodically if run by gobject.timeout_add
 
999
            logger.info("Starting checker %r for %s", command,
 
1000
                        self.name)
 
1001
            # We don't need to redirect stdout and stderr, since
 
1002
            # in normal mode, that is already done by daemon(),
 
1003
            # and in debug mode we don't want to.  (Stdin is
 
1004
            # always replaced by /dev/null.)
 
1005
            # The exception is when not debugging but nevertheless
 
1006
            # running in the foreground; use the previously
 
1007
            # created wnull.
 
1008
            popen_args = { "close_fds": True,
 
1009
                           "shell": True,
 
1010
                           "cwd": "/" }
 
1011
            if (not self.server_settings["debug"]
 
1012
                and self.server_settings["foreground"]):
 
1013
                popen_args.update({"stdout": wnull,
 
1014
                                   "stderr": wnull })
 
1015
            pipe = multiprocessing.Pipe(duplex = False)
 
1016
            self.checker = multiprocessing.Process(
 
1017
                target = call_pipe,
 
1018
                args = (pipe[1], subprocess.call, command),
 
1019
                kwargs = popen_args)
 
1020
            self.checker.start()
 
1021
            self.checker_callback_tag = GObject.io_add_watch(
 
1022
                pipe[0].fileno(), GObject.IO_IN,
 
1023
                self.checker_callback, pipe[0], command)
 
1024
        # Re-run this periodically if run by GObject.timeout_add
759
1025
        return True
760
1026
    
761
1027
    def stop_checker(self):
762
1028
        """Force the checker process, if any, to stop."""
763
1029
        if self.checker_callback_tag:
764
 
            gobject.source_remove(self.checker_callback_tag)
 
1030
            GObject.source_remove(self.checker_callback_tag)
765
1031
            self.checker_callback_tag = None
766
1032
        if getattr(self, "checker", None) is None:
767
1033
            return
768
1034
        logger.debug("Stopping checker for %(name)s", vars(self))
769
 
        try:
770
 
            self.checker.terminate()
771
 
            #time.sleep(0.5)
772
 
            #if self.checker.poll() is None:
773
 
            #    self.checker.kill()
774
 
        except OSError as error:
775
 
            if error.errno != errno.ESRCH: # No such process
776
 
                raise
 
1035
        self.checker.terminate()
777
1036
        self.checker = None
778
1037
 
779
1038
 
843
1102
                           access="r")
844
1103
    def Property_dbus_property(self):
845
1104
        return dbus.Boolean(False)
 
1105
    
 
1106
    See also the DBusObjectWithAnnotations class.
846
1107
    """
847
1108
    
848
1109
    def decorator(func):
870
1131
    pass
871
1132
 
872
1133
 
873
 
class DBusObjectWithProperties(dbus.service.Object):
874
 
    """A D-Bus object with properties.
 
1134
class DBusObjectWithAnnotations(dbus.service.Object):
 
1135
    """A D-Bus object with annotations.
875
1136
    
876
 
    Classes inheriting from this can use the dbus_service_property
877
 
    decorator to expose methods as D-Bus properties.  It exposes the
878
 
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
1137
    Classes inheriting from this can use the dbus_annotations
 
1138
    decorator to add annotations to methods or signals.
879
1139
    """
880
1140
    
881
1141
    @staticmethod
897
1157
                for name, athing in
898
1158
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
899
1159
    
 
1160
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1161
                         out_signature = "s",
 
1162
                         path_keyword = 'object_path',
 
1163
                         connection_keyword = 'connection')
 
1164
    def Introspect(self, object_path, connection):
 
1165
        """Overloading of standard D-Bus method.
 
1166
        
 
1167
        Inserts annotation tags on methods and signals.
 
1168
        """
 
1169
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
1170
                                                   connection)
 
1171
        try:
 
1172
            document = xml.dom.minidom.parseString(xmlstring)
 
1173
            
 
1174
            for if_tag in document.getElementsByTagName("interface"):
 
1175
                # Add annotation tags
 
1176
                for typ in ("method", "signal"):
 
1177
                    for tag in if_tag.getElementsByTagName(typ):
 
1178
                        annots = dict()
 
1179
                        for name, prop in (self.
 
1180
                                           _get_all_dbus_things(typ)):
 
1181
                            if (name == tag.getAttribute("name")
 
1182
                                and prop._dbus_interface
 
1183
                                == if_tag.getAttribute("name")):
 
1184
                                annots.update(getattr(
 
1185
                                    prop, "_dbus_annotations", {}))
 
1186
                        for name, value in annots.items():
 
1187
                            ann_tag = document.createElement(
 
1188
                                "annotation")
 
1189
                            ann_tag.setAttribute("name", name)
 
1190
                            ann_tag.setAttribute("value", value)
 
1191
                            tag.appendChild(ann_tag)
 
1192
                # Add interface annotation tags
 
1193
                for annotation, value in dict(
 
1194
                    itertools.chain.from_iterable(
 
1195
                        annotations().items()
 
1196
                        for name, annotations
 
1197
                        in self._get_all_dbus_things("interface")
 
1198
                        if name == if_tag.getAttribute("name")
 
1199
                        )).items():
 
1200
                    ann_tag = document.createElement("annotation")
 
1201
                    ann_tag.setAttribute("name", annotation)
 
1202
                    ann_tag.setAttribute("value", value)
 
1203
                    if_tag.appendChild(ann_tag)
 
1204
                # Fix argument name for the Introspect method itself
 
1205
                if (if_tag.getAttribute("name")
 
1206
                                == dbus.INTROSPECTABLE_IFACE):
 
1207
                    for cn in if_tag.getElementsByTagName("method"):
 
1208
                        if cn.getAttribute("name") == "Introspect":
 
1209
                            for arg in cn.getElementsByTagName("arg"):
 
1210
                                if (arg.getAttribute("direction")
 
1211
                                    == "out"):
 
1212
                                    arg.setAttribute("name",
 
1213
                                                     "xml_data")
 
1214
            xmlstring = document.toxml("utf-8")
 
1215
            document.unlink()
 
1216
        except (AttributeError, xml.dom.DOMException,
 
1217
                xml.parsers.expat.ExpatError) as error:
 
1218
            logger.error("Failed to override Introspection method",
 
1219
                         exc_info=error)
 
1220
        return xmlstring
 
1221
 
 
1222
 
 
1223
class DBusObjectWithProperties(DBusObjectWithAnnotations):
 
1224
    """A D-Bus object with properties.
 
1225
    
 
1226
    Classes inheriting from this can use the dbus_service_property
 
1227
    decorator to expose methods as D-Bus properties.  It exposes the
 
1228
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
1229
    """
 
1230
    
900
1231
    def _get_dbus_property(self, interface_name, property_name):
901
1232
        """Returns a bound method if one exists which is a D-Bus
902
1233
        property with the specified name and interface.
912
1243
        raise DBusPropertyNotFound("{}:{}.{}".format(
913
1244
            self.dbus_object_path, interface_name, property_name))
914
1245
    
 
1246
    @classmethod
 
1247
    def _get_all_interface_names(cls):
 
1248
        """Get a sequence of all interfaces supported by an object"""
 
1249
        return (name for name in set(getattr(getattr(x, attr),
 
1250
                                             "_dbus_interface", None)
 
1251
                                     for x in (inspect.getmro(cls))
 
1252
                                     for attr in dir(x))
 
1253
                if name is not None)
 
1254
    
915
1255
    @dbus.service.method(dbus.PROPERTIES_IFACE,
916
1256
                         in_signature="ss",
917
1257
                         out_signature="v")
987
1327
        
988
1328
        Inserts property tags and interface annotation tags.
989
1329
        """
990
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
991
 
                                                   connection)
 
1330
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1331
                                                         object_path,
 
1332
                                                         connection)
992
1333
        try:
993
1334
            document = xml.dom.minidom.parseString(xmlstring)
994
1335
            
1007
1348
                            if prop._dbus_interface
1008
1349
                            == if_tag.getAttribute("name")):
1009
1350
                    if_tag.appendChild(tag)
1010
 
                # Add annotation tags
1011
 
                for typ in ("method", "signal", "property"):
1012
 
                    for tag in if_tag.getElementsByTagName(typ):
1013
 
                        annots = dict()
1014
 
                        for name, prop in (self.
1015
 
                                           _get_all_dbus_things(typ)):
1016
 
                            if (name == tag.getAttribute("name")
1017
 
                                and prop._dbus_interface
1018
 
                                == if_tag.getAttribute("name")):
1019
 
                                annots.update(getattr(
1020
 
                                    prop, "_dbus_annotations", {}))
1021
 
                        for name, value in annots.items():
1022
 
                            ann_tag = document.createElement(
1023
 
                                "annotation")
1024
 
                            ann_tag.setAttribute("name", name)
1025
 
                            ann_tag.setAttribute("value", value)
1026
 
                            tag.appendChild(ann_tag)
1027
 
                # Add interface annotation tags
1028
 
                for annotation, value in dict(
1029
 
                    itertools.chain.from_iterable(
1030
 
                        annotations().items()
1031
 
                        for name, annotations
1032
 
                        in self._get_all_dbus_things("interface")
1033
 
                        if name == if_tag.getAttribute("name")
1034
 
                        )).items():
1035
 
                    ann_tag = document.createElement("annotation")
1036
 
                    ann_tag.setAttribute("name", annotation)
1037
 
                    ann_tag.setAttribute("value", value)
1038
 
                    if_tag.appendChild(ann_tag)
 
1351
                # Add annotation tags for properties
 
1352
                for tag in if_tag.getElementsByTagName("property"):
 
1353
                    annots = dict()
 
1354
                    for name, prop in self._get_all_dbus_things(
 
1355
                            "property"):
 
1356
                        if (name == tag.getAttribute("name")
 
1357
                            and prop._dbus_interface
 
1358
                            == if_tag.getAttribute("name")):
 
1359
                            annots.update(getattr(
 
1360
                                prop, "_dbus_annotations", {}))
 
1361
                    for name, value in annots.items():
 
1362
                        ann_tag = document.createElement(
 
1363
                            "annotation")
 
1364
                        ann_tag.setAttribute("name", name)
 
1365
                        ann_tag.setAttribute("value", value)
 
1366
                        tag.appendChild(ann_tag)
1039
1367
                # Add the names to the return values for the
1040
1368
                # "org.freedesktop.DBus.Properties" methods
1041
1369
                if (if_tag.getAttribute("name")
1059
1387
                         exc_info=error)
1060
1388
        return xmlstring
1061
1389
 
 
1390
try:
 
1391
    dbus.OBJECT_MANAGER_IFACE
 
1392
except AttributeError:
 
1393
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
1394
 
 
1395
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
 
1396
    """A D-Bus object with an ObjectManager.
 
1397
    
 
1398
    Classes inheriting from this exposes the standard
 
1399
    GetManagedObjects call and the InterfacesAdded and
 
1400
    InterfacesRemoved signals on the standard
 
1401
    "org.freedesktop.DBus.ObjectManager" interface.
 
1402
    
 
1403
    Note: No signals are sent automatically; they must be sent
 
1404
    manually.
 
1405
    """
 
1406
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
1407
                         out_signature = "a{oa{sa{sv}}}")
 
1408
    def GetManagedObjects(self):
 
1409
        """This function must be overridden"""
 
1410
        raise NotImplementedError()
 
1411
    
 
1412
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
 
1413
                         signature = "oa{sa{sv}}")
 
1414
    def InterfacesAdded(self, object_path, interfaces_and_properties):
 
1415
        pass
 
1416
    
 
1417
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
 
1418
    def InterfacesRemoved(self, object_path, interfaces):
 
1419
        pass
 
1420
    
 
1421
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1422
                         out_signature = "s",
 
1423
                         path_keyword = 'object_path',
 
1424
                         connection_keyword = 'connection')
 
1425
    def Introspect(self, object_path, connection):
 
1426
        """Overloading of standard D-Bus method.
 
1427
        
 
1428
        Override return argument name of GetManagedObjects to be
 
1429
        "objpath_interfaces_and_properties"
 
1430
        """
 
1431
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1432
                                                         object_path,
 
1433
                                                         connection)
 
1434
        try:
 
1435
            document = xml.dom.minidom.parseString(xmlstring)
 
1436
            
 
1437
            for if_tag in document.getElementsByTagName("interface"):
 
1438
                # Fix argument name for the GetManagedObjects method
 
1439
                if (if_tag.getAttribute("name")
 
1440
                                == dbus.OBJECT_MANAGER_IFACE):
 
1441
                    for cn in if_tag.getElementsByTagName("method"):
 
1442
                        if (cn.getAttribute("name")
 
1443
                            == "GetManagedObjects"):
 
1444
                            for arg in cn.getElementsByTagName("arg"):
 
1445
                                if (arg.getAttribute("direction")
 
1446
                                    == "out"):
 
1447
                                    arg.setAttribute(
 
1448
                                        "name",
 
1449
                                        "objpath_interfaces"
 
1450
                                        "_and_properties")
 
1451
            xmlstring = document.toxml("utf-8")
 
1452
            document.unlink()
 
1453
        except (AttributeError, xml.dom.DOMException,
 
1454
                xml.parsers.expat.ExpatError) as error:
 
1455
            logger.error("Failed to override Introspection method",
 
1456
                         exc_info = error)
 
1457
        return xmlstring
1062
1458
 
1063
1459
def datetime_to_dbus(dt, variant_level=0):
1064
1460
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1111
1507
                interface_names.add(alt_interface)
1112
1508
                # Is this a D-Bus signal?
1113
1509
                if getattr(attribute, "_dbus_is_signal", False):
1114
 
                    # Extract the original non-method undecorated
1115
 
                    # function by black magic
1116
 
                    nonmethod_func = (dict(
1117
 
                        zip(attribute.func_code.co_freevars,
1118
 
                            attribute.__closure__))
1119
 
                                      ["func"].cell_contents)
 
1510
                    if sys.version_info.major == 2:
 
1511
                        # Extract the original non-method undecorated
 
1512
                        # function by black magic
 
1513
                        nonmethod_func = (dict(
 
1514
                            zip(attribute.func_code.co_freevars,
 
1515
                                attribute.__closure__))
 
1516
                                          ["func"].cell_contents)
 
1517
                    else:
 
1518
                        nonmethod_func = attribute
1120
1519
                    # Create a new, but exactly alike, function
1121
1520
                    # object, and decorate it to be a new D-Bus signal
1122
1521
                    # with the alternate D-Bus interface name
 
1522
                    if sys.version_info.major == 2:
 
1523
                        new_function = types.FunctionType(
 
1524
                            nonmethod_func.func_code,
 
1525
                            nonmethod_func.func_globals,
 
1526
                            nonmethod_func.func_name,
 
1527
                            nonmethod_func.func_defaults,
 
1528
                            nonmethod_func.func_closure)
 
1529
                    else:
 
1530
                        new_function = types.FunctionType(
 
1531
                            nonmethod_func.__code__,
 
1532
                            nonmethod_func.__globals__,
 
1533
                            nonmethod_func.__name__,
 
1534
                            nonmethod_func.__defaults__,
 
1535
                            nonmethod_func.__closure__)
1123
1536
                    new_function = (dbus.service.signal(
1124
 
                        alt_interface, attribute._dbus_signature)
1125
 
                                    (types.FunctionType(
1126
 
                                        nonmethod_func.func_code,
1127
 
                                        nonmethod_func.func_globals,
1128
 
                                        nonmethod_func.func_name,
1129
 
                                        nonmethod_func.func_defaults,
1130
 
                                        nonmethod_func.func_closure)))
 
1537
                        alt_interface,
 
1538
                        attribute._dbus_signature)(new_function))
1131
1539
                    # Copy annotations, if any
1132
1540
                    try:
1133
1541
                        new_function._dbus_annotations = dict(
1143
1551
                        func1 and func2 to the "call_both" function
1144
1552
                        outside of its arguments"""
1145
1553
                        
 
1554
                        @functools.wraps(func2)
1146
1555
                        def call_both(*args, **kwargs):
1147
1556
                            """This function will emit two D-Bus
1148
1557
                            signals by calling func1 and func2"""
1149
1558
                            func1(*args, **kwargs)
1150
1559
                            func2(*args, **kwargs)
 
1560
                        # Make wrapper function look like a D-Bus signal
 
1561
                        for name, attr in inspect.getmembers(func2):
 
1562
                            if name.startswith("_dbus_"):
 
1563
                                setattr(call_both, name, attr)
1151
1564
                        
1152
1565
                        return call_both
1153
1566
                    # Create the "call_both" function and add it to
1356
1769
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1357
1770
        Client.__del__(self, *args, **kwargs)
1358
1771
    
1359
 
    def checker_callback(self, pid, condition, command,
1360
 
                         *args, **kwargs):
1361
 
        self.checker_callback_tag = None
1362
 
        self.checker = None
1363
 
        if os.WIFEXITED(condition):
1364
 
            exitstatus = os.WEXITSTATUS(condition)
 
1772
    def checker_callback(self, source, condition,
 
1773
                         connection, command, *args, **kwargs):
 
1774
        ret = Client.checker_callback(self, source, condition,
 
1775
                                      connection, command, *args,
 
1776
                                      **kwargs)
 
1777
        exitstatus = self.last_checker_status
 
1778
        if exitstatus >= 0:
1365
1779
            # Emit D-Bus signal
1366
1780
            self.CheckerCompleted(dbus.Int16(exitstatus),
1367
 
                                  dbus.Int64(condition),
 
1781
                                  # This is specific to GNU libC
 
1782
                                  dbus.Int64(exitstatus << 8),
1368
1783
                                  dbus.String(command))
1369
1784
        else:
1370
1785
            # Emit D-Bus signal
1371
1786
            self.CheckerCompleted(dbus.Int16(-1),
1372
 
                                  dbus.Int64(condition),
 
1787
                                  dbus.Int64(
 
1788
                                      # This is specific to GNU libC
 
1789
                                      (exitstatus << 8)
 
1790
                                      | self.last_checker_signal),
1373
1791
                                  dbus.String(command))
1374
 
        
1375
 
        return Client.checker_callback(self, pid, condition, command,
1376
 
                                       *args, **kwargs)
 
1792
        return ret
1377
1793
    
1378
1794
    def start_checker(self, *args, **kwargs):
1379
1795
        old_checker_pid = getattr(self.checker, "pid", None)
1391
1807
    
1392
1808
    def approve(self, value=True):
1393
1809
        self.approved = value
1394
 
        gobject.timeout_add(int(self.approval_duration.total_seconds()
 
1810
        GObject.timeout_add(int(self.approval_duration.total_seconds()
1395
1811
                                * 1000), self._reset_approved)
1396
1812
        self.send_changedstate()
1397
1813
    
1454
1870
        self.checked_ok()
1455
1871
    
1456
1872
    # Enable - method
 
1873
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1457
1874
    @dbus.service.method(_interface)
1458
1875
    def Enable(self):
1459
1876
        "D-Bus method"
1460
1877
        self.enable()
1461
1878
    
1462
1879
    # StartChecker - method
 
1880
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1463
1881
    @dbus.service.method(_interface)
1464
1882
    def StartChecker(self):
1465
1883
        "D-Bus method"
1466
1884
        self.start_checker()
1467
1885
    
1468
1886
    # Disable - method
 
1887
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1469
1888
    @dbus.service.method(_interface)
1470
1889
    def Disable(self):
1471
1890
        "D-Bus method"
1472
1891
        self.disable()
1473
1892
    
1474
1893
    # StopChecker - method
 
1894
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1475
1895
    @dbus.service.method(_interface)
1476
1896
    def StopChecker(self):
1477
1897
        self.stop_checker()
1513
1933
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1514
1934
    
1515
1935
    # Name - property
 
1936
    @dbus_annotations(
 
1937
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1516
1938
    @dbus_service_property(_interface, signature="s", access="read")
1517
1939
    def Name_dbus_property(self):
1518
1940
        return dbus.String(self.name)
1519
1941
    
1520
1942
    # Fingerprint - property
 
1943
    @dbus_annotations(
 
1944
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1521
1945
    @dbus_service_property(_interface, signature="s", access="read")
1522
1946
    def Fingerprint_dbus_property(self):
1523
1947
        return dbus.String(self.fingerprint)
1532
1956
        self.host = str(value)
1533
1957
    
1534
1958
    # Created - property
 
1959
    @dbus_annotations(
 
1960
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1535
1961
    @dbus_service_property(_interface, signature="s", access="read")
1536
1962
    def Created_dbus_property(self):
1537
1963
        return datetime_to_dbus(self.created)
1598
2024
                if (getattr(self, "disable_initiator_tag", None)
1599
2025
                    is None):
1600
2026
                    return
1601
 
                gobject.source_remove(self.disable_initiator_tag)
1602
 
                self.disable_initiator_tag = gobject.timeout_add(
 
2027
                GObject.source_remove(self.disable_initiator_tag)
 
2028
                self.disable_initiator_tag = GObject.timeout_add(
1603
2029
                    int((self.expires - now).total_seconds() * 1000),
1604
2030
                    self.disable)
1605
2031
    
1625
2051
            return
1626
2052
        if self.enabled:
1627
2053
            # Reschedule checker run
1628
 
            gobject.source_remove(self.checker_initiator_tag)
1629
 
            self.checker_initiator_tag = gobject.timeout_add(
 
2054
            GObject.source_remove(self.checker_initiator_tag)
 
2055
            self.checker_initiator_tag = GObject.timeout_add(
1630
2056
                value, self.start_checker)
1631
2057
            self.start_checker() # Start one now, too
1632
2058
    
1652
2078
            self.stop_checker()
1653
2079
    
1654
2080
    # ObjectPath - property
 
2081
    @dbus_annotations(
 
2082
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
2083
         "org.freedesktop.DBus.Deprecated": "true"})
1655
2084
    @dbus_service_property(_interface, signature="o", access="read")
1656
2085
    def ObjectPath_dbus_property(self):
1657
2086
        return self.dbus_object_path # is already a dbus.ObjectPath
1658
2087
    
1659
2088
    # Secret = property
 
2089
    @dbus_annotations(
 
2090
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2091
         "invalidates"})
1660
2092
    @dbus_service_property(_interface,
1661
2093
                           signature="ay",
1662
2094
                           access="write",
1672
2104
        self._pipe = child_pipe
1673
2105
        self._pipe.send(('init', fpr, address))
1674
2106
        if not self._pipe.recv():
1675
 
            raise KeyError()
 
2107
            raise KeyError(fpr)
1676
2108
    
1677
2109
    def __getattribute__(self, name):
1678
2110
        if name == '_pipe':
1708
2140
            logger.debug("Pipe FD: %d",
1709
2141
                         self.server.child_pipe.fileno())
1710
2142
            
1711
 
            session = gnutls.connection.ClientSession(
1712
 
                self.request, gnutls.connection .X509Credentials())
1713
 
            
1714
 
            # Note: gnutls.connection.X509Credentials is really a
1715
 
            # generic GnuTLS certificate credentials object so long as
1716
 
            # no X.509 keys are added to it.  Therefore, we can use it
1717
 
            # here despite using OpenPGP certificates.
 
2143
            session = gnutls.ClientSession(self.request)
1718
2144
            
1719
2145
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1720
2146
            #                      "+AES-256-CBC", "+SHA1",
1724
2150
            priority = self.server.gnutls_priority
1725
2151
            if priority is None:
1726
2152
                priority = "NORMAL"
1727
 
            gnutls.library.functions.gnutls_priority_set_direct(
1728
 
                session._c_object, priority, None)
 
2153
            gnutls.priority_set_direct(session._c_object, priority,
 
2154
                                       None)
1729
2155
            
1730
2156
            # Start communication using the Mandos protocol
1731
2157
            # Get protocol number
1741
2167
            # Start GnuTLS connection
1742
2168
            try:
1743
2169
                session.handshake()
1744
 
            except gnutls.errors.GNUTLSError as error:
 
2170
            except gnutls.Error as error:
1745
2171
                logger.warning("Handshake failed: %s", error)
1746
2172
                # Do not run session.bye() here: the session is not
1747
2173
                # established.  Just abandon the request.
1753
2179
                try:
1754
2180
                    fpr = self.fingerprint(
1755
2181
                        self.peer_certificate(session))
1756
 
                except (TypeError,
1757
 
                        gnutls.errors.GNUTLSError) as error:
 
2182
                except (TypeError, gnutls.Error) as error:
1758
2183
                    logger.warning("Bad certificate: %s", error)
1759
2184
                    return
1760
2185
                logger.debug("Fingerprint: %s", fpr)
1818
2243
                    else:
1819
2244
                        delay -= time2 - time
1820
2245
                
1821
 
                sent_size = 0
1822
 
                while sent_size < len(client.secret):
1823
 
                    try:
1824
 
                        sent = session.send(client.secret[sent_size:])
1825
 
                    except gnutls.errors.GNUTLSError as error:
1826
 
                        logger.warning("gnutls send failed",
1827
 
                                       exc_info=error)
1828
 
                        return
1829
 
                    logger.debug("Sent: %d, remaining: %d", sent,
1830
 
                                 len(client.secret) - (sent_size
1831
 
                                                       + sent))
1832
 
                    sent_size += sent
 
2246
                try:
 
2247
                    session.send(client.secret)
 
2248
                except gnutls.Error as error:
 
2249
                    logger.warning("gnutls send failed",
 
2250
                                   exc_info = error)
 
2251
                    return
1833
2252
                
1834
2253
                logger.info("Sending secret to %s", client.name)
1835
2254
                # bump the timeout using extended_timeout
1843
2262
                    client.approvals_pending -= 1
1844
2263
                try:
1845
2264
                    session.bye()
1846
 
                except gnutls.errors.GNUTLSError as error:
 
2265
                except gnutls.Error as error:
1847
2266
                    logger.warning("GnuTLS bye failed",
1848
2267
                                   exc_info=error)
1849
2268
    
1851
2270
    def peer_certificate(session):
1852
2271
        "Return the peer's OpenPGP certificate as a bytestring"
1853
2272
        # If not an OpenPGP certificate...
1854
 
        if (gnutls.library.functions.gnutls_certificate_type_get(
1855
 
                session._c_object)
1856
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1857
 
            # ...do the normal thing
1858
 
            return session.peer_certificate
 
2273
        if (gnutls.certificate_type_get(session._c_object)
 
2274
            != gnutls.CRT_OPENPGP):
 
2275
            # ...return invalid data
 
2276
            return b""
1859
2277
        list_size = ctypes.c_uint(1)
1860
 
        cert_list = (gnutls.library.functions
1861
 
                     .gnutls_certificate_get_peers
 
2278
        cert_list = (gnutls.certificate_get_peers
1862
2279
                     (session._c_object, ctypes.byref(list_size)))
1863
2280
        if not bool(cert_list) and list_size.value != 0:
1864
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1865
 
                                            " certificate")
 
2281
            raise gnutls.Error("error getting peer certificate")
1866
2282
        if list_size.value == 0:
1867
2283
            return None
1868
2284
        cert = cert_list[0]
1872
2288
    def fingerprint(openpgp):
1873
2289
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1874
2290
        # New GnuTLS "datum" with the OpenPGP public key
1875
 
        datum = gnutls.library.types.gnutls_datum_t(
 
2291
        datum = gnutls.datum_t(
1876
2292
            ctypes.cast(ctypes.c_char_p(openpgp),
1877
2293
                        ctypes.POINTER(ctypes.c_ubyte)),
1878
2294
            ctypes.c_uint(len(openpgp)))
1879
2295
        # New empty GnuTLS certificate
1880
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1881
 
        gnutls.library.functions.gnutls_openpgp_crt_init(
1882
 
            ctypes.byref(crt))
 
2296
        crt = gnutls.openpgp_crt_t()
 
2297
        gnutls.openpgp_crt_init(ctypes.byref(crt))
1883
2298
        # Import the OpenPGP public key into the certificate
1884
 
        gnutls.library.functions.gnutls_openpgp_crt_import(
1885
 
            crt, ctypes.byref(datum),
1886
 
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
2299
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2300
                                  gnutls.OPENPGP_FMT_RAW)
1887
2301
        # Verify the self signature in the key
1888
2302
        crtverify = ctypes.c_uint()
1889
 
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1890
 
            crt, 0, ctypes.byref(crtverify))
 
2303
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2304
                                       ctypes.byref(crtverify))
1891
2305
        if crtverify.value != 0:
1892
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1893
 
            raise gnutls.errors.CertificateSecurityError(
1894
 
                "Verify failed")
 
2306
            gnutls.openpgp_crt_deinit(crt)
 
2307
            raise gnutls.CertificateSecurityError("Verify failed")
1895
2308
        # New buffer for the fingerprint
1896
2309
        buf = ctypes.create_string_buffer(20)
1897
2310
        buf_len = ctypes.c_size_t()
1898
2311
        # Get the fingerprint from the certificate into the buffer
1899
 
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1900
 
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
 
2312
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2313
                                           ctypes.byref(buf_len))
1901
2314
        # Deinit the certificate
1902
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2315
        gnutls.openpgp_crt_deinit(crt)
1903
2316
        # Convert the buffer to a Python bytestring
1904
2317
        fpr = ctypes.string_at(buf, buf_len.value)
1905
2318
        # Convert the bytestring to hexadecimal notation
2049
2462
        gnutls_priority GnuTLS priority string
2050
2463
        use_dbus:       Boolean; to emit D-Bus signals or not
2051
2464
    
2052
 
    Assumes a gobject.MainLoop event loop.
 
2465
    Assumes a GObject.MainLoop event loop.
2053
2466
    """
2054
2467
    
2055
2468
    def __init__(self, server_address, RequestHandlerClass,
2080
2493
    
2081
2494
    def add_pipe(self, parent_pipe, proc):
2082
2495
        # Call "handle_ipc" for both data and EOF events
2083
 
        gobject.io_add_watch(
 
2496
        GObject.io_add_watch(
2084
2497
            parent_pipe.fileno(),
2085
 
            gobject.IO_IN | gobject.IO_HUP,
 
2498
            GObject.IO_IN | GObject.IO_HUP,
2086
2499
            functools.partial(self.handle_ipc,
2087
2500
                              parent_pipe = parent_pipe,
2088
2501
                              proc = proc))
2092
2505
                   proc = None,
2093
2506
                   client_object=None):
2094
2507
        # error, or the other end of multiprocessing.Pipe has closed
2095
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2508
        if condition & (GObject.IO_ERR | GObject.IO_HUP):
2096
2509
            # Wait for other process to exit
2097
2510
            proc.join()
2098
2511
            return False
2119
2532
                parent_pipe.send(False)
2120
2533
                return False
2121
2534
            
2122
 
            gobject.io_add_watch(
 
2535
            GObject.io_add_watch(
2123
2536
                parent_pipe.fileno(),
2124
 
                gobject.IO_IN | gobject.IO_HUP,
 
2537
                GObject.IO_IN | GObject.IO_HUP,
2125
2538
                functools.partial(self.handle_ipc,
2126
2539
                                  parent_pipe = parent_pipe,
2127
2540
                                  proc = proc,
2141
2554
        
2142
2555
        if command == 'getattr':
2143
2556
            attrname = request[1]
2144
 
            if callable(client_object.__getattribute__(attrname)):
 
2557
            if isinstance(client_object.__getattribute__(attrname),
 
2558
                          collections.Callable):
2145
2559
                parent_pipe.send(('function', ))
2146
2560
            else:
2147
2561
                parent_pipe.send((
2182
2596
    # avoid excessive use of external libraries.
2183
2597
    
2184
2598
    # New type for defining tokens, syntax, and semantics all-in-one
2185
 
    Token = collections.namedtuple("Token",
2186
 
                                   ("regexp", # To match token; if
2187
 
                                              # "value" is not None,
2188
 
                                              # must have a "group"
2189
 
                                              # containing digits
2190
 
                                    "value",  # datetime.timedelta or
2191
 
                                              # None
2192
 
                                    "followers")) # Tokens valid after
2193
 
                                                  # this token
2194
2599
    Token = collections.namedtuple("Token", (
2195
2600
        "regexp",  # To match token; if "value" is not None, must have
2196
2601
                   # a "group" containing digits
2231
2636
    # Define starting values
2232
2637
    value = datetime.timedelta() # Value so far
2233
2638
    found_token = None
2234
 
    followers = frozenset((token_duration,)) # Following valid tokens
 
2639
    followers = frozenset((token_duration, )) # Following valid tokens
2235
2640
    s = duration                # String left to parse
2236
2641
    # Loop until end token is found
2237
2642
    while found_token is not token_end:
2254
2659
                break
2255
2660
        else:
2256
2661
            # No currently valid tokens were found
2257
 
            raise ValueError("Invalid RFC 3339 duration")
 
2662
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2663
                             .format(duration))
2258
2664
    # End token found
2259
2665
    return value
2260
2666
 
2393
2799
                        "debug": "False",
2394
2800
                        "priority":
2395
2801
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2396
 
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
2802
                        ":+SIGN-DSA-SHA256",
2397
2803
                        "servicename": "Mandos",
2398
2804
                        "use_dbus": "True",
2399
2805
                        "use_ipv6": "True",
2516
2922
            logger.error("Could not open file %r", pidfilename,
2517
2923
                         exc_info=e)
2518
2924
    
2519
 
    for name in ("_mandos", "mandos", "nobody"):
 
2925
    for name, group in (("_mandos", "_mandos"),
 
2926
                        ("mandos", "mandos"),
 
2927
                        ("nobody", "nogroup")):
2520
2928
        try:
2521
2929
            uid = pwd.getpwnam(name).pw_uid
2522
 
            gid = pwd.getpwnam(name).pw_gid
 
2930
            gid = pwd.getpwnam(group).pw_gid
2523
2931
            break
2524
2932
        except KeyError:
2525
2933
            continue
2538
2946
        
2539
2947
        # "Use a log level over 10 to enable all debugging options."
2540
2948
        # - GnuTLS manual
2541
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
2949
        gnutls.global_set_log_level(11)
2542
2950
        
2543
 
        @gnutls.library.types.gnutls_log_func
 
2951
        @gnutls.log_func
2544
2952
        def debug_gnutls(level, string):
2545
2953
            logger.debug("GnuTLS: %s", string[:-1])
2546
2954
        
2547
 
        gnutls.library.functions.gnutls_global_set_log_function(
2548
 
            debug_gnutls)
 
2955
        gnutls.global_set_log_function(debug_gnutls)
2549
2956
        
2550
2957
        # Redirect stdin so all checkers get /dev/null
2551
2958
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2558
2965
        # Close all input and output, do double fork, etc.
2559
2966
        daemon()
2560
2967
    
2561
 
    # multiprocessing will use threads, so before we use gobject we
2562
 
    # need to inform gobject that threads will be used.
2563
 
    gobject.threads_init()
 
2968
    # multiprocessing will use threads, so before we use GObject we
 
2969
    # need to inform GObject that threads will be used.
 
2970
    GObject.threads_init()
2564
2971
    
2565
2972
    global main_loop
2566
2973
    # From the Avahi example code
2567
2974
    DBusGMainLoop(set_as_default=True)
2568
 
    main_loop = gobject.MainLoop()
 
2975
    main_loop = GObject.MainLoop()
2569
2976
    bus = dbus.SystemBus()
2570
2977
    # End of Avahi example code
2571
2978
    if use_dbus:
2655
3062
                    pass
2656
3063
            
2657
3064
            # Clients who has passed its expire date can still be
2658
 
            # enabled if its last checker was successful.  Clients
 
3065
            # enabled if its last checker was successful.  A Client
2659
3066
            # whose checker succeeded before we stored its state is
2660
3067
            # assumed to have successfully run all checkers during
2661
3068
            # downtime.
2730
3137
        
2731
3138
        @alternate_dbus_interfaces(
2732
3139
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2733
 
        class MandosDBusService(DBusObjectWithProperties):
 
3140
        class MandosDBusService(DBusObjectWithObjectManager):
2734
3141
            """A D-Bus proxy object"""
2735
3142
            
2736
3143
            def __init__(self):
2738
3145
            
2739
3146
            _interface = "se.recompile.Mandos"
2740
3147
            
2741
 
            @dbus_interface_annotations(_interface)
2742
 
            def _foo(self):
2743
 
                return {
2744
 
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
2745
 
                    "false" }
2746
 
            
2747
3148
            @dbus.service.signal(_interface, signature="o")
2748
3149
            def ClientAdded(self, objpath):
2749
3150
                "D-Bus signal"
2754
3155
                "D-Bus signal"
2755
3156
                pass
2756
3157
            
 
3158
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3159
                               "true"})
2757
3160
            @dbus.service.signal(_interface, signature="os")
2758
3161
            def ClientRemoved(self, objpath, name):
2759
3162
                "D-Bus signal"
2760
3163
                pass
2761
3164
            
 
3165
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3166
                               "true"})
2762
3167
            @dbus.service.method(_interface, out_signature="ao")
2763
3168
            def GetAllClients(self):
2764
3169
                "D-Bus method"
2765
3170
                return dbus.Array(c.dbus_object_path for c in
2766
3171
                                  tcp_server.clients.itervalues())
2767
3172
            
 
3173
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3174
                               "true"})
2768
3175
            @dbus.service.method(_interface,
2769
3176
                                 out_signature="a{oa{sv}}")
2770
3177
            def GetAllClientsWithProperties(self):
2771
3178
                "D-Bus method"
2772
3179
                return dbus.Dictionary(
2773
 
                    { c.dbus_object_path: c.GetAll("")
 
3180
                    { c.dbus_object_path: c.GetAll(
 
3181
                        "se.recompile.Mandos.Client")
2774
3182
                      for c in tcp_server.clients.itervalues() },
2775
3183
                    signature="oa{sv}")
2776
3184
            
2781
3189
                    if c.dbus_object_path == object_path:
2782
3190
                        del tcp_server.clients[c.name]
2783
3191
                        c.remove_from_connection()
2784
 
                        # Don't signal anything except ClientRemoved
 
3192
                        # Don't signal the disabling
2785
3193
                        c.disable(quiet=True)
2786
 
                        # Emit D-Bus signal
2787
 
                        self.ClientRemoved(object_path, c.name)
 
3194
                        # Emit D-Bus signal for removal
 
3195
                        self.client_removed_signal(c)
2788
3196
                        return
2789
3197
                raise KeyError(object_path)
2790
3198
            
2791
3199
            del _interface
 
3200
            
 
3201
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
3202
                                 out_signature = "a{oa{sa{sv}}}")
 
3203
            def GetManagedObjects(self):
 
3204
                """D-Bus method"""
 
3205
                return dbus.Dictionary(
 
3206
                    { client.dbus_object_path:
 
3207
                      dbus.Dictionary(
 
3208
                          { interface: client.GetAll(interface)
 
3209
                            for interface in
 
3210
                                 client._get_all_interface_names()})
 
3211
                      for client in tcp_server.clients.values()})
 
3212
            
 
3213
            def client_added_signal(self, client):
 
3214
                """Send the new standard signal and the old signal"""
 
3215
                if use_dbus:
 
3216
                    # New standard signal
 
3217
                    self.InterfacesAdded(
 
3218
                        client.dbus_object_path,
 
3219
                        dbus.Dictionary(
 
3220
                            { interface: client.GetAll(interface)
 
3221
                              for interface in
 
3222
                              client._get_all_interface_names()}))
 
3223
                    # Old signal
 
3224
                    self.ClientAdded(client.dbus_object_path)
 
3225
            
 
3226
            def client_removed_signal(self, client):
 
3227
                """Send the new standard signal and the old signal"""
 
3228
                if use_dbus:
 
3229
                    # New standard signal
 
3230
                    self.InterfacesRemoved(
 
3231
                        client.dbus_object_path,
 
3232
                        client._get_all_interface_names())
 
3233
                    # Old signal
 
3234
                    self.ClientRemoved(client.dbus_object_path,
 
3235
                                       client.name)
2792
3236
        
2793
3237
        mandos_dbus_service = MandosDBusService()
2794
3238
    
2859
3303
            name, client = tcp_server.clients.popitem()
2860
3304
            if use_dbus:
2861
3305
                client.remove_from_connection()
2862
 
            # Don't signal anything except ClientRemoved
 
3306
            # Don't signal the disabling
2863
3307
            client.disable(quiet=True)
 
3308
            # Emit D-Bus signal for removal
2864
3309
            if use_dbus:
2865
 
                # Emit D-Bus signal
2866
 
                mandos_dbus_service.ClientRemoved(
2867
 
                    client.dbus_object_path, client.name)
 
3310
                mandos_dbus_service.client_removed_signal(client)
2868
3311
        client_settings.clear()
2869
3312
    
2870
3313
    atexit.register(cleanup)
2871
3314
    
2872
3315
    for client in tcp_server.clients.itervalues():
2873
3316
        if use_dbus:
2874
 
            # Emit D-Bus signal
2875
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3317
            # Emit D-Bus signal for adding
 
3318
            mandos_dbus_service.client_added_signal(client)
2876
3319
        # Need to initiate checking of clients
2877
3320
        if client.enabled:
2878
3321
            client.init_checker()
2904
3347
                sys.exit(1)
2905
3348
            # End of Avahi example code
2906
3349
        
2907
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
3350
        GObject.io_add_watch(tcp_server.fileno(), GObject.IO_IN,
2908
3351
                             lambda *args, **kwargs:
2909
3352
                             (tcp_server.handle_request
2910
3353
                              (*args[2:], **kwargs) or True))