/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-23 07:11:22 UTC
  • Revision ID: teddy@recompile.se-20160323071122-55srtjdizr21rr7f
Use HTTPS in home page links

Since we have a real certificate now, change all links to the home
page to use HTTPS.

* README: Use HTTPS in home page links
* debian/control (Source: mandos/Homepage): - '' -
* debian/copyright (Source): - '' -
* intro.xml (SEE ALSO): - '' -
* mandos.lsm (Primary-site): - '' -

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
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
37
 
from future_builtins import *
 
37
try:
 
38
    from future_builtins import *
 
39
except ImportError:
 
40
    pass
38
41
 
39
42
try:
40
43
    import SocketServer as socketserver
44
47
import argparse
45
48
import datetime
46
49
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
50
try:
54
51
    import ConfigParser as configparser
55
52
except ImportError:
82
79
 
83
80
import dbus
84
81
import dbus.service
85
 
try:
86
 
    import gobject
87
 
except ImportError:
88
 
    from gi.repository import GObject as gobject
89
 
import avahi
 
82
from gi.repository import GLib
90
83
from dbus.mainloop.glib import DBusGMainLoop
91
84
import ctypes
92
85
import ctypes.util
104
97
if sys.version_info.major == 2:
105
98
    str = unicode
106
99
 
107
 
version = "1.6.9"
 
100
version = "1.7.7"
108
101
stored_state_file = "clients.pickle"
109
102
 
110
103
logger = logging.getLogger()
125
118
        return interface_index
126
119
 
127
120
 
 
121
def copy_function(func):
 
122
    """Make a copy of a function"""
 
123
    if sys.version_info.major == 2:
 
124
        return types.FunctionType(func.func_code,
 
125
                                  func.func_globals,
 
126
                                  func.func_name,
 
127
                                  func.func_defaults,
 
128
                                  func.func_closure)
 
129
    else:
 
130
        return types.FunctionType(func.__code__,
 
131
                                  func.__globals__,
 
132
                                  func.__name__,
 
133
                                  func.__defaults__,
 
134
                                  func.__closure__)
 
135
 
 
136
 
128
137
def initlogger(debug, level=logging.WARNING):
129
138
    """init logger and add loglevel"""
130
139
    
157
166
    
158
167
    def __init__(self):
159
168
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
169
        self.gpg = "gpg"
 
170
        try:
 
171
            output = subprocess.check_output(["gpgconf"])
 
172
            for line in output.splitlines():
 
173
                name, text, path = line.split(b":")
 
174
                if name == "gpg":
 
175
                    self.gpg = path
 
176
                    break
 
177
        except OSError as e:
 
178
            if e.errno != errno.ENOENT:
 
179
                raise
160
180
        self.gnupgargs = ['--batch',
161
 
                          '--home', self.tempdir,
 
181
                          '--homedir', self.tempdir,
162
182
                          '--force-mdc',
163
183
                          '--quiet',
164
184
                          '--no-use-agent']
203
223
                dir=self.tempdir) as passfile:
204
224
            passfile.write(passphrase)
205
225
            passfile.flush()
206
 
            proc = subprocess.Popen(['gpg', '--symmetric',
 
226
            proc = subprocess.Popen([self.gpg, '--symmetric',
207
227
                                     '--passphrase-file',
208
228
                                     passfile.name]
209
229
                                    + self.gnupgargs,
221
241
                dir = self.tempdir) as passfile:
222
242
            passfile.write(passphrase)
223
243
            passfile.flush()
224
 
            proc = subprocess.Popen(['gpg', '--decrypt',
 
244
            proc = subprocess.Popen([self.gpg, '--decrypt',
225
245
                                     '--passphrase-file',
226
246
                                     passfile.name]
227
247
                                    + self.gnupgargs,
233
253
            raise PGPError(err)
234
254
        return decrypted_plaintext
235
255
 
 
256
# Pretend that we have an Avahi module
 
257
class Avahi(object):
 
258
    """This isn't so much a class as it is a module-like namespace.
 
259
    It is instantiated once, and simulates having an Avahi module."""
 
260
    IF_UNSPEC = -1              # avahi-common/address.h
 
261
    PROTO_UNSPEC = -1           # avahi-common/address.h
 
262
    PROTO_INET = 0              # avahi-common/address.h
 
263
    PROTO_INET6 = 1             # avahi-common/address.h
 
264
    DBUS_NAME = "org.freedesktop.Avahi"
 
265
    DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
 
266
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
 
267
    DBUS_PATH_SERVER = "/"
 
268
    def string_array_to_txt_array(self, t):
 
269
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
 
270
                           for s in t), signature="ay")
 
271
    ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
 
272
    ENTRY_GROUP_COLLISION = 3   # avahi-common/defs.h
 
273
    ENTRY_GROUP_FAILURE = 4     # avahi-common/defs.h
 
274
    SERVER_INVALID = 0          # avahi-common/defs.h
 
275
    SERVER_REGISTERING = 1      # avahi-common/defs.h
 
276
    SERVER_RUNNING = 2          # avahi-common/defs.h
 
277
    SERVER_COLLISION = 3        # avahi-common/defs.h
 
278
    SERVER_FAILURE = 4          # avahi-common/defs.h
 
279
avahi = Avahi()
236
280
 
237
281
class AvahiError(Exception):
238
282
    def __init__(self, value, *args, **kwargs):
395
439
                    logger.error(bad_states[state] + ": %r", error)
396
440
            self.cleanup()
397
441
        elif state == avahi.SERVER_RUNNING:
398
 
            self.add()
 
442
            try:
 
443
                self.add()
 
444
            except dbus.exceptions.DBusException as error:
 
445
                if (error.get_dbus_name()
 
446
                    == "org.freedesktop.Avahi.CollisionError"):
 
447
                    logger.info("Local Zeroconf service name"
 
448
                                " collision.")
 
449
                    return self.rename(remove=False)
 
450
                else:
 
451
                    logger.critical("D-Bus Exception", exc_info=error)
 
452
                    self.cleanup()
 
453
                    os._exit(1)
399
454
        else:
400
455
            if error is None:
401
456
                logger.debug("Unknown state: %r", state)
424
479
            .format(self.name)))
425
480
        return ret
426
481
 
 
482
# Pretend that we have a GnuTLS module
 
483
class GnuTLS(object):
 
484
    """This isn't so much a class as it is a module-like namespace.
 
485
    It is instantiated once, and simulates having a GnuTLS module."""
 
486
    
 
487
    _library = ctypes.cdll.LoadLibrary(
 
488
        ctypes.util.find_library("gnutls"))
 
489
    _need_version = b"3.3.0"
 
490
    def __init__(self):
 
491
        # Need to use class name "GnuTLS" here, since this method is
 
492
        # called before the assignment to the "gnutls" global variable
 
493
        # happens.
 
494
        if GnuTLS.check_version(self._need_version) is None:
 
495
            raise GnuTLS.Error("Needs GnuTLS {} or later"
 
496
                               .format(self._need_version))
 
497
    
 
498
    # Unless otherwise indicated, the constants and types below are
 
499
    # all from the gnutls/gnutls.h C header file.
 
500
    
 
501
    # Constants
 
502
    E_SUCCESS = 0
 
503
    E_INTERRUPTED = -52
 
504
    E_AGAIN = -28
 
505
    CRT_OPENPGP = 2
 
506
    CLIENT = 2
 
507
    SHUT_RDWR = 0
 
508
    CRD_CERTIFICATE = 1
 
509
    E_NO_CERTIFICATE_FOUND = -49
 
510
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
 
511
    
 
512
    # Types
 
513
    class session_int(ctypes.Structure):
 
514
        _fields_ = []
 
515
    session_t = ctypes.POINTER(session_int)
 
516
    class certificate_credentials_st(ctypes.Structure):
 
517
        _fields_ = []
 
518
    certificate_credentials_t = ctypes.POINTER(
 
519
        certificate_credentials_st)
 
520
    certificate_type_t = ctypes.c_int
 
521
    class datum_t(ctypes.Structure):
 
522
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
523
                    ('size', ctypes.c_uint)]
 
