/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-02-28 10:59:18 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 331.
  • Revision ID: teddy@recompile.se-20160228105918-tb8pt2p5j0tkcls3
Handle GnuTLS errors and partial sends in gnutls "module".

* mandos (GnuTLS.E_INTERRUPTED, GnuTLS.E_AGAIN): New.
  (GnuTLS.Error): Set error code as "code" attribute.
  (GnuTLS.ClientSession.send): Handle partial sends with a loop.
  (GnuTLS._retry_on_error): New function.
  (GnuTLS.record_send, GnuTLS.handshake, GnuTLS.bye): Set "errcheck"
                                                      attribute to
                                                    "_retry_on_error".
  (ClientHandler.handle): Remove loop for handling partial sends;
                          GnuTLS.ClientSession.send() will do that.

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2014 Teddy Hogeborn
15
 
# Copyright © 2008-2014 Björn Påhlsson
 
14
# Copyright © 2008-2015 Teddy Hogeborn
 
15
# Copyright © 2008-2015 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
36
36
 
37
37
from future_builtins import *
38
38
 
39
 
import SocketServer as socketserver
 
39
try:
 
40
    import SocketServer as socketserver
 
41
except ImportError:
 
42
    import socketserver
40
43
import socket
41
44
import argparse
42
45
import datetime
43
46
import errno
44
 
import gnutls.crypto
45
 
import gnutls.connection
46
 
import gnutls.errors
47
 
import gnutls.library.functions
48
 
import gnutls.library.constants
49
 
import gnutls.library.types
50
 
import ConfigParser as configparser
 
47
try:
 
48
    import ConfigParser as configparser
 
49
except ImportError:
 
50
    import configparser
51
51
import sys
52
52
import re
53
53
import os
62
62
import struct
63
63
import fcntl
64
64
import functools
65
 
import cPickle as pickle
 
65
try:
 
66
    import cPickle as pickle
 
67
except ImportError:
 
68
    import pickle
66
69
import multiprocessing
67
70
import types
68
71
import binascii
69
72
import tempfile
70
73
import itertools
71
74
import collections
 
75
import codecs
72
76
 
73
77
import dbus
74
78
import dbus.service
75
 
import gobject
 
79
try:
 
80
    import gobject
 
81
except ImportError:
 
82
    from gi.repository import GObject as gobject
76
83
import avahi
77
84
from dbus.mainloop.glib import DBusGMainLoop
78
85
import ctypes
91
98
if sys.version_info.major == 2:
92
99
    str = unicode
93
100
 
94
 
version = "1.6.9"
 
101
version = "1.7.1"
95
102
stored_state_file = "clients.pickle"
96
103
 
97
104
logger = logging.getLogger()
98
105
syslogger = None
99
106
 
100
107
try:
101
 
    if_nametoindex = (ctypes.cdll.LoadLibrary
102
 
                      (ctypes.util.find_library("c"))
103
 
                      .if_nametoindex)
 
108
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
109
        ctypes.util.find_library("c")).if_nametoindex
104
110
except (OSError, AttributeError):
 
111
    
105
112
    def if_nametoindex(interface):
106
113
        "Get an interface index the hard way, i.e. using fcntl()"
107
114
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
116
123
    """init logger and add loglevel"""
117
124
    
118
125
    global syslogger
119
 
    syslogger = (logging.handlers.SysLogHandler
120
 
                 (facility =
121
 
                  logging.handlers.SysLogHandler.LOG_DAEMON,
122
 
                  address = "/dev/log"))
 
126
    syslogger = (logging.handlers.SysLogHandler(
 
127
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
128
        address = "/dev/log"))
123
129
    syslogger.setFormatter(logging.Formatter
124
130
                           ('Mandos [%(process)d]: %(levelname)s:'
125
131
                            ' %(message)s'))
142
148
 
143
149
class PGPEngine(object):
144
150
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
151
    
145
152
    def __init__(self):
