/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-06-23 19:19:33 UTC
  • Revision ID: teddy@recompile.se-20160623191933-ex460e9wi5w34ejy
Fix typo in mandos-clients.conf(5).

* mandos-clients.conf.xml (OPTIONS/--fingerprint): Spell "hexadecimal"
                                                   correctly.

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
 
import SocketServer as socketserver
 
42
try:
 
43
    import SocketServer as socketserver
 
44
except ImportError:
 
45
    import socketserver
40
46
import socket
41
47
import argparse
42
48
import datetime
43
49
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
 
50
try:
 
51
    import ConfigParser as configparser
 
52
except ImportError:
 
53
    import configparser
51
54
import sys
52
55
import re
53
56
import os
62
65
import struct
63
66
import fcntl
64
67
import functools
65
 
import cPickle as pickle
 
68
try:
 
69
    import cPickle as pickle
 
70
except ImportError:
 
71
    import pickle
66
72
import multiprocessing
67
73
import types
68
74
import binascii
69
75
import tempfile
70
76
import itertools
71
77
import collections
 
78
import codecs
72
79
 
73
80
import dbus
74
81
import dbus.service
75
 
import gobject
76
 
import avahi
 
82
from gi.repository import GLib
77
83
from dbus.mainloop.glib import DBusGMainLoop
78
84
import ctypes
79
85
import ctypes.util
80
86
import xml.dom.minidom
81
87
import inspect
82
88
 
 
89
# Try to find the value of SO_BINDTODEVICE:
83
90
try:
 
91
    # This is where SO_BINDTODEVICE is in Python 3.3 (or 3.4?) and
 
92
    # newer, and it is also the most natural place for it:
84
93
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
85
94
except AttributeError:
86
95
    try:
 
96
        # This is where SO_BINDTODEVICE was up to and including Python
 
97
        # 2.6, and also 3.2:
87
98
        from IN import SO_BINDTODEVICE
88
99
    except ImportError:
89
 
        SO_BINDTODEVICE = None
 
100
        # In Python 2.7 it seems to have been removed entirely.
 
101
        # Try running the C preprocessor:
 
102
        try:
 
103
            cc = subprocess.Popen(["cc", "--language=c", "-E",
 
104
                                   "/dev/stdin"],
 
105
                                  stdin=subprocess.PIPE,
 
106
                                  stdout=subprocess.PIPE)
 
107
            stdout = cc.communicate(
 
108
                "#include <sys/socket.h>\nSO_BINDTODEVICE\n")[0]
 
109
            SO_BINDTODEVICE = int(stdout.splitlines()[-1])
 
110
        except (OSError, ValueError, IndexError):
 
111
            # No value found
 
112
            SO_BINDTODEVICE = None
90
113
 
91
114
if sys.version_info.major == 2:
92
115
    str = unicode
93
116
 
94
 
version = "1.6.9"
 
117
version = "1.7.9"
95
118
stored_state_file = "clients.pickle"
96
119
 
97
120
logger = logging.getLogger()
112
135
        return interface_index
113
136
 
114
137
 
 
138
def copy_function(func):
 
139
    """Make a copy of a function"""
 
140
    if sys.version_info.major == 2:
 
141
        return types.FunctionType(func.func_code,
 
142
                                  func.func_globals,
 
143
                                  func.func_name,
 
144
                                  func.func_defaults,
 
145
                                  func.func_closure)
 
146
    else:
 
147
        return types.FunctionType(func.__code__,
 
148
                                  func.__globals__,
 
149
                                  func.__name__,
 
150
                                  func.__defaults__,
 
151
                                  func.__closure__)
 
152
 
 
153
 
115
154
def initlogger(debug, level=logging.WARNING):
116
155
    """init logger and add loglevel"""
117
156
    
144
183
    
145
184
    def __init__(self):
146
185
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
186
        self.gpg = "gpg"
 
187
        try:
 
188
            output = subprocess.check_output(["gpgconf"])
 
189
            for line in output.splitlines():
 
190
                name, text, path = line.split(b":")
 
191
                if name == "gpg":
 
192
                    self.gpg = path
 
193
                    break
 
194
        except OSError as e:
 
195
            if e.errno != errno.ENOENT:
 
196
                raise
147
197
        self.gnupgargs = ['--batch',
148
 
                          '--home', self.tempdir,
 
198
                          '--homedir', self.tempdir,
149
199
                          '--force-mdc',
150
 
                          '--quiet',
151
 
                          '--no-use-agent']
 
200
                          '--quiet']
 
201
        # Only GPG version 1 has the --no-use-agent option.
 
202
        if self.gpg == "gpg" or self.gpg.endswith("/gpg"):
 
203
            self.gnupgargs.append("--no-use-agent")
152
204
    
153
205
    def __enter__(self):
154
206
        return self
190
242
                dir=self.tempdir) as passfile:
191
243
            passfile.write(passphrase)
192
244
            passfile.flush()
193
 
            proc = subprocess.Popen(['gpg', '--symmetric',
 
245
            proc = subprocess.Popen([self.gpg, '--symmetric',
194
246
                                     '--passphrase-file',
195
247
                                     passfile.name]
196
248
                                    + self.gnupgargs,
208
260
                dir = self.tempdir) as passfile:
209
261
            passfile.write(passphrase)
210
262
            passfile.flush()
211
 
            proc = subprocess.Popen(['gpg', '--decrypt',
 
263
            proc = subprocess.Popen([self.gpg, '--decrypt',
212
264
                                     '--passphrase-file',
213
265
                                     passfile.name]
214
266
                                    + self.gnupgargs,
220
272
            raise PGPError(err)
221
273
        return decrypted_plaintext
222
274
 
 
275
# Pretend that we have an Avahi module
 
276
class Avahi(object):
 
277
    """This isn't so much a class as it is a module-like namespace.
 
278
    It is instantiated once, and simulates having an Avahi module."""
 
279
    IF_UNSPEC = -1              # avahi-common/address.h
 
280
    PROTO_UNSPEC = -1           # avahi-common/address.h
 
281
    PROTO_INET = 0              # avahi-common/address.h
 
282
    PROTO_INET6 = 1             # avahi-common/address.h
 
283
    DBUS_NAME = "org.freedesktop.Avahi"
 
284
    DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
 
285
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
 
286
    DBUS_PATH_SERVER = "/"
 
287
    def string_array_to_txt_array(self, t):
 
288
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
 
289
                           for s in t), signature="ay")
 
290
    ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
 
291
    ENTRY_GROUP_COLLISION = 3   # avahi-common/defs.h
 
292
    ENTRY_GROUP_FAILURE = 4     # avahi-common/defs.h
 
293
    SERVER_INVALID = 0          # avahi-common/defs.h
 
294
    SERVER_REGISTERING = 1      # avahi-common/defs.h
 
295
    SERVER_RUNNING = 2          # avahi-common/defs.h
 
296
    SERVER_COLLISION = 3        # avahi-common/defs.h
 
297
    SERVER_FAILURE = 4          # avahi-common/defs.h
 
298
avahi = Avahi()
223
299
 
224
300
class AvahiError(Exception):
225
301
    def __init__(self, value, *args, **kwargs):
382
458
                    logger.error(bad_states[state] + ": %r", error)
383
459
            self.cleanup()
384
460
        elif state == avahi.SERVER_RUNNING:
385
 
            self.add()
 
461
            try:
 
462
                self.add()
 
463
            except dbus.exceptions.DBusException as error:
 
464
                if (error.get_dbus_name()
 
465
                    == "org.freedesktop.Avahi.CollisionError"):
 
466
                    logger.info("Local Zeroconf service name"
 
467
                                " collision.")
 
468
                    return self.rename(remove=False)
 
469
                else:
 
470
                    logger.critical("D-Bus Exception", exc_info=error)
 
471
                    self.cleanup()
 
472
                    os._exit(1)
386
473
        else:
387
474
            if error is None:
388
475
                logger.debug("Unknown state: %r", state)
411
498
            .format(self.name)))
412
499
        return ret
413
500
 
 
501
# Pretend that we have a GnuTLS module
 
502
class GnuTLS(object):
 
503
    """This isn't so much a class as it is a module-like namespace.
 
504
    It is instantiated once, and simulates having a GnuTLS module."""
 
505
    
 
506
    _library = ctypes.cdll.LoadLibrary(
 
507
        ctypes.util.find_library("gnutls"))
 
508
    _need_version = b"3.3.0"
 
509
    def __init__(self):
 
510
        # Need to use class name "GnuTLS" here, since this method is
 
511
        # called before the assignment to the "gnutls" global variable
 
512
        # happens.
 
513
        if GnuTLS.check_version(self._need_version) is None:
 
514
            raise GnuTLS.Error("Needs GnuTLS {} or later"
 
515
                               .format(self._need_version))
 
516
    
 
517
    # Unless otherwise indicated, the constants and types below are
 
518
    # all from the gnutls/gnutls.h C header file.
 
519
    
 
520
    # Constants
 
521
    E_SUCCESS = 0
 
522
    E_INTERRUPTED = -52
 
523
    E_AGAIN = -28
 
524
    CRT_OPENPGP = 2
 
525
    CLIENT = 2
 
526
    SHUT_RDWR = 0
 
527
    CRD_CERTIFICATE = 1
 
528
    E_NO_CERTIFICATE_FOUND = -49
 
529
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
 
530
    
 
531
    # Types
 
532
    class session_int(ctypes.Structure):
 
533
        _fields_ = []
 
534
    session_t = ctypes.POINTER(session_int)
 
535
    class certificate_credentials_st(ctypes.Structure):
 
536
        _fields_ = []
 
537
    certificate_credentials_t = ctypes.POINTER(
 
538
        certificate_credentials_st)
 
539
    certificate_type_t = ctypes.c_int
 
540
    class datum_t(ctypes.Structure):
 
541
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
542
                    ('size', ctypes.c_uint)]
 
