/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2015-06-28 16:35:27 UTC
  • mto: This revision was merged to the branch mainline in revision 759.
  • Revision ID: teddy@recompile.se-20150628163527-cky0ec59zew7teua
Add a plugin helper directory, available to all plugins.

* Makefile (PLUGIN_HELPERS): New; list of plugin helpers.
  (CPROGS): Appended "$(PLUGIN_HELPERS)".
* initramfs-tools-hook: Create new plugin helper directory, and copy
                        plugin helpers provided by the system and/or
                        by the local administrator.
  (PLUGINHELPERDIR): New.
* plugin-runner.c: Take new --plugin-helper-dir option and provide
                   environment variable to all plugins.
  (PHDIR): New; set to "/lib/mandos/plugin-helpers".
  (main/pluginhelperdir): New.
  (main/options): New option "--plugin-helper-dir".
  (main/parse_opt, main/parse_opt_config_file): Accept new option.
  (main): Use new option to set MANDOSPLUGINHELPERDIR environment
          variable as if using --global-env MANDOSPLUGINHELPERDIR=...
* plugin-runner.xml: Document new --plugin-helper-dir option.
  (SYNOPSIS, OPTIONS): Add "--plugin-helper-dir" option.
  (PLUGINS/WRITING PLUGINS): Document new environment variable
                             available to plugins.
  (ENVIRONMENT): Document new environment variable
                 "MANDOSPLUGINHELPERDIR" affected by the new
                 --plugin-helper-dir option.

Show diffs side-by-side

added added

removed removed

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