146
153
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
147
154
        self.gnupgargs = ['--batch',
186
193
    
187
194
    def encrypt(self, data, password):
188
195
        passphrase = self.password_encode(password)
189
 
        with tempfile.NamedTemporaryFile(dir=self.tempdir
190
 
                                         ) as passfile:
 
196
        with tempfile.NamedTemporaryFile(
 
197
                dir=self.tempdir) as passfile:
191
198
            passfile.write(passphrase)
192
199
            passfile.flush()
193
200
            proc = subprocess.Popen(['gpg', '--symmetric',
204
211
    
205
212
    def decrypt(self, data, password):
206
213
        passphrase = self.password_encode(password)
207
 
        with tempfile.NamedTemporaryFile(dir = self.tempdir
208
 
                                         ) as passfile:
 
214
        with tempfile.NamedTemporaryFile(
 
215
                dir = self.tempdir) as passfile:
209
216
            passfile.write(passphrase)
210
217
            passfile.flush()
211
218
            proc = subprocess.Popen(['gpg', '--decrypt',
215
222
                                    stdin = subprocess.PIPE,
216
223
                                    stdout = subprocess.PIPE,
217
224
                                    stderr = subprocess.PIPE)
218
 
            decrypted_plaintext, err = proc.communicate(input
219
 
                                                        = data)
 
225
            decrypted_plaintext, err = proc.communicate(input = data)
220
226
        if proc.returncode != 0:
221
227
            raise PGPError(err)
222
228
        return decrypted_plaintext
228
234
        return super(AvahiError, self).__init__(value, *args,
229
235
                                                **kwargs)
230
236
 
 
237
 
231
238
class AvahiServiceError(AvahiError):
232
239
    pass
233
240
 
 
241
 
234
242
class AvahiGroupError(AvahiError):
235
243
    pass
236
244
 
256
264
    bus: dbus.SystemBus()
257
265
    """
258
266
    
259
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
260
 
                 servicetype = None, port = None, TXT = None,
261
 
                 domain = "", host = "", max_renames = 32768,
262
 
                 protocol = avahi.PROTO_UNSPEC, bus = None):
 
267
    def __init__(self,
 
268
                 interface = avahi.IF_UNSPEC,
 
269
                 name = None,
 
270
                 servicetype = None,
 
271
                 port = None,
 
272
                 TXT = None,
 
273
                 domain = "",
 
274
                 host = "",
 
275
                 max_renames = 32768,
 
276
                 protocol = avahi.PROTO_UNSPEC,
 
277
                 bus = None):
263
278
        self.interface = interface
264
279
        self.name = name
265
280
        self.type = servicetype
282
297
                            " after %i retries, exiting.",
283
298
                            self.rename_count)
284
299
            raise AvahiServiceError("Too many renames")
285
 
        self.name = str(self.server
286
 
                        .GetAlternativeServiceName(self.name))
 
300
        self.name = str(
 
301
            self.server.GetAlternativeServiceName(self.name))
287
302
        self.rename_count += 1
288
303
        logger.info("Changing Zeroconf service name to %r ...",
289
304
                    self.name)
344
359
        elif state == avahi.ENTRY_GROUP_FAILURE:
345
360
            logger.critical("Avahi: Error in group state changed %s",
346
361
                            str(error))
347
 
            raise AvahiGroupError("State changed: {!s}"
348
 
                                  .format(error))
 
362
            raise AvahiGroupError("State changed: {!s}".format(error))
349
363
    
350
364
    def cleanup(self):
351
365
        """Derived from the Avahi example code"""
361
375
    def server_state_changed(self, state, error=None):
362
376
        """Derived from the Avahi example code"""
363
377
        logger.debug("Avahi server state change: %i", state)
364
 
        bad_states = { avahi.SERVER_INVALID:
365
 
                           "Zeroconf server invalid",
366
 
                       avahi.SERVER_REGISTERING: None,
367
 
                       avahi.SERVER_COLLISION:
368
 
                           "Zeroconf server name collision",
369
 
                       avahi.SERVER_FAILURE:
370
 
                           "Zeroconf server failure" }
 
378
        bad_states = {
 
379
            avahi.SERVER_INVALID: "Zeroconf server invalid",
 
380
            avahi.SERVER_REGISTERING: None,
 
381
            avahi.SERVER_COLLISION: "Zeroconf server name collision",
 
382
            avahi.SERVER_FAILURE: "Zeroconf server failure",
 
383
        }
371
384
        if state in bad_states:
372
385
            if bad_states[state] is not None:
373
386
                if error is None:
376
389
                    logger.error(bad_states[state] + ": %r", error)
377
390
            self.cleanup()
378
391
        elif state == avahi.SERVER_RUNNING:
379
 
            self.add()
 
392
            try:
 
393
                self.add()
 
394
            except dbus.exceptions.DBusException as error:
 
395
                if (error.get_dbus_name()
 
396
                    == "org.freedesktop.Avahi.CollisionError"):
 
397
                    logger.info("Local Zeroconf service name"
 
398
                                " collision.")
 
399
                    return self.rename(remove=False)
 
400
                else:
 
401
                    logger.critical("D-Bus Exception", exc_info=error)
 
402
                    self.cleanup()
 
403
                    os._exit(1)
380
404
        else:
381
405
            if error is None:
382
406
                logger.debug("Unknown state: %r", state)
392
416
                                    follow_name_owner_changes=True),
393
417
                avahi.DBUS_INTERFACE_SERVER)
394
418
        self.server.connect_to_signal("StateChanged",
395
 
                                 self.server_state_changed)
 
419
                                      self.server_state_changed)
396
420
        self.server_state_changed(self.server.GetState())
397
421
 
398
422
 
400
424
    def rename(self, *args, **kwargs):
401
425
        """Add the new name to the syslog messages"""
402
426
        ret = AvahiService.rename(self, *args, **kwargs)
403
 
        syslogger.setFormatter(logging.Formatter
404
 
                               ('Mandos ({}) [%(process)d]:'
405
 
                                ' %(levelname)s: %(message)s'
406
 
                                .format(self.name)))
 
427
        syslogger.setFormatter(logging.Formatter(
 
428
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
429
            .format(self.name)))
407
430
        return ret
408
431
 
 
432
# Pretend that we have a GnuTLS module
 
433
class GnuTLS(object):
 
434
    """This isn't so much a class as it is a module-like namespace.
 
435
    It is instantiated once, and simulates having a GnuTLS module."""
 
436
    
 
437
    _library = ctypes.cdll.LoadLibrary(
 
438
        ctypes.util.find_library("gnutls"))
 
439
    _need_version = "3.3.0"
 
440
    def __init__(self):
 
441
        # Need to use class name "GnuTLS" here, since this method is
 
442
        # called before the assignment to the "gnutls" global variable
 
443
        # happens.
 
444
        if GnuTLS.check_version(self._need_version) is None:
 
445
            raise GnuTLS.Error("Needs GnuTLS {} or later"
 
446
                               .format(self._need_version))
 
447
    
 
448
    # Unless otherwise indicated, the constants and types below are
 
449
    # all from the gnutls/gnutls.h C header file.
 
450
    
 
451
    # Constants
 
452
    E_SUCCESS = 0
 
453
    E_INTERRUPTED = -52
 
454
    E_AGAIN = -28
 
455
    CRT_OPENPGP = 2
 
456
    CLIENT = 2
 
457
    SHUT_RDWR = 0
 
458
    CRD_CERTIFICATE = 1
 
459
    E_NO_CERTIFICATE_FOUND = -49
 
460
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
 
461
    
 
462
    # Types
 
463
    class session_int(ctypes.Structure):
 
464
        _fields_ = []
 
465
    session_t = ctypes.POINTER(session_int)
 
466
    class certificate_credentials_st(ctypes.Structure):
 
467
        _fields_ = []
 
468
    certificate_credentials_t = ctypes.POINTER(
 
469
        certificate_credentials_st)
 
470
    certificate_type_t = ctypes.c_int
 
471
    class datum_t(ctypes.Structure):
 
472
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
 
473
                    ('size', ctypes.c_uint)]
 
474
    class openpgp_crt_int(ctypes.Structure):
 
475
        _fields_ = []
 
476
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
 
477
    openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
 
478
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
 
479
    credentials_type_t = ctypes.c_int # 
 
480
    transport_ptr_t = ctypes.c_void_p
 
481
    close_request_t = ctypes.c_int
 
482
    
 
483
    # Exceptions
 
484
    class Error(Exception):
 
485
        # We need to use the class name "GnuTLS" here, since this
 
486
        # exception might be raised from within GnuTLS.__init__,
 
487
        # which is called before the assignment to the "gnutls"
 
488
        # global variable has happened.
 
489
        def __init__(self, message = None, code = None, args=()):
 
490
            # Default usage is by a message string, but if a return
 
491
            # code is passed, convert it to a string with
 
492
            # gnutls.strerror()
 
493
            self.code = code
 
494
            if message is None and code is not None:
 
495
                message = GnuTLS.strerror(code)
 
496
            return super(GnuTLS.Error, self).__init__(
 
497
                message, *args)
 
498
    
 
499
    class CertificateSecurityError(Error):
 
500
        pass
 
501
    
 
502
    # Classes
 
503
    class Credentials(object):
 
504
        def __init__(self):
 
505
            self._c_object = gnutls.certificate_credentials_t()
 
506
            gnutls.certificate_allocate_credentials(
 
507
                ctypes.byref(self._c_object))
 
508
            self.type = gnutls.CRD_CERTIFICATE
 
509
        
 
510
        def __del__(self):
 
511
            gnutls.certificate_free_credentials(self._c_object)
 
512
    
 
513
    class ClientSession(object):
 
514
        def __init__(self, socket, credentials = None):
 
515
            self._c_object = gnutls.session_t()
 
516
            gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
 
517
            gnutls.set_default_priority(self._c_object)
 
518
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
 
519
            gnutls.handshake_set_private_extensions(self._c_object,
 
520
                                                    True)
 
521
            self.socket = socket
 
522
            if credentials is None:
 
523
                credentials = gnutls.Credentials()
 
524
            gnutls.credentials_set(self._c_object, credentials.type,
 
525
                                   ctypes.cast(credentials._c_object,
 
526
                                               ctypes.c_void_p))
 
527
            self.credentials = credentials
 
528
        
 
529
        def __del__(self):
 
530
            gnutls.deinit(self._c_object)
 
531
        
 
532
        def handshake(self):
 
533
            return gnutls.handshake(self._c_object)
 
534
        
 
535
        def send(self, data):
 
536
            data = bytes(data)
 
537
            data_len = len(data)
 
538
            while data_len > 0:
 
539
                data_len -= gnutls.record_send(self._c_object,
 
540
                                               data[-data_len:],
 
541
                                               data_len)
 
542
        
 
543
        def bye(self):
 
544
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
 
545
    
 
546
    # Error handling functions
 
547
    def _error_code(result):
 
548
        """A function to raise exceptions on errors, suitable
 
549
        for the 'restype' attribute on ctypes functions"""
 
550
        if result >= 0:
 
551
            return result
 
552
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
 
553
            raise gnutls.CertificateSecurityError(code = result)
 
554
        raise gnutls.Error(code = result)
 
555
    
 
556
    def _retry_on_error(result, func, arguments):
 
557
        """A function to retry on some errors, suitable
 
558
        for the 'errcheck' attribute on ctypes functions"""
 
559
        while result < 0:
 
560
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
 
561
                return _error_code(result)
 
562
            result = func(*arguments)
 
563
        return result
 
564
    
 
565
    # Unless otherwise indicated, the function declarations below are
 
566
    # all from the gnutls/gnutls.h C header file.
 
567
    
 
568
    # Functions
 
569
    priority_set_direct = _library.gnutls_priority_set_direct
 
570
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
 
571
                                    ctypes.POINTER(ctypes.c_char_p)]
 
572
    priority_set_direct.restype = _error_code
 
573
    
 
574
    init = _library.gnutls_init
 
575
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
 
576
    init.restype = _error_code
 
577
    
 
578
    set_default_priority = _library.gnutls_set_default_priority
 
579
    set_default_priority.argtypes = [session_t]
 
580
    set_default_priority.restype = _error_code
 
581
    
 
582
    record_send = _library.gnutls_record_send
 
583
    record_send.argtypes = [session_t, ctypes.c_void_p,
 
584
                            ctypes.c_size_t]
 
585
    record_send.restype = ctypes.c_ssize_t
 
586
    record_send.errcheck = _retry_on_error
 
587
    
 
588
    certificate_allocate_credentials = (
 
589
        _library.gnutls_certificate_allocate_credentials)
 
590
    certificate_allocate_credentials.argtypes = [
 
591
        ctypes.POINTER(certificate_credentials_t)]
 
592
    certificate_allocate_credentials.restype = _error_code
 
593
    
 
594
    certificate_free_credentials = (
 
595
        _library.gnutls_certificate_free_credentials)
 
596
    certificate_free_credentials.argtypes = [certificate_credentials_t]
 
597
    certificate_free_credentials.restype = None
 
598
    
 
599
    handshake_set_private_extensions = (
 
600
        _library.gnutls_handshake_set_private_extensions)
 
601
    handshake_set_private_extensions.argtypes = [session_t,
 
602
                                                 ctypes.c_int]
 
603
    handshake_set_private_extensions.restype = None
 
604
    
 
605
    credentials_set = _library.gnutls_credentials_set
 
606
    credentials_set.argtypes = [session_t, credentials_type_t,
 
607
                                ctypes.c_void_p]
 
608
    credentials_set.restype = _error_code
 
609
    
 
610
    strerror = _library.gnutls_strerror
 
611
    strerror.argtypes = [ctypes.c_int]
 
612
    strerror.restype = ctypes.c_char_p
 
613
    
 
614
    certificate_type_get = _library.gnutls_certificate_type_get
 
615
    certificate_type_get.argtypes = [session_t]
 
616
    certificate_type_get.restype = _error_code
 
617
    
 
618
    certificate_get_peers = _library.gnutls_certificate_get_peers
 
619
    certificate_get_peers.argtypes = [session_t,
 
620
                                      ctypes.POINTER(ctypes.c_uint)]
 
621
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
 
622
    
 
623
    global_set_log_level = _library.gnutls_global_set_log_level
 
624
    global_set_log_level.argtypes = [ctypes.c_int]
 
625
    global_set_log_level.restype = None
 
626
    
 
627
    global_set_log_function = _library.gnutls_global_set_log_function
 
628
    global_set_log_function.argtypes = [log_func]
 
629
    global_set_log_function.restype = None
 
630
    
 
631
    deinit = _library.gnutls_deinit
 
632
    deinit.argtypes = [session_t]
 
633
    deinit.restype = None
 
634
    
 
635
    handshake = _library.gnutls_handshake
 
636
    handshake.argtypes = [session_t]
 
637
    handshake.restype = _error_code
 
638
    handshake.errcheck = _retry_on_error
 
639
    
 
640
    transport_set_ptr = _library.gnutls_transport_set_ptr
 
641
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
 
642
    transport_set_ptr.restype = None
 
643
    
 
644
    bye = _library.gnutls_bye
 
645
    bye.argtypes = [session_t, close_request_t]
 
646
    bye.restype = _error_code
 
647
    bye.errcheck = _retry_on_error
 
648
    
 
649
    check_version = _library.gnutls_check_version
 
650
    check_version.argtypes = [ctypes.c_char_p]
 
651
    check_version.restype = ctypes.c_char_p
 
652
    
 
653
    # All the function declarations below are from gnutls/openpgp.h
 
654
    
 
655
    openpgp_crt_init = _library.gnutls_openpgp_crt_init
 
656
    openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
 
657
    openpgp_crt_init.restype = _error_code
 
658
    
 
659
    openpgp_crt_import = _library.gnutls_openpgp_crt_import
 
660
    openpgp_crt_import.argtypes = [openpgp_crt_t,
 
661
                                   ctypes.POINTER(datum_t),
 
662
                                   openpgp_crt_fmt_t]
 
663
    openpgp_crt_import.restype = _error_code
 
664
    
 
665
    openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
 
666
    openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
 
667
                                        ctypes.POINTER(ctypes.c_uint)]
 
668
    openpgp_crt_verify_self.restype = _error_code
 
669
    
 
670
    openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
 
671
    openpgp_crt_deinit.argtypes = [openpgp_crt_t]
 
672
    openpgp_crt_deinit.restype = None
 
673
    
 
674
    openpgp_crt_get_fingerprint = (
 
675
        _library.gnutls_openpgp_crt_get_fingerprint)
 
676
    openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
 
677
                                            ctypes.c_void_p,
 
678
                                            ctypes.POINTER(
 
679
                                                ctypes.c_size_t)]
 
680
    openpgp_crt_get_fingerprint.restype = _error_code
 
681
    
 
682
    # Remove non-public functions
 
683
    del _error_code, _retry_on_error
 
684
# Create the global "gnutls" object, simulating a module
 
685
gnutls = GnuTLS()
 
686
 
 
687
def call_pipe(connection,       # : multiprocessing.Connection
 
688
              func, *args, **kwargs):
 
689
    """This function is meant to be called by multiprocessing.Process
 
690
    
 
691
    This function runs func(*args, **kwargs), and writes the resulting
 
692
    return value on the provided multiprocessing.Connection.
 
693
    """
 
694
    connection.send(func(*args, **kwargs))
 
695
    connection.close()
409
696
 
410
697
class Client(object):
411
698
    """A representation of a client host served by this server.
438
725
    last_checker_status: integer between 0 and 255 reflecting exit
439
726
                         status of last checker. -1 reflects crashed
440
727
                         checker, -2 means no checker completed yet.
 
728
    last_checker_signal: The signal which killed the last checker, if
 
729
                         last_checker_status is -1
441
730
    last_enabled: datetime.datetime(); (UTC) or None
442
731
    name:       string; from the config file, used in log messages and
443
732
                        D-Bus identifiers
456
745
                          "fingerprint", "host", "interval",
457
746
                          "last_approval_request", "last_checked_ok",
458
747
                          "last_enabled", "name", "timeout")
459
 
    client_defaults = { "timeout": "PT5M",
460
 
                        "extended_timeout": "PT15M",
461
 
                        "interval": "PT2M",
462
 
                        "checker": "fping -q -- %%(host)s",
463
 
                        "host": "",
464
 
                        "approval_delay": "PT0S",
465
 
                        "approval_duration": "PT1S",
466
 
                        "approved_by_default": "True",
467
 
                        "enabled": "True",
468
 
                        }
 
748
    client_defaults = {
 
749
        "timeout": "PT5M",
 
750
        "extended_timeout": "PT15M",
 
751
        "interval": "PT2M",
 
752
        "checker": "fping -q -- %%(host)s",
 
753
        "host": "",
 
754
        "approval_delay": "PT0S",
 
755
        "approval_duration": "PT1S",
 
756
        "approved_by_default": "True",
 
757
        "enabled": "True",
 
758
    }
469
759
    
470
760
    @staticmethod
471
761
    def config_parser(config):
487
777
            client["enabled"] = config.getboolean(client_name,
488
778
                                                  "enabled")
489
779
            
 
780
            # Uppercase and remove spaces from fingerprint for later
 
781
            # comparison purposes with return value from the
 
782
            # fingerprint() function
490
783
            client["fingerprint"] = (section["fingerprint"].upper()
491
784
                                     .replace(" ", ""))
492
785
            if "secret" in section:
534
827
            self.expires = None
535
828
        
536
829
        logger.debug("Creating client %r", self.name)
537
 
        # Uppercase and remove spaces from fingerprint for later
538
 
        # comparison purposes with return value from the fingerprint()
539
 
        # function
540
830
        logger.debug("  Fingerprint: %s", self.fingerprint)
541
831
        self.created = settings.get("created",
542
832
                                    datetime.datetime.utcnow())
549
839
        self.current_checker_command = None
550
840
        self.approved = None
551
841
        self.approvals_pending = 0
552
 
        self.changedstate = (multiprocessing_manager
553
 
                             .Condition(multiprocessing_manager
554
 
                                        .Lock()))
555
 
        self.client_structure = [attr for attr in
556
 
                                 self.__dict__.iterkeys()
 
842
        self.changedstate = multiprocessing_manager.Condition(
 
843
            multiprocessing_manager.Lock())
 
844
        self.client_structure = [attr
 
845
                                 for attr in self.__dict__.iterkeys()
557
846
                                 if not attr.startswith("_")]
558
847
        self.client_structure.append("client_structure")
559
848
        
560
 
        for name, t in inspect.getmembers(type(self),
561
 
                                          lambda obj:
562
 
                                              isinstance(obj,
563
 
                                                         property)):
 
849
        for name, t in inspect.getmembers(
 
850
                type(self), lambda obj: isinstance(obj, property)):
564
851
            if not name.startswith("_"):
565
852
                self.client_structure.append(name)
566
853
    
608
895
        # and every interval from then on.
609
896
        if self.checker_initiator_tag is not None:
610
897
            gobject.source_remove(self.checker_initiator_tag)
611
 
        self.checker_initiator_tag = (gobject.timeout_add
612
 
                                      (int(self.interval
613
 
                                           .total_seconds() * 1000),
614
 
                                       self.start_checker))
 
898
        self.checker_initiator_tag = gobject.timeout_add(
 
899
            int(self.interval.total_seconds() * 1000),
 
900
            self.start_checker)
615
901
        # Schedule a disable() when 'timeout' has passed
616
902
        if self.disable_initiator_tag is not None:
617
903
            gobject.source_remove(self.disable_initiator_tag)
618
 
        self.disable_initiator_tag = (gobject.timeout_add
619
 
                                      (int(self.timeout
620
 
                                           .total_seconds() * 1000),
621
 
                                       self.disable))
 
904
        self.disable_initiator_tag = gobject.timeout_add(
 
905
            int(self.timeout.total_seconds() * 1000), self.disable)
622
906
        # Also start a new checker *right now*.
623
907
        self.start_checker()
624
908
    
625
 
    def checker_callback(self, pid, condition, command):
 
909
    def checker_callback(self, source, condition, connection,
 
910
                         command):
626
911
        """The checker has completed, so take appropriate actions."""
627
912
        self.checker_callback_tag = None
628
913
        self.checker = None
629
 
        if os.WIFEXITED(condition):
630
 
            self.last_checker_status = os.WEXITSTATUS(condition)
 
914
        # Read return code from connection (see call_pipe)
 
915
        returncode = connection.recv()
 
916
        connection.close()
 
917
        
 
918
        if returncode >= 0:
 
919
            self.last_checker_status = returncode
 
920
            self.last_checker_signal = None
631
921
            if self.last_checker_status == 0:
632
922
                logger.info("Checker for %(name)s succeeded",
633
923
                            vars(self))
634
924
                self.checked_ok()
635
925
            else:
636
 
                logger.info("Checker for %(name)s failed",
637
 
                            vars(self))
 
926
                logger.info("Checker for %(name)s failed", vars(self))
638
927
        else:
639
928
            self.last_checker_status = -1
 
929
            self.last_checker_signal = -returncode
640
930
            logger.warning("Checker for %(name)s crashed?",
641
931
                           vars(self))
 
932
        return False
642
933
    
643
934
    def checked_ok(self):
644
935
        """Assert that the client has been seen, alive and well."""
645
936
        self.last_checked_ok = datetime.datetime.utcnow()
646
937
        self.last_checker_status = 0
 
938
        self.last_checker_signal = None
647
939
        self.bump_timeout()
648
940
    
649
941
    def bump_timeout(self, timeout=None):
654
946
            gobject.source_remove(self.disable_initiator_tag)
655
947
            self.disable_initiator_tag = None
656
948
        if getattr(self, "enabled", False):
657
 
            self.disable_initiator_tag = (gobject.timeout_add
658
 
                                          (int(timeout.total_seconds()
659
 
                                               * 1000), self.disable))
 
949
            self.disable_initiator_tag = gobject.timeout_add(
 
950
                int(timeout.total_seconds() * 1000), self.disable)
660
951
            self.expires = datetime.datetime.utcnow() + timeout
661
952
    
662
953
    def need_approval(self):
676
967
        # than 'timeout' for the client to be disabled, which is as it
677
968
        # should be.
678
969
        
679
 
        # If a checker exists, make sure it is not a zombie
680
 
        try:
681
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
682
 
        except AttributeError:
683
 
            pass
684
 
        except OSError as error:
685
 
            if error.errno != errno.ECHILD:
686
 
                raise
687
 
        else:
688
 
            if pid:
689
 
                logger.warning("Checker was a zombie")
690
 
                gobject.source_remove(self.checker_callback_tag)
691
 
                self.checker_callback(pid, status,
692
 
                                      self.current_checker_command)
 
970
        if self.checker is not None and not self.checker.is_alive():
 
971
            logger.warning("Checker was not alive; joining")
 
972
            self.checker.join()
 
973
            self.checker = None
693
974
        # Start a new checker if needed
694
975
        if self.checker is None:
695
976
            # Escape attributes for the shell
696
 
            escaped_attrs = { attr:
697
 
                                  re.escape(str(getattr(self, attr)))
698
 
                              for attr in self.runtime_expansions }
 
977
            escaped_attrs = {
 
978
                attr: re.escape(str(getattr(self, attr)))
 
979
                for attr in self.runtime_expansions }
699
980
            try:
700
981
                command = self.checker_command % escaped_attrs
701
982
            except TypeError as error:
702
983
                logger.error('Could not format string "%s"',
703
 
                             self.checker_command, exc_info=error)
704
 
                return True # Try again later
 
984
                             self.checker_command,
 
985
                             exc_info=error)
 
986
                return True     # Try again later
705
987
            self.current_checker_command = command
706
 
            try:
707
 
                logger.info("Starting checker %r for %s",
708
 
                            command, self.name)
709
 
                # We don't need to redirect stdout and stderr, since
710
 
                # in normal mode, that is already done by daemon(),
711
 
                # and in debug mode we don't want to.  (Stdin is
712
 
                # always replaced by /dev/null.)
713
 
                # The exception is when not debugging but nevertheless
714
 
                # running in the foreground; use the previously
715
 
                # created wnull.
716
 
                popen_args = {}
717
 
                if (not self.server_settings["debug"]
718
 
                    and self.server_settings["foreground"]):
719
 
                    popen_args.update({"stdout": wnull,
720
 
                                       "stderr": wnull })
721
 
                self.checker = subprocess.Popen(command,
722
 
                                                close_fds=True,
723
 
                                                shell=True, 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,
731
 
                                          self.checker_callback,
732
 
                                          data=command))
733
 
            # The checker may have completed before the gobject
734
 
            # watch was added.  Check for this.
735
 
            try:
736
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
737
 
            except OSError as error:
738
 
                if error.errno == errno.ECHILD:
739
 
                    # This should never happen
740
 
                    logger.error("Child process vanished",
741
 
                                 exc_info=error)
742
 
                    return True
743
 
                raise
744
 
            if pid:
745
 
                gobject.source_remove(self.checker_callback_tag)
746
 
                self.checker_callback(pid, status, command)
 
988
            logger.info("Starting checker %r for %s", command,
 
989
                        self.name)
 
990
            # We don't need to redirect stdout and stderr, since
 
991
            # in normal mode, that is already done by daemon(),
 
992
            # and in debug mode we don't want to.  (Stdin is
 
993
            # always replaced by /dev/null.)
 
994
            # The exception is when not debugging but nevertheless
 
995
            # running in the foreground; use the previously
 
996
            # created wnull.
 
997
            popen_args = { "close_fds": True,
 
998
                           "shell": True,
 
999
                           "cwd": "/" }
 
1000
            if (not self.server_settings["debug"]
 
1001
                and self.server_settings["foreground"]):
 
1002
                popen_args.update({"stdout": wnull,
 
1003
                                   "stderr": wnull })
 
1004
            pipe = multiprocessing.Pipe(duplex = False)
 
1005
            self.checker = multiprocessing.Process(
 
1006
                target = call_pipe,
 
1007
                args = (pipe[1], subprocess.call, command),
 
1008
                kwargs = popen_args)
 
1009
            self.checker.start()
 
1010
            self.checker_callback_tag = gobject.io_add_watch(
 
1011
                pipe[0].fileno(), gobject.IO_IN,
 
1012
                self.checker_callback, pipe[0], command)
747
1013
        # Re-run this periodically if run by gobject.timeout_add
748
1014
        return True
749
1015
    
755
1021
        if getattr(self, "checker", None) is None:
756
1022
            return
757
1023
        logger.debug("Stopping checker for %(name)s", vars(self))
758
 
        try:
759
 
            self.checker.terminate()
760
 
            #time.sleep(0.5)
761
 
            #if self.checker.poll() is None:
762
 
            #    self.checker.kill()
763
 
        except OSError as error:
764
 
            if error.errno != errno.ESRCH: # No such process
765
 
                raise
 
1024
        self.checker.terminate()
766
1025
        self.checker = None
767
1026
 
768
1027
 
769
 
def dbus_service_property(dbus_interface, signature="v",
770
 
                          access="readwrite", byte_arrays=False):
 
1028
def dbus_service_property(dbus_interface,
 
1029
                          signature="v",
 
1030
                          access="readwrite",
 
1031
                          byte_arrays=False):
771
1032
    """Decorators for marking methods of a DBusObjectWithProperties to
772
1033
    become properties on the D-Bus.
773
1034
    
783
1044
    if byte_arrays and signature != "ay":
784
1045
        raise ValueError("Byte arrays not supported for non-'ay'"
785
1046
                         " signature {!r}".format(signature))
 
1047
    
786
1048
    def decorator(func):
787
1049
        func._dbus_is_property = True
788
1050
        func._dbus_interface = dbus_interface
793
1055
            func._dbus_name = func._dbus_name[:-14]
794
1056
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
795
1057
        return func
 
1058
    
796
1059
    return decorator
797
1060
 
798
1061
 
807
1070
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
808
1071
                    "false"}
809
1072
    """
 
1073
    
810
1074
    def decorator(func):
811
1075
        func._dbus_is_interface = True
812
1076
        func._dbus_interface = dbus_interface
813
1077
        func._dbus_name = dbus_interface
814
1078
        return func
 
1079
    
815
1080
    return decorator
816
1081
 
817
1082
 
826
1091
                           access="r")
827
1092
    def Property_dbus_property(self):
828
1093
        return dbus.Boolean(False)
 
1094
    
 
1095
    See also the DBusObjectWithAnnotations class.
829
1096
    """
 
1097
    
830
1098
    def decorator(func):
831
1099
        func._dbus_annotations = annotations
832
1100
        return func
 
1101
    
833
1102
    return decorator
834
1103
 
835
1104
 
838
1107
    """
839
1108
    pass
840
1109
 
 
1110
 
841
1111
class DBusPropertyAccessException(DBusPropertyException):
842
1112
    """A property's access permissions disallows an operation.
843
1113
    """
850
1120
    pass
851
1121
 
852
1122
 
853
 
class DBusObjectWithProperties(dbus.service.Object):
854
 
    """A D-Bus object with properties.
 
1123
class DBusObjectWithAnnotations(dbus.service.Object):
 
1124
    """A D-Bus object with annotations.
855
1125
    
856
 
    Classes inheriting from this can use the dbus_service_property
857
 
    decorator to expose methods as D-Bus properties.  It exposes the
858
 
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
1126
    Classes inheriting from this can use the dbus_annotations
 
1127
    decorator to add annotations to methods or signals.
859
1128
    """
860
1129
    
861
1130
    @staticmethod
871
1140
    def _get_all_dbus_things(self, thing):
872
1141
        """Returns a generator of (name, attribute) pairs
873
1142
        """
874
 
        return ((getattr(athing.__get__(self), "_dbus_name",
875
 
                         name),
 
1143
        return ((getattr(athing.__get__(self), "_dbus_name", name),
876
1144
                 athing.__get__(self))
877
1145
                for cls in self.__class__.__mro__
878
1146
                for name, athing in
879
 
                inspect.getmembers(cls,
880
 
                                   self._is_dbus_thing(thing)))
 
1147
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
 
1148
    
 
1149
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1150
                         out_signature = "s",
 
1151
                         path_keyword = 'object_path',
 
1152
                         connection_keyword = 'connection')
 
1153
    def Introspect(self, object_path, connection):
 
1154
        """Overloading of standard D-Bus method.
 
1155
        
 
1156
        Inserts annotation tags on methods and signals.
 
1157
        """
 
1158
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
1159
                                                   connection)
 
1160
        try:
 
1161
            document = xml.dom.minidom.parseString(xmlstring)
 
1162
            
 
1163
            for if_tag in document.getElementsByTagName("interface"):
 
1164
                # Add annotation tags
 
1165
                for typ in ("method", "signal"):
 
1166
                    for tag in if_tag.getElementsByTagName(typ):
 
1167
                        annots = dict()
 
1168
                        for name, prop in (self.
 
1169
                                           _get_all_dbus_things(typ)):
 
1170
                            if (name == tag.getAttribute("name")
 
1171
                                and prop._dbus_interface
 
1172
                                == if_tag.getAttribute("name")):
 
1173
                                annots.update(getattr(
 
1174
                                    prop, "_dbus_annotations", {}))
 
1175
                        for name, value in annots.items():
 
1176
                            ann_tag = document.createElement(
 
1177
                                "annotation")
 
1178
                            ann_tag.setAttribute("name", name)
 
1179
                            ann_tag.setAttribute("value", value)
 
1180
                            tag.appendChild(ann_tag)
 
1181
                # Add interface annotation tags
 
1182
                for annotation, value in dict(
 
1183
                    itertools.chain.from_iterable(
 
1184
                        annotations().items()
 
1185
                        for name, annotations
 
1186
                        in self._get_all_dbus_things("interface")
 
1187
                        if name == if_tag.getAttribute("name")
 
1188
                        )).items():
 
1189
                    ann_tag = document.createElement("annotation")
 
1190
                    ann_tag.setAttribute("name", annotation)
 
1191
                    ann_tag.setAttribute("value", value)
 
1192
                    if_tag.appendChild(ann_tag)
 
1193
                # Fix argument name for the Introspect method itself
 
1194
                if (if_tag.getAttribute("name")
 
1195
                                == dbus.INTROSPECTABLE_IFACE):
 
1196
                    for cn in if_tag.getElementsByTagName("method"):
 
1197
                        if cn.getAttribute("name") == "Introspect":
 
1198
                            for arg in cn.getElementsByTagName("arg"):
 
1199
                                if (arg.getAttribute("direction")
 
1200
                                    == "out"):
 
1201
                                    arg.setAttribute("name",
 
1202
                                                     "xml_data")
 
1203
            xmlstring = document.toxml("utf-8")
 
1204
            document.unlink()
 
1205
        except (AttributeError, xml.dom.DOMException,
 
1206
                xml.parsers.expat.ExpatError) as error:
 
1207
            logger.error("Failed to override Introspection method",
 
1208
                         exc_info=error)
 
1209
        return xmlstring
 
1210
 
 
1211
 
 
1212
class DBusObjectWithProperties(DBusObjectWithAnnotations):
 
1213
    """A D-Bus object with properties.
 
1214
    
 
1215
    Classes inheriting from this can use the dbus_service_property
 
1216
    decorator to expose methods as D-Bus properties.  It exposes the
 
1217
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
1218
    """
881
1219
    
882
1220
    def _get_dbus_property(self, interface_name, property_name):
883
1221
        """Returns a bound method if one exists which is a D-Bus
884
1222
        property with the specified name and interface.
885
1223
        """
886
 
        for cls in  self.__class__.__mro__:
887
 
            for name, value in (inspect.getmembers
888
 
                                (cls,
889
 
                                 self._is_dbus_thing("property"))):
 
1224
        for cls in self.__class__.__mro__:
 
1225
            for name, value in inspect.getmembers(
 
1226
                    cls, self._is_dbus_thing("property")):
890
1227
                if (value._dbus_name == property_name
891
1228
                    and value._dbus_interface == interface_name):
892
1229
                    return value.__get__(self)
893
1230
        
894
1231
        # No such property
895
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
896
 
                                   + interface_name + "."
897
 
                                   + property_name)
898
 
    
899
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
1232
        raise DBusPropertyNotFound("{}:{}.{}".format(
 
1233
            self.dbus_object_path, interface_name, property_name))
 
1234
    
 
1235
    @classmethod
 
1236
    def _get_all_interface_names(cls):
 
1237
        """Get a sequence of all interfaces supported by an object"""
 
1238
        return (name for name in set(getattr(getattr(x, attr),
 
1239
                                             "_dbus_interface", None)
 
1240
                                     for x in (inspect.getmro(cls))
 
1241
                                     for attr in dir(x))
 
1242
                if name is not None)
 
1243
    
 
1244
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1245
                         in_signature="ss",
900
1246
                         out_signature="v")
901
1247
    def Get(self, interface_name, property_name):
902
1248
        """Standard D-Bus property Get() method, see D-Bus standard.
927
1273
                                            for byte in value))