524
    class openpgp_crt_int(ctypes.Structure):
 
525
        _fields_ = []
 
526
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
527
    openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
 
528
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
 
529
    credentials_type_t = ctypes.c_int
 
530
    transport_ptr_t = ctypes.c_void_p
 
531
    close_request_t = ctypes.c_int
 
532
    
 
533
    # Exceptions
 
534
    class Error(Exception):
 
535
        # We need to use the class name "GnuTLS" here, since this
 
536
        # exception might be raised from within GnuTLS.__init__,
 
537
        # which is called before the assignment to the "gnutls"
 
538
        # global variable has happened.
 
539
        def __init__(self, message = None, code = None, args=()):
 
540
            # Default usage is by a message string, but if a return
 
541
            # code is passed, convert it to a string with
 
542
            # gnutls.strerror()
 
543
            self.code = code
 
544
            if message is None and code is not None:
 
545
                message = GnuTLS.strerror(code)
 
546
            return super(GnuTLS.Error, self).__init__(
 
547
                message, *args)
 
548
    
 
549
    class CertificateSecurityError(Error):
 
550
        pass
 
551
    
 
552
    # Classes
 
553
    class Credentials(object):
 
554
        def __init__(self):
 
555
            self._c_object = gnutls.certificate_credentials_t()
 
556
            gnutls.certificate_allocate_credentials(
 
557
                ctypes.byref(self._c_object))
 
558
            self.type = gnutls.CRD_CERTIFICATE
 
559
        
 
560
        def __del__(self):
 
561
            gnutls.certificate_free_credentials(self._c_object)
 
562
    
 
563
    class ClientSession(object):
 
564
        def __init__(self, socket, credentials = None):
 
565
            self._c_object = gnutls.session_t()
 
566
            gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
 
567
            gnutls.set_default_priority(self._c_object)
 
568
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
569
            gnutls.handshake_set_private_extensions(self._c_object,
 
570
                                                    True)
 
571
            self.socket = socket
 
572
            if credentials is None:
 
573
                credentials = gnutls.Credentials()
 
574
            gnutls.credentials_set(self._c_object, credentials.type,
 
575
                                   ctypes.cast(credentials._c_object,
 
576
                                               ctypes.c_void_p))
 
577
            self.credentials = credentials
 
578
        
 
579
        def __del__(self):
 
580
            gnutls.deinit(self._c_object)
 
581
        
 
582
        def handshake(self):
 
583
            return gnutls.handshake(self._c_object)
 
584
        
 
585
        def send(self, data):
 
586
            data = bytes(data)
 
587
            data_len = len(data)
 
588
            while data_len > 0:
 
589
                data_len -= gnutls.record_send(self._c_object,
 
590
                                               data[-data_len:],
 
591
                                               data_len)
 
592
        
 
593
        def bye(self):
 
594
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
595
    
 
596
    # Error handling functions
 
597
    def _error_code(result):
 
598
        """A function to raise exceptions on errors, suitable
 
599
        for the 'restype' attribute on ctypes functions"""
 
600
        if result >= 0:
 
601
            return result
 
602
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
 
603
            raise gnutls.CertificateSecurityError(code = result)
 
604
        raise gnutls.Error(code = result)
 
605
    
 
606
    def _retry_on_error(result, func, arguments):
 
607
        """A function to retry on some errors, suitable
 
608
        for the 'errcheck' attribute on ctypes functions"""
 
609
        while result < 0:
 
610
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
 
611
                return _error_code(result)
 
612
            result = func(*arguments)
 
613
        return result
 
614
    
 
615
    # Unless otherwise indicated, the function declarations below are
 
616
    # all from the gnutls/gnutls.h C header file.
 
617
    
 
618
    # Functions
 
619
    priority_set_direct = _library.gnutls_priority_set_direct
 
620
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
621
                                    ctypes.POINTER(ctypes.c_char_p)]
 
622
    priority_set_direct.restype = _error_code
 
623
    
 
624
    init = _library.gnutls_init
 
625
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
626
    init.restype = _error_code
 
627
    
 
628
    set_default_priority = _library.gnutls_set_default_priority
 
629
    set_default_priority.argtypes = [session_t]
 
630
    set_default_priority.restype = _error_code
 
631
    
 
632
    record_send = _library.gnutls_record_send
 
633
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
634
                            ctypes.c_size_t]
 
635
    record_send.restype = ctypes.c_ssize_t
 
636
    record_send.errcheck = _retry_on_error
 
637
    
 
638
    certificate_allocate_credentials = (
 
639
        _library.gnutls_certificate_allocate_credentials)
 
640
    certificate_allocate_credentials.argtypes = [
 
641
        ctypes.POINTER(certificate_credentials_t)]
 
642
    certificate_allocate_credentials.restype = _error_code
 
643
    
 
644
    certificate_free_credentials = (
 
645
        _library.gnutls_certificate_free_credentials)
 
646
    certificate_free_credentials.argtypes = [certificate_credentials_t]
 
647
    certificate_free_credentials.restype = None
 
648
    
 
649
    handshake_set_private_extensions = (
 
650
        _library.gnutls_handshake_set_private_extensions)
 
651
    handshake_set_private_extensions.argtypes = [session_t,
 
652
                                                 ctypes.c_int]
 
653
    handshake_set_private_extensions.restype = None
 
654
    
 
655
    credentials_set = _library.gnutls_credentials_set
 
656
    credentials_set.argtypes = [session_t, credentials_type_t,
 
657
                                ctypes.c_void_p]
 
658
    credentials_set.restype = _error_code
 
659
    
 
660
    strerror = _library.gnutls_strerror
 
661
    strerror.argtypes = [ctypes.c_int]
 
662
    strerror.restype = ctypes.c_char_p
 
663
    
 
664
    certificate_type_get = _library.gnutls_certificate_type_get
 
665
    certificate_type_get.argtypes = [session_t]
 
666
    certificate_type_get.restype = _error_code
 
667
    
 
668
    certificate_get_peers = _library.gnutls_certificate_get_peers
 
669
    certificate_get_peers.argtypes = [session_t,
 
670
                                      ctypes.POINTER(ctypes.c_uint)]
 
671
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
 
672
    
 
673
    global_set_log_level = _library.gnutls_global_set_log_level
 
674
    global_set_log_level.argtypes = [ctypes.c_int]
 
675
    global_set_log_level.restype = None
 
676
    
 
677
    global_set_log_function = _library.gnutls_global_set_log_function
 
678
    global_set_log_function.argtypes = [log_func]
 
679
    global_set_log_function.restype = None
 
680
    
 
681
    deinit = _library.gnutls_deinit
 
682
    deinit.argtypes = [session_t]
 
683
    deinit.restype = None
 
684
    
 
685
    handshake = _library.gnutls_handshake
 
686
    handshake.argtypes = [session_t]
 
687
    handshake.restype = _error_code
 
688
    handshake.errcheck = _retry_on_error
 
689
    
 
690
    transport_set_ptr = _library.gnutls_transport_set_ptr
 
691
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
692
    transport_set_ptr.restype = None
 
693
    
 
694
    bye = _library.gnutls_bye
 
695
    bye.argtypes = [session_t, close_request_t]
 
696
    bye.restype = _error_code
 
697
    bye.errcheck = _retry_on_error
 
698
    
 
699
    check_version = _library.gnutls_check_version
 
700
    check_version.argtypes = [ctypes.c_char_p]
 
701
    check_version.restype = ctypes.c_char_p
 
702
    
 
703
    # All the function declarations below are from gnutls/openpgp.h
 
704
    
 
705
    openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
706
    openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
707
    openpgp_crt_init.restype = _error_code
 
708
    
 
709
    openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
710
    openpgp_crt_import.argtypes = [openpgp_crt_t,
 
711
                                   ctypes.POINTER(datum_t),
 
712
                                   openpgp_crt_fmt_t]
 
713
    openpgp_crt_import.restype = _error_code
 
714
    
 
715
    openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
716
    openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
717
                                        ctypes.POINTER(ctypes.c_uint)]
 
718
    openpgp_crt_verify_self.restype = _error_code
 
