/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-02-28 03:01:43 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 331.
  • Revision ID: teddy@recompile.se-20160228030143-i6w90r7wzkvlx9kq
Stop using python-gnutls.  Use GnuTLS 3.3 or later directly.

* INSTALL: Document dependency on GnuTLS 3.3 and remove dependency on
          Python-GnuTLS.

* debian/control (Source: mandos/Build-Depends): Add (>= 3.3.0) to
                                                 "libgnutls28-dev" and
                                                 "gnutls-dev".
  (Source: mandos/Build-Depends-Indep): Remove "python2.7-gnutls".
  (Package: mandos/Depends): Remove "python-gnutls" and
                             "python2.7-gnutls", add "libgnutls28-dev
                             (>= 3.3.0) | libgnutls30 (>= 3.3.0)"
* mandos: Remove imports of "gnutls" and all submodules.
  (GnuTLS, gnutls): New; simulate a "gnutls" module.  Change all
                    callers to match new shorter names.

Show diffs side-by-side

added added

removed removed

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