928
1274
        prop(value)
929
1275
    
930
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
1276
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1277
                         in_signature="s",
931
1278
                         out_signature="a{sv}")
932
1279
    def GetAll(self, interface_name):
933
1280
        """Standard D-Bus property GetAll() method, see D-Bus
948
1295
            if not hasattr(value, "variant_level"):
949
1296
                properties[name] = value
950
1297
                continue
951
 
            properties[name] = type(value)(value, variant_level=
952
 
                                           value.variant_level+1)
 
1298
            properties[name] = type(value)(
 
1299
                value, variant_level = value.variant_level + 1)
953
1300
        return dbus.Dictionary(properties, signature="sv")
954
1301
    
955
1302
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
969
1316
        
970
1317
        Inserts property tags and interface annotation tags.
971
1318
        """
972
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
973
 
                                                   connection)
 
1319
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1320
                                                         object_path,
 
1321
                                                         connection)
974
1322
        try:
975
1323
            document = xml.dom.minidom.parseString(xmlstring)
 
1324
            
976
1325
            def make_tag(document, name, prop):
977
1326
                e = document.createElement("property")
978
1327
                e.setAttribute("name", name)
979
1328
                e.setAttribute("type", prop._dbus_signature)
980
1329
                e.setAttribute("access", prop._dbus_access)
