/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-03-10 18:03:38 UTC
  • Revision ID: teddy@recompile.se-20150310180338-pcxw6r2qmw9k6br9
Add ":!RSA" to GnuTLS priority string, to disallow non-DHE kx.

If Mandos was somehow made to use a non-ephemeral Diffie-Hellman key
exchange algorithm in the TLS handshake, any saved network traffic
could then be decrypted later if the Mandos client key was obtained.
By default, Mandos uses ephemeral DH key exchanges which does not have
this problem, but a non-ephemeral key exchange algorithm was still
enabled by default.  The simplest solution is to simply turn that off,
which ensures that Mandos will always use ephemeral DH key exchanges.

There is a "PFS" priority string specifier, but we can't use it because:

1. Security-wise, it is a mix between "NORMAL" and "SECURE128" - it
   enables a lot more algorithms than "SECURE256".

2. It is only available since GnuTLS 3.2.4.

Thanks to Andreas Fischer <af@bantuX.org> for reporting this issue.

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-2015 Teddy Hogeborn
15
 
# Copyright © 2008-2015 Björn Påhlsson
 
14
# Copyright © 2008-2014 Teddy Hogeborn
 
15
# Copyright © 2008-2014 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
 
try:
40
 
    import SocketServer as socketserver
41
 
except ImportError:
42
 
    import socketserver
 
39
import SocketServer as socketserver
43
40
import socket
44
41
import argparse
45
42
import datetime
46
43
import errno
47
 
try:
48
 
    import ConfigParser as configparser
49
 
except ImportError:
50
 
    import configparser
 
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
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
 
try:
66
 
    import cPickle as pickle
67
 
except ImportError:
68
 
    import pickle
 
65
import cPickle as pickle
69
66
import multiprocessing
70
67
import types
71
68
import binascii
72
69
import tempfile
73
70
import itertools
74
71
import collections
75
 
import codecs
76
72
 
77
73
import dbus
78
74
import dbus.service
79
 
try:
80
 
    import gobject
81
 
except ImportError:
82
 
    from gi.repository import GObject as gobject
 
75
import gobject
83
76
import avahi
84
77
from dbus.mainloop.glib import DBusGMainLoop
85
78
import ctypes
98
91
if sys.version_info.major == 2:
99
92
    str = unicode
100
93
 
101
 
version = "1.7.1"
 
94
version = "1.6.9"
102
95
stored_state_file = "clients.pickle"
103
96
 
104
97
logger = logging.getLogger()
105
98
syslogger = None
106
99
 
107
100
try:
108
 
    if_nametoindex = ctypes.cdll.LoadLibrary(
109
 
        ctypes.util.find_library("c")).if_nametoindex
 
101
    if_nametoindex = (ctypes.cdll.LoadLibrary
 
102
                      (ctypes.util.find_library("c"))
 
103
                      .if_nametoindex)
110
104
except (OSError, AttributeError):
111
 
    
112
105
    def if_nametoindex(interface):
113
106
        "Get an interface index the hard way, i.e. using fcntl()"
114
107
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
123
116
    """init logger and add loglevel"""
124
117
    
125
118
    global syslogger
126
 
    syslogger = (logging.handlers.SysLogHandler(
127
 
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
128
 
        address = "/dev/log"))
 
119
    syslogger = (logging.handlers.SysLogHandler
 
120
                 (facility =
 
121
                  logging.handlers.SysLogHandler.LOG_DAEMON,
 
122
                  address = "/dev/log"))
129
123
    syslogger.setFormatter(logging.Formatter
130
124
                           ('Mandos [%(process)d]: %(levelname)s:'
131
125
                            ' %(message)s'))
148
142
 
149
143
class PGPEngine(object):
150
144
    """A simple class for OpenPGP symmetric encryption & decryption"""
151
 
    
152
145
    def __init__(self):
153
146
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
154
147
        self.gnupgargs = ['--batch',
193
186
    
194
187
    def encrypt(self, data, password):
195
188
        passphrase = self.password_encode(password)
196
 
        with tempfile.NamedTemporaryFile(
197
 
                dir=self.tempdir) as passfile:
 
189
        with tempfile.NamedTemporaryFile(dir=self.tempdir
 
190
                                         ) as passfile:
198
191
            passfile.write(passphrase)
199
192
            passfile.flush()
200
193
            proc = subprocess.Popen(['gpg', '--symmetric',
211
204
    
212
205
    def decrypt(self, data, password):
213
206
        passphrase = self.password_encode(password)
214
 
        with tempfile.NamedTemporaryFile(
215
 
                dir = self.tempdir) as passfile:
 
207
        with tempfile.NamedTemporaryFile(dir = self.tempdir
 
208
                                         ) as passfile:
216
209
            passfile.write(passphrase)
217
210
            passfile.flush()
218
211
            proc = subprocess.Popen(['gpg', '--decrypt',
222
215
                                    stdin = subprocess.PIPE,
223
216
                                    stdout = subprocess.PIPE,
224
217
                                    stderr = subprocess.PIPE)
225
 
            decrypted_plaintext, err = proc.communicate(input = data)
 
218
            decrypted_plaintext, err = proc.communicate(input
 
219
                                                        = data)
226
220
        if proc.returncode != 0:
227
221
            raise PGPError(err)
228
222
        return decrypted_plaintext
234
228
        return super(AvahiError, self).__init__(value, *args,
235
229
                                                **kwargs)
236
230
 
237
 
 
238
231
class AvahiServiceError(AvahiError):
239
232
    pass
240
233
 
241
 
 
242
234
class AvahiGroupError(AvahiError):
243
235
    pass
244
236
 
264
256
    bus: dbus.SystemBus()
265
257
    """
266
258
    
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):
 
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):
278
263
        self.interface = interface
279
264
        self.name = name
280
265
        self.type = servicetype
297
282
                            " after %i retries, exiting.",
298
283
                            self.rename_count)
299
284
            raise AvahiServiceError("Too many renames")
300
 
        self.name = str(
301
 
            self.server.GetAlternativeServiceName(self.name))
 
285
        self.name = str(self.server
 
286
                        .GetAlternativeServiceName(self.name))
302
287
        self.rename_count += 1
303
288
        logger.info("Changing Zeroconf service name to %r ...",
304
289
                    self.name)
359
344
        elif state == avahi.ENTRY_GROUP_FAILURE:
360
345
            logger.critical("Avahi: Error in group state changed %s",
361
346
                            str(error))
362
 
            raise AvahiGroupError("State changed: {!s}".format(error))
 
347
            raise AvahiGroupError("State changed: {!s}"
 
348
                                  .format(error))
363
349
    
364
350
    def cleanup(self):
365
351
        """Derived from the Avahi example code"""
375
361
    def server_state_changed(self, state, error=None):
376
362
        """Derived from the Avahi example code"""
377
363
        logger.debug("Avahi server state change: %i", state)
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
 
        }
 
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" }
384
371
        if state in bad_states:
385
372
            if bad_states[state] is not None:
386
373
                if error is None:
389
376
                    logger.error(bad_states[state] + ": %r", error)
390
377
            self.cleanup()
391
378
        elif state == avahi.SERVER_RUNNING:
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)
 
379
            self.add()
404
380
        else:
405
381
            if error is None:
406
382
                logger.debug("Unknown state: %r", state)
416
392
                                    follow_name_owner_changes=True),
417
393
                avahi.DBUS_INTERFACE_SERVER)
418
394
        self.server.connect_to_signal("StateChanged",
419
 
                                      self.server_state_changed)
 
395
                                 self.server_state_changed)
420
396
        self.server_state_changed(self.server.GetState())
421
397
 
422
398
 
424
400
    def rename(self, *args, **kwargs):
425
401
        """Add the new name to the syslog messages"""
426
402
        ret = AvahiService.rename(self, *args, **kwargs)
427
 
        syslogger.setFormatter(logging.Formatter(
428
 
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
429
 
            .format(self.name)))
 
403
        syslogger.setFormatter(logging.Formatter
 
404
                               ('Mandos ({}) [%(process)d]:'
 
405
                                ' %(levelname)s: %(message)s'
 
406
                                .format(self.name)))
430
407
        return ret
431
408
 
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()
696
409
 
697
410
class Client(object):
698
411
    """A representation of a client host served by this server.
725
438
    last_checker_status: integer between 0 and 255 reflecting exit
726
439
                         status of last checker. -1 reflects crashed
727
440
                         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
730
441
    last_enabled: datetime.datetime(); (UTC) or None
731
442
    name:       string; from the config file, used in log messages and
732
443
                        D-Bus identifiers
745
456
                          "fingerprint", "host", "interval",
746
457
                          "last_approval_request", "last_checked_ok",
747
458
                          "last_enabled", "name", "timeout")
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
 
    }
 
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
                        }
759
469
    
760
470
    @staticmethod
761
471
    def config_parser(config):
839
549
        self.current_checker_command = None
840
550
        self.approved = None
841
551
        self.approvals_pending = 0
842
 
        self.changedstate = multiprocessing_manager.Condition(
843
 
            multiprocessing_manager.Lock())
844
 
        self.client_structure = [attr
845
 
                                 for attr in self.__dict__.iterkeys()
 
552
        self.changedstate = (multiprocessing_manager
 
553
                             .Condition(multiprocessing_manager
 
554
                                        .Lock()))
 
555
        self.client_structure = [attr for attr in
 
556
                                 self.__dict__.iterkeys()
846
557
                                 if not attr.startswith("_")]
847
558
        self.client_structure.append("client_structure")
848
559
        
849
 
        for name, t in inspect.getmembers(
850
 
                type(self), lambda obj: isinstance(obj, property)):
 
560
        for name, t in inspect.getmembers(type(self),
 
561
                                          lambda obj:
 
562
                                              isinstance(obj,
 
563
                                                         property)):
851
564
            if not name.startswith("_"):
852
565
                self.client_structure.append(name)
853
566
    
895
608
        # and every interval from then on.
896
609
        if self.checker_initiator_tag is not None:
897
610
            gobject.source_remove(self.checker_initiator_tag)
898
 
        self.checker_initiator_tag = gobject.timeout_add(
899
 
            int(self.interval.total_seconds() * 1000),
900
 
            self.start_checker)
 
611
        self.checker_initiator_tag = (gobject.timeout_add
 
612
                                      (int(self.interval
 
613
                                           .total_seconds() * 1000),
 
614
                                       self.start_checker))
901
615
        # Schedule a disable() when 'timeout' has passed
902
616
        if self.disable_initiator_tag is not None:
903
617
            gobject.source_remove(self.disable_initiator_tag)
904
 
        self.disable_initiator_tag = gobject.timeout_add(
905
 
            int(self.timeout.total_seconds() * 1000), self.disable)
 
618
        self.disable_initiator_tag = (gobject.timeout_add
 
619
                                      (int(self.timeout
 
620
                                           .total_seconds() * 1000),
 
621
                                       self.disable))
906
622
        # Also start a new checker *right now*.
907
623
        self.start_checker()
908
624
    
909
 
    def checker_callback(self, source, condition, connection,
910
 
                         command):
 
625
    def checker_callback(self, pid, condition, command):
911
626
        """The checker has completed, so take appropriate actions."""
912
627
        self.checker_callback_tag = None
913
628
        self.checker = None
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
 
629
        if os.WIFEXITED(condition):
 
630
            self.last_checker_status = os.WEXITSTATUS(condition)
921
631
            if self.last_checker_status == 0:
922
632
                logger.info("Checker for %(name)s succeeded",
923
633
                            vars(self))
924
634
                self.checked_ok()
925
635
            else:
926
 
                logger.info("Checker for %(name)s failed", vars(self))
 
636
                logger.info("Checker for %(name)s failed",
 
637
                            vars(self))
927
638
        else:
928
639
            self.last_checker_status = -1
929
 
            self.last_checker_signal = -returncode
930
640
            logger.warning("Checker for %(name)s crashed?",
931
641
                           vars(self))
932
 
        return False
933
642
    
934
643
    def checked_ok(self):
935
644
        """Assert that the client has been seen, alive and well."""
936
645
        self.last_checked_ok = datetime.datetime.utcnow()
937
646
        self.last_checker_status = 0
938
 
        self.last_checker_signal = None
939
647
        self.bump_timeout()
940
648
    
941
649
    def bump_timeout(self, timeout=None):
946
654
            gobject.source_remove(self.disable_initiator_tag)
947
655
            self.disable_initiator_tag = None
948
656
        if getattr(self, "enabled", False):
949
 
            self.disable_initiator_tag = gobject.timeout_add(
950
 
                int(timeout.total_seconds() * 1000), self.disable)
 
657
            self.disable_initiator_tag = (gobject.timeout_add
 
658
                                          (int(timeout.total_seconds()
 
659
                                               * 1000), self.disable))
951
660
            self.expires = datetime.datetime.utcnow() + timeout
952
661
    
953
662
    def need_approval(self):
967
676
        # than 'timeout' for the client to be disabled, which is as it
968
677
        # should be.
969
678
        
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
 
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)
974
693
        # Start a new checker if needed
975
694
        if self.checker is None:
976
695
            # Escape attributes for the shell
977
 
            escaped_attrs = {
978
 
                attr: re.escape(str(getattr(self, attr)))
979
 
                for attr in self.runtime_expansions }
 
696
            escaped_attrs = { attr:
 
697
                                  re.escape(str(getattr(self, attr)))
 
698
                              for attr in self.runtime_expansions }
980
699
            try:
981
700
                command = self.checker_command % escaped_attrs
982
701
            except TypeError as error:
983
702
                logger.error('Could not format string "%s"',
984
 
                             self.checker_command,
 
703
                             self.checker_command, exc_info=error)
 
704
                return True # Try again later
 
705
            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",
985
727
                             exc_info=error)