543
    class openpgp_crt_int(ctypes.Structure):
 
544
        _fields_ = []
 
545
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
546
    openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
 
547
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
 
548
    credentials_type_t = ctypes.c_int
 
549
    transport_ptr_t = ctypes.c_void_p
 
550
    close_request_t = ctypes.c_int
 
551
    
 
552
    # Exceptions
 
553
    class Error(Exception):
 
554
        # We need to use the class name "GnuTLS" here, since this
 
555
        # exception might be raised from within GnuTLS.__init__,
 
556
        # which is called before the assignment to the "gnutls"
 
557
        # global variable has happened.
 
558
        def __init__(self, message = None, code = None, args=()):
 
559
            # Default usage is by a message string, but if a return
 
560
            # code is passed, convert it to a string with
 
561
            # gnutls.strerror()
 
562
            self.code = code
 
563
            if message is None and code is not None:
 
564
                message = GnuTLS.strerror(code)
 
565
            return super(GnuTLS.Error, self).__init__(
 
566
                message, *args)
 
567
    
 
568
    class CertificateSecurityError(Error):
 
569
        pass
 
570
    
 
571
    # Classes
 
572
    class Credentials(object):
 
573
        def __init__(self):
 
574
            self._c_object = gnutls.certificate_credentials_t()
 
575
            gnutls.certificate_allocate_credentials(
 
576
                ctypes.byref(self._c_object))
 
577
            self.type = gnutls.CRD_CERTIFICATE
 
578
        
 
579
        def __del__(self):
 
580
            gnutls.certificate_free_credentials(self._c_object)
 
581
    
 
582
    class ClientSession(object):
 
583
        def __init__(self, socket, credentials = None):
 
584
            self._c_object = gnutls.session_t()
 
585
            gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
 
586
            gnutls.set_default_priority(self._c_object)
 
587
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
588
            gnutls.handshake_set_private_extensions(self._c_object,
 
589
                                                    True)
 
590
            self.socket = socket
 
591
            if credentials is None:
 
592
                credentials = gnutls.Credentials()
 
593
            gnutls.credentials_set(self._c_object, credentials.type,
 
594
                                   ctypes.cast(credentials._c_object,
 
595
                                               ctypes.c_void_p))
 
596
            self.credentials = credentials
 
597
        
 
598
        def __del__(self):
 
599
            gnutls.deinit(self._c_object)
 
600
        
 
601
        def handshake(self):
 
602
            return gnutls.handshake(self._c_object)
 
603
        
 
604
        def send(self, data):
 
605
            data = bytes(data)
 
606
            data_len = len(data)
 
607
            while data_len > 0:
 
608
                data_len -= gnutls.record_send(self._c_object,
 
609
                                               data[-data_len:],
 
610
                                               data_len)
 
611
        
 
612
        def bye(self):
 
613
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
614
    
 
615
    # Error handling functions
 
616
    def _error_code(result):
 
617
        """A function to raise exceptions on errors, suitable
 
618
        for the 'restype' attribute on ctypes functions"""
 
619
        if result >= 0:
 
620
            return result
 
621
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
 
622
            raise gnutls.CertificateSecurityError(code = result)
 
623
        raise gnutls.Error(code = result)
 
624
    
 
625
    def _retry_on_error(result, func, arguments):
 
626
        """A function to retry on some errors, suitable
 
627
        for the 'errcheck' attribute on ctypes functions"""
 
628
        while result < 0:
 
629
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
 
630
                return _error_code(result)
 
631
            result = func(*arguments)
 
632
        return result
 
633
    
 
634
    # Unless otherwise indicated, the function declarations below are
 
635
    # all from the gnutls/gnutls.h C header file.
 
636
    
 
637
    # Functions
 
638
    priority_set_direct = _library.gnutls_priority_set_direct
 
639
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
640
                                    ctypes.POINTER(ctypes.c_char_p)]
 
641
    priority_set_direct.restype = _error_code
 
642
    
 
643
    init = _library.gnutls_init
 
644
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
645
    init.restype = _error_code
 
646
    
 
647
    set_default_priority = _library.gnutls_set_default_priority
 
648
    set_default_priority.argtypes = [session_t]
 
649
    set_default_priority.restype = _error_code
 
650
    
 
651
    record_send = _library.gnutls_record_send
 
652
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
653
                            ctypes.c_size_t]
 
654
    record_send.restype = ctypes.c_ssize_t
 
655
    record_send.errcheck = _retry_on_error
 
656
    
 
657
    certificate_allocate_credentials = (
 
658
        _library.gnutls_certificate_allocate_credentials)
 
659
    certificate_allocate_credentials.argtypes = [
 
660
        ctypes.POINTER(certificate_credentials_t)]
 
661
    certificate_allocate_credentials.restype = _error_code
 
662
    
 
663
    certificate_free_credentials = (
 
664
        _library.gnutls_certificate_free_credentials)
 
665
    certificate_free_credentials.argtypes = [certificate_credentials_t]
 
666
    certificate_free_credentials.restype = None
 
667
    
 
668
    handshake_set_private_extensions = (
 
669
        _library.gnutls_handshake_set_private_extensions)
 
670
    handshake_set_private_extensions.argtypes = [session_t,
 
671
                                                 ctypes.c_int]
 
672
    handshake_set_private_extensions.restype = None
 
673
    
 
674
    credentials_set = _library.gnutls_credentials_set
 
675
    credentials_set.argtypes = [session_t, credentials_type_t,
 
676
                                ctypes.c_void_p]
 
677
    credentials_set.restype = _error_code
 
678
    
 
679
    strerror = _library.gnutls_strerror
 
680
    strerror.argtypes = [ctypes.c_int]
 
681
    strerror.restype = ctypes.c_char_p
 
682
    
 
683
    certificate_type_get = _library.gnutls_certificate_type_get
 
684
    certificate_type_get.argtypes = [session_t]
 
685
    certificate_type_get.restype = _error_code
 
686
    
 
687
    certificate_get_peers = _library.gnutls_certificate_get_peers
 
688
    certificate_get_peers.argtypes = [session_t,
 
689
                                      ctypes.POINTER(ctypes.c_uint)]
 
690
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
 
691
    
 
692
    global_set_log_level = _library.gnutls_global_set_log_level
 
693
    global_set_log_level.argtypes = [ctypes.c_int]
 
694
    global_set_log_level.restype = None
 
695
    
 
696
    global_set_log_function = _library.gnutls_global_set_log_function
 
697
    global_set_log_function.argtypes = [log_func]
 
698
    global_set_log_function.restype = None
 
699
    
 
700
    deinit = _library.gnutls_deinit
 
701
    deinit.argtypes = [session_t]
 
702
    deinit.restype = None
 
703
    
 
704
    handshake = _library.gnutls_handshake
 
705
    handshake.argtypes = [session_t]
 
706
    handshake.restype = _error_code
 
707
    handshake.errcheck = _retry_on_error
 
708
    
 
709
    transport_set_ptr = _library.gnutls_transport_set_ptr
 
710
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
711
    transport_set_ptr.restype = None
 
712
    
 
713
    bye = _library.gnutls_bye
 
714
    bye.argtypes = [session_t, close_request_t]
 
715
    bye.restype = _error_code
 
716
    bye.errcheck = _retry_on_error
 
717
    
 
718
    check_version = _library.gnutls_check_version
 
719
    check_version.argtypes = [ctypes.c_char_p]
 
720
    check_version.restype = ctypes.c_char_p
 
721
    
 
722
    # All the function declarations below are from gnutls/openpgp.h
 
723
    
 
724
    openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
725
    openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
726
    openpgp_crt_init.restype = _error_code
 
727
    
 
728
    openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
729
    openpgp_crt_import.argtypes = [openpgp_crt_t,
 
730
                                   ctypes.POINTER(datum_t),
 
731
                                   openpgp_crt_fmt_t]
 
732
    openpgp_crt_import.restype = _error_code
 
733
    
 
734
    openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
735
    openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
736
                                        ctypes.POINTER(ctypes.c_uint)]
 
737
    openpgp_crt_verify_self.restype = _error_code
 
738
    
 
739
    openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
740
    openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
741
    openpgp_crt_deinit.restype = None
 
742
    
 
743
    openpgp_crt_get_fingerprint = (
 
744
        _library.gnutls_openpgp_crt_get_fingerprint)
 
745
    openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
746
                                            ctypes.c_void_p,
 
747
                                            ctypes.POINTER(
 
748
                                                ctypes.c_size_t)]
 
749
    openpgp_crt_get_fingerprint.restype = _error_code
 
750
    
 
751
    # Remove non-public functions
 
752
    del _error_code, _retry_on_error
 
753
# Create the global "gnutls" object, simulating a module
 
754
gnutls = GnuTLS()
 
755
 
 
756
def call_pipe(connection,       # : multiprocessing.Connection
 
757
              func, *args, **kwargs):
 