981
1330
                return e
 
1331
            
982
1332
            for if_tag in document.getElementsByTagName("interface"):
983
1333
                # Add property tags
984
1334
                for tag in (make_tag(document, name, prop)
987
1337
                            if prop._dbus_interface
988
1338
                            == if_tag.getAttribute("name")):
989
1339
                    if_tag.appendChild(tag)
990
 
                # Add annotation tags
991
 
                for typ in ("method", "signal", "property"):
992
 
                    for tag in if_tag.getElementsByTagName(typ):
993
 
                        annots = dict()
994
 
                        for name, prop in (self.
995
 
                                           _get_all_dbus_things(typ)):
996
 
                            if (name == tag.getAttribute("name")
997
 
                                and prop._dbus_interface
998
 
                                == if_tag.getAttribute("name")):
999
 
                                annots.update(getattr
1000
 
                                              (prop,
1001
 
                                               "_dbus_annotations",
1002
 
                                               {}))
1003
 
                        for name, value in annots.items():
1004
 
                            ann_tag = document.createElement(
1005
 
                                "annotation")
1006
 
                            ann_tag.setAttribute("name", name)
1007
 
                            ann_tag.setAttribute("value", value)
1008
 
                            tag.appendChild(ann_tag)
1009
 
                # Add interface annotation tags
1010
 
                for annotation, value in dict(
1011
 
                    itertools.chain.from_iterable(
1012
 
                        annotations().items()
1013
 
                        for name, annotations in
1014
 
                        self._get_all_dbus_things("interface")
1015
 
                        if name == if_tag.getAttribute("name")
1016
 
                        )).items():
1017
 
                    ann_tag = document.createElement("annotation")
1018
 
                    ann_tag.setAttribute("name", annotation)
1019
 
                    ann_tag.setAttribute("value", value)
1020
 
                    if_tag.appendChild(ann_tag)
 
1340
                # Add annotation tags for properties
 
1341
                for tag in if_tag.getElementsByTagName("property"):
 
1342
                    annots = dict()
 
1343
                    for name, prop in self._get_all_dbus_things(
 
1344
                            "property"):
 
1345
                        if (name == tag.getAttribute("name")
 
1346
                            and prop._dbus_interface
 
1347
                            == if_tag.getAttribute("name")):
 
1348
                            annots.update(getattr(
 
1349
                                prop, "_dbus_annotations", {}))
 
1350
                    for name, value in annots.items():
 
1351
                        ann_tag = document.createElement(
 
1352
                            "annotation")
 
1353
                        ann_tag.setAttribute("name", name)
 
1354
                        ann_tag.setAttribute("value", value)
 
1355
                        tag.appendChild(ann_tag)
1021
1356
                # Add the names to the return values for the
1022
1357
                # "org.freedesktop.DBus.Properties" methods
1023
1358
                if (if_tag.getAttribute("name")
1041
1376
                         exc_info=error)
1042
1377
        return xmlstring
1043
1378
 
 
1379
try:
 
1380
    dbus.OBJECT_MANAGER_IFACE
 
1381
except AttributeError:
 
1382
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
 
1383
 
 
1384
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
 
1385
    """A D-Bus object with an ObjectManager.
 
1386
    
 
1387
    Classes inheriting from this exposes the standard
 
1388
    GetManagedObjects call and the InterfacesAdded and
 
1389
    InterfacesRemoved signals on the standard
 
1390
    "org.freedesktop.DBus.ObjectManager" interface.
 
1391
    
 
1392
    Note: No signals are sent automatically; they must be sent
 
1393
    manually.
 
1394
    """
 
1395
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
1396
                         out_signature = "a{oa{sa{sv}}}")
 
1397
    def GetManagedObjects(self):
 
1398
        """This function must be overridden"""
 
1399
        raise NotImplementedError()
 
1400
    
 
1401
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
 
1402
                         signature = "oa{sa{sv}}")
 
1403
    def InterfacesAdded(self, object_path, interfaces_and_properties):
 
1404
        pass
 
1405
    
 
1406
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
 
1407
    def InterfacesRemoved(self, object_path, interfaces):
 
1408
        pass
 
1409
    
 
1410
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
1411
                         out_signature = "s",
 
1412
                         path_keyword = 'object_path',
 
1413
                         connection_keyword = 'connection')
 
1414
    def Introspect(self, object_path, connection):
 
1415
        """Overloading of standard D-Bus method.
 
1416
        
 
1417
        Override return argument name of GetManagedObjects to be
 
1418
        "objpath_interfaces_and_properties"
 
1419
        """
 
1420
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1421
                                                         object_path,
 
1422
                                                         connection)
 
1423
        try:
 
1424
            document = xml.dom.minidom.parseString(xmlstring)
 
1425
            
 
1426
            for if_tag in document.getElementsByTagName("interface"):
 
1427
                # Fix argument name for the GetManagedObjects method
 
1428
                if (if_tag.getAttribute("name")
 
1429
                                == dbus.OBJECT_MANAGER_IFACE):
 
1430
                    for cn in if_tag.getElementsByTagName("method"):
 
1431
                        if (cn.getAttribute("name")
 
1432
                            == "GetManagedObjects"):
 
1433
                            for arg in cn.getElementsByTagName("arg"):
 
1434
                                if (arg.getAttribute("direction")
 
1435
                                    == "out"):
 
1436
                                    arg.setAttribute(
 
1437
                                        "name",
 
1438
                                        "objpath_interfaces"
 
1439
                                        "_and_properties")
 
1440
            xmlstring = document.toxml("utf-8")
 
1441
            document.unlink()
 
1442
        except (AttributeError, xml.dom.DOMException,
 
1443
                xml.parsers.expat.ExpatError) as error:
 
1444
            logger.error("Failed to override Introspection method",
 
1445
                         exc_info = error)
 
1446
        return xmlstring
1044
1447
 
1045
1448
def datetime_to_dbus(dt, variant_level=0):
1046
1449
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1047
1450
    if dt is None:
1048
1451
        return dbus.String("", variant_level = variant_level)
1049
 
    return dbus.String(dt.isoformat(),
1050
 
                       variant_level=variant_level)
 
1452
    return dbus.String(dt.isoformat(), variant_level=variant_level)
1051
1453
 
1052
1454
 
1053
1455
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1073
1475
    (from DBusObjectWithProperties) and interfaces (from the
1074
1476
    dbus_interface_annotations decorator).
1075
1477
    """
 
1478
    
1076
1479
    def wrapper(cls):
1077
1480
        for orig_interface_name, alt_interface_name in (
1078
 
            alt_interface_names.items()):
 
1481
                alt_interface_names.items()):
1079
1482
            attr = {}
1080
1483
            interface_names = set()
1081
1484
            # Go though all attributes of the class
1083
1486
                # Ignore non-D-Bus attributes, and D-Bus attributes
1084
1487
                # with the wrong interface name
1085
1488
                if (not hasattr(attribute, "_dbus_interface")
1086
 
                    or not attribute._dbus_interface
1087
 
                    .startswith(orig_interface_name)):
 
1489
                    or not attribute._dbus_interface.startswith(
 
1490
                        orig_interface_name)):
1088
1491
                    continue
1089
1492
                # Create an alternate D-Bus interface name based on
1090
1493
                # the current name
1091
 
                alt_interface = (attribute._dbus_interface
1092
 
                                 .replace(orig_interface_name,
1093
 
                                          alt_interface_name))
 
1494
                alt_interface = attribute._dbus_interface.replace(
 
1495
                    orig_interface_name, alt_interface_name)
1094
1496
                interface_names.add(alt_interface)
1095
1497
                # Is this a D-Bus signal?
1096
1498
                if getattr(attribute, "_dbus_is_signal", False):
1097
 
                    # Extract the original non-method undecorated
1098
 
                    # function by black magic
1099
 
                    nonmethod_func = (dict(
 
1499
                    if sys.version_info.major == 2:
 
1500
                        # Extract the original non-method undecorated
 
1501
                        # function by black magic
 
1502
                        nonmethod_func = (dict(
1100
1503
                            zip(attribute.func_code.co_freevars,
1101
 
                                attribute.__closure__))["func"]
1102
 
                                      .cell_contents)
 
1504
                                attribute.__closure__))
 
1505
                                          ["func"].cell_contents)
 
1506
                    else:
 
1507
                        nonmethod_func = attribute
1103
1508
                    # Create a new, but exactly alike, function
1104
1509
                    # object, and decorate it to be a new D-Bus signal
1105
1510
                    # with the alternate D-Bus interface name
1106
 
                    new_function = (dbus.service.signal
1107
 
                                    (alt_interface,
1108
 
                                     attribute._dbus_signature)
1109
 
                                    (types.FunctionType(
1110
 
                                nonmethod_func.func_code,
1111
 
                                nonmethod_func.func_globals,
1112
 
                                nonmethod_func.func_name,
1113
 
                                nonmethod_func.func_defaults,
1114
 
                                nonmethod_func.func_closure)))
 
1511
                    if sys.version_info.major == 2:
 
1512
                        new_function = types.FunctionType(
 
1513
                            nonmethod_func.func_code,
 
1514
                            nonmethod_func.func_globals,
 
1515
                            nonmethod_func.func_name,
 
1516
                            nonmethod_func.func_defaults,
 
1517
                            nonmethod_func.func_closure)
 
1518
                    else:
 
1519
                        new_function = types.FunctionType(
 
1520
                            nonmethod_func.__code__,
 
1521
                            nonmethod_func.__globals__,
 
1522
                            nonmethod_func.__name__,
 
1523
                            nonmethod_func.__defaults__,
 
1524
                            nonmethod_func.__closure__)
 
1525
                    new_function = (dbus.service.signal(
 
1526
                        alt_interface,
 
1527
                        attribute._dbus_signature)(new_function))
1115
1528
                    # Copy annotations, if any
1116
1529
                    try:
1117
 
                        new_function._dbus_annotations = (
1118
 
                            dict(attribute._dbus_annotations))
 
1530
                        new_function._dbus_annotations = dict(
 
1531
                            attribute._dbus_annotations)
1119
1532
                    except AttributeError:
1120
1533
                        pass
1121
1534
                    # Define a creator of a function to call both the
1126
1539
                        """This function is a scope container to pass
1127
1540
                        func1 and func2 to the "call_both" function
1128
1541
                        outside of its arguments"""
 
1542
                        
 
1543
                        @functools.wraps(func2)
1129
1544
                        def call_both(*args, **kwargs):
1130
1545
                            """This function will emit two D-Bus
1131
1546
                            signals by calling func1 and func2"""
1132
1547
                            func1(*args, **kwargs)
1133
1548
                            func2(*args, **kwargs)
 
1549
                        # Make wrapper function look like a D-Bus signal
 
1550
                        for name, attr in inspect.getmembers(func2):
 
1551
                            if name.startswith("_dbus_"):
 
1552
                                setattr(call_both, name, attr)
 
1553
                        
1134
1554
                        return call_both
1135
1555
                    # Create the "call_both" function and add it to
1136
1556
                    # the class
1141
1561
                    # object.  Decorate it to be a new D-Bus method
1142
1562
                    # with the alternate D-Bus interface name.  Add it
1143
1563
                    # to the class.
1144
 
                    attr[attrname] = (dbus.service.method
1145
 
                                      (alt_interface,
1146
 
                                       attribute._dbus_in_signature,
1147
 
                                       attribute._dbus_out_signature)
1148
 
                                      (types.FunctionType
1149
 
                                       (attribute.func_code,
1150
 
                                        attribute.func_globals,
1151
 
                                        attribute.func_name,
1152
 
                                        attribute.func_defaults,
1153
 
                                        attribute.func_closure)))
 
1564
                    attr[attrname] = (
 
1565
                        dbus.service.method(
 
1566
                            alt_interface,
 
1567
                            attribute._dbus_in_signature,
 
1568
                            attribute._dbus_out_signature)
 
1569
                        (types.FunctionType(attribute.func_code,
 
1570
                                            attribute.func_globals,
 
1571
                                            attribute.func_name,
 
1572
                                            attribute.func_defaults,
 
1573
                                            attribute.func_closure)))
1154
1574
                    # Copy annotations, if any
1155
1575
                    try:
1156
 
                        attr[attrname]._dbus_annotations = (
1157
 
                            dict(attribute._dbus_annotations))
 
1576
                        attr[attrname]._dbus_annotations = dict(
 
1577
                            attribute._dbus_annotations)
1158
1578
                    except AttributeError:
1159
1579
                        pass
1160
1580
                # Is this a D-Bus property?
1163
1583
                    # object, and decorate it to be a new D-Bus
1164
1584
                    # property with the alternate D-Bus interface
1165
1585
                    # name.  Add it to the class.
1166
 
                    attr[attrname] = (dbus_service_property
1167
 
                                      (alt_interface,
1168
 
                                       attribute._dbus_signature,
1169
 
                                       attribute._dbus_access,
1170
 
                                       attribute
1171
 
                                       ._dbus_get_args_options
1172
 
                                       ["byte_arrays"])
1173
 
                                      (types.FunctionType
1174
 
                                       (attribute.func_code,
1175
 
                                        attribute.func_globals,
1176
 
                                        attribute.func_name,
1177
 
                                        attribute.func_defaults,
1178
 
                                        attribute.func_closure)))
 
1586
                    attr[attrname] = (dbus_service_property(
 
1587
                        alt_interface, attribute._dbus_signature,
 
1588
                        attribute._dbus_access,
 
1589
                        attribute._dbus_get_args_options
 
1590
                        ["byte_arrays"])
 
1591
                                      (types.FunctionType(
 
1592
                                          attribute.func_code,
 
1593
                                          attribute.func_globals,
 
1594
                                          attribute.func_name,
 
1595
                                          attribute.func_defaults,
 
1596
                                          attribute.func_closure)))
1179
1597
                    # Copy annotations, if any
1180
1598
                    try:
1181
 
                        attr[attrname]._dbus_annotations = (
1182
 
                            dict(attribute._dbus_annotations))
 
1599
                        attr[attrname]._dbus_annotations = dict(
 
1600
                            attribute._dbus_annotations)
1183
1601
                    except AttributeError:
1184
1602
                        pass
1185
1603
                # Is this a D-Bus interface?
1188
1606
                    # object.  Decorate it to be a new D-Bus interface
1189
1607
                    # with the alternate D-Bus interface name.  Add it
1190
1608
                    # to the class.
1191
 
                    attr[attrname] = (dbus_interface_annotations
1192
 
                                      (alt_interface)
1193
 
                                      (types.FunctionType
1194
 
                                       (attribute.func_code,
1195
 
                                        attribute.func_globals,
1196
 
                                        attribute.func_name,
1197
 
                                        attribute.func_defaults,
1198
 
                                        attribute.func_closure)))
 
1609
                    attr[attrname] = (
 
1610
                        dbus_interface_annotations(alt_interface)
 
1611
                        (types.FunctionType(attribute.func_code,
 
1612
                                            attribute.func_globals,
 
1613
                                            attribute.func_name,
 
1614
                                            attribute.func_defaults,
 
1615
                                            attribute.func_closure)))
1199
1616
            if deprecate:
1200
1617
                # Deprecate all alternate interfaces
1201
1618
                iname="_AlternateDBusNames_interface_annotation{}"
1202
1619
                for interface_name in interface_names:
 
1620
                    
1203
1621
                    @dbus_interface_annotations(interface_name)
1204
1622
                    def func(self):
1205
1623
                        return { "org.freedesktop.DBus.Deprecated":
1206
 
                                     "true" }
 
1624
                                 "true" }
1207
1625
                    # Find an unused name
1208
1626
                    for aname in (iname.format(i)
1209
1627
                                  for i in itertools.count()):
1214
1632
                # Replace the class with a new subclass of it with
1215
1633
                # methods, signals, etc. as created above.
1216
1634
                cls = type(b"{}Alternate".format(cls.__name__),
1217
 
                           (cls,), attr)
 
1635
                           (cls, ), attr)
1218
1636
        return cls
 
1637
    
1219
1638
    return wrapper
1220
1639
 
1221
1640
 
1222
1641
@alternate_dbus_interfaces({"se.recompile.Mandos":
1223
 
                                "se.bsnet.fukt.Mandos"})
 
1642
                            "se.bsnet.fukt.Mandos"})
1224
1643
class ClientDBus(Client, DBusObjectWithProperties):
1225
1644
    """A Client class using D-Bus