986
 
                return True     # Try again later
987
 
            self.current_checker_command = 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)
 
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)
1013
747
        # Re-run this periodically if run by gobject.timeout_add
1014
748
        return True
1015
749
    
1021
755
        if getattr(self, "checker", None) is None:
1022
756
            return
1023
757
        logger.debug("Stopping checker for %(name)s", vars(self))
1024
 
        self.checker.terminate()
 
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
1025
766
        self.checker = None
1026
767
 
1027
768
 
1028
 
def dbus_service_property(dbus_interface,
1029
 
                          signature="v",
1030
 
                          access="readwrite",
1031
 
                          byte_arrays=False):
 
769
def dbus_service_property(dbus_interface, signature="v",
 
770
                          access="readwrite", byte_arrays=False):
1032
771
    """Decorators for marking methods of a DBusObjectWithProperties to
1033
772
    become properties on the D-Bus.
1034
773
    
1044
783
    if byte_arrays and signature != "ay":
1045
784
        raise ValueError("Byte arrays not supported for non-'ay'"
1046
785
                         " signature {!r}".format(signature))
1047
 
    
1048
786
    def decorator(func):
1049
787
        func._dbus_is_property = True
1050
788
        func._dbus_interface = dbus_interface
1055
793
            func._dbus_name = func._dbus_name[:-14]
1056
794
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1057
795
        return func
1058
 
    
1059
796
    return decorator
1060
797
 
1061
798
 
1070
807
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
1071
808
                    "false"}
1072
809
    """
1073
 
    
1074
810
    def decorator(func):
1075
811
        func._dbus_is_interface = True
1076
812
        func._dbus_interface = dbus_interface
1077
813
        func._dbus_name = dbus_interface
1078
814
        return func
1079
 
    
1080
815
    return decorator
1081
816
 
1082
817
 
1091
826
                           access="r")
1092
827
    def Property_dbus_property(self):
1093
828
        return dbus.Boolean(False)
1094
 
    
1095
 
    See also the DBusObjectWithAnnotations class.
1096
829
    """
1097
 
    
1098
830
    def decorator(func):
1099
831
        func._dbus_annotations = annotations
1100
832
        return func
1101
 
    
1102
833
    return decorator
1103
834
 
1104
835
 
1107
838
    """
1108
839
    pass
1109
840
 
1110
 
 
1111
841
class DBusPropertyAccessException(DBusPropertyException):
1112
842
    """A property's access permissions disallows an operation.
1113
843
    """
1120
850
    pass
1121
851
 
1122
852
 
1123
 
class DBusObjectWithAnnotations(dbus.service.Object):
1124
 
    """A D-Bus object with annotations.
 
853
class DBusObjectWithProperties(dbus.service.Object):
 
854
    """A D-Bus object with properties.
1125
855
    
1126
 
    Classes inheriting from this can use the dbus_annotations
1127
 
    decorator to add annotations to methods or signals.
 
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.
1128
859
    """
1129
860
    
1130
861
    @staticmethod
1140
871
    def _get_all_dbus_things(self, thing):
1141
872
        """Returns a generator of (name, attribute) pairs
1142
873
        """
1143
 
        return ((getattr(athing.__get__(self), "_dbus_name", name),
 
874
        return ((getattr(athing.__get__(self), "_dbus_name",
 
875
                         name),
1144
876
                 athing.__get__(self))
1145
877
                for cls in self.__class__.__mro__
1146
878
                for name, athing in
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
 
    """
 
879
                inspect.getmembers(cls,
 
880
                                   self._is_dbus_thing(thing)))
1219
881
    
1220
882
    def _get_dbus_property(self, interface_name, property_name):
1221
883
        """Returns a bound method if one exists which is a D-Bus
1222
884
        property with the specified name and interface.
1223
885
        """
1224
 
        for cls in self.__class__.__mro__:
1225
 
            for name, value in inspect.getmembers(
1226
 
                    cls, self._is_dbus_thing("property")):
 
886
        for cls in  self.__class__.__mro__:
 
887
            for name, value in (inspect.getmembers
 
888
                                (cls,
 
889
                                 self._is_dbus_thing("property"))):
1227
890
                if (value._dbus_name == property_name
1228
891
                    and value._dbus_interface == interface_name):
1229
892
                    return value.__get__(self)
1230
893
        
1231
894
        # No such property
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",
 
895
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
 
896
                                   + interface_name + "."
 
897
                                   + property_name)
 
898
    
 
899
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1246
900
                         out_signature="v")
1247
901
    def Get(self, interface_name, property_name):