758
    """This function is meant to be called by multiprocessing.Process
 
759
    
 
760
    This function runs func(*args, **kwargs), and writes the resulting
 
761
    return value on the provided multiprocessing.Connection.
 
762
    """
 
763
    connection.send(func(*args, **kwargs))
 
764
    connection.close()
414
765
 
415
766
class Client(object):
416
767
    """A representation of a client host served by this server.
422
773
    checker:    subprocess.Popen(); a running checker process used
423
774
                                    to see if the client lives.
424
775
                                    'None' if no process is running.
425
 
    checker_callback_tag: a gobject event source tag, or None
 
776
    checker_callback_tag: a GLib event source tag, or None
426
777
    checker_command: string; External command which is run to check
427
778
                     if client lives.  %() expansions are done at
428
779
                     runtime with vars(self) as dict, so that for
429
780
                     instance %(name)s can be used in the command.
430
 
    checker_initiator_tag: a gobject event source tag, or None
 
781
    checker_initiator_tag: a GLib event source tag, or None
431
782
    created:    datetime.datetime(); (UTC) object creation
432
783
    client_structure: Object describing what attributes a client has
433
784
                      and is used for storing the client at exit
434
785
    current_checker_command: string; current running checker_command
435
 
    disable_initiator_tag: a gobject event source tag, or None
 
786
    disable_initiator_tag: a GLib event source tag, or None
436
787
    enabled:    bool()
437
788
    fingerprint: string (40 or 32 hexadecimal digits); used to
438
789
                 uniquely identify the client
443
794
    last_checker_status: integer between 0 and 255 reflecting exit
444
795
                         status of last checker. -1 reflects crashed
445
796
                         checker, -2 means no checker completed yet.
 
797
    last_checker_signal: The signal which killed the last checker, if
 
798
                         last_checker_status is -1
446
799
    last_enabled: datetime.datetime(); (UTC) or None
447
800
    name:       string; from the config file, used in log messages and
448
801
                        D-Bus identifiers
499
852
            client["fingerprint"] = (section["fingerprint"].upper()
500
853
                                     .replace(" ", ""))
501
854
            if "secret" in section:
502
 
                client["secret"] = section["secret"].decode("base64")
 
855
                client["secret"] = codecs.decode(section["secret"]
 
856
                                                 .encode("utf-8"),
 
857
                                                 "base64")
503
858
            elif "secfile" in section:
504
859
                with open(os.path.expanduser(os.path.expandvars
505
860
                                             (section["secfile"])),
558
913
        self.changedstate = multiprocessing_manager.Condition(
559
914
            multiprocessing_manager.Lock())
560
915
        self.client_structure = [attr
561
 
                                 for attr in self.__dict__.iterkeys()
 
916
                                 for attr in self.__dict__.keys()
562
917
                                 if not attr.startswith("_")]
563
918
        self.client_structure.append("client_structure")
564
919
        
590
945
        if not quiet:
591
946
            logger.info("Disabling client %s", self.name)
592
947
        if getattr(self, "disable_initiator_tag", None) is not None:
593
 
            gobject.source_remove(self.disable_initiator_tag)
 
948
            GLib.source_remove(self.disable_initiator_tag)
594
949
            self.disable_initiator_tag = None
595
950
        self.expires = None
596
951
        if getattr(self, "checker_initiator_tag", None) is not None:
597
 
            gobject.source_remove(self.checker_initiator_tag)
 
952
            GLib.source_remove(self.checker_initiator_tag)
598
953
            self.checker_initiator_tag = None
599
954
        self.stop_checker()
600
955
        self.enabled = False
601
956
        if not quiet:
602
957
            self.send_changedstate()
603
 
        # Do not run this again if called by a gobject.timeout_add
 
958
        # Do not run this again if called by a GLib.timeout_add
604
959
        return False
605
960
    
606
961
    def __del__(self):
610
965
        # Schedule a new checker to be started an 'interval' from now,
611
966
        # and every interval from then on.
612
967
        if self.checker_initiator_tag is not None:
613
 
            gobject.source_remove(self.checker_initiator_tag)
614
 
        self.checker_initiator_tag = gobject.timeout_add(
 
968
            GLib.source_remove(self.checker_initiator_tag)
 
969
        self.checker_initiator_tag = GLib.timeout_add(
615
970
            int(self.interval.total_seconds() * 1000),
616
971
            self.start_checker)
617
972
        # Schedule a disable() when 'timeout' has passed
618
973
        if self.disable_initiator_tag is not None:
619
 
            gobject.source_remove(self.disable_initiator_tag)
620
 
        self.disable_initiator_tag = gobject.timeout_add(
 
974
            GLib.source_remove(self.disable_initiator_tag)
 
975
        self.disable_initiator_tag = GLib.timeout_add(
621
976
            int(self.timeout.total_seconds() * 1000), self.disable)
622
977
        # Also start a new checker *right now*.
623
978
        self.start_checker()
624
979
    
625
 
    def checker_callback(self, pid, condition, command):
 
980
    def checker_callback(self, source, condition, connection,
 
981
                         command):
626
982
        """The checker has completed, so take appropriate actions."""
627
983
        self.checker_callback_tag = None
628
984
        self.checker = None
629
 
        if os.WIFEXITED(condition):
630
 
            self.last_checker_status = os.WEXITSTATUS(condition)
 
985
        # Read return code from connection (see call_pipe)
 
986
        returncode = connection.recv()
 
987
        connection.close()
 
988
        
 
989
        if returncode >= 0:
 
990
            self.last_checker_status = returncode
 
991
            self.last_checker_signal = None
631
992
            if self.last_checker_status == 0:
632
993
                logger.info("Checker for %(name)s succeeded",
633
994
                            vars(self))
636
997
                logger.info("Checker for %(name)s failed", vars(self))
637
998
        else:
638
999
            self.last_checker_status = -1
 
1000
            self.last_checker_signal = -returncode
639
1001
            logger.warning("Checker for %(name)s crashed?",
640
1002
                           vars(self))
 
1003
        return False
641
1004
    
642
1005
    def checked_ok(self):
643
1006
        """Assert that the client has been seen, alive and well."""
644
1007
        self.last_checked_ok = datetime.datetime.utcnow()
645
1008
        self.last_checker_status = 0
 
1009
        self.last_checker_signal = None
646
1010
        self.bump_timeout()
647
1011
    
648
1012
    def bump_timeout(self, timeout=None):
650
1014
        if timeout is None:
651
1015
            timeout = self.timeout
652
1016
        if self.disable_initiator_tag is not None:
653
 
            gobject.source_remove(self.disable_initiator_tag)
 
1017
            GLib.source_remove(self.disable_initiator_tag)
654
1018
            self.disable_initiator_tag = None
655
1019
        if getattr(self, "enabled", False):
656
 
            self.disable_initiator_tag = gobject.timeout_add(
 
1020
            self.disable_initiator_tag = GLib.timeout_add(
657
1021
                int(timeout.total_seconds() * 1000), self.disable)
658
1022
            self.expires = datetime.datetime.utcnow() + timeout
659
1023
    
674
1038
        # than 'timeout' for the client to be disabled, which is as it
675
1039
        # should be.
676
1040
        
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)
 
1041
        if self.checker is not None and not self.checker.is_alive():
 
1042
            logger.warning("Checker was not alive; joining")
 
1043
            self.checker.join()
 
1044
            self.checker = None
691
1045
        # Start a new checker if needed
692
1046
        if self.checker is None:
693
1047
            # Escape attributes for the shell
702
1056
                             exc_info=error)
703
1057
                return True     # Try again later
704
1058
            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
 
1059
            logger.info("Starting checker %r for %s", command,
 
1060
                        self.name)
 
1061
            # We don't need to redirect stdout and stderr, since
 
1062
            # in normal mode, that is already done by daemon(),
 
1063
            # and in debug mode we don't want to.  (Stdin is
 
1064
            # always replaced by /dev/null.)
 
1065
            # The exception is when not debugging but nevertheless
 
1066
            # running in the foreground; use the previously
 
1067
            # created wnull.
 
1068
            popen_args = { "close_fds": True,
 
1069
                           "shell": True,
 
1070
                           "cwd": "/" }
 
1071
            if (not self.server_settings["debug"]
 
1072
                and self.server_settings["foreground"]):
 
1073
                popen_args.update({"stdout": wnull,
 
1074
                                   "stderr": wnull })
 
1075
            pipe = multiprocessing.Pipe(duplex = False)
 
1076
            self.checker = multiprocessing.Process(
 
1077
                target = call_pipe,
 
1078
                args = (pipe[1], subprocess.call, command),
 
1079
                kwargs = popen_args)
 
1080
            self.checker.start()
 
1081
            self.checker_callback_tag = GLib.io_add_watch(
 
1082
                pipe[0].fileno(), GLib.IO_IN,
 
1083
                self.checker_callback, pipe[0], command)
 
1084
        # Re-run this periodically if run by GLib.timeout_add
746
1085
        return True
747
1086
    
748
1087
    def stop_checker(self):
749
1088
        """Force the checker process, if any, to stop."""
750
1089
        if self.checker_callback_tag:
751
 
            gobject.source_remove(self.checker_callback_tag)
 
1090
            GLib.source_remove(self.checker_callback_tag)
752
1091
            self.checker_callback_tag = None
753
1092
        if getattr(self, "checker", None) is None:
754
1093
            return
755
1094
        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
 
1095
        self.checker.terminate()
764
1096
        self.checker = None
765
1097
 
766
1098
 
830
1162
                           access="r")
831
1163
    def Property_dbus_property(self):
832
1164
        return dbus.Boolean(False)
 
1165
    
 
1166
    See also the DBusObjectWithAnnotations class.
833
1167
    """