1226
1645
    
1230
1649
    """
1231
1650
    
1232
1651
    runtime_expansions = (Client.runtime_expansions
1233
 
                          + ("dbus_object_path",))
 
1652
                          + ("dbus_object_path", ))
1234
1653
    
1235
1654
    _interface = "se.recompile.Mandos.Client"
1236
1655
    
1244
1663
        client_object_name = str(self.name).translate(
1245
1664
            {ord("."): ord("_"),
1246
1665
             ord("-"): ord("_")})
1247
 
        self.dbus_object_path = (dbus.ObjectPath
1248
 
                                 ("/clients/" + client_object_name))
 
1666
        self.dbus_object_path = dbus.ObjectPath(
 
1667
            "/clients/" + client_object_name)
1249
1668
        DBusObjectWithProperties.__init__(self, self.bus,
1250
1669
                                          self.dbus_object_path)
1251
1670
    
1252
 
    def notifychangeproperty(transform_func,
1253
 
                             dbus_name, type_func=lambda x: x,
1254
 
                             variant_level=1, invalidate_only=False,
 
1671
    def notifychangeproperty(transform_func, dbus_name,
 
1672
                             type_func=lambda x: x,
 
1673
                             variant_level=1,
 
1674
                             invalidate_only=False,
1255
1675
                             _interface=_interface):
1256
1676
        """ Modify a variable so that it's a property which announces
1257
1677
        its changes to DBus.
1264
1684
        variant_level: D-Bus variant level.  Default: 1
