/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-03-08 00:52:12 UTC
  • mfrom: (237.4.69 release)
  • Revision ID: teddy@recompile.se-20160308005212-o5m2eaphq6ze5bb0
Merge from release branch

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
36
36
 
37
37
from future_builtins import *
38
38
 
39
 
import SocketServer as socketserver
 
39
try:
 
40
    import SocketServer as socketserver
 
41
except ImportError:
 
42
    import socketserver
40
43
import socket
41
44
import argparse
42
45
import datetime
43
46
import errno
44
 
import gnutls.crypto
45
 
import gnutls.connection
46
 
import gnutls.errors
47
 
import gnutls.library.functions
48
 
import gnutls.library.constants
49
 
import gnutls.library.types
50
 
import ConfigParser as configparser
 
47
try:
 
48
    import ConfigParser as configparser
 
49
except ImportError:
 
50
    import configparser
51
51
import sys
52
52
import re
53
53
import os
62
62
import struct
63
63
import fcntl
64
64
import functools
65
 
import cPickle as pickle
 
65
try:
 
66
    import cPickle as pickle
 
67
except ImportError:
 
68
    import pickle
66
69
import multiprocessing
67
70
import types
68
71
import binascii
69
72
import tempfile
70
73
import itertools
71
74
import collections
 
75
import codecs
72
76
 
73
77
import dbus
74
78
import dbus.service
75
 
import gobject
 
79
try:
 
80
    from gi.repository import GObject
 
81
except ImportError:
 
82
    import gobject as GObject
76
83
import avahi
77
84
from dbus.mainloop.glib import DBusGMainLoop
78
85
import ctypes
91
98
if sys.version_info.major == 2:
92
99
    str = unicode
93
100
 
94
 
version = "1.6.9"
 
101
version = "1.7.5"
95
102
stored_state_file = "clients.pickle"
96
103
 
97
104
logger = logging.getLogger()
144
151
    
145
152
    def __init__(self):
146
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
147
165
        self.gnupgargs = ['--batch',
148
 
                          '--home', self.tempdir,
 
166
                          '--homedir', self.tempdir,
149
167
                          '--force-mdc',
150
168
                          '--quiet',
151
169
                          '--no-use-agent']
190
208
                dir=self.tempdir) as passfile:
191
209
            passfile.write(passphrase)
192
210
            passfile.flush()