719
    
 
720
    openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
721
    openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
722
    openpgp_crt_deinit.restype = None
 
723
    
 
724
    openpgp_crt_get_fingerprint = (
 
725
        _library.gnutls_openpgp_crt_get_fingerprint)
 
726
    openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
727
                                            ctypes.c_void_p,
 
728
                                            ctypes.POINTER(
 
729
                                                ctypes.c_size_t)]
 
730
    openpgp_crt_get_fingerprint.restype = _error_code
 
731
    
 
732
    # Remove non-public functions
 
733
    del _error_code, _retry_on_error
 
734
# Create the global "gnutls" object, simulating a module
 
735
gnutls = GnuTLS()
 
736
 
427
737
def call_pipe(connection,       # : multiprocessing.Connection
428
738
              func, *args, **kwargs):
429
739
    """This function is meant to be called by multiprocessing.Process
444
754
    checker:    subprocess.Popen(); a running checker process used
445
755
                                    to see if the client lives.
446
756
                                    'None' if no process is running.
447
 
    checker_callback_tag: a gobject event source tag, or None
 
757
    checker_callback_tag: a GLib event source tag, or None
448
758
    checker_command: string; External command which is run to check
449
759
                     if client lives.  %() expansions are done at
450
760
                     runtime with vars(self) as dict, so that for
451
761
                     instance %(name)s can be used in the command.
452
 
    checker_initiator_tag: a gobject event source tag, or None
 
762
    checker_initiator_tag: a GLib event source tag, or None
453
763
    created:    datetime.datetime(); (UTC) object creation
454
764
    client_structure: Object describing what attributes a client has
455
765
                      and is used for storing the client at exit
456
766
    current_checker_command: string; current running checker_command
457
 
    disable_initiator_tag: a gobject event source tag, or None
 
767
    disable_initiator_tag: a GLib event source tag, or None
458
768
    enabled:    bool()
459
769
    fingerprint: string (40 or 32 hexadecimal digits); used to
460
770
                 uniquely identify the client
523
833
            client["fingerprint"] = (section["fingerprint"].upper()
524
834
                                     .replace(" ", ""))
525
835
            if "secret" in section:
526
 
                client["secret"] = section["secret"].decode("base64")
 
836
                client["secret"] = codecs.decode(section["secret"]
 
837
                                                 .encode("utf-8"),
 
838
                                                 "base64")
527
839
            elif "secfile" in section:
528
840
                with open(os.path.expanduser(os.path.expandvars
529
841
                                             (section["secfile"])),
582
894
        self.changedstate = multiprocessing_manager.Condition(
583
895
            multiprocessing_manager.Lock())
584
896
        self.client_structure = [attr
585
 
                                 for attr in self.__dict__.iterkeys()
 
897
                                 for attr in self.__dict__.keys()
586
898
                                 if not attr.startswith("_")]
587
899
        self.client_structure.append("client_structure")
588
900
        
614
926
        if not quiet:
615
927
            logger.info("Disabling client %s", self.name)
616
928
        if getattr(self, "disable_initiator_tag", None) is not None:
617
 
            gobject.source_remove(self.disable_initiator_tag)
 
929
            GLib.source_remove(self.disable_initiator_tag)
618
930
            self.disable_initiator_tag = None
619
931
        self.expires = None
620
932
        if getattr(self, "checker_initiator_tag", None) is not None:
621
 
            gobject.source_remove(self.checker_initiator_tag)
 
933
            GLib.source_remove(self.checker_initiator_tag)
622
934
            self.checker_initiator_tag = None
623
935
        self.stop_checker()
624
936
        self.enabled = False
625
937
        if not quiet:
626
938
            self.send_changedstate()
627
 
        # Do not run this again if called by a gobject.timeout_add
 
939
        # Do not run this again if called by a GLib.timeout_add
628
940
        return False
629
941
    
630
942
    def __del__(self):
634
946
        # Schedule a new checker to be started an 'interval' from now,
635
947
        # and every interval from then on.
636
948
        if self.checker_initiator_tag is not None:
637
 
            gobject.source_remove(self.checker_initiator_tag)
638
 
        self.checker_initiator_tag = gobject.timeout_add(
 
949
            GLib.source_remove(self.checker_initiator_tag)
 
950
        self.checker_initiator_tag = GLib.timeout_add(
639
951
            int(self.interval.total_seconds() * 1000),
640
952
            self.start_checker)
641
953
        # Schedule a disable() when 'timeout' has passed
642
954
        if self.disable_initiator_tag is not None:
643
 
            gobject.source_remove(self.disable_initiator_tag)
644
 
        self.disable_initiator_tag = gobject.timeout_add(
 
955
            GLib.source_remove(self.disable_initiator_tag)
 
956
        self.disable_initiator_tag = GLib.timeout_add(
645
957
            int(self.timeout.total_seconds() * 1000), self.disable)
646
958
        # Also start a new checker *right now*.
647
959
        self.start_checker()
683
995
        if timeout is None:
684
996
            timeout = self.timeout
685
997
        if self.disable_initiator_tag is not None:
686
 
            gobject.source_remove(self.disable_initiator_tag)
 
998
            GLib.source_remove(self.disable_initiator_tag)
687
999
            self.disable_initiator_tag = None
688
1000
        if getattr(self, "enabled", False):
689
 
            self.disable_initiator_tag = gobject.timeout_add(
 
1001
            self.disable_initiator_tag = GLib.timeout_add(
690
1002
                int(timeout.total_seconds() * 1000), self.disable)
691
1003
            self.expires = datetime.datetime.utcnow() + timeout
692
1004
    
747
1059
                args = (pipe[1], subprocess.call, command),
748
1060
                kwargs = popen_args)
749
1061
            self.checker.start()
750
 
            self.checker_callback_tag = gobject.io_add_watch(
751
 
                pipe[0].fileno(), gobject.IO_IN,
 
1062
            self.checker_callback_tag = GLib.io_add_watch(
 
1063
                pipe[0].fileno(), GLib.IO_IN,
752
1064
                self.checker_callback, pipe[0], command)
753
 
        # Re-run this periodically if run by gobject.timeout_add
 
1065
        # Re-run this periodically if run by GLib.timeout_add
754
1066
        return True
755
1067
    
756
1068
    def stop_checker(self):
757
1069
        """Force the checker process, if any, to stop."""
758
1070
        if self.checker_callback_tag:
759
 
            gobject.source_remove(self.checker_callback_tag)
 
1071
            GLib.source_remove(self.checker_callback_tag)
760
1072
            self.checker_callback_tag = None
761
1073
        if getattr(self, "checker", None) is None:
762
1074
            return
831
1143
                           access="r")
832
1144
    def Property_dbus_property(self):
833
1145
        return dbus.Boolean(False)
 
1146
    
 
1147
    See also the DBusObjectWithAnnotations class.
834
1148
    """
835
1149
    
836
1150
    def decorator(func):
858
1172
    pass
859
1173
 
860
1174
 
861
 
class DBusObjectWithProperties(dbus.service.Object):
862
 
    """A D-Bus object with properties.
 
1175
class DBusObjectWithAnnotations(dbus.service.Object):
 
1176
    """A D-Bus object with annotations.
863
1177
    
864
 
    Classes inheriting from this can use the dbus_service_property
865
 
    decorator to expose methods as D-Bus properties.  It exposes the
866
 
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
1178
    Classes inheriting from this can use the dbus_annotations
 
1179
    decorator to add annotations to methods or signals.
867
1180
    """
868
1181
    
869
1182
    @staticmethod
885
1198
                for name, athing in
886
1199
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
887
1200
    
 
1201
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1202
                         out_signature = "s",
 
1203
                         path_keyword = 'object_path',
 
1204
                         connection_keyword = 'connection')
 
1205
    def Introspect(self, object_path, connection):
 
1206
        """Overloading of standard D-Bus method.
 
1207
        
 
1208
        Inserts annotation tags on methods and signals.
 