1265
1685
        """
1266
1686
        attrname = "_{}".format(dbus_name)
 
1687
        
1267
1688
        def setter(self, value):
1268
1689
            if hasattr(self, "dbus_object_path"):
1269
1690
                if (not hasattr(self, attrname) or
1270
1691
                    type_func(getattr(self, attrname, None))
1271
1692
                    != type_func(value)):
1272
1693
                    if invalidate_only:
1273
 
                        self.PropertiesChanged(_interface,
1274
 
                                               dbus.Dictionary(),
1275
 
                                               dbus.Array
1276
 
                                               ((dbus_name,)))
 
1694
                        self.PropertiesChanged(
 
1695
                            _interface, dbus.Dictionary(),
 
1696
                            dbus.Array((dbus_name, )))
1277
1697
                    else:
1278
 
                        dbus_value = transform_func(type_func(value),
1279
 
                                                    variant_level
1280
 
                                                    =variant_level)
 
1698
                        dbus_value = transform_func(
 
1699
                            type_func(value),
 
1700
                            variant_level = variant_level)
1281
1701
                        self.PropertyChanged(dbus.String(dbus_name),
1282
1702
                                             dbus_value)
1283
 
                        self.PropertiesChanged(_interface,
1284
 
                                               dbus.Dictionary({
1285
 
                                    dbus.String(dbus_name):
1286
 
                                        dbus_value }), dbus.Array())
 
1703
                        self.PropertiesChanged(
 
1704
                            _interface,
 
1705
                            dbus.Dictionary({ dbus.String(dbus_name):
 
1706
                                              dbus_value }),
 
1707
                            dbus.Array())
1287
1708
            setattr(self, attrname, value)
1288
1709
        
1289
1710
        return property(lambda self: getattr(self, attrname), setter)
1295
1716
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1296
1717
    last_enabled = notifychangeproperty(datetime_to_dbus,
1297
1718
                                        "LastEnabled")
1298
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1299
 
                                   type_func = lambda checker:
1300
 
                                       checker is not None)
 
1719
    checker = notifychangeproperty(
 
1720
        dbus.Boolean, "CheckerRunning",
 
1721
        type_func = lambda checker: checker is not None)
1301
1722
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1302
1723
                                           "LastCheckedOK")
1303
1724
    last_checker_status = notifychangeproperty(dbus.Int16,
1306
1727
        datetime_to_dbus, "LastApprovalRequest")
1307
1728
    approved_by_default = notifychangeproperty(dbus.Boolean,
1308
1729
                                               "ApprovedByDefault")
1309
 
    approval_delay = notifychangeproperty(dbus.UInt64,
1310
 
                                          "ApprovalDelay",
1311
 
                                          type_func =
1312
 
                                          lambda td: td.total_seconds()
1313
 
                                          * 1000)
 
1730
    approval_delay = notifychangeproperty(
 
1731
        dbus.UInt64, "ApprovalDelay",
 
1732
        type_func = lambda td: td.total_seconds() * 1000)
1314
1733
    approval_duration = notifychangeproperty(
1315
1734
        dbus.UInt64, "ApprovalDuration",
1316
1735
        type_func = lambda td: td.total_seconds() * 1000)
1317
1736
    host = notifychangeproperty(dbus.String, "Host")
1318
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1319
 
                                   type_func = lambda td:
1320
 
                                       td.total_seconds() * 1000)
 
1737
    timeout = notifychangeproperty(
 
1738
        dbus.UInt64, "Timeout",
 
1739
        type_func = lambda td: td.total_seconds() * 1000)
1321
1740
    extended_timeout = notifychangeproperty(
1322
1741
        dbus.UInt64, "ExtendedTimeout",
1323
1742
        type_func = lambda td: td.total_seconds() * 1000)
1324
 
    interval = notifychangeproperty(dbus.UInt64,
1325
 
                                    "Interval",
1326
 
                                    type_func =
1327
 
                                    lambda td: td.total_seconds()
1328
 
                                    * 1000)
 
1743
    interval = notifychangeproperty(
 
1744
        dbus.UInt64, "Interval",
 
1745
        type_func = lambda td: td.total_seconds() * 1000)
1329
1746
    checker_command = notifychangeproperty(dbus.String, "Checker")
1330
1747
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1331
1748
                                  invalidate_only=True)
1341
1758
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1342
1759
        Client.__del__(self, *args, **kwargs)
1343
1760
    
1344
 
    def checker_callback(self, pid, condition, command,
1345
 
                         *args, **kwargs):
1346
 
        self.checker_callback_tag = None
1347
 
        self.checker = None
1348
 
        if os.WIFEXITED(condition):
1349
 
            exitstatus = os.WEXITSTATUS(condition)
 
1761
    def checker_callback(self, source, condition,
 
1762
                         connection, command, *args, **kwargs):
 
1763
        ret = Client.checker_callback(self, source, condition,
 
1764
                                      connection, command, *args,
 
1765
                                      **kwargs)
 
1766
        exitstatus = self.last_checker_status
 
1767
        if exitstatus >= 0:
1350
1768
            # Emit D-Bus signal
1351
1769
            self.CheckerCompleted(dbus.Int16(exitstatus),
1352
 
                                  dbus.Int64(condition),
 
1770
                                  # This is specific to GNU libC
 
1771
                                  dbus.Int64(exitstatus << 8),
1353
1772
                                  dbus.String(command))
1354
1773
        else:
1355
1774
            # Emit D-Bus signal
1356
1775
            self.CheckerCompleted(dbus.Int16(-1),
1357
 
                                  dbus.Int64(condition),
 
1776
                                  dbus.Int64(
 
1777
                                      # This is specific to GNU libC
 
1778
                                      (exitstatus << 8)
 
1779
                                      | self.last_checker_signal),
1358
1780
                                  dbus.String(command))
1359
 
        
1360
 
        return Client.checker_callback(self, pid, condition, command,
1361
 
                                       *args, **kwargs)
 
1781
        return ret
1362
1782
    
1363
1783
    def start_checker(self, *args, **kwargs):
1364
1784
        old_checker_pid = getattr(self.checker, "pid", None)
1439
1859
        self.checked_ok()
1440
1860
    
1441
1861
    # Enable - method
 
1862
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1442
1863
    @dbus.service.method(_interface)
1443
1864
    def Enable(self):
1444
1865
        "D-Bus method"
1445
1866
        self.enable()
1446
1867
    
1447
1868
    # StartChecker - method
 
1869
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1448
1870
    @dbus.service.method(_interface)
1449
1871
    def StartChecker(self):
1450
1872
        "D-Bus method"
1451
1873
        self.start_checker()
1452
1874
    
1453
1875
    # Disable - method
 
1876
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1454
1877
    @dbus.service.method(_interface)
1455
1878
    def Disable(self):
1456
1879
        "D-Bus method"
1457
1880
        self.disable()
1458
1881
    
1459
1882
    # StopChecker - method
 
1883
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1460
1884
    @dbus.service.method(_interface)
1461
1885
    def StopChecker(self):
1462
1886
        self.stop_checker()
1469
1893
        return dbus.Boolean(bool(self.approvals_pending))
1470
1894
    
1471
1895
    # ApprovedByDefault - property
1472
 
    @dbus_service_property(_interface, signature="b",
 
1896
    @dbus_service_property(_interface,
 
1897
                           signature="b",
1473
1898
                           access="readwrite")
1474
1899
    def ApprovedByDefault_dbus_property(self, value=None):
1475
1900
        if value is None:       # get
1477
1902
        self.approved_by_default = bool(value)
1478
1903
    
1479
1904
    # ApprovalDelay - property
1480
 
    @dbus_service_property(_interface, signature="t",
 
1905
    @dbus_service_property(_interface,
 
1906
                           signature="t",
1481
1907
                           access="readwrite")
1482
1908
    def ApprovalDelay_dbus_property(self, value=None):
1483
1909
        if value is None:       # get
1486
1912
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1487
1913
    
1488
1914
    # ApprovalDuration - property
1489
 
    @dbus_service_property(_interface, signature="t",
 
1915
    @dbus_service_property(_interface,
 
1916
                           signature="t",
1490
1917
                           access="readwrite")
1491
1918
    def ApprovalDuration_dbus_property(self, value=None):
1492
1919
        if value is None:       # get
1495
1922
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1496
1923
    
1497
1924
    # Name - property
 
1925
    @dbus_annotations(
 
1926
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1498
1927
    @dbus_service_property(_interface, signature="s", access="read")
1499
1928
    def Name_dbus_property(self):
1500
1929
        return dbus.String(self.name)
1501
1930
    
1502
1931
    # Fingerprint - property
 
1932
    @dbus_annotations(
 
1933
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1503
1934
    @dbus_service_property(_interface, signature="s", access="read")
1504
1935
    def Fingerprint_dbus_property(self):
1505
1936
        return dbus.String(self.fingerprint)
1506
1937
    
1507
1938
    # Host - property
1508
 
    @dbus_service_property(_interface, signature="s",
 
1939
    @dbus_service_property(_interface,
 
1940
                           signature="s",
1509
1941
                           access="readwrite")
1510
1942
    def Host_dbus_property(self, value=None):
1511
1943
        if value is None:       # get
1513
1945
        self.host = str(value)
1514
1946
    
1515
1947
    # Created - property
 
1948
    @dbus_annotations(
 
1949
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1516
1950
    @dbus_service_property(_interface, signature="s", access="read")
1517
1951
    def Created_dbus_property(self):
1518
1952
        return datetime_to_dbus(self.created)
1523
1957
        return datetime_to_dbus(self.last_enabled)
1524
1958
    
1525
1959
    # Enabled - property
1526
 
    @dbus_service_property(_interface, signature="b",
 
1960
    @dbus_service_property(_interface,
 
1961
                           signature="b",
1527
1962
                           access="readwrite")
1528
1963
    def Enabled_dbus_property(self, value=None):
1529
1964
        if value is None:       # get
1534
1969
            self.disable()
1535
1970
    
1536
1971
    # LastCheckedOK - property
1537
 
    @dbus_service_property(_interface, signature="s",
 
1972
    @dbus_service_property(_interface,
 
1973
                           signature="s",
1538
1974
                           access="readwrite")
1539
1975
    def LastCheckedOK_dbus_property(self, value=None):
1540
1976
        if value is not None:
1543
1979
        return datetime_to_dbus(self.last_checked_ok)
1544
1980
    
1545
1981
    # LastCheckerStatus - property
1546
 
    @dbus_service_property(_interface, signature="n",
1547
 
                           access="read")
 
1982
    @dbus_service_property(_interface, signature="n", access="read")
1548
1983
    def LastCheckerStatus_dbus_property(self):
1549
1984
        return dbus.Int16(self.last_checker_status)
1550
1985
    
1559
1994
        return datetime_to_dbus(self.last_approval_request)
1560
1995
    
1561
1996
    # Timeout - property
1562
 
    @dbus_service_property(_interface, signature="t",
 
1997
    @dbus_service_property(_interface,
 
1998
                           signature="t",
1563
1999
                           access="readwrite")
1564
2000
    def Timeout_dbus_property(self, value=None):
1565
2001
        if value is None:       # get
1578
2014
                    is None):
1579
2015
                    return
1580
2016
                gobject.source_remove(self.disable_initiator_tag)
1581
 
                self.disable_initiator_tag = (
1582
 
                    gobject.timeout_add(
1583
 
                        int((self.expires - now).total_seconds()
1584
 
                            * 1000), self.disable))
 
2017
                self.disable_initiator_tag = gobject.timeout_add(
 
2018
                    int((self.expires - now).total_seconds() * 1000),
 
2019
                    self.disable)
1585
2020
    
1586
2021
    # ExtendedTimeout - property
1587
 
    @dbus_service_property(_interface, signature="t",
 
2022
    @dbus_service_property(_interface,
 
2023
                           signature="t",
1588
2024
                           access="readwrite")
1589
2025
    def ExtendedTimeout_dbus_property(self, value=None):
1590
2026
        if value is None:       # get
1593
2029
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1594
2030
    
1595
2031
    # Interval - property
1596
 
    @dbus_service_property(_interface, signature="t",
 
2032
    @dbus_service_property(_interface,
 
2033
                           signature="t",
1597
2034
                           access="readwrite")
1598
2035
    def Interval_dbus_property(self, value=None):
1599
2036
        if value is None:       # get
1604
2041
        if self.enabled:
1605
2042
            # Reschedule checker run
1606
2043
            gobject.source_remove(self.checker_initiator_tag)
1607
 
            self.checker_initiator_tag = (gobject.timeout_add
1608
 
                                          (value, self.start_checker))
1609
 
            self.start_checker()    # Start one now, too
 
2044
            self.checker_initiator_tag = gobject.timeout_add(
 
2045
                value, self.start_checker)
 
2046
            self.start_checker() # Start one now, too
1610
2047
    
1611
2048
    # Checker - property
1612
 
    @dbus_service_property(_interface, signature="s",
 
2049
    @dbus_service_property(_interface,
 
2050
                           signature="s",
1613
2051
                           access="readwrite")
1614
2052
    def Checker_dbus_property(self, value=None):
1615
2053
        if value is None:       # get
1617
2055
        self.checker_command = str(value)
1618
2056
    
1619
2057
    # CheckerRunning - property
1620
 
    @dbus_service_property(_interface, signature="b",
 
2058
    @dbus_service_property(_interface,
 
2059
                           signature="b",
1621
2060
                           access="readwrite")
1622
2061
    def CheckerRunning_dbus_property(self, value=None):
1623
2062
        if value is None:       # get
1628
2067
            self.stop_checker()
1629
2068
    
1630
2069
    # ObjectPath - property
 
2070
    @dbus_annotations(
 
2071
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
2072
         "org.freedesktop.DBus.Deprecated": "true"})
1631
2073
    @dbus_service_property(_interface, signature="o", access="read")
1632
2074
    def ObjectPath_dbus_property(self):
1633
2075
        return self.dbus_object_path # is already a dbus.ObjectPath
1634
2076
    
1635
2077
    # Secret = property
1636
 
    @dbus_service_property(_interface, signature="ay",
1637
 
                           access="write", byte_arrays=True)
 
2078
    @dbus_annotations(
 
2079
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
 
2080
         "invalidates"})
 
2081
    @dbus_service_property(_interface,
 
2082
                           signature="ay",
 
2083
                           access="write",
 
2084
                           byte_arrays=True)
1638
2085
    def Secret_dbus_property(self, value):
1639
2086
        self.secret = bytes(value)
1640
2087
    
1646
2093
        self._pipe = child_pipe
1647
2094
        self._pipe.send(('init', fpr, address))
1648
2095
        if not self._pipe.recv():
1649
 
            raise KeyError()
 
2096
            raise KeyError(fpr)
1650
2097
    
1651
2098
    def __getattribute__(self, name):
1652
2099
        if name == '_pipe':
1656
2103
        if data[0] == 'data':
1657
2104
            return data[1]
1658
2105
        if data[0] == 'function':
 
2106
            
1659
2107
            def func(*args, **kwargs):
1660
2108
                self._pipe.send(('funcall', name, args, kwargs))
1661
2109
                return self._pipe.recv()[1]
 
2110
            
1662
2111
            return func
1663
2112
    
1664
2113
    def __setattr__(self, name, value):
1680
2129
            logger.debug("Pipe FD: %d",
1681
2130
                         self.server.child_pipe.fileno())
1682
2131
            
1683
 
            session = (gnutls.connection
1684
 
                       .ClientSession(self.request,
1685
 
                                      gnutls.connection
1686
 
                                      .X509Credentials()))
1687
 
            
1688
 
            # Note: gnutls.connection.X509Credentials is really a
1689
 
            # generic GnuTLS certificate credentials object so long as
1690
 
            # no X.509 keys are added to it.  Therefore, we can use it
1691
 
            # here despite using OpenPGP certificates.
 
2132
            session = gnutls.ClientSession(self.request)
1692
2133
            
1693
2134
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1694
2135
            #                      "+AES-256-CBC", "+SHA1",
1698
2139
            priority = self.server.gnutls_priority
1699
2140
            if priority is None:
1700
2141
                priority = "NORMAL"
1701
 
            (gnutls.library.functions
1702
 
             .gnutls_priority_set_direct(session._c_object,
1703
 
                                         priority, None))
 
2142
            gnutls.priority_set_direct(session._c_object, priority,
 
2143
                                       None)
1704
2144
            
1705
2145
            # Start communication using the Mandos protocol
1706
2146
            # Get protocol number
1716
2156
            # Start GnuTLS connection
1717
2157
            try:
1718
2158
                session.handshake()
1719
 
            except gnutls.errors.GNUTLSError as error:
 
2159
            except gnutls.Error as error:
1720
2160
                logger.warning("Handshake failed: %s", error)
1721
2161
                # Do not run session.bye() here: the session is not
1722
2162
                # established.  Just abandon the request.
1726
2166
            approval_required = False
1727
2167
            try:
1728
2168
                try:
1729
 
                    fpr = self.fingerprint(self.peer_certificate
1730
 
                                           (session))
1731
 
                except (TypeError,
1732
 
                        gnutls.errors.GNUTLSError) as error:
 
2169
                    fpr = self.fingerprint(
 
2170
                        self.peer_certificate(session))
 
2171
                except (TypeError, gnutls.Error) as error:
1733
2172
                    logger.warning("Bad certificate: %s", error)
1734
2173
                    return
1735
2174
                logger.debug("Fingerprint: %s", fpr)
1748
2187
                while True:
1749
2188
                    if not client.enabled:
1750
2189
                        logger.info("Client %s is disabled",
1751
 
                                       client.name)
 
2190
                                    client.name)
1752
2191
                        if self.server.use_dbus:
1753
2192
                            # Emit D-Bus signal
1754
2193
                            client.Rejected("Disabled")
1793
2232
                    else:
1794
2233
                        delay -= time2 - time
1795
2234
                
1796
 
                sent_size = 0
1797
 
                while sent_size < len(client.secret):
1798
 
                    try:
1799
 
                        sent = session.send(client.secret[sent_size:])
1800
 
                    except gnutls.errors.GNUTLSError as error:
1801
 
                        logger.warning("gnutls send failed",
1802
 
                                       exc_info=error)
1803
 
                        return
1804
 
                    logger.debug("Sent: %d, remaining: %d",
1805
 
                                 sent, len(client.secret)
1806
 
                                 - (sent_size + sent))
1807
 
                    sent_size += sent
 
2235
                try:
 
2236
                    session.send(client.secret)
 
2237
                except gnutls.Error as error:
 
2238
                    logger.warning("gnutls send failed",
 
2239
                                   exc_info = error)
 
2240
                    return
1808
2241
                
1809
2242
                logger.info("Sending secret to %s", client.name)
1810
2243
                # bump the timeout using extended_timeout
1818
2251
                    client.approvals_pending -= 1
1819
2252
                try:
1820
2253
                    session.bye()
1821
 
                except gnutls.errors.GNUTLSError as error:
 
2254
                except gnutls.Error as error:
1822
2255
                    logger.warning("GnuTLS bye failed",
1823
2256
                                   exc_info=error)
1824
2257
    
1826
2259
    def peer_certificate(session):
1827
2260
        "Return the peer's OpenPGP certificate as a bytestring"
1828
2261
        # If not an OpenPGP certificate...
1829
 
        if (gnutls.library.functions
1830
 
            .gnutls_certificate_type_get(session._c_object)
1831
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1832
 
            # ...do the normal thing
1833
 
            return session.peer_certificate
 
2262
        if (gnutls.certificate_type_get(session._c_object)
 
2263
            != gnutls.CRT_OPENPGP):
 
2264
            # ...return invalid data
 
2265
            return b""
1834
2266
        list_size = ctypes.c_uint(1)
1835
 
        cert_list = (gnutls.library.functions
1836
 
                     .gnutls_certificate_get_peers
 
2267
        cert_list = (gnutls.certificate_get_peers
1837
2268
                     (session._c_object, ctypes.byref(list_size)))
1838
2269
        if not bool(cert_list) and list_size.value != 0:
1839
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1840
 
                                            " certificate")
 
2270
            raise gnutls.Error("error getting peer certificate")
1841
2271
        if list_size.value == 0:
1842
2272
            return None
1843
2273
        cert = cert_list[0]
1847
2277
    def fingerprint(openpgp):
1848
2278
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1849
2279
        # New GnuTLS "datum" with the OpenPGP public key
1850
 
        datum = (gnutls.library.types
1851
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1852
 
                                             ctypes.POINTER
1853
 
                                             (ctypes.c_ubyte)),
1854
 
                                 ctypes.c_uint(len(openpgp))))
 
2280
        datum = gnutls.datum_t(
 
2281
            ctypes.cast(ctypes.c_char_p(openpgp),
 
2282
                        ctypes.POINTER(ctypes.c_ubyte)),
 
2283
            ctypes.c_uint(len(openpgp)))
1855
2284
        # New empty GnuTLS certificate
1856
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1857
 
        (gnutls.library.functions
1858
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
2285
        crt = gnutls.openpgp_crt_t()
 
2286
        gnutls.openpgp_crt_init(ctypes.byref(crt))
1859
2287
        # Import the OpenPGP public key into the certificate
1860
 
        (gnutls.library.functions
1861
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1862
 
                                    gnutls.library.constants
1863
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
2288
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2289
                                  gnutls.OPENPGP_FMT_RAW)
1864
2290
        # Verify the self signature in the key
1865
2291
        crtverify = ctypes.c_uint()
1866
 
        (gnutls.library.functions
1867
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1868
 
                                         ctypes.byref(crtverify)))
 
2292
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2293
                                       ctypes.byref(crtverify))
1869
2294
        if crtverify.value != 0:
1870
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1871
 
            raise (gnutls.errors.CertificateSecurityError
1872
 
                   ("Verify failed"))
 
2295
            gnutls.openpgp_crt_deinit(crt)
 
2296
            raise gnutls.CertificateSecurityError("Verify failed")
1873
2297
        # New buffer for the fingerprint
1874
2298
        buf = ctypes.create_string_buffer(20)
1875
2299
        buf_len = ctypes.c_size_t()
1876
2300
        # Get the fingerprint from the certificate into the buffer
1877
 
        (gnutls.library.functions
1878
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1879
 
                                             ctypes.byref(buf_len)))
 
2301
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2302
                                           ctypes.byref(buf_len))
1880
2303
        # Deinit the certificate
1881
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2304
        gnutls.openpgp_crt_deinit(crt)
1882
2305
        # Convert the buffer to a Python bytestring
1883
2306
        fpr = ctypes.string_at(buf, buf_len.value)
1884
2307
        # Convert the bytestring to hexadecimal notation
1888
2311
 
1889
2312
class MultiprocessingMixIn(object):
1890
2313
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
2314
    
1891
2315
    def sub_process_main(self, request, address):
1892
2316
        try:
1893
2317
            self.finish_request(request, address)
1905
2329
 
1906
2330
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1907
2331
    """ adds a pipe to the MixIn """
 
2332
    
1908
2333
    def process_request(self, request, client_address):
1909
2334
        """Overrides and wraps the original process_request().
1910
2335
        
1931
2356
        interface:      None or a network interface name (string)
1932
2357
        use_ipv6:       Boolean; to use IPv6 or not
1933
2358
    """
 
2359
    
1934
2360
    def __init__(self, server_address, RequestHandlerClass,
1935
 
                 interface=None, use_ipv6=True, socketfd=None):
 
2361
                 interface=None,
 
2362
                 use_ipv6=True,
 
2363
                 socketfd=None):
1936
2364
        """If socketfd is set, use that file descriptor instead of
1937
2365
        creating a new one with socket.socket().
