/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: 2014-08-09 13:18:46 UTC
  • mto: (237.7.304 trunk)
  • mto: This revision was merged to the branch mainline in revision 323.
  • Revision ID: teddy@recompile.se-20140809131846-2emd272mf9c9wihe
mandos: Replace unicode() with str().

This is in preparation for the coming Python 3 conversion.

* mandos: Replace "str" with "unicode".  All callers changed.

Show diffs side-by-side

added added

removed removed

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