834
1168
    
835
1169
    def decorator(func):
857
1191
    pass
858
1192
 
859
1193
 
860
 
class DBusObjectWithProperties(dbus.service.Object):
861
 
    """A D-Bus object with properties.
 
1194
class DBusObjectWithAnnotations(dbus.service.Object):
 
1195
    """A D-Bus object with annotations.
862
1196
    
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.
 
1197
    Classes inheriting from this can use the dbus_annotations
 
1198
    decorator to add annotations to methods or signals.
866
1199
    """
867
1200
    
868
1201
    @staticmethod
884
1217
                for name, athing in
885
1218
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
886
1219
    
 
1220
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1221
                         out_signature = "s",
 
1222
                         path_keyword = 'object_path',
 
1223
                         connection_keyword = 'connection')
 
1224
    def Introspect(self, object_path, connection):
 
1225
        """Overloading of standard D-Bus method.
 
1226
        
 
1227
        Inserts annotation tags on methods and signals.
 
1228
        """
 
1229
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
1230
                                                   connection)
 
1231
        try:
 
1232
            document = xml.dom.minidom.parseString(xmlstring)
 
1233
            
 
1234
            for if_tag in document.getElementsByTagName("interface"):
 
1235
                # Add annotation tags
 
1236
                for typ in ("method", "signal"):
 
1237
                    for tag in if_tag.getElementsByTagName(typ):
 
1238
                        annots = dict()
 
1239
                        for name, prop in (self.
 
1240
                                           _get_all_dbus_things(typ)):
 
1241
                            if (name == tag.getAttribute("name")
 
1242
                                and prop._dbus_interface
 
1243
                                == if_tag.getAttribute("name")):
 
1244
                                annots.update(getattr(
 
1245
                                    prop, "_dbus_annotations", {}))
 
1246
                        for name, value in annots.items():
 
1247
                            ann_tag = document.createElement(
 
1248
                                "annotation")
 
1249
                            ann_tag.setAttribute("name", name)
 
1250
                            ann_tag.setAttribute("value", value)
 
1251
                            tag.appendChild(ann_tag)
 
1252
                # Add interface annotation tags
 
1253
                for annotation, value in dict(
 
1254
                    itertools.chain.from_iterable(
 
1255
                        annotations().items()
 
1256
                        for name, annotations
 
1257
                        in self._get_all_dbus_things("interface")
 
1258
                        if name == if_tag.getAttribute("name")
 
1259
                        )).items():
 
1260
                    ann_tag = document.createElement("annotation")
 
1261
                    ann_tag.setAttribute("name", annotation)
 
1262
                    ann_tag.setAttribute("value", value)
 
1263
                    if_tag.appendChild(ann_tag)
 
1264
                # Fix argument name for the Introspect method itself
 
1265
                if (if_tag.getAttribute("name")
 
1266
                                == dbus.INTROSPECTABLE_IFACE):
 
1267
                    for cn in if_tag.getElementsByTagName("method"):
 
1268
                        if cn.getAttribute("name") == "Introspect":
 
1269
                            for arg in cn.getElementsByTagName("arg"):
 
1270
                                if (arg.getAttribute("direction")
 
1271
                                    == "out"):
 
1272
                                    arg.setAttribute("name",
 
1273
                                                     "xml_data")
 
1274
            xmlstring = document.toxml("utf-8")
 
1275
            document.unlink()
 
1276
        except (AttributeError, xml.dom.DOMException,
 
1277
                xml.parsers.expat.ExpatError) as error:
 
1278
            logger.error("Failed to override Introspection method",
 
1279
                         exc_info=error)
 
1280
        return xmlstring
 
1281
 
 
1282
 
 
1283
class DBusObjectWithProperties(DBusObjectWithAnnotations):
 
1284
    """A D-Bus object with properties.
 
1285
    
 
1286
    Classes inheriting from this can use the dbus_service_property
 
1287
    decorator to expose methods as D-Bus properties.  It exposes the
 
1288
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
1289
    """
 
1290
    
887
1291
    def _get_dbus_property(self, interface_name, property_name):
888
1292
        """Returns a bound method if one exists which is a D-Bus
889
1293
        property with the specified name and interface.
899
1303
        raise DBusPropertyNotFound("{}:{}.{}".format(
900
1304
            self.dbus_object_path, interface_name, property_name))
901
1305
    
 
1306
    @classmethod
 
1307
    def _get_all_interface_names(cls):
 
1308
        """Get a sequence of all interfaces supported by an object"""
 
1309
        return (name for name in set(getattr(getattr(x, attr),
 
1310
                                             "_dbus_interface", None)
 
1311
                                     for x in (inspect.getmro(cls))
 
1312
                                     for attr in dir(x))
 
1313
                if name is not None)
 
1314
    
902
1315
    @dbus.service.method(dbus.PROPERTIES_IFACE,
903
1316
                         in_signature="ss",
904
1317
                         out_signature="v")
974
1387
        
975
1388
        Inserts property tags and interface annotation tags.
976
1389
        """
977
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
978
 
                                                   connection)
 
1390
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1391
                                                         object_path,
 
1392
                                                         connection)
979
1393
        try:
980
1394
            document = xml.dom.minidom.parseString(xmlstring)
981
1395
            
994
1408
                            if prop._dbus_interface
995
1409
                            == if_tag.getAttribute("name")):
996
1410
                    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)
 
1411
                # Add annotation tags for properties
 
1412
                for tag in if_tag.getElementsByTagName("property"):
 
1413
                    annots = dict()
 
1414
                    for name, prop in self._get_all_dbus_things(
 
1415
                            "property"):
 
1416
                        if (name == tag.getAttribute("name")
 
1417
                            and prop._dbus_interface
 
1418
                            == if_tag.getAttribute("name")):
 
1419
                            annots.update(getattr(
 
1420
                                prop, "_dbus_annotations", {}))
 
1421
                    for name, value in annots.items():
 
1422
                        ann_tag = document.createElement(
 
1423
                            "annotation")
 
1424
                        ann_tag.setAttribute("name", name)
 
1425
                        ann_tag.setAttribute("value", value)
 
1426
                        tag.appendChild(ann_tag)
1026
1427
                # Add the names to the return values for the
1027
1428
                # "org.freedesktop.DBus.Properties" methods
1028
1429
                if (if_tag.getAttribute("name")
1046
1447
                         exc_info=error)
1047
1448
        return xmlstring
1048
1449
 
 
1450
try:
 
1451
    dbus.OBJECT_MANAGER_IFACE
 
1452
except AttributeError:
 
1453
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
1454
 
 
1455
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
 
1456
    """A D-Bus object with an ObjectManager.
 
1457
    
 
1458
    Classes inheriting from this exposes the standard
 
1459
    GetManagedObjects call and the InterfacesAdded and
 
1460
    InterfacesRemoved signals on the standard
 
1461
    "org.freedesktop.DBus.ObjectManager" interface.
 
1462
    
 
1463
    Note: No signals are sent automatically; they must be sent
 
1464
    manually.
 
1465
    """
 
1466
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
1467
                         out_signature = "a{oa{sa{sv}}}")
 
1468
    def GetManagedObjects(self):
 
1469
        """This function must be overridden"""
 
1470
        raise NotImplementedError()
 
1471
    
 
1472
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
 
1473
                         signature = "oa{sa{sv}}")
 
1474
    def InterfacesAdded(self, object_path, interfaces_and_properties):
 
1475
        pass
 
1476
    
 
1477
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
 
1478
    def InterfacesRemoved(self, object_path, interfaces):
 
1479
        pass
 
1480
    
 
1481
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1482
                         out_signature = "s",
 
1483
                         path_keyword = 'object_path',
 
1484
                         connection_keyword = 'connection')
 
1485
    def Introspect(self, object_path, connection):
 
1486
        """Overloading of standard D-Bus method.
 
1487
        
 
1488
        Override return argument name of GetManagedObjects to be
 
1489
        "objpath_interfaces_and_properties"
 