1248
902
        """Standard D-Bus property Get() method, see D-Bus standard.
1273
927
                                            for byte in value))
1274
928
        prop(value)
1275
929
    
1276
 
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1277
 
                         in_signature="s",
 
930
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1278
931
                         out_signature="a{sv}")
1279
932
    def GetAll(self, interface_name):
1280
933
        """Standard D-Bus property GetAll() method, see D-Bus
1295
948
            if not hasattr(value, "variant_level"):
1296
949
                properties[name] = value
1297
950
                continue
1298
 
            properties[name] = type(value)(
1299
 
                value, variant_level = value.variant_level + 1)
 
951
            properties[name] = type(value)(value, variant_level=
 
952
                                           value.variant_level+1)
1300
953
        return dbus.Dictionary(properties, signature="sv")
1301
954
    
1302
955
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1316
969
        
1317
970
        Inserts property tags and interface annotation tags.
1318
971
        """
1319
 
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
1320
 
                                                         object_path,
1321
 
                                                         connection)
 
972
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
973
                                                   connection)
1322
974
        try:
1323
975
            document = xml.dom.minidom.parseString(xmlstring)
1324
 
            
1325
976
            def make_tag(document, name, prop):
1326
977
                e = document.createElement("property")
1327
978
                e.setAttribute("name", name)
1328
979
                e.setAttribute("type", prop._dbus_signature)
1329
980
                e.setAttribute("access", prop._dbus_access)
1330
981
                return e
1331
 
            
1332
982
            for if_tag in document.getElementsByTagName("interface"):
1333
983
                # Add property tags
1334
984
                for tag in (make_tag(document, name, prop)
1337
987
                            if prop._dbus_interface
1338
988
                            == if_tag.getAttribute("name")):
1339
989
                    if_tag.appendChild(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)
 
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)
1356
1021
                # Add the names to the return values for the
1357
1022
                # "org.freedesktop.DBus.Properties" methods
1358
1023
                if (if_tag.getAttribute("name")
1376
1041
                         exc_info=error)
1377
1042
        return xmlstring
1378
1043
 
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
1447
1044
 
1448
1045
def datetime_to_dbus(dt, variant_level=0):
1449
1046
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1450
1047
    if dt is None:
1451
1048
        return dbus.String("", variant_level = variant_level)
1452
 
    return dbus.String(dt.isoformat(), variant_level=variant_level)
 
1049
    return dbus.String(dt.isoformat(),
 
1050
                       variant_level=variant_level)
1453
1051
 
1454
1052
 
1455
1053
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1475
1073
    (from DBusObjectWithProperties) and interfaces (from the
1476
1074
    dbus_interface_annotations decorator).
1477
1075
    """
1478
 
    
1479
1076
    def wrapper(cls):
1480
1077
        for orig_interface_name, alt_interface_name in (
1481
 
                alt_interface_names.items()):
 
1078
            alt_interface_names.items()):
1482
1079
            attr = {}
1483
1080
            interface_names = set()
1484
1081
            # Go though all attributes of the class
1486
1083
                # Ignore non-D-Bus attributes, and D-Bus attributes
1487
1084
                # with the wrong interface name
1488
1085
                if (not hasattr(attribute, "_dbus_interface")
1489
 
                    or not attribute._dbus_interface.startswith(
1490
 
                        orig_interface_name)):
 
1086
                    or not attribute._dbus_interface
 
1087
                    .startswith(orig_interface_name)):
1491
1088
                    continue
1492
1089
                # Create an alternate D-Bus interface name based on
1493
1090
                # the current name
1494
 
                alt_interface = attribute._dbus_interface.replace(
1495
 
                    orig_interface_name, alt_interface_name)
 
1091
                alt_interface = (attribute._dbus_interface
 
1092
                                 .replace(orig_interface_name,
 
1093
                                          alt_interface_name))
1496
1094
                interface_names.add(alt_interface)
1497
1095
                # Is this a D-Bus signal?
1498
1096
                if getattr(attribute, "_dbus_is_signal", False):
1499
 
                    if sys.version_info.major == 2:
1500
 
                        # Extract the original non-method undecorated
1501
 
                        # function by black magic
1502
 
                        nonmethod_func = (dict(
 
1097
                    # Extract the original non-method undecorated
 
1098
                    # function by black magic
 
1099
                    nonmethod_func = (dict(
1503
1100
                            zip(attribute.func_code.co_freevars,
1504
 
                                attribute.__closure__))
1505
 
                                          ["func"].cell_contents)
1506
 
                    else:
1507
 
                        nonmethod_func = attribute
 
1101
                                attribute.__closure__))["func"]
 
1102
                                      .cell_contents)
1508
1103
                    # Create a new, but exactly alike, function
1509
1104
                    # object, and decorate it to be a new D-Bus signal
1510
1105
                    # with the alternate D-Bus interface name
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))
 
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)))
1528
1115
                    # Copy annotations, if any
1529
1116
                    try:
1530
 
                        new_function._dbus_annotations = dict(
1531
 
                            attribute._dbus_annotations)
 
1117
                        new_function._dbus_annotations = (
 
1118
                            dict(attribute._dbus_annotations))
1532
1119
                    except AttributeError:
1533
1120
                        pass
1534
1121
                    # Define a creator of a function to call both the
1539
1126
                        """This function is a scope container to pass
1540
1127
                        func1 and func2 to the "call_both" function
1541
1128
                        outside of its arguments"""
1542
 
                        
1543
 
                        @functools.wraps(func2)
1544
1129
                        def call_both(*args, **kwargs):
1545
1130
                            """This function will emit two D-Bus
1546
1131
                            signals by calling func1 and func2"""
1547
1132
                            func1(*args, **kwargs)
1548
1133
                            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
 
                        
1554
1134
                        return call_both
1555
1135
                    # Create the "call_both" function and add it to
1556
1136
                    # the class
1561
1141
                    # object.  Decorate it to be a new D-Bus method
1562
1142
                    # with the alternate D-Bus interface name.  Add it
1563
1143
                    # to the class.
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)))
 
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)))
1574
1154
                    # Copy annotations, if any
1575
1155
                    try:
1576
 
                        attr[attrname]._dbus_annotations = dict(
1577
 
                            attribute._dbus_annotations)
 
1156
                        attr[attrname]._dbus_annotations = (
 
1157
                            dict(attribute._dbus_annotations))
1578
1158
                    except AttributeError:
1579
1159
                        pass
1580
1160
                # Is this a D-Bus property?
1583
1163
                    # object, and decorate it to be a new D-Bus
1584
1164
                    # property with the alternate D-Bus interface
1585
1165
                    # name.  Add it to the class.
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)))
 
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)))
1597
1179
                    # Copy annotations, if any
1598
1180
                    try:
1599
 
                        attr[attrname]._dbus_annotations = dict(
1600
 
                            attribute._dbus_annotations)
 
1181
                        attr[attrname]._dbus_annotations = (
 
1182
                            dict(attribute._dbus_annotations))
1601
1183
                    except AttributeError:
1602
1184
                        pass
1603
1185
                # Is this a D-Bus interface?
1606
1188
                    # object.  Decorate it to be a new D-Bus interface
1607
1189
                    # with the alternate D-Bus interface name.  Add it
1608
1190
                    # to the class.
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)))
 
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)))
1616
1199
            if deprecate:
1617
1200
                # Deprecate all alternate interfaces
1618
1201
                iname="_AlternateDBusNames_interface_annotation{}"
1619
1202
                for interface_name in interface_names:
1620
 
                    
1621
1203
                    @dbus_interface_annotations(interface_name)
1622
1204
                    def func(self):
1623
1205
                        return { "org.freedesktop.DBus.Deprecated":
1624
 
                                 "true" }
 
1206
                                     "true" }
1625
1207
                    # Find an unused name
1626
1208
                    for aname in (iname.format(i)
1627
1209
                                  for i in itertools.count()):
1632
1214
                # Replace the class with a new subclass of it with
1633
1215
                # methods, signals, etc. as created above.
1634
1216
                cls = type(b"{}Alternate".format(cls.__name__),
1635
 
                           (cls, ), attr)
 
1217
                           (cls,), attr)
1636
1218
        return cls
1637
 
    
1638
1219
    return wrapper
1639
1220
 
1640
1221
 
1641
1222
@alternate_dbus_interfaces({"se.recompile.Mandos":
1642
 
                            "se.bsnet.fukt.Mandos"})
 
1223
                                "se.bsnet.fukt.Mandos"})
1643
1224
class ClientDBus(Client, DBusObjectWithProperties):
1644
1225
    """A Client class using D-Bus
1645
1226
    
1649
1230
    """
1650
1231
    
1651
1232
    runtime_expansions = (Client.runtime_expansions
1652
 
                          + ("dbus_object_path", ))
 
1233
                          + ("dbus_object_path",))
1653
1234
    
1654
1235
    _interface = "se.recompile.Mandos.Client"
1655
1236
    
1663
1244
        client_object_name = str(self.name).translate(
1664
1245
            {ord("."): ord("_"),
1665
1246
             ord("-"): ord("_")})