1209
        """
 
1210
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
1211
                                                   connection)
 
1212
        try:
 
1213
            document = xml.dom.minidom.parseString(xmlstring)
 
1214
            
 
1215
            for if_tag in document.getElementsByTagName("interface"):
 
1216
                # Add annotation tags
 
1217
                for typ in ("method", "signal"):
 
1218
                    for tag in if_tag.getElementsByTagName(typ):
 
1219
                        annots = dict()
 
1220
                        for name, prop in (self.
 
1221
                                           _get_all_dbus_things(typ)):
 
1222
                            if (name == tag.getAttribute("name")
 
1223
                                and prop._dbus_interface
 
1224
                                == if_tag.getAttribute("name")):
 
1225
                                annots.update(getattr(
 
1226
                                    prop, "_dbus_annotations", {}))
 
1227
                        for name, value in annots.items():
 
1228
                            ann_tag = document.createElement(
 
1229
                                "annotation")
 
1230
                            ann_tag.setAttribute("name", name)
 
1231
                            ann_tag.setAttribute("value", value)
 
1232
                            tag.appendChild(ann_tag)
 
1233
                # Add interface annotation tags
 
1234
                for annotation, value in dict(
 
1235
                    itertools.chain.from_iterable(
 
1236
                        annotations().items()
 
1237
                        for name, annotations
 
1238
                        in self._get_all_dbus_things("interface")
 
1239
                        if name == if_tag.getAttribute("name")
 
1240
                        )).items():
 
1241
                    ann_tag = document.createElement("annotation")
 
1242
                    ann_tag.setAttribute("name", annotation)
 
1243
                    ann_tag.setAttribute("value", value)
 
1244
                    if_tag.appendChild(ann_tag)
 
1245
                # Fix argument name for the Introspect method itself
 
1246
                if (if_tag.getAttribute("name")
 
1247
                                == dbus.INTROSPECTABLE_IFACE):
 
1248
                    for cn in if_tag.getElementsByTagName("method"):
 
1249
                        if cn.getAttribute("name") == "Introspect":
 
1250
                            for arg in cn.getElementsByTagName("arg"):
 
1251
                                if (arg.getAttribute("direction")
 
1252
                                    == "out"):
 
1253
                                    arg.setAttribute("name",
 
1254
                                                     "xml_data")
 
1255
            xmlstring = document.toxml("utf-8")
 
1256
            document.unlink()
 
1257
        except (AttributeError, xml.dom.DOMException,
 
1258
                xml.parsers.expat.ExpatError) as error:
 
1259
            logger.error("Failed to override Introspection method",
 
1260
                         exc_info=error)
 
1261
        return xmlstring
 
1262
 
 
1263
 
 
1264
class DBusObjectWithProperties(DBusObjectWithAnnotations):
 
1265
    """A D-Bus object with properties.
 
1266
    
 
1267
    Classes inheriting from this can use the dbus_service_property
 
1268
    decorator to expose methods as D-Bus properties.  It exposes the
 
1269
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
1270
    """
 
1271
    
888
1272
    def _get_dbus_property(self, interface_name, property_name):
889
1273
        """Returns a bound method if one exists which is a D-Bus
890
1274
        property with the specified name and interface.
900
1284
        raise DBusPropertyNotFound("{}:{}.{}".format(
901
1285
            self.dbus_object_path, interface_name, property_name))
902
1286
    
 
1287
    @classmethod
 
1288
    def _get_all_interface_names(cls):
 
1289
        """Get a sequence of all interfaces supported by an object"""
 
1290
        return (name for name in set(getattr(getattr(x, attr),
 
1291
                                             "_dbus_interface", None)
 
1292
                                     for x in (inspect.getmro(cls))
 
1293
                                     for attr in dir(x))
 
1294
                if name is not None)
 
1295
    
903
1296
    @dbus.service.method(dbus.PROPERTIES_IFACE,
904
1297
                         in_signature="ss",
905
1298
                         out_signature="v")
975
1368
        
976
1369
        Inserts property tags and interface annotation tags.
977
1370
        """
978
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
979
 
                                                   connection)
 
1371
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1372
                                                         object_path,
 
1373
                                                         connection)
980
1374
        try:
981
1375
            document = xml.dom.minidom.parseString(xmlstring)
982
1376
            
995
1389
                            if prop._dbus_interface
996
1390
                            == if_tag.getAttribute("name")):
997
1391
                    if_tag.appendChild(tag)
998
 
                # Add annotation tags
999
 
                for typ in ("method", "signal", "property"):
1000
 
                    for tag in if_tag.getElementsByTagName(typ):
1001
 
                        annots = dict()
1002
 
                        for name, prop in (self.
1003
 
                                           _get_all_dbus_things(typ)):
1004
 
                            if (name == tag.getAttribute("name")
1005
 
                                and prop._dbus_interface
1006
 
                                == if_tag.getAttribute("name")):
1007
 
                                annots.update(getattr(
1008
 
                                    prop, "_dbus_annotations", {}))
1009
 
                        for name, value in annots.items():
1010
 
                            ann_tag = document.createElement(
1011
 
                                "annotation")
1012
 
                            ann_tag.setAttribute("name", name)
1013
 
                            ann_tag.setAttribute("value", value)
1014
 
                            tag.appendChild(ann_tag)
1015
 
                # Add interface annotation tags
1016
 
                for annotation, value in dict(
1017
 
                    itertools.chain.from_iterable(
1018
 
                        annotations().items()
1019
 
                        for name, annotations
1020
 
                        in self._get_all_dbus_things("interface")
1021
 
                        if name == if_tag.getAttribute("name")
1022
 
                        )).items():
1023
 
                    ann_tag = document.createElement("annotation")
1024
 
                    ann_tag.setAttribute("name", annotation)
1025
 
                    ann_tag.setAttribute("value", value)
1026
 
                    if_tag.appendChild(ann_tag)
 
1392
                # Add annotation tags for properties
 
1393
                for tag in if_tag.getElementsByTagName("property"):
 
1394
                    annots = dict()
 
1395
                    for name, prop in self._get_all_dbus_things(
 
1396
                            "property"):
 
1397
                        if (name == tag.getAttribute("name")
 
1398
                            and prop._dbus_interface
 
1399
                            == if_tag.getAttribute("name")):
 
1400
                            annots.update(getattr(
 
1401
                                prop, "_dbus_annotations", {}))
 
1402
                    for name, value in annots.items():
 
1403
                        ann_tag = document.createElement(
 
1404
                            "annotation")
 
1405
                        ann_tag.setAttribute("name", name)
 
1406
                        ann_tag.setAttribute("value", value)
 
1407
                        tag.appendChild(ann_tag)
1027
1408
                # Add the names to the return values for the
1028
1409
                # "org.freedesktop.DBus.Properties" methods
1029
1410
                if (if_tag.getAttribute("name")
1047
1428
                         exc_info=error)
1048
1429
        return xmlstring
1049
1430
 
 
1431
try:
 
1432
    dbus.OBJECT_MANAGER_IFACE
 
1433
except AttributeError:
 
1434
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
1435
 
 
1436
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
 
1437
    """A D-Bus object with an ObjectManager.
 
1438
    
 
1439
    Classes inheriting from this exposes the standard
 
1440
    GetManagedObjects call and the InterfacesAdded and
 
1441
    InterfacesRemoved signals on the standard
 
1442
    "org.freedesktop.DBus.ObjectManager" interface.
 
1443
    
 
1444
    Note: No signals are sent automatically; they must be sent
 
1445
    manually.
 
1446
    """
 
1447
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
1448
                         out_signature = "a{oa{sa{sv}}}")
 
1449
    def GetManagedObjects(self):
 
1450
        """This function must be overridden"""
 
1451
        raise NotImplementedError()
 
1452
    
 
1453
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
 
1454
                         signature = "oa{sa{sv}}")
 
1455
    def InterfacesAdded(self, object_path, interfaces_and_properties):
 
1456
        pass
 
1457
    
 
1458
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
 
1459
    def InterfacesRemoved(self, object_path, interfaces):
 
1460
        pass
 
1461
    
 
1462
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1463
                         out_signature = "s",
 
1464
                         path_keyword = 'object_path',
 
1465
                         connection_keyword = 'connection')
 
1466
    def Introspect(self, object_path, connection):
 
1467
        """Overloading of standard D-Bus method.
 