1938
2366
        """
1979
2407
                             self.interface)
1980
2408
            else:
1981
2409
                try:
1982
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1983
 
                                           SO_BINDTODEVICE,
1984
 
                                           (self.interface + "\0")
1985
 
                                           .encode("utf-8"))
 
2410
                    self.socket.setsockopt(
 
2411
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2412
                        (self.interface + "\0").encode("utf-8"))
1986
2413
                except socket.error as error:
1987
2414
                    if error.errno == errno.EPERM:
1988
2415
                        logger.error("No permission to bind to"
2006
2433
                self.server_address = (any_address,
2007
2434
                                       self.server_address[1])
2008
2435
            elif not self.server_address[1]:
2009
 
                self.server_address = (self.server_address[0],
2010
 
                                       0)
 
2436
                self.server_address = (self.server_address[0], 0)
2011
2437
#                 if self.interface:
2012
2438
#                     self.server_address = (self.server_address[0],
2013
2439
#                                            0, # port
2027
2453
    
2028
2454
    Assumes a gobject.MainLoop event loop.
2029
2455
    """
 
2456
    
2030
2457
    def __init__(self, server_address, RequestHandlerClass,
2031
 
                 interface=None, use_ipv6=True, clients=None,
2032
 
                 gnutls_priority=None, use_dbus=True, socketfd=None):
 
2458
                 interface=None,
 
2459
                 use_ipv6=True,
 
2460
                 clients=None,
 
2461
                 gnutls_priority=None,
 
2462
                 use_dbus=True,
 
2463
                 socketfd=None):
2033
2464
        self.enabled = False
2034
2465
        self.clients = clients
2035
2466
        if self.clients is None:
2041
2472
                                interface = interface,
2042
2473
                                use_ipv6 = use_ipv6,
2043
2474
                                socketfd = socketfd)
 
2475
    
2044
2476
    def server_activate(self):
2045
2477
        if self.enabled:
2046
2478
            return socketserver.TCPServer.server_activate(self)
2050
2482
    
2051
2483
    def add_pipe(self, parent_pipe, proc):
2052
2484
        # Call "handle_ipc" for both data and EOF events
2053
 
        gobject.io_add_watch(parent_pipe.fileno(),
2054
 
                             gobject.IO_IN | gobject.IO_HUP,
2055
 
                             functools.partial(self.handle_ipc,
2056
 
                                               parent_pipe =
2057
 
                                               parent_pipe,
2058
 
                                               proc = proc))
 
2485
        gobject.io_add_watch(
 
2486
            parent_pipe.fileno(),
 
2487
            gobject.IO_IN | gobject.IO_HUP,
 
2488
            functools.partial(self.handle_ipc,
 
2489
                              parent_pipe = parent_pipe,
 
2490
                              proc = proc))
2059
2491
    
2060
 
    def handle_ipc(self, source, condition, parent_pipe=None,
2061
 
                   proc = None, client_object=None):
 
2492
    def handle_ipc(self, source, condition,
 
2493
                   parent_pipe=None,
 
2494
                   proc = None,
 
2495
                   client_object=None):
2062
2496
        # error, or the other end of multiprocessing.Pipe has closed
2063
2497
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
2064
2498
            # Wait for other process to exit
2087
2521
                parent_pipe.send(False)
2088
2522
                return False
2089
2523
            
2090
 
            gobject.io_add_watch(parent_pipe.fileno(),
2091
 
                                 gobject.IO_IN | gobject.IO_HUP,
2092
 
                                 functools.partial(self.handle_ipc,
2093
 
                                                   parent_pipe =
2094
 
                                                   parent_pipe,
2095
 
                                                   proc = proc,
2096
 
                                                   client_object =
2097
 
                                                   client))
 
2524
            gobject.io_add_watch(
 
2525
                parent_pipe.fileno(),
 
2526
                gobject.IO_IN | gobject.IO_HUP,
 
2527
                functools.partial(self.handle_ipc,
 
2528
                                  parent_pipe = parent_pipe,
 
2529
                                  proc = proc,
 
2530
                                  client_object = client))
2098
2531
            parent_pipe.send(True)
2099
2532
            # remove the old hook in favor of the new above hook on
2100
2533
            # same fileno
2106
2539
            
2107
2540
            parent_pipe.send(('data', getattr(client_object,
2108
2541
                                              funcname)(*args,
2109
 
                                                         **kwargs)))
 
2542
                                                        **kwargs)))
2110
2543
        
2111
2544
        if command == 'getattr':
2112
2545
            attrname = request[1]
2113
 
            if callable(client_object.__getattribute__(attrname)):
2114
 
                parent_pipe.send(('function',))
 
2546
            if isinstance(client_object.__getattribute__(attrname),
 
2547
                          collections.Callable):
 
2548
                parent_pipe.send(('function', ))
2115
2549
            else:
2116
 
                parent_pipe.send(('data', client_object
2117
 
                                  .__getattribute__(attrname)))
 
2550
                parent_pipe.send((
 
2551
                    'data', client_object.__getattribute__(attrname)))
2118
2552
        
2119
2553
        if command == 'setattr':
2120
2554
            attrname = request[1]
2151
2585
    # avoid excessive use of external libraries.
2152
2586
    
2153
2587
    # New type for defining tokens, syntax, and semantics all-in-one
2154
 
    Token = collections.namedtuple("Token",
2155
 
                                   ("regexp", # To match token; if
2156
 
                                              # "value" is not None,
2157
 
                                              # must have a "group"
2158
 
                                              # containing digits
2159
 
                                    "value",  # datetime.timedelta or
2160
 
                                              # None
2161
 
                                    "followers")) # Tokens valid after
2162
 
                                                  # this token
 
2588
    Token = collections.namedtuple("Token", (
 
2589
        "regexp",  # To match token; if "value" is not None, must have
 
2590
                   # a "group" containing digits
 
2591
        "value",   # datetime.timedelta or None
 
2592
        "followers"))           # Tokens valid after this token
2163
2593
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2164
2594
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2165
2595
    token_end = Token(re.compile(r"$"), None, frozenset())
2166
2596
    token_second = Token(re.compile(r"(\d+)S"),
2167
2597
                         datetime.timedelta(seconds=1),
2168
 
                         frozenset((token_end,)))
 
2598
                         frozenset((token_end, )))
2169
2599
    token_minute = Token(re.compile(r"(\d+)M"),
2170
2600
                         datetime.timedelta(minutes=1),
2171
2601
                         frozenset((token_second, token_end)))
2187
2617
                       frozenset((token_month, token_end)))
2188
2618
    token_week = Token(re.compile(r"(\d+)W"),
2189
2619
                       datetime.timedelta(weeks=1),
2190
 
                       frozenset((token_end,)))
 
2620
                       frozenset((token_end, )))
2191
2621
    token_duration = Token(re.compile(r"P"), None,
2192
2622
                           frozenset((token_year, token_month,
2193
2623
                                      token_day, token_time,
2195
2625
    # Define starting values
2196
2626
    value = datetime.timedelta() # Value so far
2197
2627
    found_token = None
2198
 
    followers = frozenset((token_duration,)) # Following valid tokens
 
2628
    followers = frozenset((token_duration, )) # Following valid tokens
2199
2629
    s = duration                # String left to parse
2200
2630
    # Loop until end token is found
2201
2631
    while found_token is not token_end:
2218
2648
                break
2219
2649
        else:
2220
2650
            # No currently valid tokens were found
2221
 
            raise ValueError("Invalid RFC 3339 duration")
 
2651
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2652
                             .format(duration))
2222
2653
    # End token found
2223
2654
    return value
2224
2655
 
2261
2692
            elif suffix == "w":
2262
2693
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2263
2694
            else:
2264
 
                raise ValueError("Unknown suffix {!r}"
2265
 
                                 .format(suffix))
 
2695
                raise ValueError("Unknown suffix {!r}".format(suffix))
2266
2696
        except IndexError as e:
2267
2697
            raise ValueError(*(e.args))
2268
2698
        timevalue += delta
2284
2714
        # Close all standard open file descriptors
2285
2715
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2286
2716
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2287
 
            raise OSError(errno.ENODEV, "{} not a character device"
 
2717
            raise OSError(errno.ENODEV,
 
2718
                          "{} not a character device"
2288
2719
                          .format(os.devnull))
2289
2720
        os.dup2(null, sys.stdin.fileno())
2290
2721
        os.dup2(null, sys.stdout.fileno())
2356
2787
                        "port": "",
2357
2788
                        "debug": "False",
2358
2789
                        "priority":
2359
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
2790
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2791
                        ":+SIGN-DSA-SHA256",
2360
2792
                        "servicename": "Mandos",
2361
2793
                        "use_dbus": "True",
2362
2794
                        "use_ipv6": "True",
2366
2798
                        "statedir": "/var/lib/mandos",
2367
2799
                        "foreground": "False",
2368
2800
                        "zeroconf": "True",
2369
 
                        }
 
2801
                    }
2370
2802
    
2371
2803
    # Parse config file for server-global settings
2372
2804
    server_config = configparser.SafeConfigParser(server_defaults)
2373
2805
    del server_defaults
2374
 
    server_config.read(os.path.join(options.configdir,
2375
 
                                    "mandos.conf"))
 
2806
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
2376
2807
    # Convert the SafeConfigParser object to a dict
2377
2808
    server_settings = server_config.defaults()
2378
2809
    # Use the appropriate methods on the non-string config options
2396
2827
    # Override the settings from the config file with command line
2397
2828
    # options, if set.
2398
2829
    for option in ("interface", "address", "port", "debug",
2399
 
                   "priority", "servicename", "configdir",
2400
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2401
 
                   "statedir", "socket", "foreground", "zeroconf"):
 
2830
                   "priority", "servicename", "configdir", "use_dbus",
 
2831
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2832
                   "socket", "foreground", "zeroconf"):
2402
2833
        value = getattr(options, option)
2403
2834
        if value is not None:
2404
2835
            server_settings[option] = value
2419
2850
    
2420
2851
    ##################################################################
2421
2852
    
2422
 
    if (not server_settings["zeroconf"] and
2423
 
        not (server_settings["port"]
2424
 
             or server_settings["socket"] != "")):
2425
 
            parser.error("Needs port or socket to work without"
2426
 
                         " Zeroconf")
 
2853
    if (not server_settings["zeroconf"]
 
2854
        and not (server_settings["port"]
 
2855
                 or server_settings["socket"] != "")):
 
2856
        parser.error("Needs port or socket to work without Zeroconf")
2427
2857
    
2428
2858
    # For convenience
2429
2859
    debug = server_settings["debug"]
2445
2875
            initlogger(debug, level)
2446
2876
    
2447
2877
    if server_settings["servicename"] != "Mandos":
2448
 
        syslogger.setFormatter(logging.Formatter
2449
 
                               ('Mandos ({}) [%(process)d]:'
2450
 
                                ' %(levelname)s: %(message)s'
2451
 
                                .format(server_settings
2452
 
                                        ["servicename"])))
 
2878
        syslogger.setFormatter(
 
2879
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2880
                              ' %(levelname)s: %(message)s'.format(
 
2881
                                  server_settings["servicename"])))
2453
2882
    
2454
2883
    # Parse config file with clients
2455
2884
    client_config = configparser.SafeConfigParser(Client
2463
2892
    socketfd = None
2464
2893
    if server_settings["socket"] != "":
2465
2894
        socketfd = server_settings["socket"]
2466
 
    tcp_server = MandosServer((server_settings["address"],
2467
 
                               server_settings["port"]),
2468
 
                              ClientHandler,
2469
 
                              interface=(server_settings["interface"]
2470
 
                                         or None),
2471
 
                              use_ipv6=use_ipv6,
2472
 
                              gnutls_priority=
2473
 
                              server_settings["priority"],
2474
 
                              use_dbus=use_dbus,
2475
 
                              socketfd=socketfd)
 
2895
    tcp_server = MandosServer(
 
2896
        (server_settings["address"], server_settings["port"]),
 
2897
        ClientHandler,
 
2898
        interface=(server_settings["interface"] or None),
 
2899
        use_ipv6=use_ipv6,
 
2900
        gnutls_priority=server_settings["priority"],
 
2901
        use_dbus=use_dbus,
 
2902
        socketfd=socketfd)
2476
2903
    if not foreground:
2477
2904
        pidfilename = "/run/mandos.pid"
2478
2905
        if not os.path.isdir("/run/."):
2479
2906
            pidfilename = "/var/run/mandos.pid"
2480
2907
        pidfile = None
2481
2908
        try:
2482
 
            pidfile = open(pidfilename, "w")
 
2909
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2483
2910
        except IOError as e:
2484
2911
            logger.error("Could not open file %r", pidfilename,
2485
2912
                         exc_info=e)
2506
2933
        
2507
2934
        # "Use a log level over 10 to enable all debugging options."
2508
2935
        # - GnuTLS manual
2509
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
2936
        gnutls.global_set_log_level(11)
2510
2937
        
2511
 
        @gnutls.library.types.gnutls_log_func
 
2938
        @gnutls.log_func
2512
2939
        def debug_gnutls(level, string):
2513
2940
            logger.debug("GnuTLS: %s", string[:-1])
2514
2941
        
2515
 
        (gnutls.library.functions
2516
 
         .gnutls_global_set_log_function(debug_gnutls))
 
2942
        gnutls.global_set_log_function(debug_gnutls)
2517
2943
        
2518
2944
        # Redirect stdin so all checkers get /dev/null
2519
2945
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2539
2965
    if use_dbus:
2540
2966
        try:
2541
2967
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2542
 
                                            bus, do_not_queue=True)
2543
 
            old_bus_name = (dbus.service.BusName
2544
 
                            ("se.bsnet.fukt.Mandos", bus,
2545
 
                             do_not_queue=True))
2546
 
        except dbus.exceptions.NameExistsException as e:
 
2968
                                            bus,
 
2969
                                            do_not_queue=True)
 
2970
            old_bus_name = dbus.service.BusName(
 
2971
                "se.bsnet.fukt.Mandos", bus,
 
2972
                do_not_queue=True)
 