1666
 
        self.dbus_object_path = dbus.ObjectPath(
1667
 
            "/clients/" + client_object_name)
 
1247
        self.dbus_object_path = (dbus.ObjectPath
 
1248
                                 ("/clients/" + client_object_name))
1668
1249
        DBusObjectWithProperties.__init__(self, self.bus,
1669
1250
                                          self.dbus_object_path)
1670
1251
    
1671
 
    def notifychangeproperty(transform_func, dbus_name,
1672
 
                             type_func=lambda x: x,
1673
 
                             variant_level=1,
1674
 
                             invalidate_only=False,
 
1252
    def notifychangeproperty(transform_func,
 
1253
                             dbus_name, type_func=lambda x: x,
 
1254
                             variant_level=1, invalidate_only=False,
1675
1255
                             _interface=_interface):
1676
1256
        """ Modify a variable so that it's a property which announces
1677
1257
        its changes to DBus.
1684
1264
        variant_level: D-Bus variant level.  Default: 1
1685
1265
        """
1686
1266
        attrname = "_{}".format(dbus_name)
1687
 
        
1688
1267
        def setter(self, value):
1689
1268
            if hasattr(self, "dbus_object_path"):
1690
1269
                if (not hasattr(self, attrname) or
1691
1270
                    type_func(getattr(self, attrname, None))
1692
1271
                    != type_func(value)):
1693
1272
                    if invalidate_only:
1694
 
                        self.PropertiesChanged(
1695
 
                            _interface, dbus.Dictionary(),
1696
 
                            dbus.Array((dbus_name, )))
 
1273
                        self.PropertiesChanged(_interface,
 
1274
                                               dbus.Dictionary(),
 
1275
                                               dbus.Array
 
1276
                                               ((dbus_name,)))
1697
1277
                    else:
1698
 
                        dbus_value = transform_func(
1699
 
                            type_func(value),
1700
 
                            variant_level = variant_level)
 
1278
                        dbus_value = transform_func(type_func(value),
 
1279
                                                    variant_level
 
1280
                                                    =variant_level)
1701
1281
                        self.PropertyChanged(dbus.String(dbus_name),
1702
1282
                                             dbus_value)
1703
 
                        self.PropertiesChanged(
1704
 
                            _interface,
1705
 
                            dbus.Dictionary({ dbus.String(dbus_name):
1706
 
                                              dbus_value }),
1707
 
                            dbus.Array())
 
1283
                        self.PropertiesChanged(_interface,
 
1284
                                               dbus.Dictionary({
 
1285
                                    dbus.String(dbus_name):
 
1286
                                        dbus_value }), dbus.Array())
1708
1287
            setattr(self, attrname, value)
1709
1288
        
1710
1289
        return property(lambda self: getattr(self, attrname), setter)
1716
1295
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1717
1296
    last_enabled = notifychangeproperty(datetime_to_dbus,
1718
1297
                                        "LastEnabled")
1719
 
    checker = notifychangeproperty(
1720
 
        dbus.Boolean, "CheckerRunning",
1721
 
        type_func = lambda checker: checker is not None)
 
1298
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
 
1299
                                   type_func = lambda checker:
 
1300
                                       checker is not None)
1722
1301
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1723
1302
                                           "LastCheckedOK")
1724
1303
    last_checker_status = notifychangeproperty(dbus.Int16,
1727
1306
        datetime_to_dbus, "LastApprovalRequest")
1728
1307
    approved_by_default = notifychangeproperty(dbus.Boolean,
1729
1308
                                               "ApprovedByDefault")
1730
 
    approval_delay = notifychangeproperty(
1731
 
        dbus.UInt64, "ApprovalDelay",
1732
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1309
    approval_delay = notifychangeproperty(dbus.UInt64,
 
1310
                                          "ApprovalDelay",
 
1311
                                          type_func =
 
1312
                                          lambda td: td.total_seconds()
 
1313
                                          * 1000)
1733
1314
    approval_duration = notifychangeproperty(
1734
1315
        dbus.UInt64, "ApprovalDuration",
1735
1316
        type_func = lambda td: td.total_seconds() * 1000)
1736
1317
    host = notifychangeproperty(dbus.String, "Host")
1737
 
    timeout = notifychangeproperty(
1738
 
        dbus.UInt64, "Timeout",
1739
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1318
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
1319
                                   type_func = lambda td:
 
1320
                                       td.total_seconds() * 1000)
1740
1321
    extended_timeout = notifychangeproperty(
1741
1322
        dbus.UInt64, "ExtendedTimeout",
1742
1323
        type_func = lambda td: td.total_seconds() * 1000)
1743
 
    interval = notifychangeproperty(
1744
 
        dbus.UInt64, "Interval",
1745
 
        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)
1746
1329
    checker_command = notifychangeproperty(dbus.String, "Checker")
1747
1330
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1748
1331
                                  invalidate_only=True)
1758
1341
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1759
1342
        Client.__del__(self, *args, **kwargs)
1760
1343
    
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:
 
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)
1768
1350
            # Emit D-Bus signal
1769
1351
            self.CheckerCompleted(dbus.Int16(exitstatus),
1770
 
                                  # This is specific to GNU libC
1771
 
                                  dbus.Int64(exitstatus << 8),
 
1352
                                  dbus.Int64(condition),
1772
1353
                                  dbus.String(command))
1773
1354
        else:
1774
1355
            # Emit D-Bus signal
1775
1356
            self.CheckerCompleted(dbus.Int16(-1),
1776
 
                                  dbus.Int64(
1777
 
                                      # This is specific to GNU libC
1778
 
                                      (exitstatus << 8)
1779
 
                                      | self.last_checker_signal),
 
1357
                                  dbus.Int64(condition),
1780
1358
                                  dbus.String(command))
1781
 
        return ret
 
1359
        
 
1360
        return Client.checker_callback(self, pid, condition, command,
 
1361
                                       *args, **kwargs)
1782
1362
    
1783
1363
    def start_checker(self, *args, **kwargs):
1784
1364
        old_checker_pid = getattr(self.checker, "pid", None)
1859
1439
        self.checked_ok()
1860
1440
    
1861
1441
    # Enable - method
1862
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1863
1442
    @dbus.service.method(_interface)
1864
1443
    def Enable(self):
1865
1444
        "D-Bus method"
1866
1445
        self.enable()
1867
1446
    
1868
1447
    # StartChecker - method
1869
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1870
1448
    @dbus.service.method(_interface)
1871
1449
    def StartChecker(self):
1872
1450
        "D-Bus method"
1873
1451
        self.start_checker()
1874
1452
    
1875
1453
    # Disable - method
1876
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1877
1454
    @dbus.service.method(_interface)
1878
1455
    def Disable(self):
1879
1456
        "D-Bus method"
1880
1457
        self.disable()
1881
1458
    
1882
1459
    # StopChecker - method
1883
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1884
1460
    @dbus.service.method(_interface)
1885
1461
    def StopChecker(self):
1886
1462
        self.stop_checker()
1893
1469
        return dbus.Boolean(bool(self.approvals_pending))
1894
1470
    
1895
1471
    # ApprovedByDefault - property