1468
        
 
1469
        Override return argument name of GetManagedObjects to be
 
1470
        "objpath_interfaces_and_properties"
 
1471
        """
 
1472
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1473
                                                         object_path,
 
1474
                                                         connection)
 
1475
        try:
 
1476
            document = xml.dom.minidom.parseString(xmlstring)
 
1477
            
 
1478
            for if_tag in document.getElementsByTagName("interface"):
 
1479
                # Fix argument name for the GetManagedObjects method
 
1480
                if (if_tag.getAttribute("name")
 
1481
                                == dbus.OBJECT_MANAGER_IFACE):
 
1482
                    for cn in if_tag.getElementsByTagName("method"):
 
1483
                        if (cn.getAttribute("name")
 
1484
                            == "GetManagedObjects"):
 
1485
                            for arg in cn.getElementsByTagName("arg"):
 
1486
                                if (arg.getAttribute("direction")
 
1487
                                    == "out"):
 
1488
                                    arg.setAttribute(
 
1489
                                        "name",
 
1490
                                        "objpath_interfaces"
 
1491
                                        "_and_properties")
 
1492
            xmlstring = document.toxml("utf-8")
 
1493
            document.unlink()
 
1494
        except (AttributeError, xml.dom.DOMException,
 
1495
                xml.parsers.expat.ExpatError) as error:
 
1496
            logger.error("Failed to override Introspection method",
 
1497
                         exc_info = error)
 
1498
        return xmlstring
1050
1499
 
1051
1500
def datetime_to_dbus(dt, variant_level=0):
1052
1501
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1099
1548
                interface_names.add(alt_interface)
1100
1549
                # Is this a D-Bus signal?
1101
1550
                if getattr(attribute, "_dbus_is_signal", False):
 
1551
                    # Extract the original non-method undecorated
 
1552
                    # function by black magic
1102
1553
                    if sys.version_info.major == 2:
1103
 
                        # Extract the original non-method undecorated
1104
 
                        # function by black magic
1105
1554
                        nonmethod_func = (dict(
1106
1555
                            zip(attribute.func_code.co_freevars,
1107
1556
                                attribute.__closure__))
1108
1557
                                          ["func"].cell_contents)
1109
1558
                    else:
1110
 
                        nonmethod_func = attribute
 
1559
                        nonmethod_func = (dict(
 
1560
                            zip(attribute.__code__.co_freevars,
 
1561
                                attribute.__closure__))
 
1562
                                          ["func"].cell_contents)
1111
1563
                    # Create a new, but exactly alike, function
1112
1564
                    # object, and decorate it to be a new D-Bus signal
1113
1565
                    # with the alternate D-Bus interface name
1114
 
                    if sys.version_info.major == 2:
1115
 
                        new_function = types.FunctionType(
1116
 
                            nonmethod_func.func_code,
1117
 
                            nonmethod_func.func_globals,
1118
 
                            nonmethod_func.func_name,
1119
 
                            nonmethod_func.func_defaults,
1120
 
                            nonmethod_func.func_closure)
1121
 
                    else:
1122
 
                        new_function = types.FunctionType(
1123
 
                            nonmethod_func.__code__,
1124
 
                            nonmethod_func.__globals__,
1125
 
                            nonmethod_func.__name__,
1126
 
                            nonmethod_func.__defaults__,
1127
 
                            nonmethod_func.__closure__)
 
1566
                    new_function = copy_function(nonmethod_func)
1128
1567
                    new_function = (dbus.service.signal(
1129
1568
                        alt_interface,
1130
1569
                        attribute._dbus_signature)(new_function))
1143
1582
                        func1 and func2 to the "call_both" function
1144
1583
                        outside of its arguments"""
1145
1584
                        
 
1585
                        @functools.wraps(func2)
1146
1586
                        def call_both(*args, **kwargs):
1147
1587
                            """This function will emit two D-Bus
1148
1588
                            signals by calling func1 and func2"""
1149
1589
                            func1(*args, **kwargs)
1150
1590
                            func2(*args, **kwargs)
 
1591
                        # Make wrapper function look like a D-Bus signal
 
1592
                        for name, attr in inspect.getmembers(func2):
 
1593
                            if name.startswith("_dbus_"):
 
1594
                                setattr(call_both, name, attr)
1151
1595
                        
1152
1596
                        return call_both
1153
1597
                    # Create the "call_both" function and add it to
1164
1608
                            alt_interface,
1165
1609
                            attribute._dbus_in_signature,
1166
1610
                            attribute._dbus_out_signature)
1167
 
                        (types.FunctionType(attribute.func_code,
1168
 
                                            attribute.func_globals,
1169
 
                                            attribute.func_name,
1170
 
                                            attribute.func_defaults,
1171
 
                                            attribute.func_closure)))
 
1611
                        (copy_function(attribute)))
1172
1612
                    # Copy annotations, if any
1173
1613
                    try:
1174
1614
                        attr[attrname]._dbus_annotations = dict(
1186
1626
                        attribute._dbus_access,
1187
1627
                        attribute._dbus_get_args_options
1188
1628
                        ["byte_arrays"])
1189
 
                                      (types.FunctionType(
1190
 
                                          attribute.func_code,
1191
 
                                          attribute.func_globals,
1192
 
                                          attribute.func_name,
1193
 
                                          attribute.func_defaults,
1194
 
                                          attribute.func_closure)))
 
1629
                                      (copy_function(attribute)))
1195
1630
                    # Copy annotations, if any
1196
1631
                    try:
1197
1632
                        attr[attrname]._dbus_annotations = dict(
1206
1641
                    # to the class.
1207
1642
                    attr[attrname] = (
1208
1643
                        dbus_interface_annotations(alt_interface)
1209
 
                        (types.FunctionType(attribute.func_code,
1210
 
                                            attribute.func_globals,
1211
 
                                            attribute.func_name,
1212
 
                                            attribute.func_defaults,
1213
 
                                            attribute.func_closure)))
 
1644
                        (copy_function(attribute)))
1214
1645
            if deprecate:
1215
1646
                # Deprecate all alternate interfaces
1216
1647
                iname="_AlternateDBusNames_interface_annotation{}"
1229
1660
            if interface_names:
1230
1661
                # Replace the class with a new subclass of it with
1231
1662
                # methods, signals, etc. as created above.
1232
 
                cls = type(b"{}Alternate".format(cls.__name__),
1233
 
                           (cls, ), attr)
 
1663
                if sys.version_info.major == 2:
 
1664
                    cls = type(b"{}Alternate".format(cls.__name__),
 
1665
                               (cls, ), attr)
 
1666
                else:
 
1667
                    cls = type("{}Alternate".format(cls.__name__),
 
1668
                               (cls, ), attr)
1234
1669
        return cls
1235
1670
    
1236
1671
    return wrapper
1365
1800
        if exitstatus >= 0:
1366
1801
            # Emit D-Bus signal
1367
1802
            self.CheckerCompleted(dbus.Int16(exitstatus),
1368
 
                                  dbus.Int64(0),
 
1803
                                  # This is specific to GNU libC
 
1804
                                  dbus.Int64(exitstatus << 8),
1369
1805
                                  dbus.String(command))
1370
1806
        else:
1371
1807
            # Emit D-Bus signal
1372
1808
            self.CheckerCompleted(dbus.Int16(-1),
1373
1809
                                  dbus.Int64(
1374
 
                                      self.last_checker_signal),
 
1810
                                      # This is specific to GNU libC
 
1811
                                      (exitstatus << 8)
 
1812
                                      | self.last_checker_signal),
1375
1813
                                  dbus.String(command))
1376
1814
        return ret
1377
1815
    
1391
1829
    
1392
1830
    def approve(self, value=True):
1393
1831
        self.approved = value
1394
 
        gobject.timeout_add(int(self.approval_duration.total_seconds()
1395
 
                                * 1000), self._reset_approved)
 
1832
        GLib.timeout_add(int(self.approval_duration.total_seconds()
 
1833
                             * 1000), self._reset_approved)