2973
        except dbus.exceptions.DBusException as e:
2547
2974
            logger.error("Disabling D-Bus:", exc_info=e)
2548
2975
            use_dbus = False
2549
2976
            server_settings["use_dbus"] = False
2550
2977
            tcp_server.use_dbus = False
2551
2978
    if zeroconf:
2552
2979
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2553
 
        service = AvahiServiceToSyslog(name =
2554
 
                                       server_settings["servicename"],
2555
 
                                       servicetype = "_mandos._tcp",
2556
 
                                       protocol = protocol, bus = bus)
 
2980
        service = AvahiServiceToSyslog(
 
2981
            name = server_settings["servicename"],
 
2982
            servicetype = "_mandos._tcp",
 
2983
            protocol = protocol,
 
2984
            bus = bus)
2557
2985
        if server_settings["interface"]:
2558
 
            service.interface = (if_nametoindex
2559
 
                                 (server_settings["interface"]
2560
 
                                  .encode("utf-8")))
 
2986
            service.interface = if_nametoindex(
 
2987
                server_settings["interface"].encode("utf-8"))
2561
2988
    
2562
2989
    global multiprocessing_manager
2563
2990
    multiprocessing_manager = multiprocessing.Manager()
2582
3009
    if server_settings["restore"]:
2583
3010
        try:
2584
3011
            with open(stored_state_path, "rb") as stored_state:
2585
 
                clients_data, old_client_settings = (pickle.load
2586
 
                                                     (stored_state))
 
3012
                clients_data, old_client_settings = pickle.load(
 
3013
                    stored_state)
2587
3014
            os.remove(stored_state_path)
2588
3015
        except IOError as e:
2589
3016
            if e.errno == errno.ENOENT:
2590
 
                logger.warning("Could not load persistent state: {}"
2591
 
                                .format(os.strerror(e.errno)))
 
3017
                logger.warning("Could not load persistent state:"
 
3018
                               " {}".format(os.strerror(e.errno)))
2592
3019
            else:
2593
3020
                logger.critical("Could not load persistent state:",
2594
3021
                                exc_info=e)
2595
3022
                raise
2596
3023
        except EOFError as e:
2597
3024
            logger.warning("Could not load persistent state: "
2598
 
                           "EOFError:", exc_info=e)
 
3025
                           "EOFError:",
 
3026
                           exc_info=e)
2599
3027
    
2600
3028
    with PGPEngine() as pgp:
2601
3029
        for client_name, client in clients_data.items():
2613
3041
                    # For each value in new config, check if it
2614
3042
                    # differs from the old config value (Except for
2615
3043
                    # the "secret" attribute)
2616
 
                    if (name != "secret" and
2617
 
                        value != old_client_settings[client_name]
2618
 
                        [name]):
 
3044
                    if (name != "secret"
 
3045
                        and (value !=
 
3046
                             old_client_settings[client_name][name])):
2619
3047
                        client[name] = value
2620
3048
                except KeyError:
2621
3049
                    pass
2622
3050
            
2623
3051
            # Clients who has passed its expire date can still be
2624
 
            # enabled if its last checker was successful.  Clients
 
3052
            # enabled if its last checker was successful.  A Client
2625
3053
            # whose checker succeeded before we stored its state is
2626
3054
            # assumed to have successfully run all checkers during
2627
3055
            # downtime.
2630
3058
                    if not client["last_checked_ok"]:
2631
3059
                        logger.warning(
2632
3060
                            "disabling client {} - Client never "
2633
 
                            "performed a successful checker"
2634
 
                            .format(client_name))
 
3061
                            "performed a successful checker".format(
 
3062
                                client_name))
2635
3063
                        client["enabled"] = False
2636
3064
                    elif client["last_checker_status"] != 0:
2637
3065
                        logger.warning(
2638
3066
                            "disabling client {} - Client last"
2639
 
                            " checker failed with error code {}"
2640
 
                            .format(client_name,
2641
 
                                    client["last_checker_status"]))
 
3067
                            " checker failed with error code"
 
3068
                            " {}".format(
 
3069
                                client_name,
 
3070
                                client["last_checker_status"]))
2642
3071
                        client["enabled"] = False
2643
3072
                    else:
2644
 
                        client["expires"] = (datetime.datetime
2645
 
                                             .utcnow()
2646
 
                                             + client["timeout"])
 
3073
                        client["expires"] = (
 
3074
                            datetime.datetime.utcnow()
 
3075
                            + client["timeout"])
2647
3076
                        logger.debug("Last checker succeeded,"
2648
 
                                     " keeping {} enabled"
2649
 
                                     .format(client_name))
 
3077
                                     " keeping {} enabled".format(
 
3078
                                         client_name))
2650
3079
            try:
2651
 
                client["secret"] = (
2652
 
                    pgp.decrypt(client["encrypted_secret"],
2653
 
                                client_settings[client_name]
2654
 
                                ["secret"]))
 
3080
                client["secret"] = pgp.decrypt(
 
3081
                    client["encrypted_secret"],
 
3082
                    client_settings[client_name]["secret"])
2655
3083
            except PGPError:
2656
3084
                # If decryption fails, we use secret from new settings
2657
 
                logger.debug("Failed to decrypt {} old secret"
2658
 
                             .format(client_name))
2659
 
                client["secret"] = (
2660
 
                    client_settings[client_name]["secret"])
 
3085
                logger.debug("Failed to decrypt {} old secret".format(
 
3086
                    client_name))
 
3087
                client["secret"] = (client_settings[client_name]
 
3088
                                    ["secret"])
2661
3089
    
2662
3090
    # Add/remove clients based on new changes made to config
2663
3091
    for client_name in (set(old_client_settings)
2670
3098
    # Create all client objects
2671
3099
    for client_name, client in clients_data.items():
2672
3100
        tcp_server.clients[client_name] = client_class(
2673
 
            name = client_name, settings = client,
 
3101
            name = client_name,
 
3102
            settings = client,
2674
3103
            server_settings = server_settings)
2675
3104
    
2676
3105
    if not tcp_server.clients:
2678
3107
    
2679
3108
    if not foreground:
2680
3109
        if pidfile is not None:
 
3110
            pid = os.getpid()
2681
3111
            try:
2682
3112
                with pidfile:
2683
 
                    pid = os.getpid()
2684
 
                    pidfile.write("{}\n".format(pid).encode("utf-8"))
 
3113
                    print(pid, file=pidfile)
2685
3114
            except IOError:
2686
3115
                logger.error("Could not write to file %r with PID %d",
2687
3116
                             pidfilename, pid)
2692
3121
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2693
3122
    
2694
3123
    if use_dbus:
2695
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2696
 
                                        "se.bsnet.fukt.Mandos"})
2697
 
        class MandosDBusService(DBusObjectWithProperties):
 
3124
        
 
3125
        @alternate_dbus_interfaces(
 
3126
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
3127
        class MandosDBusService(DBusObjectWithObjectManager):
2698
3128
            """A D-Bus proxy object"""
 
3129
            
2699
3130
            def __init__(self):
2700
3131
                dbus.service.Object.__init__(self, bus, "/")
 
3132
            
2701
3133
            _interface = "se.recompile.Mandos"
2702
3134
            
2703
 
            @dbus_interface_annotations(_interface)
2704
 
            def _foo(self):
2705
 
                return { "org.freedesktop.DBus.Property"
2706
 
                         ".EmitsChangedSignal":
2707
 
                             "false"}
2708
 
            
2709
3135
            @dbus.service.signal(_interface, signature="o")
2710
3136
            def ClientAdded(self, objpath):
2711
3137
                "D-Bus signal"
2716
3142
                "D-Bus signal"
2717
3143
                pass
2718
3144
            
 
3145
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3146
                               "true"})
2719
3147
            @dbus.service.signal(_interface, signature="os")
2720
3148
            def ClientRemoved(self, objpath, name):
2721
3149
                "D-Bus signal"
2722
3150
                pass
2723
3151
            
 
3152
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3153
                               "true"})
2724
3154
            @dbus.service.method(_interface, out_signature="ao")
2725
3155
            def GetAllClients(self):
2726
3156
                "D-Bus method"
2727
 
                return dbus.Array(c.dbus_object_path
2728
 
                                  for c in
 
3157
                return dbus.Array(c.dbus_object_path for c in
2729
3158
                                  tcp_server.clients.itervalues())
2730
3159
            
 
3160
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3161
                               "true"})
2731
3162
            @dbus.service.method(_interface,
2732
3163
                                 out_signature="a{oa{sv}}")
2733
3164
            def GetAllClientsWithProperties(self):
2734
3165
                "D-Bus method"
2735
3166
                return dbus.Dictionary(
2736
 
                    { c.dbus_object_path: c.GetAll("")
 
3167
                    { c.dbus_object_path: c.GetAll(
 
3168
                        "se.recompile.Mandos.Client")
2737
3169
                      for c in tcp_server.clients.itervalues() },
2738
3170
                    signature="oa{sv}")
2739
3171
            
2744
3176
                    if c.dbus_object_path == object_path:
2745
3177
                        del tcp_server.clients[c.name]
2746
3178
                        c.remove_from_connection()
2747
 
                        # Don't signal anything except ClientRemoved
 
3179
                        # Don't signal the disabling
2748
3180
                        c.disable(quiet=True)
2749
 
                        # Emit D-Bus signal
2750
 
                        self.ClientRemoved(object_path, c.name)
 
3181
                        # Emit D-Bus signal for removal
 
3182
                        self.client_removed_signal(c)
2751
3183
                        return
2752
3184
                raise KeyError(object_path)
2753
3185
            
2754
3186
            del _interface
 
3187
            
 
3188
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
3189
                                 out_signature = "a{oa{sa{sv}}}")
 
3190
            def GetManagedObjects(self):
 
3191
                """D-Bus method"""
 
3192
                return dbus.Dictionary(
 
3193
                    { client.dbus_object_path:
 
3194
                      dbus.Dictionary(
 
3195
                          { interface: client.GetAll(interface)
 
3196
                            for interface in
 
3197
                                 client._get_all_interface_names()})
 
3198
                      for client in tcp_server.clients.values()})
 
3199
            
 
3200
            def client_added_signal(self, client):
 
3201
                """Send the new standard signal and the old signal"""
 
3202
                if use_dbus:
 
3203
                    # New standard signal
 
3204
                    self.InterfacesAdded(
 
3205
                        client.dbus_object_path,
 
3206
                        dbus.Dictionary(
 
3207
                            { interface: client.GetAll(interface)
 
3208
                              for interface in
 
3209
                              client._get_all_interface_names()}))
 
3210
                    # Old signal
 
3211
                    self.ClientAdded(client.dbus_object_path)
 
3212
            
 
3213
            def client_removed_signal(self, client):
 
3214
                """Send the new standard signal and the old signal"""
 
3215
                if use_dbus:
 
3216
                    # New standard signal
 
3217
                    self.InterfacesRemoved(
 
3218
                        client.dbus_object_path,
 
3219
                        client._get_all_interface_names())
 
3220
                    # Old signal
 
3221
                    self.ClientRemoved(client.dbus_object_path,
 
3222
                                       client.name)
2755
3223
        
2756
3224
        mandos_dbus_service = MandosDBusService()
2757
3225
    
2780
3248
                # + secret.
2781
3249
                exclude = { "bus", "changedstate", "secret",
2782
3250
                            "checker", "server_settings" }
2783
 
                for name, typ in (inspect.getmembers
2784
 
                                  (dbus.service.Object)):
 
3251
                for name, typ in inspect.getmembers(dbus.service
 
3252
                                                    .Object):
2785
3253
                    exclude.add(name)
2786
3254
                
2787
3255
                client_dict["encrypted_secret"] = (client
2794
3262
                del client_settings[client.name]["secret"]
2795
3263
        
2796
3264
        try:
2797
 
            with (tempfile.NamedTemporaryFile
2798
 
                  (mode='wb', suffix=".pickle", prefix='clients-',
2799
 
                   dir=os.path.dirname(stored_state_path),
2800
 
                   delete=False)) as stored_state:
 
3265
            with tempfile.NamedTemporaryFile(
 
3266
                    mode='wb',
 
3267
                    suffix=".pickle",
 
3268
                    prefix='clients-',
 
3269
                    dir=os.path.dirname(stored_state_path),
 
3270
                    delete=False) as stored_state:
2801
3271
                pickle.dump((clients, client_settings), stored_state)
2802
 
                tempname=stored_state.name
 
3272
                tempname = stored_state.name
2803
3273
            os.rename(tempname, stored_state_path)
2804
3274
        except (IOError, OSError) as e:
2805
3275
            if not debug:
2820
3290
            name, client = tcp_server.clients.popitem()
2821
3291
            if use_dbus:
2822
3292
                client.remove_from_connection()
2823
 
            # Don't signal anything except ClientRemoved
 
3293
            # Don't signal the disabling
2824
3294
            client.disable(quiet=True)
 
3295
            # Emit D-Bus signal for removal
2825
3296
            if use_dbus:
2826
 
                # Emit D-Bus signal
2827
 
                mandos_dbus_service.ClientRemoved(client
2828
 
                                                  .dbus_object_path,
2829
 
                                                  client.name)
 
3297
                mandos_dbus_service.client_removed_signal(client)
2830
3298
        client_settings.clear()
2831
3299
    
2832
3300
    atexit.register(cleanup)
2833
3301
    
2834
3302
    for client in tcp_server.clients.itervalues():
2835
3303
        if use_dbus:
2836
 
            # Emit D-Bus signal
2837
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3304
            # Emit D-Bus signal for adding
 
3305
            mandos_dbus_service.client_added_signal(client)
2838
3306
        # Need to initiate checking of clients
2839
3307
        if client.enabled:
2840
3308
            client.init_checker()
2885
3353
    # Must run before the D-Bus bus name gets deregistered
2886
3354
    cleanup()
2887
3355
 
 
3356
 
2888
3357
if __name__ == '__main__':
2889
3358
    main()