1896
 
    @dbus_service_property(_interface,
1897
 
                           signature="b",
 
1472
    @dbus_service_property(_interface, signature="b",
1898
1473
                           access="readwrite")
1899
1474
    def ApprovedByDefault_dbus_property(self, value=None):
1900
1475
        if value is None:       # get
1902
1477
        self.approved_by_default = bool(value)
1903
1478
    
1904
1479
    # ApprovalDelay - property
1905
 
    @dbus_service_property(_interface,
1906
 
                           signature="t",
 
1480
    @dbus_service_property(_interface, signature="t",
1907
1481
                           access="readwrite")
1908
1482
    def ApprovalDelay_dbus_property(self, value=None):
1909
1483
        if value is None:       # get
1912
1486
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1913
1487
    
1914
1488
    # ApprovalDuration - property
1915
 
    @dbus_service_property(_interface,
1916
 
                           signature="t",
 
1489
    @dbus_service_property(_interface, signature="t",
1917
1490
                           access="readwrite")
1918
1491
    def ApprovalDuration_dbus_property(self, value=None):
1919
1492
        if value is None:       # get
1922
1495
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1923
1496
    
1924
1497
    # Name - property
1925
 
    @dbus_annotations(
1926
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1927
1498
    @dbus_service_property(_interface, signature="s", access="read")
1928
1499
    def Name_dbus_property(self):
1929
1500
        return dbus.String(self.name)
1930
1501
    
1931
1502
    # Fingerprint - property
1932
 
    @dbus_annotations(
1933
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1934
1503
    @dbus_service_property(_interface, signature="s", access="read")
1935
1504
    def Fingerprint_dbus_property(self):
1936
1505
        return dbus.String(self.fingerprint)
1937
1506
    
1938
1507
    # Host - property
1939
 
    @dbus_service_property(_interface,
1940
 
                           signature="s",
 
1508
    @dbus_service_property(_interface, signature="s",
1941
1509
                           access="readwrite")
1942
1510
    def Host_dbus_property(self, value=None):
1943
1511
        if value is None:       # get
1945
1513
        self.host = str(value)
1946
1514
    
1947
1515
    # Created - property
1948
 
    @dbus_annotations(
1949
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1950
1516
    @dbus_service_property(_interface, signature="s", access="read")
1951
1517
    def Created_dbus_property(self):
1952
1518
        return datetime_to_dbus(self.created)
1957
1523
        return datetime_to_dbus(self.last_enabled)
1958
1524
    
1959
1525
    # Enabled - property
1960
 
    @dbus_service_property(_interface,
1961
 
                           signature="b",
 
1526
    @dbus_service_property(_interface, signature="b",
1962
1527
                           access="readwrite")
1963
1528
    def Enabled_dbus_property(self, value=None):
1964
1529
        if value is None:       # get
1969
1534
            self.disable()
1970
1535
    
1971
1536
    # LastCheckedOK - property
1972
 
    @dbus_service_property(_interface,
1973
 
                           signature="s",
 
1537
    @dbus_service_property(_interface, signature="s",
1974
1538
                           access="readwrite")
1975
1539
    def LastCheckedOK_dbus_property(self, value=None):
1976
1540
        if value is not None:
1979
1543
        return datetime_to_dbus(self.last_checked_ok)
1980
1544
    
1981
1545
    # LastCheckerStatus - property
1982
 
    @dbus_service_property(_interface, signature="n", access="read")
 
1546
    @dbus_service_property(_interface, signature="n",
 
1547
                           access="read")
1983
1548
    def LastCheckerStatus_dbus_property(self):
1984
1549
        return dbus.Int16(self.last_checker_status)
1985
1550
    
1994
1559
        return datetime_to_dbus(self.last_approval_request)
1995
1560
    
1996
1561
    # Timeout - property
1997
 
    @dbus_service_property(_interface,
1998
 
                           signature="t",
 
1562
    @dbus_service_property(_interface, signature="t",
1999
1563
                           access="readwrite")
2000
1564
    def Timeout_dbus_property(self, value=None):
2001
1565
        if value is None:       # get
2014
1578
                    is None):
2015
1579
                    return
2016
1580
                gobject.source_remove(self.disable_initiator_tag)
2017
 
                self.disable_initiator_tag = gobject.timeout_add(
2018
 
                    int((self.expires - now).total_seconds() * 1000),
2019
 
                    self.disable)
 
1581
                self.disable_initiator_tag = (
 
1582
                    gobject.timeout_add(
 
1583
                        int((self.expires - now).total_seconds()
 
1584
                            * 1000), self.disable))
2020
1585
    
2021
1586
    # ExtendedTimeout - property
2022
 
    @dbus_service_property(_interface,
2023
 
                           signature="t",
 
1587
    @dbus_service_property(_interface, signature="t",
2024
1588
                           access="readwrite")
2025
1589
    def ExtendedTimeout_dbus_property(self, value=None):
2026
1590
        if value is None:       # get
2029
1593
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2030
1594
    
2031
1595
    # Interval - property
2032
 
    @dbus_service_property(_interface,
2033
 
                           signature="t",
 
1596
    @dbus_service_property(_interface, signature="t",
2034
1597
                           access="readwrite")
2035
1598
    def Interval_dbus_property(self, value=None):
2036
1599
        if value is None:       # get
2041
1604
        if self.enabled:
2042
1605
            # Reschedule checker run
2043
1606
            gobject.source_remove(self.checker_initiator_tag)
2044
 
            self.checker_initiator_tag = gobject.timeout_add(
2045
 
                value, self.start_checker)
2046
 
            self.start_checker() # Start one now, too
 
1607
            self.checker_initiator_tag = (gobject.timeout_add
 
1608
                                          (value, self.start_checker))
 
1609
            self.start_checker()    # Start one now, too
2047
1610
    
2048
1611
    # Checker - property
2049
 
    @dbus_service_property(_interface,
2050
 
                           signature="s",
 
1612
    @dbus_service_property(_interface, signature="s",
2051
1613
                           access="readwrite")
2052
1614
    def Checker_dbus_property(self, value=None):
2053
1615
        if value is None:       # get
2055
1617
        self.checker_command = str(value)
2056
1618
    
2057
1619
    # CheckerRunning - property
2058
 
    @dbus_service_property(_interface,
2059
 
                           signature="b",
 
1620
    @dbus_service_property(_interface, signature="b",
2060
1621
                           access="readwrite")
2061
1622
    def CheckerRunning_dbus_property(self, value=None):
2062
1623
        if value is None:       # get
2067
1628
            self.stop_checker()
2068
1629
    
2069
1630
    # ObjectPath - property
2070
 
    @dbus_annotations(
2071
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2072
 
         "org.freedesktop.DBus.Deprecated": "true"})
2073
1631
    @dbus_service_property(_interface, signature="o", access="read")
2074
1632
    def ObjectPath_dbus_property(self):
2075
1633
        return self.dbus_object_path # is already a dbus.ObjectPath
2076
1634
    
2077
1635
    # Secret = property
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)
 
1636
    @dbus_service_property(_interface, signature="ay",
 
1637
                           access="write", byte_arrays=True)
2085
1638
    def Secret_dbus_property(self, value):
2086
1639
        self.secret = bytes(value)
2087
1640
    
2093
1646
        self._pipe = child_pipe
2094
1647
        self._pipe.send(('init', fpr, address))
2095
1648
        if not self._pipe.recv():
2096
 
            raise KeyError(fpr)
 
1649
            raise KeyError()
2097
1650
    
2098
1651
    def __getattribute__(self, name):
2099
1652
        if name == '_pipe':
2103
1656
        if data[0] == 'data':
2104
1657
            return data[1]
2105
1658
        if data[0] == 'function':
2106
 
            
2107
1659
            def func(*args, **kwargs):
2108
1660
                self._pipe.send(('funcall', name, args, kwargs))
2109
1661
                return self._pipe.recv()[1]
2110
 
            
2111
1662
            return func
2112
1663
    
2113
1664
    def __setattr__(self, name, value):
2129
1680
            logger.debug("Pipe FD: %d",
2130
1681
                         self.server.child_pipe.fileno())
2131
1682
            
2132
 
            session = gnutls.ClientSession(self.request)
 
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.
2133
1692
            
2134
1693
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
2135
1694
            #                      "+AES-256-CBC", "+SHA1",
2139
1698
            priority = self.server.gnutls_priority
2140
1699
            if priority is None:
2141
1700
                priority = "NORMAL"
2142
 
            gnutls.priority_set_direct(session._c_object, priority,
2143
 
                                       None)
 
1701
            (gnutls.library.functions
 
1702
             .gnutls_priority_set_direct(session._c_object,
 
1703
                                         priority, None))
2144
1704
            
2145
1705
            # Start communication using the Mandos protocol
2146
1706
            # Get protocol number
2156
1716
            # Start GnuTLS connection
2157
1717
            try:
2158
1718
                session.handshake()
2159
 
            except gnutls.Error as error:
 
1719
            except gnutls.errors.GNUTLSError as error:
2160
1720
                logger.warning("Handshake failed: %s", error)
2161
1721
                # Do not run session.bye() here: the session is not
2162
1722
                # established.  Just abandon the request.
2166
1726
            approval_required = False
2167
1727
            try:
2168
1728
                try:
2169
 
                    fpr = self.fingerprint(
2170
 
                        self.peer_certificate(session))
2171
 
                except (TypeError, gnutls.Error) as error:
 
1729
                    fpr = self.fingerprint(self.peer_certificate
 
1730
                                           (session))
 
1731
                except (TypeError,
 
1732
                        gnutls.errors.GNUTLSError) as error:
2172
1733
                    logger.warning("Bad certificate: %s", error)
2173
1734
                    return
2174
1735
                logger.debug("Fingerprint: %s", fpr)
2187
1748
                while True:
2188
1749
                    if not client.enabled:
2189
1750
                        logger.info("Client %s is disabled",
2190
 
                                    client.name)
 
1751
                                       client.name)
2191
1752
                        if self.server.use_dbus:
2192
1753
                            # Emit D-Bus signal
2193
1754
                            client.Rejected("Disabled")
2232
1793
                    else:
2233
1794
                        delay -= time2 - time
2234
1795
                
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
 
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
2241
1808
                
2242
1809
                logger.info("Sending secret to %s", client.name)
2243
1810
                # bump the timeout using extended_timeout
2251
1818
                    client.approvals_pending -= 1
2252
1819
                try:
2253
1820
                    session.bye()
2254
 
                except gnutls.Error as error:
 
1821
                except gnutls.errors.GNUTLSError as error:
2255
1822
                    logger.warning("GnuTLS bye failed",
2256
1823
                                   exc_info=error)
2257
1824
    
2259
1826
    def peer_certificate(session):
2260
1827
        "Return the peer's OpenPGP certificate as a bytestring"
2261
1828
        # If not an OpenPGP certificate...
2262
 
        if (gnutls.certificate_type_get(session._c_object)
2263
 
            != gnutls.CRT_OPENPGP):
2264
 
            # ...return invalid data
2265
 
            return b""
 
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
2266
1834
        list_size = ctypes.c_uint(1)
2267
 
        cert_list = (gnutls.certificate_get_peers
 
1835
        cert_list = (gnutls.library.functions
 
1836
                     .gnutls_certificate_get_peers
2268
1837
                     (session._c_object, ctypes.byref(list_size)))
2269
1838
        if not bool(cert_list) and list_size.value != 0:
2270
 
            raise gnutls.Error("error getting peer certificate")
 
1839
            raise gnutls.errors.GNUTLSError("error getting peer"
 
1840
                                            " certificate")
2271
1841
        if list_size.value == 0:
2272
1842
            return None
2273
1843
        cert = cert_list[0]
2277
1847
    def fingerprint(openpgp):
2278
1848
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
2279
1849
        # New GnuTLS "datum" with the OpenPGP public key
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)))
 
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))))
2284
1855
        # New empty GnuTLS certificate
2285
 
        crt = gnutls.openpgp_crt_t()
2286
 
        gnutls.openpgp_crt_init(ctypes.byref(crt))
 
1856
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
1857
        (gnutls.library.functions
 
1858
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
2287
1859
        # Import the OpenPGP public key into the certificate
2288
 
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2289
 
                                  gnutls.OPENPGP_FMT_RAW)
 
1860
        (gnutls.library.functions
 
1861
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
1862
                                    gnutls.library.constants
 
1863
                                    .GNUTLS_OPENPGP_FMT_RAW))
2290
1864
        # Verify the self signature in the key
2291
1865
        crtverify = ctypes.c_uint()
2292
 
        gnutls.openpgp_crt_verify_self(crt, 0,
2293
 
                                       ctypes.byref(crtverify))
 
1866
        (gnutls.library.functions
 
1867
         .gnutls_openpgp_crt_verify_self(crt, 0,
 
1868
                                         ctypes.byref(crtverify)))
2294
1869
        if crtverify.value != 0:
2295
 
            gnutls.openpgp_crt_deinit(crt)
2296
 
            raise gnutls.CertificateSecurityError("Verify failed")
 
1870
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
1871
            raise (gnutls.errors.CertificateSecurityError
 
1872
                   ("Verify failed"))
2297
1873
        # New buffer for the fingerprint
2298
1874
        buf = ctypes.create_string_buffer(20)
2299
1875
        buf_len = ctypes.c_size_t()
2300
1876
        # Get the fingerprint from the certificate into the buffer
2301
 
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2302
 
                                           ctypes.byref(buf_len))
 
1877
        (gnutls.library.functions
 
1878
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
1879
                                             ctypes.byref(buf_len)))
2303
1880
        # Deinit the certificate
2304
 
        gnutls.openpgp_crt_deinit(crt)
 
1881
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2305
1882
        # Convert the buffer to a Python bytestring
2306
1883
        fpr = ctypes.string_at(buf, buf_len.value)
2307
1884
        # Convert the bytestring to hexadecimal notation
2311
1888
 
2312
1889
class MultiprocessingMixIn(object):
2313
1890
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2314
 
    
2315
1891
    def sub_process_main(self, request, address):
2316
1892
        try:
2317
1893
            self.finish_request(request, address)
2329
1905
 
2330
1906
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2331
1907
    """ adds a pipe to the MixIn """
2332
 
    
2333
1908
    def process_request(self, request, client_address):
2334
1909
        """Overrides and wraps the original process_request().
2335
1910
        
2356
1931
        interface:      None or a network interface name (string)
2357
1932
        use_ipv6:       Boolean; to use IPv6 or not
2358
1933
    """
2359
 
    
2360
1934
    def __init__(self, server_address, RequestHandlerClass,
2361
 
                 interface=None,
2362
 
                 use_ipv6=True,
2363
 
                 socketfd=None):
 
1935
                 interface=None, use_ipv6=True, socketfd=None):