193
 
            proc = subprocess.Popen(['gpg', '--symmetric',
 
211
            proc = subprocess.Popen([self.gpg, '--symmetric',
194
212
                                     '--passphrase-file',
195
213
                                     passfile.name]
196
214
                                    + self.gnupgargs,
208
226
                dir = self.tempdir) as passfile:
209
227
            passfile.write(passphrase)
210
228
            passfile.flush()
211
 
            proc = subprocess.Popen(['gpg', '--decrypt',
 
229
            proc = subprocess.Popen([self.gpg, '--decrypt',
212
230
                                     '--passphrase-file',
213
231
                                     passfile.name]
214
232
                                    + self.gnupgargs,
382
400
                    logger.error(bad_states[state] + ": %r", error)
383
401
            self.cleanup()
384
402
        elif state == avahi.SERVER_RUNNING:
385
 
            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)
386
415
        else:
387
416
            if error is None:
388
417
                logger.debug("Unknown state: %r", state)
411
440
            .format(self.name)))
412
441
        return ret
413
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()
414
707
 
415
708
class Client(object):
416
709
    """A representation of a client host served by this server.
422
715
    checker:    subprocess.Popen(); a running checker process used
423
716
                                    to see if the client lives.
424
717
                                    'None' if no process is running.
425
 
    checker_callback_tag: a gobject event source tag, or None
 
718
    checker_callback_tag: a GObject event source tag, or None
426
719
    checker_command: string; External command which is run to check
427
720
                     if client lives.  %() expansions are done at
428
721
                     runtime with vars(self) as dict, so that for
429
722
                     instance %(name)s can be used in the command.
430
 
    checker_initiator_tag: a gobject event source tag, or None
 
723
    checker_initiator_tag: a GObject event source tag, or None
431
724
    created:    datetime.datetime(); (UTC) object creation
432
725
    client_structure: Object describing what attributes a client has
433
726
                      and is used for storing the client at exit
434
727
    current_checker_command: string; current running checker_command
435
 
    disable_initiator_tag: a gobject event source tag, or None
 
728
    disable_initiator_tag: a GObject event source tag, or None
436
729
    enabled:    bool()
437
730
    fingerprint: string (40 or 32 hexadecimal digits); used to
438
731
                 uniquely identify the client
443
736
    last_checker_status: integer between 0 and 255 reflecting exit
444
737
                         status of last checker. -1 reflects crashed
445
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
446
741
    last_enabled: datetime.datetime(); (UTC) or None
447
742
    name:       string; from the config file, used in log messages and
448
743
                        D-Bus identifiers
590
885
        if not quiet:
591
886
            logger.info("Disabling client %s", self.name)
592
887
        if getattr(self, "disable_initiator_tag", None) is not None:
593
 
            gobject.source_remove(self.disable_initiator_tag)
 
888
            GObject.source_remove(self.disable_initiator_tag)
594
889
            self.disable_initiator_tag = None
595
890
        self.expires = None
596
891
        if getattr(self, "checker_initiator_tag", None) is not None:
597
 
            gobject.source_remove(self.checker_initiator_tag)
 
892
            GObject.source_remove(self.checker_initiator_tag)
598
893
            self.checker_initiator_tag = None
599
894
        self.stop_checker()
600
895
        self.enabled = False
601
896
        if not quiet:
602
897
            self.send_changedstate()
603
 
        # 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
604
899
        return False
605
900
    
606
901
    def __del__(self):
610
905
        # Schedule a new checker to be started an 'interval' from now,
611
906
        # and every interval from then on.
612
907
        if self.checker_initiator_tag is not None:
613
 
            gobject.source_remove(self.checker_initiator_tag)
614
 
        self.checker_initiator_tag = gobject.timeout_add(
 
908
            GObject.source_remove(self.checker_initiator_tag)
 
909
        self.checker_initiator_tag = GObject.timeout_add(
615
910
            int(self.interval.total_seconds() * 1000),
616
911
            self.start_checker)
617
912
        # Schedule a disable() when 'timeout' has passed
618
913
        if self.disable_initiator_tag is not None:
619
 
            gobject.source_remove(self.disable_initiator_tag)
620
 
        self.disable_initiator_tag = gobject.timeout_add(
 
914
            GObject.source_remove(self.disable_initiator_tag)
 
915
        self.disable_initiator_tag = GObject.timeout_add(
621
916
            int(self.timeout.total_seconds() * 1000), self.disable)
622
917
        # Also start a new checker *right now*.
623
918
        self.start_checker()
624
919
    
625
 
    def checker_callback(self, pid, condition, command):
 
920
    def checker_callback(self, source, condition, connection,
 
921
                         command):
626
922
        """The checker has completed, so take appropriate actions."""
627
923
        self.checker_callback_tag = None
628
924
        self.checker = None
629
 
        if os.WIFEXITED(condition):
630
 
            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
631
932
            if self.last_checker_status == 0:
632
933
                logger.info("Checker for %(name)s succeeded",
633
934
                            vars(self))
636
937
                logger.info("Checker for %(name)s failed", vars(self))
637
938
        else:
638
939
            self.last_checker_status = -1
 
940
            self.last_checker_signal = -returncode
639
941
            logger.warning("Checker for %(name)s crashed?",
640
942
                           vars(self))
 
943
        return False
641
944
    
642
945
    def checked_ok(self):
643
946
        """Assert that the client has been seen, alive and well."""
644
947
        self.last_checked_ok = datetime.datetime.utcnow()
645
948
        self.last_checker_status = 0
 
949
        self.last_checker_signal = None
646
950
        self.bump_timeout()
647
951
    
648
952
    def bump_timeout(self, timeout=None):
650
954
        if timeout is None:
651
955
            timeout = self.timeout
652
956
        if self.disable_initiator_tag is not None:
653
 
            gobject.source_remove(self.disable_initiator_tag)
 
957
            GObject.source_remove(self.disable_initiator_tag)
654
958
            self.disable_initiator_tag = None
655
959
        if getattr(self, "enabled", False):
656
 
            self.disable_initiator_tag = gobject.timeout_add(
 
960
            self.disable_initiator_tag = GObject.timeout_add(
657
961
                int(timeout.total_seconds() * 1000), self.disable)
658
962
            self.expires = datetime.datetime.utcnow() + timeout
659
963
    
674
978
        # than 'timeout' for the client to be disabled, which is as it
675
979
        # should be.
676
980
        
677
 
        # If a checker exists, make sure it is not a zombie
678
 
        try:
679
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
680
 
        except AttributeError:
681
 
            pass
682
 
        except OSError as error:
683
 
            if error.errno != errno.ECHILD:
684
 
                raise
685
 
        else:
686
 
            if pid:
687
 
                logger.warning("Checker was a zombie")
688
 
                gobject.source_remove(self.checker_callback_tag)
689
 
                self.checker_callback(pid, status,
690
 
                                      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
691
985
        # Start a new checker if needed
692
986
        if self.checker is None:
693
987
            # Escape attributes for the shell
702
996
                             exc_info=error)
703
997
                return True     # Try again later
704
998
            self.current_checker_command = command
705
 
            try:
706
 
                logger.info("Starting checker %r for %s", command,
707
 
                            self.name)
708
 
                # We don't need to redirect stdout and stderr, since
709
 
                # in normal mode, that is already done by daemon(),
710
 
                # and in debug mode we don't want to.  (Stdin is
711
 
                # always replaced by /dev/null.)
712
 
                # The exception is when not debugging but nevertheless
713
 
                # running in the foreground; use the previously
714
 
                # created wnull.
715
 
                popen_args = {}
716
 
                if (not self.server_settings["debug"]
717
 
                    and self.server_settings["foreground"]):
718
 
                    popen_args.update({"stdout": wnull,
719
 
                                       "stderr": wnull })
720
 
                self.checker = subprocess.Popen(command,
721
 
                                                close_fds=True,
722
 
                                                shell=True,
723
 
                                                cwd="/",
724
 
                                                **popen_args)
725
 
            except OSError as error:
726
 
                logger.error("Failed to start subprocess",
727
 
                             exc_info=error)
728
 
                return True
729
 
            self.checker_callback_tag = gobject.child_watch_add(
730
 
                self.checker.pid, self.checker_callback, data=command)
731
 
            # The checker may have completed before the gobject
732
 
            # watch was added.  Check for this.
733
 
            try:
734
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
735
 
            except OSError as error:
736
 
                if error.errno == errno.ECHILD:
737
 
                    # This should never happen
738
 
                    logger.error("Child process vanished",
739
 
                                 exc_info=error)
740
 
                    return True
741
 
                raise
742
 
            if pid:
743
 
                gobject.source_remove(self.checker_callback_tag)
744
 
                self.checker_callback(pid, status, command)
745
 
        # 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
746
1025
        return True
747
1026
    
748
1027
    def stop_checker(self):
749
1028
        """Force the checker process, if any, to stop."""
750
1029
        if self.checker_callback_tag:
751
 
            gobject.source_remove(self.checker_callback_tag)
 
1030
            GObject.source_remove(self.checker_callback_tag)
752
1031
            self.checker_callback_tag = None
753
1032
        if getattr(self, "checker", None) is None:
754
1033
            return
755
1034
        logger.debug("Stopping checker for %(name)s", vars(self))
756
 
        try:
757
 
            self.checker.terminate()
758
 
            #time.sleep(0.5)
759
 
            #if self.checker.poll() is None:
760
 
            #    self.checker.kill()
761
 
        except OSError as error:
762
 
            if error.errno != errno.ESRCH: # No such process
763
 
                raise
 
1035
        self.checker.terminate()
764
1036
        self.checker = None
765
1037
 
766
1038
 
830
1102
                           access="r")
831
1103
    def Property_dbus_property(self):
832
1104
        return dbus.Boolean(False)
 
1105
    
 
1106
    See also the DBusObjectWithAnnotations class.
833
1107
    """
834
1108
    
835
1109
    def decorator(func):
857
1131
    pass
858
1132
 
859
1133
 
860
 
class DBusObjectWithProperties(dbus.service.Object):
861
 
    """A D-Bus object with properties.
 
1134
class DBusObjectWithAnnotations(dbus.service.Object):
 
1135
    """A D-Bus object with annotations.
862
1136
    
863
 
    Classes inheriting from this can use the dbus_service_property
864
 
    decorator to expose methods as D-Bus properties.  It exposes the
865
 
    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.
866
1139
    """
867
1140
    
868
1141
    @staticmethod
884
1157
                for name, athing in
885
1158
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
886
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
    
887
1231
    def _get_dbus_property(self, interface_name, property_name):
888
1232
        """Returns a bound method if one exists which is a D-Bus
889
1233
        property with the specified name and interface.
899
1243
        raise DBusPropertyNotFound("{}:{}.{}".format(
900
1244
            self.dbus_object_path, interface_name, property_name))
901
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
    
902
1255
    @dbus.service.method(dbus.PROPERTIES_IFACE,
903
1256
                         in_signature="ss",
904
1257
                         out_signature="v")
974
1327
        
975
1328
        Inserts property tags and interface annotation tags.
976
1329
        """
977
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
978
 
                                                   connection)
 
1330
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1331
                                                         object_path,
 
1332
                                                         connection)
979
1333
        try:
980
1334
            document = xml.dom.minidom.parseString(xmlstring)
981
1335
            
994
1348
                            if prop._dbus_interface
995
1349
                            == if_tag.getAttribute("name")):
996
1350
                    if_tag.appendChild(tag)
997
 
                # Add annotation tags
998
 
                for typ in ("method", "signal", "property"):
999
 
                    for tag in if_tag.getElementsByTagName(typ):
1000
 
                        annots = dict()
1001
 
                        for name, prop in (self.
1002
 
                                           _get_all_dbus_things(typ)):
1003
 
                            if (name == tag.getAttribute("name")
1004
 
                                and prop._dbus_interface
1005
 
                                == if_tag.getAttribute("name")):
1006
 
                                annots.update(getattr(
1007
 
                                    prop, "_dbus_annotations", {}))
1008
 
                        for name, value in annots.items():
1009
 
                            ann_tag = document.createElement(
1010
 
                                "annotation")
1011
 
                            ann_tag.setAttribute("name", name)
1012
 
                            ann_tag.setAttribute("value", value)
1013
 
                            tag.appendChild(ann_tag)
1014
 
                # Add interface annotation tags
1015
 
                for annotation, value in dict(
1016
 
                    itertools.chain.from_iterable(
1017
 
                        annotations().items()
1018
 
                        for name, annotations
1019
 
                        in self._get_all_dbus_things("interface")
1020
 
                        if name == if_tag.getAttribute("name")
1021
 
                        )).items():
1022
 
                    ann_tag = document.createElement("annotation")
1023
 
                    ann_tag.setAttribute("name", annotation)
1024
 
                    ann_tag.setAttribute("value", value)
1025
 
                    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)
1026
1367
                # Add the names to the return values for the
1027
1368
                # "org.freedesktop.DBus.Properties" methods
1028
1369
                if (if_tag.getAttribute("name")
1046
1387
                         exc_info=error)
1047
1388
        return xmlstring
1048
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
1049
1458
 
1050
1459
def datetime_to_dbus(dt, variant_level=0):
1051
1460
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1098
1507
                interface_names.add(alt_interface)
1099
1508
                # Is this a D-Bus signal?
1100
1509
                if getattr(attribute, "_dbus_is_signal", False):
1101
 
                    # Extract the original non-method undecorated
1102
 
                    # function by black magic
1103
 
                    nonmethod_func = (dict(
1104
 
                        zip(attribute.func_code.co_freevars,
1105
 
                            attribute.__closure__))
1106
 
                                      ["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
1107
1519
                    # Create a new, but exactly alike, function
1108
1520
                    # object, and decorate it to be a new D-Bus signal
1109
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__)
1110
1536
                    new_function = (dbus.service.signal(
1111
 
                        alt_interface, attribute._dbus_signature)
1112
 
                                    (types.FunctionType(
1113
 
                                        nonmethod_func.func_code,
1114
 
                                        nonmethod_func.func_globals,
1115
 
                                        nonmethod_func.func_name,
1116
 
                                        nonmethod_func.func_defaults,
1117
 
                                        nonmethod_func.func_closure)))
 
1537
                        alt_interface,
 
1538
                        attribute._dbus_signature)(new_function))
1118
1539
                    # Copy annotations, if any
1119
1540
                    try:
1120
1541
                        new_function._dbus_annotations = dict(
1130
1551
                        func1 and func2 to the "call_both" function
1131
1552
                        outside of its arguments"""
1132
1553
                        
 
1554
                        @functools.wraps(func2)
1133
1555
                        def call_both(*args, **kwargs):
1134
1556
                            """This function will emit two D-Bus
1135
1557
                            signals by calling func1 and func2"""
1136
1558
                            func1(*args, **kwargs)
1137
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)
1138
1564
                        
1139
1565
                        return call_both
1140
1566
                    # Create the "call_both" function and add it to
1343
1769
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1344
1770
        Client.__del__(self, *args, **kwargs)
1345
1771
    
1346
 
    def checker_callback(self, pid, condition, command,
1347
 
                         *args, **kwargs):
1348
 
        self.checker_callback_tag = None
1349
 
        self.checker = None
1350
 
        if os.WIFEXITED(condition):
1351
 
            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:
1352
1779
            # Emit D-Bus signal
1353
1780
            self.CheckerCompleted(dbus.Int16(exitstatus),
1354
 
                                  dbus.Int64(condition),
 
1781
                                  # This is specific to GNU libC
 
1782
                                  dbus.Int64(exitstatus << 8),
1355
1783
                                  dbus.String(command))
1356
1784
        else:
1357
1785
            # Emit D-Bus signal
1358
1786
            self.CheckerCompleted(dbus.Int16(-1),
1359
 
                                  dbus.Int64(condition),
 
1787
                                  dbus.Int64(
 
1788
                                      # This is specific to GNU libC
 
1789
                                      (exitstatus << 8)
 
1790
                                      | self.last_checker_signal),
1360
1791
                                  dbus.String(command))
1361
 
        
1362
 
        return Client.checker_callback(self, pid, condition, command,
1363
 
                                       *args, **kwargs)
 
1792
        return ret
1364
1793
    
1365
1794
    def start_checker(self, *args, **kwargs):
1366
1795
        old_checker_pid = getattr(self.checker, "pid", None)
1378
1807
    
1379
1808
    def approve(self, value=True):
1380
1809
        self.approved = value
1381
 
        gobject.timeout_add(int(self.approval_duration.total_seconds()
 
1810
        GObject.timeout_add(int(self.approval_duration.total_seconds()
1382
1811
                                * 1000), self._reset_approved)
1383
1812
        self.send_changedstate()
1384
1813
    
1441
1870
        self.checked_ok()
1442
1871
    
1443
1872
    # Enable - method
 
1873
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1444
1874
    @dbus.service.method(_interface)
1445
1875
    def Enable(self):
1446
1876
        "D-Bus method"
1447
1877
        self.enable()
1448
1878
    
1449
1879
    # StartChecker - method
 
1880
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1450
1881
    @dbus.service.method(_interface)
1451
1882
    def StartChecker(self):
1452
1883
        "D-Bus method"
1453
1884
        self.start_checker()
1454
1885
    
1455
1886
    # Disable - method
 
1887
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1456
1888
    @dbus.service.method(_interface)
1457
1889
    def Disable(self):
1458
1890
        "D-Bus method"
1459
1891
        self.disable()
1460
1892
    
1461
1893
    # StopChecker - method
 
1894
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1462
1895
    @dbus.service.method(_interface)
1463
1896
    def StopChecker(self):
1464
1897
        self.stop_checker()
1500
1933
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1501
1934
    
1502
1935
    # Name - property
 
1936
    @dbus_annotations(
 
1937
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1503
1938
    @dbus_service_property(_interface, signature="s", access="read")
1504
1939
    def Name_dbus_property(self):
1505
1940
        return dbus.String(self.name)
1506
1941
    
1507
1942
    # Fingerprint - property
 
1943
    @dbus_annotations(
 
1944
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1508
1945
    @dbus_service_property(_interface, signature="s", access="read")
1509
1946
    def Fingerprint_dbus_property(self):
1510
1947
        return dbus.String(self.fingerprint)
1519
1956
        self.host = str(value)
1520
1957
    
1521
1958
    # Created - property
 
1959
    @dbus_annotations(
 
1960
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1522
1961
    @dbus_service_property(_interface, signature="s", access="read")
1523
1962
    def Created_dbus_property(self):
1524
1963
        return datetime_to_dbus(self.created)
1585
2024
                if (getattr(self, "disable_initiator_tag", None)
1586
2025
                    is None):
1587
2026
                    return
1588
 
                gobject.source_remove(self.disable_initiator_tag)
1589
 
                self.disable_initiator_tag = gobject.timeout_add(
 
2027
                GObject.source_remove(self.disable_initiator_tag)
 
2028
                self.disable_initiator_tag = GObject.timeout_add(
1590
2029
                    int((self.expires - now).total_seconds() * 1000),
1591
2030
                    self.disable)
1592
2031
    
1612
2051
            return
1613
2052
        if self.enabled:
1614
2053
            # Reschedule checker run
1615
 
            gobject.source_remove(self.checker_initiator_tag)
1616
 
            self.checker_initiator_tag = gobject.timeout_add(
 
2054
            GObject.source_remove(self.checker_initiator_tag)
 
2055
            self.checker_initiator_tag = GObject.timeout_add(
1617
2056
                value, self.start_checker)
1618
2057
            self.start_checker() # Start one now, too
1619
2058
    
1639
2078
            self.stop_checker()
1640
2079
    
1641
2080
    # ObjectPath - property
 
2081
    @dbus_annotations(
 
2082
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
2083
         "org.freedesktop.DBus.Deprecated": "true"})
1642
2084
    @dbus_service_property(_interface, signature="o", access="read")
1643
2085
    def ObjectPath_dbus_property(self):
1644
2086
        return self.dbus_object_path # is already a dbus.ObjectPath
1645
2087
    
1646
2088
    # Secret = property
 
2089
    @dbus_annotations(
 
2090
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2091
         "invalidates"})
1647
2092
    @dbus_service_property(_interface,
1648
2093
                           signature="ay",
1649
2094
                           access="write",
1659
2104
        self._pipe = child_pipe
1660
2105
        self._pipe.send(('init', fpr, address))
1661
2106
        if not self._pipe.recv():
1662
 
            raise KeyError()
 
2107
            raise KeyError(fpr)
1663
2108
    
1664
2109
    def __getattribute__(self, name):
1665
2110
        if name == '_pipe':
1695
2140
            logger.debug("Pipe FD: %d",
1696
2141
                         self.server.child_pipe.fileno())
1697
2142
            
1698
 
            session = gnutls.connection.ClientSession(
1699
 
                self.request, gnutls.connection .X509Credentials())
1700
 
            
1701
 
            # Note: gnutls.connection.X509Credentials is really a
1702
 
            # generic GnuTLS certificate credentials object so long as
1703
 
            # no X.509 keys are added to it.  Therefore, we can use it
1704
 
            # here despite using OpenPGP certificates.
 
2143
            session = gnutls.ClientSession(self.request)
1705
2144
            
1706
2145
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1707
2146
            #                      "+AES-256-CBC", "+SHA1",
1711
2150
            priority = self.server.gnutls_priority
1712
2151
            if priority is None:
1713
2152
                priority = "NORMAL"
1714
 
            gnutls.library.functions.gnutls_priority_set_direct(
1715
 
                session._c_object, priority, None)
 
2153
            gnutls.priority_set_direct(session._c_object, priority,
 
2154
                                       None)
1716
2155
            
1717
2156
            # Start communication using the Mandos protocol
1718
2157
            # Get protocol number
1728
2167
            # Start GnuTLS connection
1729
2168
            try:
1730
2169
                session.handshake()
1731
 
            except gnutls.errors.GNUTLSError as error:
 
2170
            except gnutls.Error as error:
1732
2171
                logger.warning("Handshake failed: %s", error)
1733
2172
                # Do not run session.bye() here: the session is not
1734
2173
                # established.  Just abandon the request.
1740
2179
                try:
1741
2180
                    fpr = self.fingerprint(
1742
2181
                        self.peer_certificate(session))
1743
 
                except (TypeError,
1744
 
                        gnutls.errors.GNUTLSError) as error:
 
2182
                except (TypeError, gnutls.Error) as error:
1745
2183
                    logger.warning("Bad certificate: %s", error)
1746
2184
                    return
1747
2185
                logger.debug("Fingerprint: %s", fpr)
1805
2243
                    else:
1806
2244
                        delay -= time2 - time
1807
2245
                
1808
 
                sent_size = 0
1809
 
                while sent_size < len(client.secret):
1810
 
                    try:
1811
 
                        sent = session.send(client.secret[sent_size:])
1812
 
                    except gnutls.errors.GNUTLSError as error:
1813
 
                        logger.warning("gnutls send failed",
1814
 
                                       exc_info=error)
1815
 
                        return
1816
 
                    logger.debug("Sent: %d, remaining: %d", sent,
1817
 
                                 len(client.secret) - (sent_size
1818
 
                                                       + sent))
1819
 
                    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
1820
2252
                
1821
2253
                logger.info("Sending secret to %s", client.name)
1822
2254
                # bump the timeout using extended_timeout
1830
2262
                    client.approvals_pending -= 1
1831
2263
                try:
1832
2264
                    session.bye()
1833
 
                except gnutls.errors.GNUTLSError as error:
 
2265
                except gnutls.Error as error:
1834
2266
                    logger.warning("GnuTLS bye failed",
1835
2267
                                   exc_info=error)
1836
2268
    
1838
2270
    def peer_certificate(session):
1839
2271
        "Return the peer's OpenPGP certificate as a bytestring"
1840
2272
        # If not an OpenPGP certificate...
1841
 
        if (gnutls.library.functions.gnutls_certificate_type_get(
1842
 
                session._c_object)
1843
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1844
 
            # ...do the normal thing
1845
 
            return session.peer_certificate
 
2273
        if (gnutls.certificate_type_get(session._c_object)
 
2274
            != gnutls.CRT_OPENPGP):
 
2275
            # ...return invalid data
 
2276
            return b""
1846
2277
        list_size = ctypes.c_uint(1)
1847
 
        cert_list = (gnutls.library.functions
1848
 
                     .gnutls_certificate_get_peers
 
2278
        cert_list = (gnutls.certificate_get_peers
1849
2279
                     (session._c_object, ctypes.byref(list_size)))
1850
2280
        if not bool(cert_list) and list_size.value != 0:
1851
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1852
 
                                            " certificate")
 
2281
            raise gnutls.Error("error getting peer certificate")
1853
2282
        if list_size.value == 0:
1854
2283
            return None
1855
2284
        cert = cert_list[0]
1859
2288
    def fingerprint(openpgp):
1860
2289
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1861
2290
        # New GnuTLS "datum" with the OpenPGP public key
1862
 
        datum = gnutls.library.types.gnutls_datum_t(
 
2291
        datum = gnutls.datum_t(
1863
2292
            ctypes.cast(ctypes.c_char_p(openpgp),
1864
2293
                        ctypes.POINTER(ctypes.c_ubyte)),
1865
2294
            ctypes.c_uint(len(openpgp)))
1866
2295
        # New empty GnuTLS certificate
1867
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1868
 
        gnutls.library.functions.gnutls_openpgp_crt_init(
1869
 
            ctypes.byref(crt))
 
2296
        crt = gnutls.openpgp_crt_t()
 
2297
        gnutls.openpgp_crt_init(ctypes.byref(crt))
1870
2298
        # Import the OpenPGP public key into the certificate
1871
 
        gnutls.library.functions.gnutls_openpgp_crt_import(
1872
 
            crt, ctypes.byref(datum),
1873
 
            gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
 
2299
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2300
                                  gnutls.OPENPGP_FMT_RAW)
1874
2301
        # Verify the self signature in the key
1875
2302
        crtverify = ctypes.c_uint()
1876
 
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1877
 
            crt, 0, ctypes.byref(crtverify))
 
2303
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2304
                                       ctypes.byref(crtverify))
1878
2305
        if crtverify.value != 0:
1879
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1880
 
            raise gnutls.errors.CertificateSecurityError(
1881
 
                "Verify failed")
 
2306
            gnutls.openpgp_crt_deinit(crt)
 
2307
            raise gnutls.CertificateSecurityError("Verify failed")
1882
2308
        # New buffer for the fingerprint
1883
2309
        buf = ctypes.create_string_buffer(20)
1884
2310
        buf_len = ctypes.c_size_t()
1885
2311
        # Get the fingerprint from the certificate into the buffer
1886
 
        gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1887
 
            crt, ctypes.byref(buf), ctypes.byref(buf_len))
 
2312
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2313
                                           ctypes.byref(buf_len))
1888
2314
        # Deinit the certificate
1889
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2315
        gnutls.openpgp_crt_deinit(crt)
1890
2316
        # Convert the buffer to a Python bytestring
1891
2317
        fpr = ctypes.string_at(buf, buf_len.value)
1892
2318
        # Convert the bytestring to hexadecimal notation
2036
2462
        gnutls_priority GnuTLS priority string
2037
2463
        use_dbus:       Boolean; to emit D-Bus signals or not
2038
2464
    
2039
 
    Assumes a gobject.MainLoop event loop.
 
2465
    Assumes a GObject.MainLoop event loop.
2040
2466
    """
2041
2467
    
2042
2468
    def __init__(self, server_address, RequestHandlerClass,
2067
2493
    
2068
2494
    def add_pipe(self, parent_pipe, proc):
2069
2495
        # Call "handle_ipc" for both data and EOF events
2070
 
        gobject.io_add_watch(
 
2496
        GObject.io_add_watch(
2071
2497
            parent_pipe.fileno(),
2072
 
            gobject.IO_IN | gobject.IO_HUP,
 
2498
            GObject.IO_IN | GObject.IO_HUP,
2073
2499
            functools.partial(self.handle_ipc,
2074
2500
                              parent_pipe = parent_pipe,
2075
2501
                              proc = proc))
2079
2505
                   proc = None,
2080
2506
                   client_object=None):
2081
2507
        # error, or the other end of multiprocessing.Pipe has closed
2082
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2508
        if condition & (GObject.IO_ERR | GObject.IO_HUP):
2083
2509
            # Wait for other process to exit
2084
2510
            proc.join()
2085
2511
            return False
2106
2532
                parent_pipe.send(False)
2107
2533
                return False
2108
2534
            
2109
 
            gobject.io_add_watch(
 
2535
            GObject.io_add_watch(
2110
2536
                parent_pipe.fileno(),
2111
 
                gobject.IO_IN | gobject.IO_HUP,
 
2537
                GObject.IO_IN | GObject.IO_HUP,
2112
2538
                functools.partial(self.handle_ipc,
2113
2539
                                  parent_pipe = parent_pipe,
2114
2540
                                  proc = proc,
2128
2554
        
2129
2555
        if command == 'getattr':
2130
2556
            attrname = request[1]
2131
 
            if callable(client_object.__getattribute__(attrname)):
 
2557
            if isinstance(client_object.__getattribute__(attrname),
 
2558
                          collections.Callable):
2132
2559
                parent_pipe.send(('function', ))
2133
2560
            else:
2134
2561
                parent_pipe.send((
2169
2596
    # avoid excessive use of external libraries.
2170
2597
    
2171
2598
    # New type for defining tokens, syntax, and semantics all-in-one
2172
 
    Token = collections.namedtuple("Token",
2173
 
                                   ("regexp", # To match token; if
2174
 
                                              # "value" is not None,
2175
 
                                              # must have a "group"
2176
 
                                              # containing digits
2177
 
                                    "value",  # datetime.timedelta or
2178
 
                                              # None
2179
 
                                    "followers")) # Tokens valid after
2180
 
                                                  # this token
2181
2599
    Token = collections.namedtuple("Token", (
2182
2600
        "regexp",  # To match token; if "value" is not None, must have
2183
2601
                   # a "group" containing digits
2218
2636
    # Define starting values
2219
2637
    value = datetime.timedelta() # Value so far
2220
2638
    found_token = None
2221
 
    followers = frozenset((token_duration,)) # Following valid tokens
 
2639
    followers = frozenset((token_duration, )) # Following valid tokens
2222
2640
    s = duration                # String left to parse
2223
2641
    # Loop until end token is found
2224
2642
    while found_token is not token_end:
2241
2659
                break
2242
2660
        else:
2243
2661
            # No currently valid tokens were found
2244
 
            raise ValueError("Invalid RFC 3339 duration")
 
2662
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2663
                             .format(duration))
2245
2664
    # End token found
2246
2665
    return value
2247
2666
 
2380
2799
                        "debug": "False",
2381
2800
                        "priority":
2382
2801
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2383
 
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
2802
                        ":+SIGN-DSA-SHA256",
2384
2803
                        "servicename": "Mandos",
2385
2804
                        "use_dbus": "True",
2386
2805
                        "use_ipv6": "True",
2498
2917
            pidfilename = "/var/run/mandos.pid"
2499
2918
        pidfile = None
2500
2919
        try:
2501
 
            pidfile = open(pidfilename, "w")
 
2920
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2502
2921
        except IOError as e:
2503
2922
            logger.error("Could not open file %r", pidfilename,
2504
2923
                         exc_info=e)
2505
2924
    
2506
 
    for name in ("_mandos", "mandos", "nobody"):
 
2925
    for name, group in (("_mandos", "_mandos"),
 
2926
                        ("mandos", "mandos"),
 
2927
                        ("nobody", "nogroup")):
2507
2928
        try:
2508
2929
            uid = pwd.getpwnam(name).pw_uid
2509
 
            gid = pwd.getpwnam(name).pw_gid
 
2930
            gid = pwd.getpwnam(group).pw_gid
2510
2931
            break
2511
2932
        except KeyError:
2512
2933
            continue
2516
2937
    try:
2517
2938
        os.setgid(gid)
2518
2939
        os.setuid(uid)
 
2940
        if debug:
 
2941
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
2942
                                                             gid))
2519
2943
    except OSError as error:
 
2944
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
2945
                       .format(uid, gid, os.strerror(error.errno)))
2520
2946
        if error.errno != errno.EPERM:
2521
2947
            raise
2522
2948
    
2525
2951
        
2526
2952
        # "Use a log level over 10 to enable all debugging options."
2527
2953
        # - GnuTLS manual
2528
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
2954
        gnutls.global_set_log_level(11)
2529
2955
        
2530
 
        @gnutls.library.types.gnutls_log_func
 
2956
        @gnutls.log_func
2531
2957
        def debug_gnutls(level, string):
2532
2958
            logger.debug("GnuTLS: %s", string[:-1])
2533
2959
        
2534
 
        gnutls.library.functions.gnutls_global_set_log_function(
2535
 
            debug_gnutls)
 
2960
        gnutls.global_set_log_function(debug_gnutls)
2536
2961
        
2537
2962
        # Redirect stdin so all checkers get /dev/null
2538
2963
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2545
2970
        # Close all input and output, do double fork, etc.
2546
2971
        daemon()
2547
2972
    
2548
 
    # multiprocessing will use threads, so before we use gobject we
2549
 
    # need to inform gobject that threads will be used.
2550
 
    gobject.threads_init()
 
2973
    # multiprocessing will use threads, so before we use GObject we
 
2974
    # need to inform GObject that threads will be used.
 
2975
    GObject.threads_init()
2551
2976
    
2552
2977
    global main_loop
2553
2978
    # From the Avahi example code
2554
2979
    DBusGMainLoop(set_as_default=True)
2555
 
    main_loop = gobject.MainLoop()
 
2980
    main_loop = GObject.MainLoop()
2556
2981
    bus = dbus.SystemBus()
2557
2982
    # End of Avahi example code
2558
2983
    if use_dbus:
2563
2988
            old_bus_name = dbus.service.BusName(
2564
2989
                "se.bsnet.fukt.Mandos", bus,
2565
2990
                do_not_queue=True)
2566
 
        except dbus.exceptions.NameExistsException as e:
 
2991
        except dbus.exceptions.DBusException as e:
2567
2992
            logger.error("Disabling D-Bus:", exc_info=e)
2568
2993
            use_dbus = False
2569
2994
            server_settings["use_dbus"] = False
2642
3067
                    pass
2643
3068
            
2644
3069
            # Clients who has passed its expire date can still be
2645
 
            # enabled if its last checker was successful.  Clients
 
3070
            # enabled if its last checker was successful.  A Client
2646
3071
            # whose checker succeeded before we stored its state is
2647
3072
            # assumed to have successfully run all checkers during
2648
3073
            # downtime.
2700
3125
    
2701
3126
    if not foreground:
2702
3127
        if pidfile is not None:
 
3128
            pid = os.getpid()
2703
3129
            try:
2704
3130
                with pidfile:
2705
 
                    pid = os.getpid()
2706
 
                    pidfile.write("{}\n".format(pid).encode("utf-8"))
 
3131
                    print(pid, file=pidfile)
2707
3132
            except IOError:
2708
3133
                logger.error("Could not write to file %r with PID %d",
2709
3134
                             pidfilename, pid)
2717
3142
        
2718
3143
        @alternate_dbus_interfaces(
2719
3144
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2720
 
        class MandosDBusService(DBusObjectWithProperties):
 
3145
        class MandosDBusService(DBusObjectWithObjectManager):
2721
3146
            """A D-Bus proxy object"""
2722
3147
            
2723
3148
            def __init__(self):
2725
3150
            
2726
3151
            _interface = "se.recompile.Mandos"
2727
3152
            
2728
 
            @dbus_interface_annotations(_interface)
2729
 
            def _foo(self):
2730
 
                return {
2731
 
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
2732
 
                    "false" }
2733
 
            
2734
3153
            @dbus.service.signal(_interface, signature="o")
2735
3154
            def ClientAdded(self, objpath):
2736
3155
                "D-Bus signal"
2741
3160
                "D-Bus signal"
2742
3161
                pass
2743
3162
            
 
3163
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3164
                               "true"})
2744
3165
            @dbus.service.signal(_interface, signature="os")
2745
3166
            def ClientRemoved(self, objpath, name):
2746
3167
                "D-Bus signal"
2747
3168
                pass
2748
3169
            
 
3170
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3171
                               "true"})
2749
3172
            @dbus.service.method(_interface, out_signature="ao")
2750
3173
            def GetAllClients(self):
2751
3174
                "D-Bus method"
2752
3175
                return dbus.Array(c.dbus_object_path for c in
2753
3176
                                  tcp_server.clients.itervalues())
2754
3177
            
 
3178
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3179
                               "true"})
2755
3180
            @dbus.service.method(_interface,
2756
3181
                                 out_signature="a{oa{sv}}")
2757
3182
            def GetAllClientsWithProperties(self):
2758
3183
                "D-Bus method"
2759
3184
                return dbus.Dictionary(
2760
 
                    { c.dbus_object_path: c.GetAll("")
 
3185
                    { c.dbus_object_path: c.GetAll(
 
3186
                        "se.recompile.Mandos.Client")
2761
3187
                      for c in tcp_server.clients.itervalues() },
2762
3188
                    signature="oa{sv}")
2763
3189
            
2768
3194
                    if c.dbus_object_path == object_path:
2769
3195
                        del tcp_server.clients[c.name]
2770
3196
                        c.remove_from_connection()
2771
 
                        # Don't signal anything except ClientRemoved
 
3197
                        # Don't signal the disabling
2772
3198
                        c.disable(quiet=True)
2773
 
                        # Emit D-Bus signal
2774
 
                        self.ClientRemoved(object_path, c.name)
 
3199
                        # Emit D-Bus signal for removal
 
3200
                        self.client_removed_signal(c)
2775
3201
                        return
2776
3202
                raise KeyError(object_path)
2777
3203
            
2778
3204
            del _interface
 
3205
            
 
3206
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
3207
                                 out_signature = "a{oa{sa{sv}}}")
 
3208
            def GetManagedObjects(self):
 
3209
                """D-Bus method"""
 
3210
                return dbus.Dictionary(
 
3211
                    { client.dbus_object_path:
 
3212
                      dbus.Dictionary(
 
3213
                          { interface: client.GetAll(interface)
 
3214
                            for interface in
 
3215
                                 client._get_all_interface_names()})
 
3216
                      for client in tcp_server.clients.values()})
 
3217
            
 
3218
            def client_added_signal(self, client):
 
3219
                """Send the new standard signal and the old signal"""
 
3220
                if use_dbus:
 
3221
                    # New standard signal
 
3222
                    self.InterfacesAdded(
 
3223
                        client.dbus_object_path,
 
3224
                        dbus.Dictionary(
 
3225
                            { interface: client.GetAll(interface)
 
3226
                              for interface in
 
3227
                              client._get_all_interface_names()}))
 
3228
                    # Old signal
 
3229
                    self.ClientAdded(client.dbus_object_path)
 
3230
            
 
3231
            def client_removed_signal(self, client):
 
3232
                """Send the new standard signal and the old signal"""
 
3233
                if use_dbus:
 
3234
                    # New standard signal
 
3235
                    self.InterfacesRemoved(
 
3236
                        client.dbus_object_path,
 
3237
                        client._get_all_interface_names())
 
3238
                    # Old signal
 
3239
                    self.ClientRemoved(client.dbus_object_path,
 
3240
                                       client.name)
2779
3241
        
2780
3242
        mandos_dbus_service = MandosDBusService()
2781
3243
    
2846
3308
            name, client = tcp_server.clients.popitem()
2847
3309
            if use_dbus:
2848
3310
                client.remove_from_connection()
2849
 
            # Don't signal anything except ClientRemoved
 
3311
            # Don't signal the disabling
2850
3312
            client.disable(quiet=True)
 
3313
            # Emit D-Bus signal for removal
2851
3314
            if use_dbus:
2852
 
                # Emit D-Bus signal
2853
 
                mandos_dbus_service.ClientRemoved(
2854
 
                    client.dbus_object_path, client.name)
 
3315
                mandos_dbus_service.client_removed_signal(client)
2855
3316
        client_settings.clear()
2856
3317
    
2857
3318
    atexit.register(cleanup)
2858
3319
    
2859
3320
    for client in tcp_server.clients.itervalues():
2860
3321
        if use_dbus:
2861
 
            # Emit D-Bus signal
2862
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3322
            # Emit D-Bus signal for adding
 
3323
            mandos_dbus_service.client_added_signal(client)
2863
3324
        # Need to initiate checking of clients
2864
3325
        if client.enabled:
2865
3326
            client.init_checker()
2891
3352
                sys.exit(1)
2892
3353
            # End of Avahi example code
2893
3354
        
2894
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
3355
        GObject.io_add_watch(tcp_server.fileno(), GObject.IO_IN,
2895
3356
                             lambda *args, **kwargs:
2896
3357
                             (tcp_server.handle_request
2897
3358
                              (*args[2:], **kwargs) or True))