1490
        """
 
1491
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1492
                                                         object_path,
 
1493
                                                         connection)
 
1494
        try:
 
1495
            document = xml.dom.minidom.parseString(xmlstring)
 
1496
            
 
1497
            for if_tag in document.getElementsByTagName("interface"):
 
1498
                # Fix argument name for the GetManagedObjects method
 
1499
                if (if_tag.getAttribute("name")
 
1500
                                == dbus.OBJECT_MANAGER_IFACE):
 
1501
                    for cn in if_tag.getElementsByTagName("method"):
 
1502
                        if (cn.getAttribute("name")
 
1503
                            == "GetManagedObjects"):
 
1504
                            for arg in cn.getElementsByTagName("arg"):
 
1505
                                if (arg.getAttribute("direction")
 
1506
                                    == "out"):
 
1507
                                    arg.setAttribute(
 
1508
                                        "name",
 
1509
                                        "objpath_interfaces"
 
1510
                                        "_and_properties")
 
1511
            xmlstring = document.toxml("utf-8")
 
1512
            document.unlink()
 
1513
        except (AttributeError, xml.dom.DOMException,
 
1514
                xml.parsers.expat.ExpatError) as error:
 
1515
            logger.error("Failed to override Introspection method",
 
1516
                         exc_info = error)
 
1517
        return xmlstring
1049
1518
 
1050
1519
def datetime_to_dbus(dt, variant_level=0):
1051
1520
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1100
1569
                if getattr(attribute, "_dbus_is_signal", False):
1101
1570
                    # Extract the original non-method undecorated
1102
1571
                    # function by black magic
1103
 
                    nonmethod_func = (dict(
1104
 
                        zip(attribute.func_code.co_freevars,
1105
 
                            attribute.__closure__))
1106
 
                                      ["func"].cell_contents)
 
1572
                    if sys.version_info.major == 2:
 
1573
                        nonmethod_func = (dict(
 
1574
                            zip(attribute.func_code.co_freevars,
 
1575
                                attribute.__closure__))
 
1576
                                          ["func"].cell_contents)
 
1577
                    else:
 
1578
                        nonmethod_func = (dict(
 
1579
                            zip(attribute.__code__.co_freevars,
 
1580
                                attribute.__closure__))
 
1581
                                          ["func"].cell_contents)
1107
1582
                    # Create a new, but exactly alike, function
1108
1583
                    # object, and decorate it to be a new D-Bus signal
1109
1584
                    # with the alternate D-Bus interface name
 
1585
                    new_function = copy_function(nonmethod_func)
1110
1586
                    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)))
 
1587
                        alt_interface,
 
1588
                        attribute._dbus_signature)(new_function))
1118
1589
                    # Copy annotations, if any
1119
1590
                    try:
1120
1591
                        new_function._dbus_annotations = dict(
1130
1601
                        func1 and func2 to the "call_both" function
1131
1602
                        outside of its arguments"""
1132
1603
                        
 
1604
                        @functools.wraps(func2)
1133
1605
                        def call_both(*args, **kwargs):
1134
1606
                            """This function will emit two D-Bus
1135
1607
                            signals by calling func1 and func2"""
1136
1608
                            func1(*args, **kwargs)
1137
1609
                            func2(*args, **kwargs)
 
1610
                        # Make wrapper function look like a D-Bus signal
 
1611
                        for name, attr in inspect.getmembers(func2):
 
1612
                            if name.startswith("_dbus_"):
 
1613
                                setattr(call_both, name, attr)
1138
1614
                        
1139
1615
                        return call_both
1140
1616
                    # Create the "call_both" function and add it to
1151
1627
                            alt_interface,
1152
1628
                            attribute._dbus_in_signature,
1153
1629
                            attribute._dbus_out_signature)
1154
 
                        (types.FunctionType(attribute.func_code,
1155
 
                                            attribute.func_globals,
1156
 
                                            attribute.func_name,
1157
 
                                            attribute.func_defaults,
1158
 
                                            attribute.func_closure)))
 
1630
                        (copy_function(attribute)))
1159
1631
                    # Copy annotations, if any
1160
1632
                    try:
1161
1633
                        attr[attrname]._dbus_annotations = dict(
1173
1645
                        attribute._dbus_access,
1174
1646
                        attribute._dbus_get_args_options
1175
1647
                        ["byte_arrays"])
1176
 
                                      (types.FunctionType(
1177
 
                                          attribute.func_code,
1178
 
                                          attribute.func_globals,
1179
 
                                          attribute.func_name,
1180
 
                                          attribute.func_defaults,
1181
 
                                          attribute.func_closure)))
 
1648
                                      (copy_function(attribute)))
1182
1649
                    # Copy annotations, if any
1183
1650
                    try:
1184
1651
                        attr[attrname]._dbus_annotations = dict(
1193
1660
                    # to the class.
1194
1661
                    attr[attrname] = (
1195
1662
                        dbus_interface_annotations(alt_interface)
1196
 
                        (types.FunctionType(attribute.func_code,
1197
 
                                            attribute.func_globals,
1198
 
                                            attribute.func_name,
1199
 
                                            attribute.func_defaults,
1200
 
                                            attribute.func_closure)))
 
1663
                        (copy_function(attribute)))
1201
1664
            if deprecate:
1202
1665
                # Deprecate all alternate interfaces
1203
1666
                iname="_AlternateDBusNames_interface_annotation{}"
1216
1679
            if interface_names:
1217
1680
                # Replace the class with a new subclass of it with
1218
1681
                # methods, signals, etc. as created above.
1219
 
                cls = type(b"{}Alternate".format(cls.__name__),
1220
 
                           (cls, ), attr)
 
1682
                if sys.version_info.major == 2:
 
1683
                    cls = type(b"{}Alternate".format(cls.__name__),
 
1684
                               (cls, ), attr)
 
1685
                else:
 
1686
                    cls = type("{}Alternate".format(cls.__name__),
 
1687
                               (cls, ), attr)
1221
1688
        return cls
1222
1689
    
1223
1690
    return wrapper
1343
1810
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1344
1811
        Client.__del__(self, *args, **kwargs)
1345
1812
    
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)
 
1813
    def checker_callback(self, source, condition,
 
1814
                         connection, command, *args, **kwargs):
 
1815
        ret = Client.checker_callback(self, source, condition,
 
1816
                                      connection, command, *args,
 
1817
                                      **kwargs)
 
1818
        exitstatus = self.last_checker_status
 
1819
        if exitstatus >= 0:
1352
1820
            # Emit D-Bus signal
1353
1821
            self.CheckerCompleted(dbus.Int16(exitstatus),
1354
 
                                  dbus.Int64(condition),
 
1822
                                  # This is specific to GNU libC
 
1823
                                  dbus.Int64(exitstatus << 8),
1355
1824
                                  dbus.String(command))
1356
1825
        else:
1357
1826
            # Emit D-Bus signal
1358
1827
            self.CheckerCompleted(dbus.Int16(-1),
1359
 
                                  dbus.Int64(condition),
 
1828
                                  dbus.Int64(
 
1829
                                      # This is specific to GNU libC
 
1830
                                      (exitstatus << 8)
 
1831
                                      | self.last_checker_signal),
1360
1832
                                  dbus.String(command))
1361
 
        
1362
 
        return Client.checker_callback(self, pid, condition, command,
1363
 
                                       *args, **kwargs)
 
1833
        return ret
1364
1834
    
1365
1835
    def start_checker(self, *args, **kwargs):
1366
1836
        old_checker_pid = getattr(self.checker, "pid", None)
1378
1848
    
1379
1849
    def approve(self, value=True):
1380
1850
        self.approved = value
1381
 
        gobject.timeout_add(int(self.approval_duration.total_seconds()
1382
 
                                * 1000), self._reset_approved)
 
1851
        GLib.timeout_add(int(self.approval_duration.total_seconds()
 
1852
                             * 1000), self._reset_approved)
1383
1853
        self.send_changedstate()
1384
1854
    
1385
1855
    ## D-Bus methods, signals & properties
1441
1911
        self.checked_ok()
1442
1912
    
1443
1913
    # Enable - method
 
1914
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1444
1915
    @dbus.service.method(_interface)
1445
1916
    def Enable(self):
1446
1917
        "D-Bus method"
1447
1918
        self.enable()
1448
1919
    
1449
1920
    # StartChecker - method
 
1921
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1450
1922
    @dbus.service.method(_interface)
1451
1923
    def StartChecker(self):
1452
1924
        "D-Bus method"
1453
1925
        self.start_checker()
1454
1926
    
1455
1927
    # Disable - method
 
1928
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1456
1929
    @dbus.service.method(_interface)
1457
1930
    def Disable(self):
1458
1931
        "D-Bus method"
1459
1932
        self.disable()
1460
1933
    
1461
1934
    # StopChecker - method
 
1935
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1462
1936
    @dbus.service.method(_interface)
1463
1937
    def StopChecker(self):
1464
1938
        self.stop_checker()
1500
1974
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1501
1975
    
1502
1976
    # Name - property
 