2364
1936
        """If socketfd is set, use that file descriptor instead of
2365
1937
        creating a new one with socket.socket().
2366
1938
        """
2407
1979
                             self.interface)
2408
1980
            else:
2409
1981
                try:
2410
 
                    self.socket.setsockopt(
2411
 
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
2412
 
                        (self.interface + "\0").encode("utf-8"))
 
1982
                    self.socket.setsockopt(socket.SOL_SOCKET,
 
1983
                                           SO_BINDTODEVICE,
 
1984
                                           (self.interface + "\0")
 
1985
                                           .encode("utf-8"))
2413
1986
                except socket.error as error:
2414
1987
                    if error.errno == errno.EPERM:
2415
1988
                        logger.error("No permission to bind to"
2433
2006
                self.server_address = (any_address,
2434
2007
                                       self.server_address[1])
2435
2008
            elif not self.server_address[1]:
2436
 
                self.server_address = (self.server_address[0], 0)
 
2009
                self.server_address = (self.server_address[0],
 
2010
                                       0)
2437
2011
#                 if self.interface:
2438
2012
#                     self.server_address = (self.server_address[0],
2439
2013
#                                            0, # port
2453
2027
    
2454
2028
    Assumes a gobject.MainLoop event loop.
2455
2029
    """
2456
 
    
2457
2030
    def __init__(self, server_address, RequestHandlerClass,
2458
 
                 interface=None,
2459
 
                 use_ipv6=True,
2460
 
                 clients=None,
2461
 
                 gnutls_priority=None,
2462
 
                 use_dbus=True,
2463
 
                 socketfd=None):
 
2031
                 interface=None, use_ipv6=True, clients=None,
 
2032
                 gnutls_priority=None, use_dbus=True, socketfd=None):
2464
2033
        self.enabled = False
2465
2034
        self.clients = clients
2466
2035
        if self.clients is None:
2472
2041
                                interface = interface,
2473
2042
                                use_ipv6 = use_ipv6,
2474
2043
                                socketfd = socketfd)
2475
 
    
2476
2044
    def server_activate(self):
2477
2045
        if self.enabled:
2478
2046
            return socketserver.TCPServer.server_activate(self)
2482
2050
    
2483
2051
    def add_pipe(self, parent_pipe, proc):
2484
2052
        # Call "handle_ipc" for both data and EOF events
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))
 
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))
2491
2059
    
2492
 
    def handle_ipc(self, source, condition,
2493
 
                   parent_pipe=None,
2494
 
                   proc = None,
2495
 
                   client_object=None):
 
2060
    def handle_ipc(self, source, condition, parent_pipe=None,
 
2061
                   proc = None, client_object=None):
2496
2062
        # error, or the other end of multiprocessing.Pipe has closed
2497
2063
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
2498
2064
            # Wait for other process to exit
2521
2087
                parent_pipe.send(False)
2522
2088
                return False
2523
2089
            
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))
 
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))
2531
2098
            parent_pipe.send(True)
2532
2099
            # remove the old hook in favor of the new above hook on
2533
2100
            # same fileno
2539
2106
            
2540
2107
            parent_pipe.send(('data', getattr(client_object,
2541
2108
                                              funcname)(*args,
2542
 
                                                        **kwargs)))
 
2109
                                                         **kwargs)))
2543
2110
        
2544
2111
        if command == 'getattr':
2545
2112
            attrname = request[1]
2546
 
            if isinstance(client_object.__getattribute__(attrname),
2547
 
                          collections.Callable):
2548
 
                parent_pipe.send(('function', ))
 
2113
            if callable(client_object.__getattribute__(attrname)):
 
2114
                parent_pipe.send(('function',))
2549
2115
            else:
2550
 
                parent_pipe.send((
2551
 
                    'data', client_object.__getattribute__(attrname)))
 
2116
                parent_pipe.send(('data', client_object
 
2117
                                  .__getattribute__(attrname)))
2552
2118
        
2553
2119
        if command == 'setattr':
2554
2120
            attrname = request[1]
2585
2151
    # avoid excessive use of external libraries.
2586
2152
    
2587
2153
    # New type for defining tokens, syntax, and semantics all-in-one
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
 
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
2593
2163
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2594
2164
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2595
2165
    token_end = Token(re.compile(r"$"), None, frozenset())
2596
2166
    token_second = Token(re.compile(r"(\d+)S"),
2597
2167
                         datetime.timedelta(seconds=1),
2598
 
                         frozenset((token_end, )))
 
2168
                         frozenset((token_end,)))
2599
2169
    token_minute = Token(re.compile(r"(\d+)M"),
2600
2170
                         datetime.timedelta(minutes=1),
2601
2171
                         frozenset((token_second, token_end)))
2617
2187
                       frozenset((token_month, token_end)))
2618
2188
    token_week = Token(re.compile(r"(\d+)W"),
2619
2189
                       datetime.timedelta(weeks=1),
2620
 
                       frozenset((token_end, )))
 
2190
                       frozenset((token_end,)))
2621
2191
    token_duration = Token(re.compile(r"P"), None,
2622
2192
                           frozenset((token_year, token_month,
2623
2193
                                      token_day, token_time,
2625
2195
    # Define starting values
2626
2196
    value = datetime.timedelta() # Value so far
2627
2197
    found_token = None
2628
 
    followers = frozenset((token_duration, )) # Following valid tokens
 
2198
    followers = frozenset((token_duration,)) # Following valid tokens
2629
2199
    s = duration                # String left to parse
2630
2200
    # Loop until end token is found
2631
2201
    while found_token is not token_end:
2648
2218
                break
2649
2219
        else:
2650
2220
            # No currently valid tokens were found
2651
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
2652
 
                             .format(duration))
 
2221
            raise ValueError("Invalid RFC 3339 duration")
2653
2222
    # End token found
2654
2223
    return value
2655
2224
 
2692
2261
            elif suffix == "w":
2693
2262
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2694
2263
            else:
2695
 
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2264
                raise ValueError("Unknown suffix {!r}"
 
2265
                                 .format(suffix))
2696
2266
        except IndexError as e:
2697
2267
            raise ValueError(*(e.args))
2698
2268
        timevalue += delta
2714
2284
        # Close all standard open file descriptors
2715
2285
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2716
2286
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2717
 
            raise OSError(errno.ENODEV,
2718
 
                          "{} not a character device"
 
2287
            raise OSError(errno.ENODEV, "{} not a character device"
2719
2288
                          .format(os.devnull))
2720
2289
        os.dup2(null, sys.stdin.fileno())
2721
2290
        os.dup2(null, sys.stdout.fileno())
2788
2357
                        "debug": "False",
2789
2358
                        "priority":
2790
2359
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2791
 
                        ":+SIGN-DSA-SHA256",
 
2360
                        ":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2792
2361
                        "servicename": "Mandos",
2793
2362
                        "use_dbus": "True",
2794
2363
                        "use_ipv6": "True",
2798
2367
                        "statedir": "/var/lib/mandos",
2799
2368
                        "foreground": "False",
2800
2369
                        "zeroconf": "True",
2801
 
                    }
 
2370
                        }
2802
2371
    
2803
2372
    # Parse config file for server-global settings
2804
2373
    server_config = configparser.SafeConfigParser(server_defaults)
2805
2374
    del server_defaults
2806
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
2375
    server_config.read(os.path.join(options.configdir,
 
2376
                                    "mandos.conf"))
2807
2377
    # Convert the SafeConfigParser object to a dict
2808
2378
    server_settings = server_config.defaults()
2809
2379
    # Use the appropriate methods on the non-string config options
2827
2397
    # Override the settings from the config file with command line
2828
2398
    # options, if set.
2829
2399
    for option in ("interface", "address", "port", "debug",
2830
 
                   "priority", "servicename", "configdir", "use_dbus",
2831
 
                   "use_ipv6", "debuglevel", "restore", "statedir",
2832
 
                   "socket", "foreground", "zeroconf"):
 
2400
                   "priority", "servicename", "configdir",
 
2401
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2402
                   "statedir", "socket", "foreground", "zeroconf"):
2833
2403
        value = getattr(options, option)
2834
2404
        if value is not None:
2835
2405
            server_settings[option] = value
2850
2420
    
2851
2421
    ##################################################################
2852
2422
    
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")
 
2423
    if (not server_settings["zeroconf"] and
 
2424
        not (server_settings["port"]
 
2425
             or server_settings["socket"] != "")):
 
2426
            parser.error("Needs port or socket to work without"
 
2427
                         " Zeroconf")
2857
2428
    
2858
2429
    # For convenience
2859
2430
    debug = server_settings["debug"]
2875
2446
            initlogger(debug, level)
2876
2447
    
2877
2448
    if server_settings["servicename"] != "Mandos":
2878
 
        syslogger.setFormatter(
2879
 
            logging.Formatter('Mandos ({}) [%(process)d]:'
2880
 
                              ' %(levelname)s: %(message)s'.format(
2881
 
                                  server_settings["servicename"])))
 
2449
        syslogger.setFormatter(logging.Formatter
 
2450
                               ('Mandos ({}) [%(process)d]:'
 
2451
                                ' %(levelname)s: %(message)s'
 
2452
                                .format(server_settings
 
2453
                                        ["servicename"])))
2882
2454
    
2883
2455
    # Parse config file with clients
2884
2456
    client_config = configparser.SafeConfigParser(Client
2892
2464
    socketfd = None
2893
2465
    if server_settings["socket"] != "":
2894
2466
        socketfd = server_settings["socket"]
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)
 
2467
    tcp_server = MandosServer((server_settings["address"],
 
2468
                               server_settings["port"]),
 
2469
                              ClientHandler,
 
2470
                              interface=(server_settings["interface"]
 
2471
                                         or None),
 
2472
                              use_ipv6=use_ipv6,
 
2473
                              gnutls_priority=
 
2474
                              server_settings["priority"],
 
2475
                              use_dbus=use_dbus,
 
2476
                              socketfd=socketfd)
2903
2477
    if not foreground:
2904
2478
        pidfilename = "/run/mandos.pid"
2905
2479
        if not os.path.isdir("/run/."):
2906
2480
            pidfilename = "/var/run/mandos.pid"
2907
2481
        pidfile = None
2908
2482
        try:
2909
 
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
 
2483
            pidfile = open(pidfilename, "w")
2910
2484
        except IOError as e:
2911
2485
            logger.error("Could not open file %r", pidfilename,
2912
2486
                         exc_info=e)
2933
2507
        
2934
2508
        # "Use a log level over 10 to enable all debugging options."
2935
2509
        # - GnuTLS manual
2936
 
        gnutls.global_set_log_level(11)
 
2510
        gnutls.library.functions.gnutls_global_set_log_level(11)
2937
2511
        
2938
 
        @gnutls.log_func
 
2512
        @gnutls.library.types.gnutls_log_func
2939
2513
        def debug_gnutls(level, string):
2940
2514
            logger.debug("GnuTLS: %s", string[:-1])
2941
2515
        
2942
 
        gnutls.global_set_log_function(debug_gnutls)
 
2516
        (gnutls.library.functions
 
2517
         .gnutls_global_set_log_function(debug_gnutls))
2943
2518
        
2944
2519
        # Redirect stdin so all checkers get /dev/null
2945
2520
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2965
2540
    if use_dbus:
2966
2541
        try:
2967
2542
            bus_name = dbus.service.BusName("se.recompile.Mandos",
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:
 
2543
                                            bus, do_not_queue=True)
 
2544
            old_bus_name = (dbus.service.BusName
 
2545
                            ("se.bsnet.fukt.Mandos", bus,
 
2546
                             do_not_queue=True))
 
2547
        except dbus.exceptions.NameExistsException as e:
2974
2548
            logger.error("Disabling D-Bus:", exc_info=e)
2975
2549
            use_dbus = False
2976
2550
            server_settings["use_dbus"] = False
2977
2551
            tcp_server.use_dbus = False
2978
2552
    if zeroconf:
2979
2553
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2980
 
        service = AvahiServiceToSyslog(
2981
 
            name = server_settings["servicename"],
2982
 
            servicetype = "_mandos._tcp",
2983
 
            protocol = protocol,
2984
 
            bus = bus)
 
2554
        service = AvahiServiceToSyslog(name =
 
2555
                                       server_settings["servicename"],
 
2556
                                       servicetype = "_mandos._tcp",
 
2557
                                       protocol = protocol, bus = bus)
2985
2558
        if server_settings["interface"]:
2986
 
            service.interface = if_nametoindex(
2987
 
                server_settings["interface"].encode("utf-8"))
 
2559
            service.interface = (if_nametoindex
 
2560
                                 (server_settings["interface"]
 
2561
                                  .encode("utf-8")))
2988
2562
    
2989
2563
    global multiprocessing_manager
2990
2564
    multiprocessing_manager = multiprocessing.Manager()
3009
2583
    if server_settings["restore"]:
3010
2584
        try:
3011
2585
            with open(stored_state_path, "rb") as stored_state:
3012
 
                clients_data, old_client_settings = pickle.load(
3013
 
                    stored_state)
 
2586
                clients_data, old_client_settings = (pickle.load
 
2587
                                                     (stored_state))
3014
2588
            os.remove(stored_state_path)
3015
2589
        except IOError as e:
3016
2590
            if e.errno == errno.ENOENT:
3017
 
                logger.warning("Could not load persistent state:"
3018
 
                               " {}".format(os.strerror(e.errno)))
 
2591
                logger.warning("Could not load persistent state: {}"
 
2592
                                .format(os.strerror(e.errno)))
3019
2593
            else:
3020
2594
                logger.critical("Could not load persistent state:",
3021
2595
                                exc_info=e)
3022
2596
                raise
3023
2597
        except EOFError as e:
3024
2598
            logger.warning("Could not load persistent state: "
3025
 
                           "EOFError:",
3026
 
                           exc_info=e)
 
2599
                           "EOFError:", exc_info=e)
3027
2600
    
3028
2601
    with PGPEngine() as pgp:
3029
2602
        for client_name, client in clients_data.items():
3041
2614
                    # For each value in new config, check if it
3042
2615
                    # differs from the old config value (Except for
3043
2616
                    # the "secret" attribute)
3044
 
                    if (name != "secret"
3045
 
                        and (value !=
3046
 
                             old_client_settings[client_name][name])):
 
2617
                    if (name != "secret" and
 
2618
                        value != old_client_settings[client_name]
 
2619
                        [name]):
3047
2620
                        client[name] = value
3048
2621
                except KeyError:
3049
2622
                    pass
3050
2623
            
3051
2624
            # Clients who has passed its expire date can still be
3052
 
            # enabled if its last checker was successful.  A Client
 
2625
            # enabled if its last checker was successful.  Clients
3053
2626
            # whose checker succeeded before we stored its state is
3054
2627
            # assumed to have successfully run all checkers during
3055
2628
            # downtime.
3058
2631
                    if not client["last_checked_ok"]:
3059
2632
                        logger.warning(
3060
2633
                            "disabling client {} - Client never "
3061
 
                            "performed a successful checker".format(
3062
 
                                client_name))
 
2634
                            "performed a successful checker"
 
2635
                            .format(client_name))
3063
2636
                        client["enabled"] = False
3064
2637
                    elif client["last_checker_status"] != 0:
3065
2638
                        logger.warning(
3066
2639
                            "disabling client {} - Client last"
3067
 
                            " checker failed with error code"
3068
 
                            " {}".format(
3069
 
                                client_name,
3070
 
                                client["last_checker_status"]))
 
2640
                            " checker failed with error code {}"
 
2641
                            .format(client_name,
 
2642
                                    client["last_checker_status"]))
3071
2643
                        client["enabled"] = False
3072
2644
                    else:
3073
 
                        client["expires"] = (
3074
 
                            datetime.datetime.utcnow()
3075
 
                            + client["timeout"])
 
2645
                        client["expires"] = (datetime.datetime
 
2646
                                             .utcnow()
 
2647
                                             + client["timeout"])
3076
2648
                        logger.debug("Last checker succeeded,"
3077
 
                                     " keeping {} enabled".format(
3078
 
                                         client_name))
 
2649
                                     " keeping {} enabled"
 
2650
                                     .format(client_name))
3079
2651
            try:
3080
 
                client["secret"] = pgp.decrypt(
3081
 
                    client["encrypted_secret"],
3082
 
                    client_settings[client_name]["secret"])
 
2652
                client["secret"] = (
 
2653
                    pgp.decrypt(client["encrypted_secret"],
 
2654
                                client_settings[client_name]
 
2655
                                ["secret"]))
3083
2656
            except PGPError:
3084
2657
                # If decryption fails, we use secret from new settings
3085
 
                logger.debug("Failed to decrypt {} old secret".format(
3086
 
                    client_name))
3087
 
                client["secret"] = (client_settings[client_name]
3088
 
                                    ["secret"])
 
2658
                logger.debug("Failed to decrypt {} old secret"
 
2659
                             .format(client_name))
 
2660
                client["secret"] = (
 
2661
                    client_settings[client_name]["secret"])
3089
2662
    
3090
2663
    # Add/remove clients based on new changes made to config
3091
2664
    for client_name in (set(old_client_settings)
3098
2671
    # Create all client objects
3099
2672
    for client_name, client in clients_data.items():
3100
2673
        tcp_server.clients[client_name] = client_class(
3101
 
            name = client_name,
3102
 
            settings = client,
 
2674
            name = client_name, settings = client,
3103
2675
            server_settings = server_settings)
3104
2676
    
3105
2677
    if not tcp_server.clients:
3107
2679
    
3108
2680
    if not foreground:
3109
2681
        if pidfile is not None:
3110
 
            pid = os.getpid()
3111
2682
            try:
3112
2683
                with pidfile:
3113
 
                    print(pid, file=pidfile)
 
2684
                    pid = os.getpid()
 
2685
                    pidfile.write("{}\n".format(pid).encode("utf-8"))
3114
2686
            except IOError:
3115
2687
                logger.error("Could not write to file %r with PID %d",
3116
2688
                             pidfilename, pid)
3121
2693
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3122
2694
    
3123
2695
    if use_dbus:
3124
 
        
3125
 
        @alternate_dbus_interfaces(
3126
 
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3127
 
        class MandosDBusService(DBusObjectWithObjectManager):
 
2696
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2697
                                        "se.bsnet.fukt.Mandos"})
 
2698
        class MandosDBusService(DBusObjectWithProperties):
3128
2699
            """A D-Bus proxy object"""
3129
 
            
3130
2700
            def __init__(self):
3131
2701
                dbus.service.Object.__init__(self, bus, "/")
3132
 
            
3133
2702
            _interface = "se.recompile.Mandos"
3134
2703
            
 
2704
            @dbus_interface_annotations(_interface)
 
2705
            def _foo(self):
 
2706
                return { "org.freedesktop.DBus.Property"
 
2707
                         ".EmitsChangedSignal":
 
2708
                             "false"}
 
2709
            
3135
2710
            @dbus.service.signal(_interface, signature="o")
3136
2711
            def ClientAdded(self, objpath):
3137
2712
                "D-Bus signal"
3142
2717
                "D-Bus signal"
3143
2718
                pass
3144
2719
            
3145
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3146
 
                               "true"})
3147
2720
            @dbus.service.signal(_interface, signature="os")
3148
2721
            def ClientRemoved(self, objpath, name):
3149
2722
                "D-Bus signal"
3150
2723
                pass
3151
2724
            
3152
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3153
 
                               "true"})
3154
2725
            @dbus.service.method(_interface, out_signature="ao")
3155
2726
            def GetAllClients(self):
3156
2727
                "D-Bus method"
3157
 
                return dbus.Array(c.dbus_object_path for c in
 
2728
                return dbus.Array(c.dbus_object_path
 
2729
                                  for c in
3158
2730
                                  tcp_server.clients.itervalues())
3159
2731
            
3160
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3161
 
                               "true"})
3162
2732
            @dbus.service.method(_interface,
3163
2733
                                 out_signature="a{oa{sv}}")
3164
2734
            def GetAllClientsWithProperties(self):
3165
2735
                "D-Bus method"
3166
2736
                return dbus.Dictionary(
3167
 
                    { c.dbus_object_path: c.GetAll(
3168
 
                        "se.recompile.Mandos.Client")
 
2737
                    { c.dbus_object_path: c.GetAll("")
3169
2738
                      for c in tcp_server.clients.itervalues() },
3170
2739
                    signature="oa{sv}")
3171
2740
            
3176
2745
                    if c.dbus_object_path == object_path:
3177
2746
                        del tcp_server.clients[c.name]
3178
2747
                        c.remove_from_connection()
3179
 
                        # Don't signal the disabling
 
2748
                        # Don't signal anything except ClientRemoved
3180
2749
                        c.disable(quiet=True)
3181
 
                        # Emit D-Bus signal for removal
3182
 
                        self.client_removed_signal(c)
 
2750
                        # Emit D-Bus signal
 
2751
                        self.ClientRemoved(object_path, c.name)
3183
2752
                        return
3184
2753
                raise KeyError(object_path)
3185
2754
            
3186
2755
            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)
3223
2756
        
3224
2757
        mandos_dbus_service = MandosDBusService()
3225
2758
    
3248
2781
                # + secret.
3249
2782
                exclude = { "bus", "changedstate", "secret",
3250
2783
                            "checker", "server_settings" }
3251
 
                for name, typ in inspect.getmembers(dbus.service
3252
 
                                                    .Object):
 
2784
                for name, typ in (inspect.getmembers
 
2785
                                  (dbus.service.Object)):
3253
2786
                    exclude.add(name)
3254
2787
                
3255
2788
                client_dict["encrypted_secret"] = (client
3262
2795
                del client_settings[client.name]["secret"]
3263
2796
        
3264
2797
        try:
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:
 
2798
            with (tempfile.NamedTemporaryFile
 
2799
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2800
                   dir=os.path.dirname(stored_state_path),
 
2801
                   delete=False)) as stored_state:
3271
2802
                pickle.dump((clients, client_settings), stored_state)
3272
 
                tempname = stored_state.name
 
2803
                tempname=stored_state.name
3273
2804
            os.rename(tempname, stored_state_path)
3274
2805
        except (IOError, OSError) as e:
3275
2806
            if not debug:
3290
2821
            name, client = tcp_server.clients.popitem()
3291
2822
            if use_dbus:
3292
2823
                client.remove_from_connection()
3293
 
            # Don't signal the disabling
 
2824
            # Don't signal anything except ClientRemoved
3294
2825
            client.disable(quiet=True)
3295
 
            # Emit D-Bus signal for removal
3296
2826
            if use_dbus:
3297
 
                mandos_dbus_service.client_removed_signal(client)
 
2827
                # Emit D-Bus signal
 
2828
                mandos_dbus_service.ClientRemoved(client
 
2829
                                                  .dbus_object_path,
 
2830
                                                  client.name)
3298
2831
        client_settings.clear()
3299
2832
    
3300
2833
    atexit.register(cleanup)
3301
2834
    
3302
2835
    for client in tcp_server.clients.itervalues():
3303
2836
        if use_dbus:
3304
 
            # Emit D-Bus signal for adding
3305
 
            mandos_dbus_service.client_added_signal(client)
 
2837
            # Emit D-Bus signal
 
2838
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
3306
2839
        # Need to initiate checking of clients
3307
2840
        if client.enabled:
3308
2841
            client.init_checker()
3353
2886
    # Must run before the D-Bus bus name gets deregistered
3354
2887
    cleanup()
3355
2888
 
3356
 
 
3357
2889
if __name__ == '__main__':
3358
2890
    main()