1396
1834
        self.send_changedstate()
1397
1835
    
1398
1836
    ## D-Bus methods, signals & properties
1454
1892
        self.checked_ok()
1455
1893
    
1456
1894
    # Enable - method
 
1895
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1457
1896
    @dbus.service.method(_interface)
1458
1897
    def Enable(self):
1459
1898
        "D-Bus method"
1460
1899
        self.enable()
1461
1900
    
1462
1901
    # StartChecker - method
 
1902
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1463
1903
    @dbus.service.method(_interface)
1464
1904
    def StartChecker(self):
1465
1905
        "D-Bus method"
1466
1906
        self.start_checker()
1467
1907
    
1468
1908
    # Disable - method
 
1909
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1469
1910
    @dbus.service.method(_interface)
1470
1911
    def Disable(self):
1471
1912
        "D-Bus method"
1472
1913
        self.disable()
1473
1914
    
1474
1915
    # StopChecker - method
 
1916
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1475
1917
    @dbus.service.method(_interface)
1476
1918
    def StopChecker(self):
1477
1919
        self.stop_checker()
1513
1955
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1514
1956
    
1515
1957
    # Name - property
 
1958
    @dbus_annotations(
 
1959
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1516
1960
    @dbus_service_property(_interface, signature="s", access="read")
1517
1961
    def Name_dbus_property(self):
1518
1962
        return dbus.String(self.name)
1519
1963
    
1520
1964
    # Fingerprint - property
 
1965
    @dbus_annotations(
 
1966
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1521
1967
    @dbus_service_property(_interface, signature="s", access="read")
1522
1968
    def Fingerprint_dbus_property(self):
1523
1969
        return dbus.String(self.fingerprint)
1532
1978
        self.host = str(value)
1533
1979
    
1534
1980
    # Created - property
 
1981
    @dbus_annotations(
 
1982
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1535
1983
    @dbus_service_property(_interface, signature="s", access="read")
1536
1984
    def Created_dbus_property(self):
1537
1985
        return datetime_to_dbus(self.created)
1598
2046
                if (getattr(self, "disable_initiator_tag", None)
1599
2047
                    is None):
1600
2048
                    return
1601
 
                gobject.source_remove(self.disable_initiator_tag)
1602
 
                self.disable_initiator_tag = gobject.timeout_add(
 
2049
                GLib.source_remove(self.disable_initiator_tag)
 
2050
                self.disable_initiator_tag = GLib.timeout_add(
1603
2051
                    int((self.expires - now).total_seconds() * 1000),
1604
2052
                    self.disable)
1605
2053
    
1625
2073
            return
1626
2074
        if self.enabled:
1627
2075
            # Reschedule checker run
1628
 
            gobject.source_remove(self.checker_initiator_tag)
1629
 
            self.checker_initiator_tag = gobject.timeout_add(
 
2076
            GLib.source_remove(self.checker_initiator_tag)
 
2077
            self.checker_initiator_tag = GLib.timeout_add(
1630
2078
                value, self.start_checker)
1631
2079
            self.start_checker() # Start one now, too
1632
2080
    
1652
2100
            self.stop_checker()
1653
2101
    
1654
2102
    # ObjectPath - property
 
2103
    @dbus_annotations(
 
2104
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
2105
         "org.freedesktop.DBus.Deprecated": "true"})
1655
2106
    @dbus_service_property(_interface, signature="o", access="read")
1656
2107
    def ObjectPath_dbus_property(self):
1657
2108
        return self.dbus_object_path # is already a dbus.ObjectPath
1658
2109
    
1659
2110
    # Secret = property
 
2111
    @dbus_annotations(
 
2112
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2113
         "invalidates"})
1660
2114
    @dbus_service_property(_interface,
1661
2115
                           signature="ay",
1662
2116
                           access="write",
1708
2162
            logger.debug("Pipe FD: %d",
1709
2163
                         self.server.child_pipe.fileno())
1710
2164
            
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.
 
2165
            session = gnutls.ClientSession(self.request)
1718
2166
            
1719
2167
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1720
2168
            #                      "+AES-256-CBC", "+SHA1",
1724
2172
            priority = self.server.gnutls_priority
1725
2173
            if priority is None:
1726
2174
                priority = "NORMAL"
1727
 
            gnutls.library.functions.gnutls_priority_set_direct(
1728
 
                session._c_object, priority, None)
 
2175
            gnutls.priority_set_direct(session._c_object, priority,
 
2176
                                       None)
1729
2177
            
1730
2178
            # Start communication using the Mandos protocol
1731
2179
            # Get protocol number
1741
2189
            # Start GnuTLS connection
1742
2190
            try:
1743
2191
                session.handshake()
1744
 
            except gnutls.errors.GNUTLSError as error:
 
2192
            except gnutls.Error as error:
1745
2193
                logger.warning("Handshake failed: %s", error)
1746
2194
                # Do not run session.bye() here: the session is not
1747
2195
                # established.  Just abandon the request.
1753
2201
                try:
1754
2202
                    fpr = self.fingerprint(
1755
2203
                        self.peer_certificate(session))
1756
 
                except (TypeError,
1757
 
                        gnutls.errors.GNUTLSError) as error:
 
2204
                except (TypeError, gnutls.Error) as error:
1758
2205
                    logger.warning("Bad certificate: %s", error)
1759
2206
                    return
1760
2207
                logger.debug("Fingerprint: %s", fpr)
1818
2265
                    else:
1819
2266
                        delay -= time2 - time
1820
2267
                
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
 
2268
                try:
 
2269
                    session.send(client.secret)
 
2270
                except gnutls.Error as error:
 
2271
                    logger.warning("gnutls send failed",
 
2272
                                   exc_info = error)
 
2273
                    return
1833
2274
                
1834
2275
                logger.info("Sending secret to %s", client.name)
1835
2276
                # bump the timeout using extended_timeout
1843
2284
                    client.approvals_pending -= 1
1844
2285
                try:
1845
2286
                    session.bye()
1846
 
                except gnutls.errors.GNUTLSError as error:
 
2287
                except gnutls.Error as error:
1847
2288
                    logger.warning("GnuTLS bye failed",
1848
2289
                                   exc_info=error)
1849
2290
    
1851
2292
    def peer_certificate(session):
1852
2293
        "Return the peer's OpenPGP certificate as a bytestring"
1853
2294
        # 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
 
2295
        if (gnutls.certificate_type_get(session._c_object)
 
2296
            != gnutls.CRT_OPENPGP):
 
2297
            # ...return invalid data
 
2298
            return b""
1859
2299
        list_size = ctypes.c_uint(1)
1860
 
        cert_list = (gnutls.library.functions
1861
 
                     .gnutls_certificate_get_peers
 
2300
        cert_list = (gnutls.certificate_get_peers
1862
2301
                     (session._c_object, ctypes.byref(list_size)))
1863
2302
        if not bool(cert_list) and list_size.value != 0:
1864
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1865
 
                                            " certificate")
 
2303
            raise gnutls.Error("error getting peer certificate")
1866
2304
        if list_size.value == 0:
1867
2305
            return None
1868
2306
        cert = cert_list[0]
1872
2310
    def fingerprint(openpgp):
1873
2311
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1874
2312
        # New GnuTLS "datum" with the OpenPGP public key
1875
 
        datum = gnutls.library.types.gnutls_datum_t(
 
2313
        datum = gnutls.datum_t(
1876
2314
            ctypes.cast(ctypes.c_char_p(openpgp),
1877
2315
                        ctypes.POINTER(ctypes.c_ubyte)),
1878
2316
            ctypes.c_uint(len(openpgp)))
1879
2317
        # 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))
 
2318
        crt = gnutls.openpgp_crt_t()
 
2319
        gnutls.openpgp_crt_init(ctypes.byref(crt))
1883
2320
        # 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)
 
2321
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2322
                                  gnutls.OPENPGP_FMT_RAW)
1887
2323
        # Verify the self signature in the key
1888
2324
        crtverify = ctypes.c_uint()
1889
 
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1890
 
            crt, 0, ctypes.byref(crtverify))
 
2325
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2326
                                       ctypes.byref(crtverify))
1891
2327
        if crtverify.value != 0:
1892
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1893
 
            raise gnutls.errors.CertificateSecurityError(
1894
 
                "Verify failed")
 
2328
            gnutls.openpgp_crt_deinit(crt)
 
2329
            raise gnutls.CertificateSecurityError("Verify failed")
1895
2330
        # New buffer for the fingerprint
1896
2331
        buf = ctypes.create_string_buffer(20)
1897
2332
        buf_len = ctypes.c_size_t()
1898
2333
        # 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))
 
2334
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2335
                                           ctypes.byref(buf_len))
1901
2336
        # Deinit the certificate
1902
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2337
        gnutls.openpgp_crt_deinit(crt)
1903
2338
        # Convert the buffer to a Python bytestring
1904
2339
        fpr = ctypes.string_at(buf, buf_len.value)
1905
2340
        # Convert the bytestring to hexadecimal notation
2049
2484
        gnutls_priority GnuTLS priority string
2050
2485
        use_dbus:       Boolean; to emit D-Bus signals or not
2051
2486
    
2052
 
    Assumes a gobject.MainLoop event loop.
 
2487
    Assumes a GLib.MainLoop event loop.
2053
2488
    """
2054
2489
    
2055
2490
    def __init__(self, server_address, RequestHandlerClass,
2080
2515
    
2081
2516
    def add_pipe(self, parent_pipe, proc):
2082
2517
        # Call "handle_ipc" for both data and EOF events
2083
 
        gobject.io_add_watch(
 
2518
        GLib.io_add_watch(
2084
2519
            parent_pipe.fileno(),
2085
 
            gobject.IO_IN | gobject.IO_HUP,
 
2520
            GLib.IO_IN | GLib.IO_HUP,
2086
2521
            functools.partial(self.handle_ipc,
2087
2522
                              parent_pipe = parent_pipe,
2088
2523
                              proc = proc))
2092
2527
                   proc = None,
2093
2528
                   client_object=None):
2094
2529
        # error, or the other end of multiprocessing.Pipe has closed
2095
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2530
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
2096
2531
            # Wait for other process to exit
2097
2532
            proc.join()
2098
2533
            return False
2105
2540
            fpr = request[1]
2106
2541
            address = request[2]
2107
2542
            
2108
 
            for c in self.clients.itervalues():
 
2543
            for c in self.clients.values():
2109
2544
                if c.fingerprint == fpr:
2110
2545
                    client = c
2111
2546
                    break
2119
2554
                parent_pipe.send(False)
2120
2555
                return False
2121
2556
            
2122
 
            gobject.io_add_watch(
 
2557
            GLib.io_add_watch(
2123
2558
                parent_pipe.fileno(),
2124
 
                gobject.IO_IN | gobject.IO_HUP,
 
2559
                GLib.IO_IN | GLib.IO_HUP,
2125
2560
                functools.partial(self.handle_ipc,
2126
2561
                                  parent_pipe = parent_pipe,
2127
2562
                                  proc = proc,
2386
2821
                        "debug": "False",
2387
2822
                        "priority":
2388
2823
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2389
 
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
2824
                        ":+SIGN-DSA-SHA256",
2390
2825
                        "servicename": "Mandos",
2391
2826
                        "use_dbus": "True",
2392
2827
                        "use_ipv6": "True",
2509
2944
            logger.error("Could not open file %r", pidfilename,
2510
2945
                         exc_info=e)
2511
2946
    
2512
 
    for name in ("_mandos", "mandos", "nobody"):
 
2947
    for name, group in (("_mandos", "_mandos"),
 
2948
                        ("mandos", "mandos"),
 
2949
                        ("nobody", "nogroup")):
2513
2950
        try:
2514
2951
            uid = pwd.getpwnam(name).pw_uid
2515
 
            gid = pwd.getpwnam(name).pw_gid
 
2952
            gid = pwd.getpwnam(group).pw_gid
2516
2953
            break
2517
2954
        except KeyError:
2518
2955
            continue
2522
2959
    try:
2523
2960
        os.setgid(gid)
2524
2961
        os.setuid(uid)
 
2962
        if debug:
 
2963
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
2964
                                                             gid))
2525
2965
    except OSError as error:
 
2966
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
2967
                       .format(uid, gid, os.strerror(error.errno)))
2526
2968
        if error.errno != errno.EPERM:
2527
2969
            raise
2528
2970
    
2531
2973
        
2532
2974
        # "Use a log level over 10 to enable all debugging options."
2533
2975
        # - GnuTLS manual
2534
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
2976
        gnutls.global_set_log_level(11)
2535
2977
        
2536
 
        @gnutls.library.types.gnutls_log_func
 
2978
        @gnutls.log_func
2537
2979
        def debug_gnutls(level, string):
2538
2980
            logger.debug("GnuTLS: %s", string[:-1])
2539
2981
        
2540
 
        gnutls.library.functions.gnutls_global_set_log_function(
2541
 
            debug_gnutls)
 
2982
        gnutls.global_set_log_function(debug_gnutls)
2542
2983
        
2543
2984
        # Redirect stdin so all checkers get /dev/null
2544
2985
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2551
2992
        # Close all input and output, do double fork, etc.
2552
2993
        daemon()
2553
2994
    
2554
 
    # multiprocessing will use threads, so before we use gobject we
2555
 
    # need to inform gobject that threads will be used.
2556
 
    gobject.threads_init()
 
2995
    # multiprocessing will use threads, so before we use GLib we need
 
2996
    # to inform GLib that threads will be used.
 
2997
    GLib.threads_init()
2557
2998
    
2558
2999
    global main_loop
2559
3000
    # From the Avahi example code
2560
3001
    DBusGMainLoop(set_as_default=True)
2561
 
    main_loop = gobject.MainLoop()
 
3002
    main_loop = GLib.MainLoop()
2562
3003
    bus = dbus.SystemBus()
2563
3004
    # End of Avahi example code
2564
3005
    if use_dbus:
2608
3049
    if server_settings["restore"]:
2609
3050
        try:
2610
3051
            with open(stored_state_path, "rb") as stored_state:
2611
 
                clients_data, old_client_settings = pickle.load(
2612
 
                    stored_state)
 
3052
                if sys.version_info.major == 2:                
 
3053
                    clients_data, old_client_settings = pickle.load(
 
3054
                        stored_state)
 
3055
                else:
 
3056
                    bytes_clients_data, bytes_old_client_settings = (
 
3057
                        pickle.load(stored_state, encoding = "bytes"))
 
3058
                    ### Fix bytes to strings
 
3059
                    ## clients_data
 
3060
                    # .keys()
 
3061
                    clients_data = { (key.decode("utf-8")
 
3062
                                      if isinstance(key, bytes)
 
3063
                                      else key): value
 
3064
                                     for key, value in
 
3065
                                     bytes_clients_data.items() }
 
3066
                    del bytes_clients_data
 
3067
                    for key in clients_data:
 
3068
                        value = { (k.decode("utf-8")
 
3069
                                   if isinstance(k, bytes) else k): v
 
3070
                                  for k, v in
 
3071
                                  clients_data[key].items() }
 
3072
                        clients_data[key] = value
 
3073
                        # .client_structure
 
3074
                        value["client_structure"] = [
 
3075
                            (s.decode("utf-8")
 
3076
                             if isinstance(s, bytes)
 
3077
                             else s) for s in
 
3078
                            value["client_structure"] ]
 
3079
                        # .name & .host
 
3080
                        for k in ("name", "host"):
 
3081
                            if isinstance(value[k], bytes):
 
3082
                                value[k] = value[k].decode("utf-8")
 
3083
                    ## old_client_settings
 
3084
                    # .keys()
 
3085
                    old_client_settings = {
 
3086
                        (key.decode("utf-8")
 
3087
                         if isinstance(key, bytes)
 
3088
                         else key): value
 
3089
                        for key, value in
 
3090
                        bytes_old_client_settings.items() }
 
3091
                    del bytes_old_client_settings
 
3092
                    # .host
 
3093
                    for value in old_client_settings.values():
 
3094
                        if isinstance(value["host"], bytes):
 
3095
                            value["host"] = (value["host"]
 
3096
                                             .decode("utf-8"))
2613
3097
            os.remove(stored_state_path)
2614
3098
        except IOError as e:
2615
3099
            if e.errno == errno.ENOENT:
2716
3200
        del pidfile
2717
3201
        del pidfilename
2718
3202
    
2719
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2720
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
 
3203
    for termsig in (signal.SIGHUP, signal.SIGTERM):
 
3204
        GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
 
3205
                             lambda: main_loop.quit() and False)
2721
3206
    
2722
3207
    if use_dbus:
2723
3208
        
2724
3209
        @alternate_dbus_interfaces(
2725
3210
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2726
 
        class MandosDBusService(DBusObjectWithProperties):
 
3211
        class MandosDBusService(DBusObjectWithObjectManager):
2727
3212
            """A D-Bus proxy object"""
2728
3213
            
2729
3214
            def __init__(self):
2731
3216
            
2732
3217
            _interface = "se.recompile.Mandos"
2733
3218
            
2734
 
            @dbus_interface_annotations(_interface)
2735
 
            def _foo(self):
2736
 
                return {
2737
 
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
2738
 
                    "false" }
2739
 
            
2740
3219
            @dbus.service.signal(_interface, signature="o")
2741
3220
            def ClientAdded(self, objpath):
2742
3221
                "D-Bus signal"
2747
3226
                "D-Bus signal"
2748
3227
                pass
2749
3228
            
 
3229
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3230
                               "true"})
2750
3231
            @dbus.service.signal(_interface, signature="os")
2751
3232
            def ClientRemoved(self, objpath, name):
2752
3233
                "D-Bus signal"
2753
3234
                pass
2754
3235
            
 
3236
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3237
                               "true"})
2755
3238
            @dbus.service.method(_interface, out_signature="ao")
2756
3239
            def GetAllClients(self):
2757
3240
                "D-Bus method"
2758
3241
                return dbus.Array(c.dbus_object_path for c in
2759
 
                                  tcp_server.clients.itervalues())
 
3242
                                  tcp_server.clients.values())
2760
3243
            
 
3244
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3245
                               "true"})
2761
3246
            @dbus.service.method(_interface,
2762
3247
                                 out_signature="a{oa{sv}}")
2763
3248
            def GetAllClientsWithProperties(self):
2764
3249
                "D-Bus method"
2765
3250
                return dbus.Dictionary(
2766
 
                    { c.dbus_object_path: c.GetAll("")
2767
 
                      for c in tcp_server.clients.itervalues() },
 
3251
                    { c.dbus_object_path: c.GetAll(
 
3252
                        "se.recompile.Mandos.Client")
 
3253
                      for c in tcp_server.clients.values() },
2768
3254
                    signature="oa{sv}")
2769
3255
            
2770
3256
            @dbus.service.method(_interface, in_signature="o")
2771
3257
            def RemoveClient(self, object_path):
2772
3258
                "D-Bus method"
2773
 
                for c in tcp_server.clients.itervalues():
 
3259
                for c in tcp_server.clients.values():
2774
3260
                    if c.dbus_object_path == object_path:
2775
3261
                        del tcp_server.clients[c.name]
2776
3262
                        c.remove_from_connection()
2777
 
                        # Don't signal anything except ClientRemoved
 
3263
                        # Don't signal the disabling
2778
3264
                        c.disable(quiet=True)
2779
 
                        # Emit D-Bus signal
2780
 
                        self.ClientRemoved(object_path, c.name)
 
3265
                        # Emit D-Bus signal for removal
 
3266
                        self.client_removed_signal(c)
2781
3267
                        return
2782
3268
                raise KeyError(object_path)
2783
3269
            
2784
3270
            del _interface
 
3271
            
 
3272
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
3273
                                 out_signature = "a{oa{sa{sv}}}")
 
3274
            def GetManagedObjects(self):
 
3275
                """D-Bus method"""
 
3276
                return dbus.Dictionary(
 
3277
                    { client.dbus_object_path:
 
3278
                      dbus.Dictionary(
 
3279
                          { interface: client.GetAll(interface)
 
3280
                            for interface in
 
3281
                                 client._get_all_interface_names()})
 
3282
                      for client in tcp_server.clients.values()})
 
3283
            
 
3284
            def client_added_signal(self, client):
 
3285
                """Send the new standard signal and the old signal"""
 
3286
                if use_dbus:
 
3287
                    # New standard signal
 
3288
                    self.InterfacesAdded(
 
3289
                        client.dbus_object_path,
 
3290
                        dbus.Dictionary(
 
3291
                            { interface: client.GetAll(interface)
 
3292
                              for interface in
 
3293
                              client._get_all_interface_names()}))
 
3294
                    # Old signal
 
3295
                    self.ClientAdded(client.dbus_object_path)
 
3296
            
 
3297
            def client_removed_signal(self, client):
 
3298
                """Send the new standard signal and the old signal"""
 
3299
                if use_dbus:
 
3300
                    # New standard signal
 
3301
                    self.InterfacesRemoved(
 
3302
                        client.dbus_object_path,
 
3303
                        client._get_all_interface_names())
 
3304
                    # Old signal
 
3305
                    self.ClientRemoved(client.dbus_object_path,
 
3306
                                       client.name)
2785
3307
        
2786
3308
        mandos_dbus_service = MandosDBusService()
2787
3309
    
2800
3322
        # removed/edited, old secret will thus be unrecovable.
2801
3323
        clients = {}
2802
3324
        with PGPEngine() as pgp:
2803
 
            for client in tcp_server.clients.itervalues():
 
3325
            for client in tcp_server.clients.values():
2804
3326
                key = client_settings[client.name]["secret"]
2805
3327
                client.encrypted_secret = pgp.encrypt(client.secret,
2806
3328
                                                      key)
2830
3352
                    prefix='clients-',
2831
3353
                    dir=os.path.dirname(stored_state_path),
2832
3354
                    delete=False) as stored_state:
2833
 
                pickle.dump((clients, client_settings), stored_state)
 
3355
                pickle.dump((clients, client_settings), stored_state,
 
3356
                            protocol = 2)
2834
3357
                tempname = stored_state.name
2835
3358
            os.rename(tempname, stored_state_path)
2836
3359
        except (IOError, OSError) as e:
2852
3375
            name, client = tcp_server.clients.popitem()
2853
3376
            if use_dbus:
2854
3377
                client.remove_from_connection()
2855
 
            # Don't signal anything except ClientRemoved
 
3378
            # Don't signal the disabling
2856
3379
            client.disable(quiet=True)
 
3380
            # Emit D-Bus signal for removal
2857
3381
            if use_dbus:
2858
 
                # Emit D-Bus signal
2859
 
                mandos_dbus_service.ClientRemoved(
2860
 
                    client.dbus_object_path, client.name)
 
3382
                mandos_dbus_service.client_removed_signal(client)
2861
3383
        client_settings.clear()
2862
3384
    
2863
3385
    atexit.register(cleanup)
2864
3386
    
2865
 
    for client in tcp_server.clients.itervalues():
 
3387
    for client in tcp_server.clients.values():
2866
3388
        if use_dbus:
2867
 
            # Emit D-Bus signal
2868
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3389
            # Emit D-Bus signal for adding
 
3390
            mandos_dbus_service.client_added_signal(client)
2869
3391
        # Need to initiate checking of clients
2870
3392
        if client.enabled:
2871
3393
            client.init_checker()
2897
3419
                sys.exit(1)
2898
3420
            # End of Avahi example code
2899
3421
        
2900
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2901
 
                             lambda *args, **kwargs:
2902
 
                             (tcp_server.handle_request
2903
 
                              (*args[2:], **kwargs) or True))
 
3422
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3423
                          lambda *args, **kwargs:
 
3424
                          (tcp_server.handle_request
 
3425
                           (*args[2:], **kwargs) or True))
2904
3426
        
2905
3427
        logger.debug("Starting main loop")
2906
3428
        main_loop.run()