1977
    @dbus_annotations(
 
1978
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1503
1979
    @dbus_service_property(_interface, signature="s", access="read")
1504
1980
    def Name_dbus_property(self):
1505
1981
        return dbus.String(self.name)
1506
1982
    
1507
1983
    # Fingerprint - property
 
1984
    @dbus_annotations(
 
1985
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1508
1986
    @dbus_service_property(_interface, signature="s", access="read")
1509
1987
    def Fingerprint_dbus_property(self):
1510
1988
        return dbus.String(self.fingerprint)
1519
1997
        self.host = str(value)
1520
1998
    
1521
1999
    # Created - property
 
2000
    @dbus_annotations(
 
2001
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1522
2002
    @dbus_service_property(_interface, signature="s", access="read")
1523
2003
    def Created_dbus_property(self):
1524
2004
        return datetime_to_dbus(self.created)
1585
2065
                if (getattr(self, "disable_initiator_tag", None)
1586
2066
                    is None):
1587
2067
                    return
1588
 
                gobject.source_remove(self.disable_initiator_tag)
1589
 
                self.disable_initiator_tag = gobject.timeout_add(
 
2068
                GLib.source_remove(self.disable_initiator_tag)
 
2069
                self.disable_initiator_tag = GLib.timeout_add(
1590
2070
                    int((self.expires - now).total_seconds() * 1000),
1591
2071
                    self.disable)
1592
2072
    
1612
2092
            return
1613
2093
        if self.enabled:
1614
2094
            # Reschedule checker run
1615
 
            gobject.source_remove(self.checker_initiator_tag)
1616
 
            self.checker_initiator_tag = gobject.timeout_add(
 
2095
            GLib.source_remove(self.checker_initiator_tag)
 
2096
            self.checker_initiator_tag = GLib.timeout_add(
1617
2097
                value, self.start_checker)
1618
2098
            self.start_checker() # Start one now, too
1619
2099
    
1639
2119
            self.stop_checker()
1640
2120
    
1641
2121
    # ObjectPath - property
 
2122
    @dbus_annotations(
 
2123
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
2124
         "org.freedesktop.DBus.Deprecated": "true"})
1642
2125
    @dbus_service_property(_interface, signature="o", access="read")
1643
2126
    def ObjectPath_dbus_property(self):
1644
2127
        return self.dbus_object_path # is already a dbus.ObjectPath
1645
2128
    
1646
2129
    # Secret = property
 
2130
    @dbus_annotations(
 
2131
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2132
         "invalidates"})
1647
2133
    @dbus_service_property(_interface,
1648
2134
                           signature="ay",
1649
2135
                           access="write",
1659
2145
        self._pipe = child_pipe
1660
2146
        self._pipe.send(('init', fpr, address))
1661
2147
        if not self._pipe.recv():
1662
 
            raise KeyError()
 
2148
            raise KeyError(fpr)
1663
2149
    
1664
2150
    def __getattribute__(self, name):
1665
2151
        if name == '_pipe':
1695
2181
            logger.debug("Pipe FD: %d",
1696
2182
                         self.server.child_pipe.fileno())
1697
2183
            
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.
 
2184
            session = gnutls.ClientSession(self.request)
1705
2185
            
1706
2186
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1707
2187
            #                      "+AES-256-CBC", "+SHA1",
1711
2191
            priority = self.server.gnutls_priority
1712
2192
            if priority is None:
1713
2193
                priority = "NORMAL"
1714
 
            gnutls.library.functions.gnutls_priority_set_direct(
1715
 
                session._c_object, priority, None)
 
2194
            gnutls.priority_set_direct(session._c_object,
 
2195
                                       priority.encode("utf-8"),
 
2196
                                       None)
1716
2197
            
1717
2198
            # Start communication using the Mandos protocol
1718
2199
            # Get protocol number
1728
2209
            # Start GnuTLS connection
1729
2210
            try:
1730
2211
                session.handshake()
1731
 
            except gnutls.errors.GNUTLSError as error:
 
2212
            except gnutls.Error as error:
1732
2213
                logger.warning("Handshake failed: %s", error)
1733
2214
                # Do not run session.bye() here: the session is not
1734
2215
                # established.  Just abandon the request.
1740
2221
                try:
1741
2222
                    fpr = self.fingerprint(
1742
2223
                        self.peer_certificate(session))
1743
 
                except (TypeError,
1744
 
                        gnutls.errors.GNUTLSError) as error:
 
2224
                except (TypeError, gnutls.Error) as error:
1745
2225
                    logger.warning("Bad certificate: %s", error)
1746
2226
                    return
1747
2227
                logger.debug("Fingerprint: %s", fpr)
1805
2285
                    else:
1806
2286
                        delay -= time2 - time
1807
2287
                
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
 
2288
                try:
 
2289
                    session.send(client.secret)
 
2290
                except gnutls.Error as error:
 
2291
                    logger.warning("gnutls send failed",
 
2292
                                   exc_info = error)
 
2293
                    return
1820
2294
                
1821
2295
                logger.info("Sending secret to %s", client.name)
1822
2296
                # bump the timeout using extended_timeout
1830
2304
                    client.approvals_pending -= 1
1831
2305
                try:
1832
2306
                    session.bye()
1833
 
                except gnutls.errors.GNUTLSError as error:
 
2307
                except gnutls.Error as error:
1834
2308
                    logger.warning("GnuTLS bye failed",
1835
2309
                                   exc_info=error)
1836
2310
    
1838
2312
    def peer_certificate(session):
1839
2313
        "Return the peer's OpenPGP certificate as a bytestring"
1840
2314
        # 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
 
2315
        if (gnutls.certificate_type_get(session._c_object)
 
2316
            != gnutls.CRT_OPENPGP):
 
2317
            # ...return invalid data
 
2318
            return b""
1846
2319
        list_size = ctypes.c_uint(1)
1847
 
        cert_list = (gnutls.library.functions
1848
 
                     .gnutls_certificate_get_peers
 
2320
        cert_list = (gnutls.certificate_get_peers
1849
2321
                     (session._c_object, ctypes.byref(list_size)))
1850
2322
        if not bool(cert_list) and list_size.value != 0:
1851
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1852
 
                                            " certificate")
 
2323
            raise gnutls.Error("error getting peer certificate")
1853
2324
        if list_size.value == 0:
1854
2325
            return None
1855
2326
        cert = cert_list[0]
1859
2330
    def fingerprint(openpgp):
1860
2331
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1861
2332
        # New GnuTLS "datum" with the OpenPGP public key
1862
 
        datum = gnutls.library.types.gnutls_datum_t(
 
2333
        datum = gnutls.datum_t(
1863
2334
            ctypes.cast(ctypes.c_char_p(openpgp),
1864
2335
                        ctypes.POINTER(ctypes.c_ubyte)),
1865
2336
            ctypes.c_uint(len(openpgp)))
1866
2337
        # 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))
 
2338
        crt = gnutls.openpgp_crt_t()
 
2339
        gnutls.openpgp_crt_init(ctypes.byref(crt))
1870
2340
        # 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)
 
2341
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2342
                                  gnutls.OPENPGP_FMT_RAW)
1874
2343
        # Verify the self signature in the key
1875
2344
        crtverify = ctypes.c_uint()
1876
 
        gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1877
 
            crt, 0, ctypes.byref(crtverify))
 
2345
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2346
                                       ctypes.byref(crtverify))
1878
2347
        if crtverify.value != 0:
1879
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1880
 
            raise gnutls.errors.CertificateSecurityError(
1881
 
                "Verify failed")
 
2348
            gnutls.openpgp_crt_deinit(crt)
 
2349
            raise gnutls.CertificateSecurityError("Verify failed")
1882
2350
        # New buffer for the fingerprint
1883
2351
        buf = ctypes.create_string_buffer(20)
1884
2352
        buf_len = ctypes.c_size_t()
1885
2353
        # 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))
 
2354
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2355
                                           ctypes.byref(buf_len))
1888
2356
        # Deinit the certificate
1889
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2357
        gnutls.openpgp_crt_deinit(crt)
1890
2358
        # Convert the buffer to a Python bytestring
1891
2359
        fpr = ctypes.string_at(buf, buf_len.value)
1892
2360
        # Convert the bytestring to hexadecimal notation
1985
2453
        """This overrides the normal server_bind() function
1986
2454
        to bind to an interface if one was specified, and also NOT to
1987
2455
        bind to an address or port if they were not specified."""
 
2456
        global SO_BINDTODEVICE
1988
2457
        if self.interface is not None:
1989
2458
            if SO_BINDTODEVICE is None:
1990
 
                logger.error("SO_BINDTODEVICE does not exist;"
1991
 
                             " cannot bind to interface %s",
1992
 
                             self.interface)
1993
 
            else:
1994
 
                try:
1995
 
                    self.socket.setsockopt(
1996
 
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
1997
 
                        (self.interface + "\0").encode("utf-8"))
1998
 
                except socket.error as error:
1999
 
                    if error.errno == errno.EPERM:
2000
 
                        logger.error("No permission to bind to"
2001
 
                                     " interface %s", self.interface)
2002
 
                    elif error.errno == errno.ENOPROTOOPT:
2003
 
                        logger.error("SO_BINDTODEVICE not available;"
2004
 
                                     " cannot bind to interface %s",
2005
 
                                     self.interface)
2006
 
                    elif error.errno == errno.ENODEV:
2007
 
                        logger.error("Interface %s does not exist,"
2008
 
                                     " cannot bind", self.interface)
2009
 
                    else:
2010
 
                        raise
 
2459
                # Fall back to a hard-coded value which seems to be
 
2460
                # common enough.
 
2461
                logger.warning("SO_BINDTODEVICE not found, trying 25")
 
2462
                SO_BINDTODEVICE = 25
 
2463
            try:
 
2464
                self.socket.setsockopt(
 
2465
                    socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2466
                    (self.interface + "\0").encode("utf-8"))
 
2467
            except socket.error as error:
 
2468
                if error.errno == errno.EPERM:
 
2469
                    logger.error("No permission to bind to"
 
2470
                                 " interface %s", self.interface)
 
2471
                elif error.errno == errno.ENOPROTOOPT:
 
2472
                    logger.error("SO_BINDTODEVICE not available;"
 
2473
                                 " cannot bind to interface %s",
 
2474
                                 self.interface)
 
2475
                elif error.errno == errno.ENODEV:
 
2476
                    logger.error("Interface %s does not exist,"
 
2477
                                 " cannot bind", self.interface)
 
2478
                else:
 
2479
                    raise
2011
2480
        # Only bind(2) the socket if we really need to.
2012
2481
        if self.server_address[0] or self.server_address[1]:
2013
2482
            if not self.server_address[0]:
2036
2505
        gnutls_priority GnuTLS priority string
2037
2506
        use_dbus:       Boolean; to emit D-Bus signals or not
2038
2507
    
2039
 
    Assumes a gobject.MainLoop event loop.
 
2508
    Assumes a GLib.MainLoop event loop.
2040
2509
    """
2041
2510
    
2042
2511
    def __init__(self, server_address, RequestHandlerClass,
2067
2536
    
2068
2537
    def add_pipe(self, parent_pipe, proc):
2069
2538
        # Call "handle_ipc" for both data and EOF events
2070
 
        gobject.io_add_watch(
 
2539
        GLib.io_add_watch(
2071
2540
            parent_pipe.fileno(),
2072
 
            gobject.IO_IN | gobject.IO_HUP,
 
2541
            GLib.IO_IN | GLib.IO_HUP,
2073
2542
            functools.partial(self.handle_ipc,
2074
2543
                              parent_pipe = parent_pipe,
2075
2544
                              proc = proc))
2079
2548
                   proc = None,
2080
2549
                   client_object=None):
2081
2550
        # error, or the other end of multiprocessing.Pipe has closed
2082
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2551
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
2083
2552
            # Wait for other process to exit
2084
2553
            proc.join()
2085
2554
            return False
2092
2561
            fpr = request[1]
2093
2562
            address = request[2]
2094
2563
            
2095
 
            for c in self.clients.itervalues():
 
2564
            for c in self.clients.values():
2096
2565
                if c.fingerprint == fpr:
2097
2566
                    client = c
2098
2567
                    break
2106
2575
                parent_pipe.send(False)
2107
2576
                return False
2108
2577
            
2109
 
            gobject.io_add_watch(
 
2578
            GLib.io_add_watch(
2110
2579
                parent_pipe.fileno(),
2111
 
                gobject.IO_IN | gobject.IO_HUP,
 
2580
                GLib.IO_IN | GLib.IO_HUP,
2112
2581
                functools.partial(self.handle_ipc,
2113
2582
                                  parent_pipe = parent_pipe,
2114
2583
                                  proc = proc,
2128
2597
        
2129
2598
        if command == 'getattr':
2130
2599
            attrname = request[1]
2131
 
            if callable(client_object.__getattribute__(attrname)):
 
2600
            if isinstance(client_object.__getattribute__(attrname),
 
2601
                          collections.Callable):
2132
2602
                parent_pipe.send(('function', ))
2133
2603
            else:
2134
2604
                parent_pipe.send((
2169
2639
    # avoid excessive use of external libraries.
2170
2640
    
2171
2641
    # 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
2642
    Token = collections.namedtuple("Token", (
2182
2643
        "regexp",  # To match token; if "value" is not None, must have
2183
2644
                   # a "group" containing digits
2218
2679
    # Define starting values
2219
2680
    value = datetime.timedelta() # Value so far
2220
2681
    found_token = None
2221
 
    followers = frozenset((token_duration,)) # Following valid tokens
 
2682
    followers = frozenset((token_duration, )) # Following valid tokens
2222
2683
    s = duration                # String left to parse
2223
2684
    # Loop until end token is found
2224
2685
    while found_token is not token_end:
2241
2702
                break
2242
2703
        else:
2243
2704
            # No currently valid tokens were found
2244
 
            raise ValueError("Invalid RFC 3339 duration")
 
2705
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2706
                             .format(duration))
2245
2707
    # End token found
2246
2708
    return value
2247
2709
 
2380
2842
                        "debug": "False",
2381
2843
                        "priority":
2382
2844
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2383
 
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
2845
                        ":+SIGN-DSA-SHA256",
2384
2846
                        "servicename": "Mandos",
2385
2847
                        "use_dbus": "True",
2386
2848
                        "use_ipv6": "True",
2498
2960
            pidfilename = "/var/run/mandos.pid"
2499
2961
        pidfile = None
2500
2962
        try:
2501
 
            pidfile = open(pidfilename, "w")
 
2963
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2502
2964
        except IOError as e:
2503
2965
            logger.error("Could not open file %r", pidfilename,
2504
2966
                         exc_info=e)
2505
2967
    
2506
 
    for name in ("_mandos", "mandos", "nobody"):
 
2968
    for name, group in (("_mandos", "_mandos"),
 
2969
                        ("mandos", "mandos"),
 
2970
                        ("nobody", "nogroup")):
2507
2971
        try:
2508
2972
            uid = pwd.getpwnam(name).pw_uid
2509
 
            gid = pwd.getpwnam(name).pw_gid
 
2973
            gid = pwd.getpwnam(group).pw_gid
2510
2974
            break
2511
2975
        except KeyError:
2512
2976
            continue
2516
2980
    try:
2517
2981
        os.setgid(gid)
2518
2982
        os.setuid(uid)
 
2983
        if debug:
 
2984
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
2985
                                                             gid))
2519
2986
    except OSError as error:
 
2987
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
2988
                       .format(uid, gid, os.strerror(error.errno)))
2520
2989
        if error.errno != errno.EPERM:
2521
2990
            raise
2522
2991
    
2525
2994
        
2526
2995
        # "Use a log level over 10 to enable all debugging options."
2527
2996
        # - GnuTLS manual
2528
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
2997
        gnutls.global_set_log_level(11)
2529
2998
        
2530
 
        @gnutls.library.types.gnutls_log_func
 
2999
        @gnutls.log_func
2531
3000
        def debug_gnutls(level, string):
2532
3001
            logger.debug("GnuTLS: %s", string[:-1])
2533
3002
        
2534
 
        gnutls.library.functions.gnutls_global_set_log_function(
2535
 
            debug_gnutls)
 
3003
        gnutls.global_set_log_function(debug_gnutls)
2536
3004
        
2537
3005
        # Redirect stdin so all checkers get /dev/null
2538
3006
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2545
3013
        # Close all input and output, do double fork, etc.
2546
3014
        daemon()
2547
3015
    
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()
 
3016
    # multiprocessing will use threads, so before we use GLib we need
 
3017
    # to inform GLib that threads will be used.
 
3018
    GLib.threads_init()
2551
3019
    
2552
3020
    global main_loop
2553
3021
    # From the Avahi example code
2554
3022
    DBusGMainLoop(set_as_default=True)
2555
 
    main_loop = gobject.MainLoop()
 
3023
    main_loop = GLib.MainLoop()
2556
3024
    bus = dbus.SystemBus()
2557
3025
    # End of Avahi example code
2558
3026
    if use_dbus:
2563
3031
            old_bus_name = dbus.service.BusName(
2564
3032
                "se.bsnet.fukt.Mandos", bus,
2565
3033
                do_not_queue=True)
2566
 
        except dbus.exceptions.NameExistsException as e:
 
3034
        except dbus.exceptions.DBusException as e:
2567
3035
            logger.error("Disabling D-Bus:", exc_info=e)
2568
3036
            use_dbus = False
2569
3037
            server_settings["use_dbus"] = False
2602
3070
    if server_settings["restore"]:
2603
3071
        try:
2604
3072
            with open(stored_state_path, "rb") as stored_state:
2605
 
                clients_data, old_client_settings = pickle.load(
2606
 
                    stored_state)
 
3073
                if sys.version_info.major == 2:                
 
3074
                    clients_data, old_client_settings = pickle.load(
 
3075
                        stored_state)
 
3076
                else:
 
3077
                    bytes_clients_data, bytes_old_client_settings = (
 
3078
                        pickle.load(stored_state, encoding = "bytes"))
 
3079
                    ### Fix bytes to strings
 
3080
                    ## clients_data
 
3081
                    # .keys()
 
3082
                    clients_data = { (key.decode("utf-8")
 
3083
                                      if isinstance(key, bytes)
 
3084
                                      else key): value
 
3085
                                     for key, value in
 
3086
                                     bytes_clients_data.items() }
 
3087
                    del bytes_clients_data
 
3088
                    for key in clients_data:
 
3089
                        value = { (k.decode("utf-8")
 
3090
                                   if isinstance(k, bytes) else k): v
 
3091
                                  for k, v in
 
3092
                                  clients_data[key].items() }
 
3093
                        clients_data[key] = value
 
3094
                        # .client_structure
 
3095
                        value["client_structure"] = [
 
3096
                            (s.decode("utf-8")
 
3097
                             if isinstance(s, bytes)
 
3098
                             else s) for s in
 
3099
                            value["client_structure"] ]
 
3100
                        # .name & .host
 
3101
                        for k in ("name", "host"):
 
3102
                            if isinstance(value[k], bytes):
 
3103
                                value[k] = value[k].decode("utf-8")
 
3104
                    ## old_client_settings
 
3105
                    # .keys()
 
3106
                    old_client_settings = {
 
3107
                        (key.decode("utf-8")
 
3108
                         if isinstance(key, bytes)
 
3109
                         else key): value
 
3110
                        for key, value in
 
3111
                        bytes_old_client_settings.items() }
 
3112
                    del bytes_old_client_settings
 
3113
                    # .host
 
3114
                    for value in old_client_settings.values():
 
3115
                        if isinstance(value["host"], bytes):
 
3116
                            value["host"] = (value["host"]
 
3117
                                             .decode("utf-8"))
2607
3118
            os.remove(stored_state_path)
2608
3119
        except IOError as e:
2609
3120
            if e.errno == errno.ENOENT:
2642
3153
                    pass
2643
3154
            
2644
3155
            # Clients who has passed its expire date can still be
2645
 
            # enabled if its last checker was successful.  Clients
 
3156
            # enabled if its last checker was successful.  A Client
2646
3157
            # whose checker succeeded before we stored its state is
2647
3158
            # assumed to have successfully run all checkers during
2648
3159
            # downtime.
2700
3211
    
2701
3212
    if not foreground:
2702
3213
        if pidfile is not None:
 
3214
            pid = os.getpid()
2703
3215
            try:
2704
3216
                with pidfile:
2705
 
                    pid = os.getpid()
2706
 
                    pidfile.write("{}\n".format(pid).encode("utf-8"))
 
3217
                    print(pid, file=pidfile)
2707
3218
            except IOError:
2708
3219
                logger.error("Could not write to file %r with PID %d",
2709
3220
                             pidfilename, pid)
2710
3221
        del pidfile
2711
3222
        del pidfilename
2712
3223
    
2713
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2714
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
 
3224
    for termsig in (signal.SIGHUP, signal.SIGTERM):
 
3225
        GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
 
3226
                             lambda: main_loop.quit() and False)
2715
3227
    
2716
3228
    if use_dbus:
2717
3229
        
2718
3230
        @alternate_dbus_interfaces(
2719
3231
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2720
 
        class MandosDBusService(DBusObjectWithProperties):
 
3232
        class MandosDBusService(DBusObjectWithObjectManager):
2721
3233
            """A D-Bus proxy object"""
2722
3234
            
2723
3235
            def __init__(self):
2725
3237
            
2726
3238
            _interface = "se.recompile.Mandos"
2727
3239
            
2728
 
            @dbus_interface_annotations(_interface)
2729
 
            def _foo(self):
2730
 
                return {
2731
 
                    "org.freedesktop.DBus.Property.EmitsChangedSignal":
2732
 
                    "false" }
2733
 
            
2734
3240
            @dbus.service.signal(_interface, signature="o")
2735
3241
            def ClientAdded(self, objpath):
2736
3242
                "D-Bus signal"
2741
3247
                "D-Bus signal"
2742
3248
                pass
2743
3249
            
 
3250
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3251
                               "true"})
2744
3252
            @dbus.service.signal(_interface, signature="os")
2745
3253
            def ClientRemoved(self, objpath, name):
2746
3254
                "D-Bus signal"
2747
3255
                pass
2748
3256
            
 
3257
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3258
                               "true"})
2749
3259
            @dbus.service.method(_interface, out_signature="ao")
2750
3260
            def GetAllClients(self):
2751
3261
                "D-Bus method"
2752
3262
                return dbus.Array(c.dbus_object_path for c in
2753
 
                                  tcp_server.clients.itervalues())
 
3263
                                  tcp_server.clients.values())
2754
3264
            
 
3265
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3266
                               "true"})
2755
3267
            @dbus.service.method(_interface,
2756
3268
                                 out_signature="a{oa{sv}}")
2757
3269
            def GetAllClientsWithProperties(self):
2758
3270
                "D-Bus method"
2759
3271
                return dbus.Dictionary(
2760
 
                    { c.dbus_object_path: c.GetAll("")
2761
 
                      for c in tcp_server.clients.itervalues() },
 
3272
                    { c.dbus_object_path: c.GetAll(
 
3273
                        "se.recompile.Mandos.Client")
 
3274
                      for c in tcp_server.clients.values() },
2762
3275
                    signature="oa{sv}")
2763
3276
            
2764
3277
            @dbus.service.method(_interface, in_signature="o")
2765
3278
            def RemoveClient(self, object_path):
2766
3279
                "D-Bus method"
2767
 
                for c in tcp_server.clients.itervalues():
 
3280
                for c in tcp_server.clients.values():
2768
3281
                    if c.dbus_object_path == object_path:
2769
3282
                        del tcp_server.clients[c.name]
2770
3283
                        c.remove_from_connection()
2771
 
                        # Don't signal anything except ClientRemoved
 
3284
                        # Don't signal the disabling
2772
3285
                        c.disable(quiet=True)
2773
 
                        # Emit D-Bus signal
2774
 
                        self.ClientRemoved(object_path, c.name)
 
3286
                        # Emit D-Bus signal for removal
 
3287
                        self.client_removed_signal(c)
2775
3288
                        return
2776
3289
                raise KeyError(object_path)
2777
3290
            
2778
3291
            del _interface
 
3292
            
 
3293
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
3294
                                 out_signature = "a{oa{sa{sv}}}")
 
3295
            def GetManagedObjects(self):
 
3296
                """D-Bus method"""
 
3297
                return dbus.Dictionary(
 
3298
                    { client.dbus_object_path:
 
3299
                      dbus.Dictionary(
 
3300
                          { interface: client.GetAll(interface)
 
3301
                            for interface in
 
3302
                                 client._get_all_interface_names()})
 
3303
                      for client in tcp_server.clients.values()})
 
3304
            
 
3305
            def client_added_signal(self, client):
 
3306
                """Send the new standard signal and the old signal"""
 
3307
                if use_dbus:
 
3308
                    # New standard signal
 
3309
                    self.InterfacesAdded(
 
3310
                        client.dbus_object_path,
 
3311
                        dbus.Dictionary(
 
3312
                            { interface: client.GetAll(interface)
 
3313
                              for interface in
 
3314
                              client._get_all_interface_names()}))
 
3315
                    # Old signal
 
3316
                    self.ClientAdded(client.dbus_object_path)
 
3317
            
 
3318
            def client_removed_signal(self, client):
 
3319
                """Send the new standard signal and the old signal"""
 
3320
                if use_dbus:
 
3321
                    # New standard signal
 
3322
                    self.InterfacesRemoved(
 
3323
                        client.dbus_object_path,
 
3324
                        client._get_all_interface_names())
 
3325
                    # Old signal
 
3326
                    self.ClientRemoved(client.dbus_object_path,
 
3327
                                       client.name)
2779
3328
        
2780
3329
        mandos_dbus_service = MandosDBusService()
2781
3330
    
 
3331
    # Save modules to variables to exempt the modules from being
 
3332
    # unloaded before the function registered with atexit() is run.
 
3333
    mp = multiprocessing
 
3334
    wn = wnull
2782
3335
    def cleanup():
2783
3336
        "Cleanup function; run on exit"
2784
3337
        if zeroconf:
2785
3338
            service.cleanup()
2786
3339
        
2787
 
        multiprocessing.active_children()
2788
 
        wnull.close()
 
3340
        mp.active_children()
 
3341
        wn.close()
2789
3342
        if not (tcp_server.clients or client_settings):
2790
3343
            return
2791
3344
        
2794
3347
        # removed/edited, old secret will thus be unrecovable.
2795
3348
        clients = {}
2796
3349
        with PGPEngine() as pgp:
2797
 
            for client in tcp_server.clients.itervalues():
 
3350
            for client in tcp_server.clients.values():
2798
3351
                key = client_settings[client.name]["secret"]
2799
3352
                client.encrypted_secret = pgp.encrypt(client.secret,
2800
3353
                                                      key)
2824
3377
                    prefix='clients-',
2825
3378
                    dir=os.path.dirname(stored_state_path),
2826
3379
                    delete=False) as stored_state:
2827
 
                pickle.dump((clients, client_settings), stored_state)
 
3380
                pickle.dump((clients, client_settings), stored_state,
 
3381
                            protocol = 2)
2828
3382
                tempname = stored_state.name
2829
3383
            os.rename(tempname, stored_state_path)
2830
3384
        except (IOError, OSError) as e:
2846
3400
            name, client = tcp_server.clients.popitem()
2847
3401
            if use_dbus:
2848
3402
                client.remove_from_connection()
2849
 
            # Don't signal anything except ClientRemoved
 
3403
            # Don't signal the disabling
2850
3404
            client.disable(quiet=True)
 
3405
            # Emit D-Bus signal for removal
2851
3406
            if use_dbus:
2852
 
                # Emit D-Bus signal
2853
 
                mandos_dbus_service.ClientRemoved(
2854
 
                    client.dbus_object_path, client.name)
 
3407
                mandos_dbus_service.client_removed_signal(client)
2855
3408
        client_settings.clear()
2856
3409
    
2857
3410
    atexit.register(cleanup)
2858
3411
    
2859
 
    for client in tcp_server.clients.itervalues():
 
3412
    for client in tcp_server.clients.values():
2860
3413
        if use_dbus:
2861
 
            # Emit D-Bus signal
2862
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3414
            # Emit D-Bus signal for adding
 
3415
            mandos_dbus_service.client_added_signal(client)
2863
3416
        # Need to initiate checking of clients
2864
3417
        if client.enabled:
2865
3418
            client.init_checker()
2891
3444
                sys.exit(1)
2892
3445
            # End of Avahi example code
2893
3446
        
2894
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2895
 
                             lambda *args, **kwargs:
2896
 
                             (tcp_server.handle_request
2897
 
                              (*args[2:], **kwargs) or True))
 
3447
        GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
 
3448
                          lambda *args, **kwargs:
 
3449
                          (tcp_server.handle_request
 
3450
                           (*args[2:], **kwargs) or True))
2898
3451
        
2899
3452
        logger.debug("Starting main loop")
2900
3453
        main_loop.run()