/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: 2016-03-02 16:45:38 UTC
  • Revision ID: teddy@recompile.se-20160302164538-n9ocll4izthzw1ov
Ignore any error from initramfs-tools' "configure_networking".

* initramfs-tools-script: Wrap call to "configure_networking" with
  "set +e" and "set -e", since configure_networking was not designed
  to run in a "set -e" environment.

Closes: 816513
Thanks: Carlos Alberto Lopez Perez <clopez@igalia.com>
Thanks: Ben Hutchings <ben@decadent.org.uk>

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#!/usr/bin/python2.7
 
1
#!/usr/bin/python
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-2014 Teddy Hogeborn
15
 
# Copyright © 2008-2014 Björn Påhlsson
 
14
# Copyright © 2008-2016 Teddy Hogeborn
 
15
# Copyright © 2008-2016 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
36
36
 
37
37
from future_builtins import *
38
38
 
39
 
import SocketServer as socketserver
 
39
try:
 
40
    import SocketServer as socketserver
 
41
except ImportError:
 
42
    import socketserver
40
43
import socket
41
44
import argparse
42
45
import datetime
43
46
import errno
44
 
import gnutls.crypto
45
 
import gnutls.connection
46
 
import gnutls.errors
47
 
import gnutls.library.functions
48
 
import gnutls.library.constants
49
 
import gnutls.library.types
50
 
import ConfigParser as configparser
 
47
try:
 
48
    import ConfigParser as configparser
 
49
except ImportError:
 
50
    import configparser
51
51
import sys
52
52
import re
53
53
import os
62
62
import struct
63
63
import fcntl
64
64
import functools
65
 
import cPickle as pickle
 
65
try:
 
66
    import cPickle as pickle
 
67
except ImportError:
 
68
    import pickle
66
69
import multiprocessing
67
70
import types
68
71
import binascii
69
72
import tempfile
70
73
import itertools
71
74
import collections
 
75
import codecs
72
76
 
73
77
import dbus
74
78
import dbus.service
75
 
import gobject
 
79
try:
 
80
    import gobject
 
81
except ImportError:
 
82
    from gi.repository import GObject as gobject
76
83
import avahi
77
84
from dbus.mainloop.glib import DBusGMainLoop
78
85
import ctypes
91
98
if sys.version_info.major == 2:
92
99
    str = unicode
93
100
 
94
 
version = "1.6.9"
 
101
version = "1.7.3"
95
102
stored_state_file = "clients.pickle"
96
103
 
97
104
logger = logging.getLogger()
98
105
syslogger = None
99
106
 
100
107
try:
101
 
    if_nametoindex = (ctypes.cdll.LoadLibrary
102
 
                      (ctypes.util.find_library("c"))
103
 
                      .if_nametoindex)
 
108
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
109
        ctypes.util.find_library("c")).if_nametoindex
104
110
except (OSError, AttributeError):
 
111
    
105
112
    def if_nametoindex(interface):
106
113
        "Get an interface index the hard way, i.e. using fcntl()"
107
114
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
116
123
    """init logger and add loglevel"""
117
124
    
118
125
    global syslogger
119
 
    syslogger = (logging.handlers.SysLogHandler
120
 
                 (facility =
121
 
                  logging.handlers.SysLogHandler.LOG_DAEMON,
122
 
                  address = "/dev/log"))
 
126
    syslogger = (logging.handlers.SysLogHandler(
 
127
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
128
        address = "/dev/log"))
123
129
    syslogger.setFormatter(logging.Formatter
124
130
                           ('Mandos [%(process)d]: %(levelname)s:'
125
131
                            ' %(message)s'))
142
148
 
143
149
class PGPEngine(object):
144
150
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
151
    
145
152
    def __init__(self):
146
153
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
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
147
165
        self.gnupgargs = ['--batch',
148
 
                          '--home', self.tempdir,
 
166
                          '--homedir', self.tempdir,
149
167
                          '--force-mdc',
150
168
                          '--quiet',
151
169
                          '--no-use-agent']
186
204
    
187
205
    def encrypt(self, data, password):
188
206
        passphrase = self.password_encode(password)
189
 
        with tempfile.NamedTemporaryFile(dir=self.tempdir
190
 
                                         ) as passfile:
 
207
        with tempfile.NamedTemporaryFile(
 
208
                dir=self.tempdir) as passfile:
191
209
            passfile.write(passphrase)
192
210
            passfile.flush()
193
 
            proc = subprocess.Popen(['gpg', '--symmetric',
 
211
            proc = subprocess.Popen([self.gpg, '--symmetric',
194
212
                                     '--passphrase-file',
195
213
                                     passfile.name]
196
214
                                    + self.gnupgargs,
204
222
    
205
223
    def decrypt(self, data, password):
206
224
        passphrase = self.password_encode(password)
207
 
        with tempfile.NamedTemporaryFile(dir = self.tempdir
208
 
                                         ) as passfile:
 
225
        with tempfile.NamedTemporaryFile(
 
226
                dir = self.tempdir) as passfile:
209
227
            passfile.write(passphrase)
210
228
            passfile.flush()
211
 
            proc = subprocess.Popen(['gpg', '--decrypt',
 
229
            proc = subprocess.Popen([self.gpg, '--decrypt',
212
230
                                     '--passphrase-file',
213
231
                                     passfile.name]
214
232
                                    + self.gnupgargs,
215
233
                                    stdin = subprocess.PIPE,
216
234
                                    stdout = subprocess.PIPE,
217
235
                                    stderr = subprocess.PIPE)
218
 
            decrypted_plaintext, err = proc.communicate(input
219
 
                                                        = data)
 
236
            decrypted_plaintext, err = proc.communicate(input = data)
220
237
        if proc.returncode != 0:
221
238
            raise PGPError(err)
222
239
        return decrypted_plaintext
228
245
        return super(AvahiError, self).__init__(value, *args,
229
246
                                                **kwargs)
230
247
 
 
248
 
231
249
class AvahiServiceError(AvahiError):
232
250
    pass
233
251
 
 
252
 
234
253
class AvahiGroupError(AvahiError):
235
254
    pass
236
255
 
256
275
    bus: dbus.SystemBus()
257
276
    """
258
277
    
259
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
260
 
                 servicetype = None, port = None, TXT = None,
261
 
                 domain = "", host = "", max_renames = 32768,
262
 
                 protocol = avahi.PROTO_UNSPEC, bus = None):
 
278
    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):
263
289
        self.interface = interface
264
290
        self.name = name
265
291
        self.type = servicetype
275
301
        self.bus = bus
276
302
        self.entry_group_state_changed_match = None
277
303
    
278
 
    def rename(self):
 
304
    def rename(self, remove=True):
279
305
        """Derived from the Avahi example code"""
280
306
        if self.rename_count >= self.max_renames:
281
307
            logger.critical("No suitable Zeroconf service name found"
282
308
                            " after %i retries, exiting.",
283
309
                            self.rename_count)
284
310
            raise AvahiServiceError("Too many renames")
285
 
        self.name = str(self.server
286
 
                        .GetAlternativeServiceName(self.name))
 
311
        self.name = str(
 
312
            self.server.GetAlternativeServiceName(self.name))
 
313
        self.rename_count += 1
287
314
        logger.info("Changing Zeroconf service name to %r ...",
288
315
                    self.name)
289
 
        self.remove()
 
316
        if remove:
 
317
            self.remove()
290
318
        try:
291
319
            self.add()
292
320
        except dbus.exceptions.DBusException as error:
293
 
            logger.critical("D-Bus Exception", exc_info=error)
294
 
            self.cleanup()
295
 
            os._exit(1)
296
 
        self.rename_count += 1
 
321
            if (error.get_dbus_name()
 
322
                == "org.freedesktop.Avahi.CollisionError"):
 
323
                logger.info("Local Zeroconf service name collision.")
 
324
                return self.rename(remove=False)
 
325
            else:
 
326
                logger.critical("D-Bus Exception", exc_info=error)
 
327
                self.cleanup()
 
328
                os._exit(1)
297
329
    
298
330
    def remove(self):
299
331
        """Derived from the Avahi example code"""
338
370
        elif state == avahi.ENTRY_GROUP_FAILURE:
339
371
            logger.critical("Avahi: Error in group state changed %s",
340
372
                            str(error))
341
 
            raise AvahiGroupError("State changed: {!s}"
342
 
                                  .format(error))
 
373
            raise AvahiGroupError("State changed: {!s}".format(error))
343
374
    
344
375
    def cleanup(self):
345
376
        """Derived from the Avahi example code"""
355
386
    def server_state_changed(self, state, error=None):
356
387
        """Derived from the Avahi example code"""
357
388
        logger.debug("Avahi server state change: %i", state)
358
 
        bad_states = { avahi.SERVER_INVALID:
359
 
                           "Zeroconf server invalid",
360
 
                       avahi.SERVER_REGISTERING: None,
361
 
                       avahi.SERVER_COLLISION:
362
 
                           "Zeroconf server name collision",
363
 
                       avahi.SERVER_FAILURE:
364
 
                           "Zeroconf server failure" }
 
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
        }
365
395
        if state in bad_states:
366
396
            if bad_states[state] is not None:
367
397
                if error is None:
370
400
                    logger.error(bad_states[state] + ": %r", error)
371
401
            self.cleanup()
372
402
        elif state == avahi.SERVER_RUNNING:
373
 
            self.add()
 
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)
374
415
        else:
375
416
            if error is None:
376
417
                logger.debug("Unknown state: %r", state)
386
427
                                    follow_name_owner_changes=True),
387
428
                avahi.DBUS_INTERFACE_SERVER)
388
429
        self.server.connect_to_signal("StateChanged",
389
 
                                 self.server_state_changed)
 
430
                                      self.server_state_changed)
390
431
        self.server_state_changed(self.server.GetState())
391
432
 
392
433
 
393
434
class AvahiServiceToSyslog(AvahiService):
394
 
    def rename(self):
 
435
    def rename(self, *args, **kwargs):
395
436
        """Add the new name to the syslog messages"""
396
 
        ret = AvahiService.rename(self)
397
 
        syslogger.setFormatter(logging.Formatter
398
 
                               ('Mandos ({}) [%(process)d]:'
399
 
                                ' %(levelname)s: %(message)s'
400
 
                                .format(self.name)))
 
437
        ret = AvahiService.rename(self, *args, **kwargs)
 
438
        syslogger.setFormatter(logging.Formatter(
 
439
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
440
            .format(self.name)))
401
441
        return ret
402
442
 
 
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()
403
707
 
404
708
class Client(object):
405
709
    """A representation of a client host served by this server.
432
736
    last_checker_status: integer between 0 and 255 reflecting exit
433
737
                         status of last checker. -1 reflects crashed
434
738
                         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
435
741
    last_enabled: datetime.datetime(); (UTC) or None
436
742
    name:       string; from the config file, used in log messages and
437
743
                        D-Bus identifiers
450
756
                          "fingerprint", "host", "interval",
451
757
                          "last_approval_request", "last_checked_ok",
452
758
                          "last_enabled", "name", "timeout")
453
 
    client_defaults = { "timeout": "PT5M",
454
 
                        "extended_timeout": "PT15M",
455
 
                        "interval": "PT2M",
456
 
                        "checker": "fping -q -- %%(host)s",
457
 
                        "host": "",
458
 
                        "approval_delay": "PT0S",
459
 
                        "approval_duration": "PT1S",
460
 
                        "approved_by_default": "True",
461
 
                        "enabled": "True",
462
 
                        }
 
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
    }
463
770
    
464
771
    @staticmethod
465
772
    def config_parser(config):
481
788
            client["enabled"] = config.getboolean(client_name,
482
789
                                                  "enabled")
483
790
            
 
791
            # Uppercase and remove spaces from fingerprint for later
 
792
            # comparison purposes with return value from the
 
793
            # fingerprint() function
484
794
            client["fingerprint"] = (section["fingerprint"].upper()
485
795
                                     .replace(" ", ""))
486
796
            if "secret" in section:
528
838
            self.expires = None
529
839
        
530
840
        logger.debug("Creating client %r", self.name)
531
 
        # Uppercase and remove spaces from fingerprint for later
532
 
        # comparison purposes with return value from the fingerprint()
533
 
        # function
534
841
        logger.debug("  Fingerprint: %s", self.fingerprint)
535
842
        self.created = settings.get("created",
536
843
                                    datetime.datetime.utcnow())
543
850
        self.current_checker_command = None
544
851
        self.approved = None
545
852
        self.approvals_pending = 0
546
 
        self.changedstate = (multiprocessing_manager
547
 
                             .Condition(multiprocessing_manager
548
 
                                        .Lock()))
549
 
        self.client_structure = [attr for attr in
550
 
                                 self.__dict__.iterkeys()
 
853
        self.changedstate = multiprocessing_manager.Condition(
 
854
            multiprocessing_manager.Lock())
 
855
        self.client_structure = [attr
 
856
                                 for attr in self.__dict__.iterkeys()
551
857
                                 if not attr.startswith("_")]
552
858
        self.client_structure.append("client_structure")
553
859
        
554
 
        for name, t in inspect.getmembers(type(self),
555
 
                                          lambda obj:
556
 
                                              isinstance(obj,
557
 
                                                         property)):
 
860
        for name, t in inspect.getmembers(
 
861
                type(self), lambda obj: isinstance(obj, property)):
558
862
            if not name.startswith("_"):
559
863
                self.client_structure.append(name)
560
864
    
602
906
        # and every interval from then on.
603
907
        if self.checker_initiator_tag is not None:
604
908
            gobject.source_remove(self.checker_initiator_tag)
605
 
        self.checker_initiator_tag = (gobject.timeout_add
606
 
                                      (int(self.interval
607
 
                                           .total_seconds() * 1000),
608
 
                                       self.start_checker))
 
909
        self.checker_initiator_tag = gobject.timeout_add(
 
910
            int(self.interval.total_seconds() * 1000),
 
911
            self.start_checker)
609
912
        # Schedule a disable() when 'timeout' has passed
610
913
        if self.disable_initiator_tag is not None:
611
914
            gobject.source_remove(self.disable_initiator_tag)
612
 
        self.disable_initiator_tag = (gobject.timeout_add
613
 
                                      (int(self.timeout
614
 
                                           .total_seconds() * 1000),
615
 
                                       self.disable))
 
915
        self.disable_initiator_tag = gobject.timeout_add(
 
916
            int(self.timeout.total_seconds() * 1000), self.disable)
616
917
        # Also start a new checker *right now*.
617
918
        self.start_checker()
618
919
    
619
 
    def checker_callback(self, pid, condition, command):
 
920
    def checker_callback(self, source, condition, connection,
 
921
                         command):
620
922
        """The checker has completed, so take appropriate actions."""
621
923
        self.checker_callback_tag = None
622
924
        self.checker = None
623
 
        if os.WIFEXITED(condition):
624
 
            self.last_checker_status = os.WEXITSTATUS(condition)
 
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
625
932
            if self.last_checker_status == 0:
626
933
                logger.info("Checker for %(name)s succeeded",
627
934
                            vars(self))
628
935
                self.checked_ok()
629
936
            else:
630
 
                logger.info("Checker for %(name)s failed",
631
 
                            vars(self))
 
937
                logger.info("Checker for %(name)s failed", vars(self))
632
938
        else:
633
939
            self.last_checker_status = -1
 
940
            self.last_checker_signal = -returncode
634
941
            logger.warning("Checker for %(name)s crashed?",
635
942
                           vars(self))
 
943
        return False
636
944
    
637
945
    def checked_ok(self):
638
946
        """Assert that the client has been seen, alive and well."""
639
947
        self.last_checked_ok = datetime.datetime.utcnow()
640
948
        self.last_checker_status = 0
 
949
        self.last_checker_signal = None
641
950
        self.bump_timeout()
642
951
    
643
952
    def bump_timeout(self, timeout=None):
648
957
            gobject.source_remove(self.disable_initiator_tag)
649
958
            self.disable_initiator_tag = None
650
959
        if getattr(self, "enabled", False):
651
 
            self.disable_initiator_tag = (gobject.timeout_add
652
 
                                          (int(timeout.total_seconds()
653
 
                                               * 1000), self.disable))
 
960
            self.disable_initiator_tag = gobject.timeout_add(
 
961
                int(timeout.total_seconds() * 1000), self.disable)
654
962
            self.expires = datetime.datetime.utcnow() + timeout
655
963
    
656
964
    def need_approval(self):
670
978
        # than 'timeout' for the client to be disabled, which is as it
671
979
        # should be.
672
980
        
673
 
        # If a checker exists, make sure it is not a zombie
674
 
        try:
675
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
676
 
        except AttributeError:
677
 
            pass
678
 
        except OSError as error:
679
 
            if error.errno != errno.ECHILD:
680
 
                raise
681
 
        else:
682
 
            if pid:
683
 
                logger.warning("Checker was a zombie")
684
 
                gobject.source_remove(self.checker_callback_tag)
685
 
                self.checker_callback(pid, status,
686
 
                                      self.current_checker_command)
 
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
687
985
        # Start a new checker if needed
688
986
        if self.checker is None:
689
987
            # Escape attributes for the shell
690
 
            escaped_attrs = { attr:
691
 
                                  re.escape(str(getattr(self, attr)))
692
 
                              for attr in self.runtime_expansions }
 
988
            escaped_attrs = {
 
989
                attr: re.escape(str(getattr(self, attr)))
 
990
                for attr in self.runtime_expansions }
693
991
            try:
694
992
                command = self.checker_command % escaped_attrs
695
993
            except TypeError as error:
696
994
                logger.error('Could not format string "%s"',
697
 
                             self.checker_command, exc_info=error)
698
 
                return True # Try again later
 
995
                             self.checker_command,
 
996
                             exc_info=error)
 
997
                return True     # Try again later
699
998
            self.current_checker_command = command
700
 
            try:
701
 
                logger.info("Starting checker %r for %s",
702
 
                            command, self.name)
703
 
                # We don't need to redirect stdout and stderr, since
704
 
                # in normal mode, that is already done by daemon(),
705
 
                # and in debug mode we don't want to.  (Stdin is
706
 
                # always replaced by /dev/null.)
707
 
                # The exception is when not debugging but nevertheless
708
 
                # running in the foreground; use the previously
709
 
                # created wnull.
710
 
                popen_args = {}
711
 
                if (not self.server_settings["debug"]
712
 
                    and self.server_settings["foreground"]):
713
 
                    popen_args.update({"stdout": wnull,
714
 
                                       "stderr": wnull })
715
 
                self.checker = subprocess.Popen(command,
716
 
                                                close_fds=True,
717
 
                                                shell=True, cwd="/",
718
 
                                                **popen_args)
719
 
            except OSError as error:
720
 
                logger.error("Failed to start subprocess",
721
 
                             exc_info=error)
722
 
                return True
723
 
            self.checker_callback_tag = (gobject.child_watch_add
724
 
                                         (self.checker.pid,
725
 
                                          self.checker_callback,
726
 
                                          data=command))
727
 
            # The checker may have completed before the gobject
728
 
            # watch was added.  Check for this.
729
 
            try:
730
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
731
 
            except OSError as error:
732
 
                if error.errno == errno.ECHILD:
733
 
                    # This should never happen
734
 
                    logger.error("Child process vanished",
735
 
                                 exc_info=error)
736
 
                    return True
737
 
                raise
738
 
            if pid:
739
 
                gobject.source_remove(self.checker_callback_tag)
740
 
                self.checker_callback(pid, status, command)
 
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)
741
1024
        # Re-run this periodically if run by gobject.timeout_add
742
1025
        return True
743
1026
    
749
1032
        if getattr(self, "checker", None) is None:
750
1033
            return
751
1034
        logger.debug("Stopping checker for %(name)s", vars(self))
752
 
        try:
753
 
            self.checker.terminate()
754
 
            #time.sleep(0.5)
755
 
            #if self.checker.poll() is None:
756
 
            #    self.checker.kill()
757
 
        except OSError as error:
758
 
            if error.errno != errno.ESRCH: # No such process
759
 
                raise
 
1035
        self.checker.terminate()
760
1036
        self.checker = None
761
1037
 
762
1038
 
763
 
def dbus_service_property(dbus_interface, signature="v",
764
 
                          access="readwrite", byte_arrays=False):
 
1039
def dbus_service_property(dbus_interface,
 
1040
                          signature="v",
 
1041
                          access="readwrite",
 
1042
                          byte_arrays=False):
765
1043
    """Decorators for marking methods of a DBusObjectWithProperties to
766
1044
    become properties on the D-Bus.
767
1045
    
777
1055
    if byte_arrays and signature != "ay":
778
1056
        raise ValueError("Byte arrays not supported for non-'ay'"
779
1057
                         " signature {!r}".format(signature))
 
1058
    
780
1059
    def decorator(func):
781
1060
        func._dbus_is_property = True
782
1061
        func._dbus_interface = dbus_interface
787
1066
            func._dbus_name = func._dbus_name[:-14]
788
1067
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
789
1068
        return func
 
1069
    
790
1070
    return decorator
791
1071
 
792
1072
 
801
1081
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
802
1082
                    "false"}
803
1083
    """
 
1084
    
804
1085
    def decorator(func):
805
1086
        func._dbus_is_interface = True
806
1087
        func._dbus_interface = dbus_interface
807
1088
        func._dbus_name = dbus_interface
808
1089
        return func
 
1090
    
809
1091
    return decorator
810
1092
 
811
1093
 
820
1102
                           access="r")
821
1103
    def Property_dbus_property(self):
822
1104
        return dbus.Boolean(False)
 
1105
    
 
1106
    See also the DBusObjectWithAnnotations class.
823
1107
    """
 
1108
    
824
1109
    def decorator(func):
825
1110
        func._dbus_annotations = annotations
826
1111
        return func
 
1112
    
827
1113
    return decorator
828
1114
 
829
1115
 
832
1118
    """
833
1119
    pass
834
1120
 
 
1121
 
835
1122
class DBusPropertyAccessException(DBusPropertyException):
836
1123
    """A property's access permissions disallows an operation.
837
1124
    """
844
1131
    pass
845
1132
 
846
1133
 
847
 
class DBusObjectWithProperties(dbus.service.Object):
848
 
    """A D-Bus object with properties.
 
1134
class DBusObjectWithAnnotations(dbus.service.Object):
 
1135
    """A D-Bus object with annotations.
849
1136
    
850
 
    Classes inheriting from this can use the dbus_service_property
851
 
    decorator to expose methods as D-Bus properties.  It exposes the
852
 
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
1137
    Classes inheriting from this can use the dbus_annotations
 
1138
    decorator to add annotations to methods or signals.
853
1139
    """
854
1140
    
855
1141
    @staticmethod
865
1151
    def _get_all_dbus_things(self, thing):
866
1152
        """Returns a generator of (name, attribute) pairs
867
1153
        """
868
 
        return ((getattr(athing.__get__(self), "_dbus_name",
869
 
                         name),
 
1154
        return ((getattr(athing.__get__(self), "_dbus_name", name),
870
1155
                 athing.__get__(self))
871
1156
                for cls in self.__class__.__mro__
872
1157
                for name, athing in
873
 
                inspect.getmembers(cls,
874
 
                                   self._is_dbus_thing(thing)))
 
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
    """
875
1230
    
876
1231
    def _get_dbus_property(self, interface_name, property_name):
877
1232
        """Returns a bound method if one exists which is a D-Bus
878
1233
        property with the specified name and interface.
879
1234
        """
880
 
        for cls in  self.__class__.__mro__:
881
 
            for name, value in (inspect.getmembers
882
 
                                (cls,
883
 
                                 self._is_dbus_thing("property"))):
 
1235
        for cls in self.__class__.__mro__:
 
1236
            for name, value in inspect.getmembers(
 
1237
                    cls, self._is_dbus_thing("property")):
884
1238
                if (value._dbus_name == property_name
885
1239
                    and value._dbus_interface == interface_name):
886
1240
                    return value.__get__(self)
887
1241
        
888
1242
        # No such property
889
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
890
 
                                   + interface_name + "."
891
 
                                   + property_name)
892
 
    
893
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
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",
894
1257
                         out_signature="v")
895
1258
    def Get(self, interface_name, property_name):
896
1259
        """Standard D-Bus property Get() method, see D-Bus standard.
921
1284
                                            for byte in value))
922
1285
        prop(value)
923
1286
    
924
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
1287
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1288
                         in_signature="s",
925
1289
                         out_signature="a{sv}")
926
1290
    def GetAll(self, interface_name):
927
1291
        """Standard D-Bus property GetAll() method, see D-Bus
942
1306
            if not hasattr(value, "variant_level"):
943
1307
                properties[name] = value
944
1308
                continue
945
 
            properties[name] = type(value)(value, variant_level=
946
 
                                           value.variant_level+1)
 
1309
            properties[name] = type(value)(
 
1310
                value, variant_level = value.variant_level + 1)
947
1311
        return dbus.Dictionary(properties, signature="sv")
948
1312
    
949
1313
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
963
1327
        
964
1328
        Inserts property tags and interface annotation tags.
965
1329
        """
966
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
967
 
                                                   connection)
 
1330
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1331
                                                         object_path,
 
1332
                                                         connection)
968
1333
        try:
969
1334
            document = xml.dom.minidom.parseString(xmlstring)
 
1335
            
970
1336
            def make_tag(document, name, prop):
971
1337
                e = document.createElement("property")
972
1338
                e.setAttribute("name", name)
973
1339
                e.setAttribute("type", prop._dbus_signature)
974
1340
                e.setAttribute("access", prop._dbus_access)
975
1341
                return e
 
1342
            
976
1343
            for if_tag in document.getElementsByTagName("interface"):
977
1344
                # Add property tags
978
1345
                for tag in (make_tag(document, name, prop)
981
1348
                            if prop._dbus_interface
982
1349
                            == if_tag.getAttribute("name")):
983
1350
                    if_tag.appendChild(tag)
984
 
                # Add annotation tags
985
 
                for typ in ("method", "signal", "property"):
986
 
                    for tag in if_tag.getElementsByTagName(typ):
987
 
                        annots = dict()
988
 
                        for name, prop in (self.
989
 
                                           _get_all_dbus_things(typ)):
990
 
                            if (name == tag.getAttribute("name")
991
 
                                and prop._dbus_interface
992
 
                                == if_tag.getAttribute("name")):
993
 
                                annots.update(getattr
994
 
                                              (prop,
995
 
                                               "_dbus_annotations",
996
 
                                               {}))
997
 
                        for name, value in annots.items():
998
 
                            ann_tag = document.createElement(
999
 
                                "annotation")
1000
 
                            ann_tag.setAttribute("name", name)
1001
 
                            ann_tag.setAttribute("value", value)
1002
 
                            tag.appendChild(ann_tag)
1003
 
                # Add interface annotation tags
1004
 
                for annotation, value in dict(
1005
 
                    itertools.chain.from_iterable(
1006
 
                        annotations().items()
1007
 
                        for name, annotations in
1008
 
                        self._get_all_dbus_things("interface")
1009
 
                        if name == if_tag.getAttribute("name")
1010
 
                        )).items():
1011
 
                    ann_tag = document.createElement("annotation")
1012
 
                    ann_tag.setAttribute("name", annotation)
1013
 
                    ann_tag.setAttribute("value", value)
1014
 
                    if_tag.appendChild(ann_tag)
 
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)
1015
1367
                # Add the names to the return values for the
1016
1368
                # "org.freedesktop.DBus.Properties" methods
1017
1369
                if (if_tag.getAttribute("name")
1035
1387
                         exc_info=error)
1036
1388
        return xmlstring
1037
1389
 
 
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
1038
1458
 
1039
1459
def datetime_to_dbus(dt, variant_level=0):
1040
1460
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1041
1461
    if dt is None:
1042
1462
        return dbus.String("", variant_level = variant_level)
1043
 
    return dbus.String(dt.isoformat(),
1044
 
                       variant_level=variant_level)
 
1463
    return dbus.String(dt.isoformat(), variant_level=variant_level)
1045
1464
 
1046
1465
 
1047
1466
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1067
1486
    (from DBusObjectWithProperties) and interfaces (from the
1068
1487
    dbus_interface_annotations decorator).
1069
1488
    """
 
1489
    
1070
1490
    def wrapper(cls):
1071
1491
        for orig_interface_name, alt_interface_name in (
1072
 
            alt_interface_names.items()):
 
1492
                alt_interface_names.items()):
1073
1493
            attr = {}
1074
1494
            interface_names = set()
1075
1495
            # Go though all attributes of the class
1077
1497
                # Ignore non-D-Bus attributes, and D-Bus attributes
1078
1498
                # with the wrong interface name
1079
1499
                if (not hasattr(attribute, "_dbus_interface")
1080
 
                    or not attribute._dbus_interface
1081
 
                    .startswith(orig_interface_name)):
 
1500
                    or not attribute._dbus_interface.startswith(
 
1501
                        orig_interface_name)):
1082
1502
                    continue
1083
1503
                # Create an alternate D-Bus interface name based on
1084
1504
                # the current name
1085
 
                alt_interface = (attribute._dbus_interface
1086
 
                                 .replace(orig_interface_name,
1087
 
                                          alt_interface_name))
 
1505
                alt_interface = attribute._dbus_interface.replace(
 
1506
                    orig_interface_name, alt_interface_name)
1088
1507
                interface_names.add(alt_interface)
1089
1508
                # Is this a D-Bus signal?
1090
1509
                if getattr(attribute, "_dbus_is_signal", False):
1091
 
                    # Extract the original non-method undecorated
1092
 
                    # function by black magic
1093
 
                    nonmethod_func = (dict(
 
1510
                    if sys.version_info.major == 2:
 
1511
                        # Extract the original non-method undecorated
 
1512
                        # function by black magic
 
1513
                        nonmethod_func = (dict(
1094
1514
                            zip(attribute.func_code.co_freevars,
1095
 
                                attribute.__closure__))["func"]
1096
 
                                      .cell_contents)
 
1515
                                attribute.__closure__))
 
1516
                                          ["func"].cell_contents)
 
1517
                    else:
 
1518
                        nonmethod_func = attribute
1097
1519
                    # Create a new, but exactly alike, function
1098
1520
                    # object, and decorate it to be a new D-Bus signal
1099
1521
                    # with the alternate D-Bus interface name
1100
 
                    new_function = (dbus.service.signal
1101
 
                                    (alt_interface,
1102
 
                                     attribute._dbus_signature)
1103
 
                                    (types.FunctionType(
1104
 
                                nonmethod_func.func_code,
1105
 
                                nonmethod_func.func_globals,
1106
 
                                nonmethod_func.func_name,
1107
 
                                nonmethod_func.func_defaults,
1108
 
                                nonmethod_func.func_closure)))
 
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))
1109
1539
                    # Copy annotations, if any
1110
1540
                    try:
1111
 
                        new_function._dbus_annotations = (
1112
 
                            dict(attribute._dbus_annotations))
 
1541
                        new_function._dbus_annotations = dict(
 
1542
                            attribute._dbus_annotations)
1113
1543
                    except AttributeError:
1114
1544
                        pass
1115
1545
                    # Define a creator of a function to call both the
1120
1550
                        """This function is a scope container to pass
1121
1551
                        func1 and func2 to the "call_both" function
1122
1552
                        outside of its arguments"""
 
1553
                        
 
1554
                        @functools.wraps(func2)
1123
1555
                        def call_both(*args, **kwargs):
1124
1556
                            """This function will emit two D-Bus
1125
1557
                            signals by calling func1 and func2"""
1126
1558
                            func1(*args, **kwargs)
1127
1559
                            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
                        
1128
1565
                        return call_both
1129
1566
                    # Create the "call_both" function and add it to
1130
1567
                    # the class
1135
1572
                    # object.  Decorate it to be a new D-Bus method
1136
1573
                    # with the alternate D-Bus interface name.  Add it
1137
1574
                    # to the class.
1138
 
                    attr[attrname] = (dbus.service.method
1139
 
                                      (alt_interface,
1140
 
                                       attribute._dbus_in_signature,
1141
 
                                       attribute._dbus_out_signature)
1142
 
                                      (types.FunctionType
1143
 
                                       (attribute.func_code,
1144
 
                                        attribute.func_globals,
1145
 
                                        attribute.func_name,
1146
 
                                        attribute.func_defaults,
1147
 
                                        attribute.func_closure)))
 
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)))
1148
1585
                    # Copy annotations, if any
1149
1586
                    try:
1150
 
                        attr[attrname]._dbus_annotations = (
1151
 
                            dict(attribute._dbus_annotations))
 
1587
                        attr[attrname]._dbus_annotations = dict(
 
1588
                            attribute._dbus_annotations)
1152
1589
                    except AttributeError:
1153
1590
                        pass
1154
1591
                # Is this a D-Bus property?
1157
1594
                    # object, and decorate it to be a new D-Bus
1158
1595
                    # property with the alternate D-Bus interface
1159
1596
                    # name.  Add it to the class.
1160
 
                    attr[attrname] = (dbus_service_property
1161
 
                                      (alt_interface,
1162
 
                                       attribute._dbus_signature,
1163
 
                                       attribute._dbus_access,
1164
 
                                       attribute
1165
 
                                       ._dbus_get_args_options
1166
 
                                       ["byte_arrays"])
1167
 
                                      (types.FunctionType
1168
 
                                       (attribute.func_code,
1169
 
                                        attribute.func_globals,
1170
 
                                        attribute.func_name,
1171
 
                                        attribute.func_defaults,
1172
 
                                        attribute.func_closure)))
 
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)))
1173
1608
                    # Copy annotations, if any
1174
1609
                    try:
1175
 
                        attr[attrname]._dbus_annotations = (
1176
 
                            dict(attribute._dbus_annotations))
 
1610
                        attr[attrname]._dbus_annotations = dict(
 
1611
                            attribute._dbus_annotations)
1177
1612
                    except AttributeError:
1178
1613
                        pass
1179
1614
                # Is this a D-Bus interface?
1182
1617
                    # object.  Decorate it to be a new D-Bus interface
1183
1618
                    # with the alternate D-Bus interface name.  Add it
1184
1619
                    # to the class.
1185
 
                    attr[attrname] = (dbus_interface_annotations
1186
 
                                      (alt_interface)
1187
 
                                      (types.FunctionType
1188
 
                                       (attribute.func_code,
1189
 
                                        attribute.func_globals,
1190
 
                                        attribute.func_name,
1191
 
                                        attribute.func_defaults,
1192
 
                                        attribute.func_closure)))
 
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)))
1193
1627
            if deprecate:
1194
1628
                # Deprecate all alternate interfaces
1195
1629
                iname="_AlternateDBusNames_interface_annotation{}"
1196
1630
                for interface_name in interface_names:
 
1631
                    
1197
1632
                    @dbus_interface_annotations(interface_name)
1198
1633
                    def func(self):
1199
1634
                        return { "org.freedesktop.DBus.Deprecated":
1200
 
                                     "true" }
 
1635
                                 "true" }
1201
1636
                    # Find an unused name
1202
1637
                    for aname in (iname.format(i)
1203
1638
                                  for i in itertools.count()):
1208
1643
                # Replace the class with a new subclass of it with
1209
1644
                # methods, signals, etc. as created above.
1210
1645
                cls = type(b"{}Alternate".format(cls.__name__),
1211
 
                           (cls,), attr)
 
1646
                           (cls, ), attr)
1212
1647
        return cls
 
1648
    
1213
1649
    return wrapper
1214
1650
 
1215
1651
 
1216
1652
@alternate_dbus_interfaces({"se.recompile.Mandos":
1217
 
                                "se.bsnet.fukt.Mandos"})
 
1653
                            "se.bsnet.fukt.Mandos"})
1218
1654
class ClientDBus(Client, DBusObjectWithProperties):
1219
1655
    """A Client class using D-Bus
1220
1656
    
1224
1660
    """
1225
1661
    
1226
1662
    runtime_expansions = (Client.runtime_expansions
1227
 
                          + ("dbus_object_path",))
 
1663
                          + ("dbus_object_path", ))
1228
1664
    
1229
1665
    _interface = "se.recompile.Mandos.Client"
1230
1666
    
1238
1674
        client_object_name = str(self.name).translate(
1239
1675
            {ord("."): ord("_"),
1240
1676
             ord("-"): ord("_")})
1241
 
        self.dbus_object_path = (dbus.ObjectPath
1242
 
                                 ("/clients/" + client_object_name))
 
1677
        self.dbus_object_path = dbus.ObjectPath(
 
1678
            "/clients/" + client_object_name)
1243
1679
        DBusObjectWithProperties.__init__(self, self.bus,
1244
1680
                                          self.dbus_object_path)
1245
1681
    
1246
 
    def notifychangeproperty(transform_func,
1247
 
                             dbus_name, type_func=lambda x: x,
1248
 
                             variant_level=1, invalidate_only=False,
 
1682
    def notifychangeproperty(transform_func, dbus_name,
 
1683
                             type_func=lambda x: x,
 
1684
                             variant_level=1,
 
1685
                             invalidate_only=False,
1249
1686
                             _interface=_interface):
1250
1687
        """ Modify a variable so that it's a property which announces
1251
1688
        its changes to DBus.
1258
1695
        variant_level: D-Bus variant level.  Default: 1
1259
1696
        """
1260
1697
        attrname = "_{}".format(dbus_name)
 
1698
        
1261
1699
        def setter(self, value):
1262
1700
            if hasattr(self, "dbus_object_path"):
1263
1701
                if (not hasattr(self, attrname) or
1264
1702
                    type_func(getattr(self, attrname, None))
1265
1703
                    != type_func(value)):
1266
1704
                    if invalidate_only:
1267
 
                        self.PropertiesChanged(_interface,
1268
 
                                               dbus.Dictionary(),
1269
 
                                               dbus.Array
1270
 
                                               ((dbus_name,)))
 
1705
                        self.PropertiesChanged(
 
1706
                            _interface, dbus.Dictionary(),
 
1707
                            dbus.Array((dbus_name, )))
1271
1708
                    else:
1272
 
                        dbus_value = transform_func(type_func(value),
1273
 
                                                    variant_level
1274
 
                                                    =variant_level)
 
1709
                        dbus_value = transform_func(
 
1710
                            type_func(value),
 
1711
                            variant_level = variant_level)
1275
1712
                        self.PropertyChanged(dbus.String(dbus_name),
1276
1713
                                             dbus_value)
1277
 
                        self.PropertiesChanged(_interface,
1278
 
                                               dbus.Dictionary({
1279
 
                                    dbus.String(dbus_name):
1280
 
                                        dbus_value }), dbus.Array())
 
1714
                        self.PropertiesChanged(
 
1715
                            _interface,
 
1716
                            dbus.Dictionary({ dbus.String(dbus_name):
 
1717
                                              dbus_value }),
 
1718
                            dbus.Array())
1281
1719
            setattr(self, attrname, value)
1282
1720
        
1283
1721
        return property(lambda self: getattr(self, attrname), setter)
1289
1727
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1290
1728
    last_enabled = notifychangeproperty(datetime_to_dbus,
1291
1729
                                        "LastEnabled")
1292
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1293
 
                                   type_func = lambda checker:
1294
 
                                       checker is not None)
 
1730
    checker = notifychangeproperty(
 
1731
        dbus.Boolean, "CheckerRunning",
 
1732
        type_func = lambda checker: checker is not None)
1295
1733
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1296
1734
                                           "LastCheckedOK")
1297
1735
    last_checker_status = notifychangeproperty(dbus.Int16,
1300
1738
        datetime_to_dbus, "LastApprovalRequest")
1301
1739
    approved_by_default = notifychangeproperty(dbus.Boolean,
1302
1740
                                               "ApprovedByDefault")
1303
 
    approval_delay = notifychangeproperty(dbus.UInt64,
1304
 
                                          "ApprovalDelay",
1305
 
                                          type_func =
1306
 
                                          lambda td: td.total_seconds()
1307
 
                                          * 1000)
 
1741
    approval_delay = notifychangeproperty(
 
1742
        dbus.UInt64, "ApprovalDelay",
 
1743
        type_func = lambda td: td.total_seconds() * 1000)
1308
1744
    approval_duration = notifychangeproperty(
1309
1745
        dbus.UInt64, "ApprovalDuration",
1310
1746
        type_func = lambda td: td.total_seconds() * 1000)
1311
1747
    host = notifychangeproperty(dbus.String, "Host")
1312
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1313
 
                                   type_func = lambda td:
1314
 
                                       td.total_seconds() * 1000)
 
1748
    timeout = notifychangeproperty(
 
1749
        dbus.UInt64, "Timeout",
 
1750
        type_func = lambda td: td.total_seconds() * 1000)
1315
1751
    extended_timeout = notifychangeproperty(
1316
1752
        dbus.UInt64, "ExtendedTimeout",
1317
1753
        type_func = lambda td: td.total_seconds() * 1000)
1318
 
    interval = notifychangeproperty(dbus.UInt64,
1319
 
                                    "Interval",
1320
 
                                    type_func =
1321
 
                                    lambda td: td.total_seconds()
1322
 
                                    * 1000)
 
1754
    interval = notifychangeproperty(
 
1755
        dbus.UInt64, "Interval",
 
1756
        type_func = lambda td: td.total_seconds() * 1000)
1323
1757
    checker_command = notifychangeproperty(dbus.String, "Checker")
1324
1758
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1325
1759
                                  invalidate_only=True)
1335
1769
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1336
1770
        Client.__del__(self, *args, **kwargs)
1337
1771
    
1338
 
    def checker_callback(self, pid, condition, command,
1339
 
                         *args, **kwargs):
1340
 
        self.checker_callback_tag = None
1341
 
        self.checker = None
1342
 
        if os.WIFEXITED(condition):
1343
 
            exitstatus = os.WEXITSTATUS(condition)
 
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
1779
            # Emit D-Bus signal
1345
1780
            self.CheckerCompleted(dbus.Int16(exitstatus),
1346
 
                                  dbus.Int64(condition),
 
1781
                                  # This is specific to GNU libC
 
1782
                                  dbus.Int64(exitstatus << 8),
1347
1783
                                  dbus.String(command))
1348
1784
        else:
1349
1785
            # Emit D-Bus signal
1350
1786
            self.CheckerCompleted(dbus.Int16(-1),
1351
 
                                  dbus.Int64(condition),
 
1787
                                  dbus.Int64(
 
1788
                                      # This is specific to GNU libC
 
1789
                                      (exitstatus << 8)
 
1790
                                      | self.last_checker_signal),
1352
1791
                                  dbus.String(command))
1353
 
        
1354
 
        return Client.checker_callback(self, pid, condition, command,
1355
 
                                       *args, **kwargs)
 
1792
        return ret
1356
1793
    
1357
1794
    def start_checker(self, *args, **kwargs):
1358
1795
        old_checker_pid = getattr(self.checker, "pid", None)
1433
1870
        self.checked_ok()
1434
1871
    
1435
1872
    # Enable - method
 
1873
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1436
1874
    @dbus.service.method(_interface)
1437
1875
    def Enable(self):
1438
1876
        "D-Bus method"
1439
1877
        self.enable()
1440
1878
    
1441
1879
    # StartChecker - method
 
1880
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1442
1881
    @dbus.service.method(_interface)
1443
1882
    def StartChecker(self):
1444
1883
        "D-Bus method"
1445
1884
        self.start_checker()
1446
1885
    
1447
1886
    # Disable - method
 
1887
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1448
1888
    @dbus.service.method(_interface)
1449
1889
    def Disable(self):
1450
1890
        "D-Bus method"
1451
1891
        self.disable()
1452
1892
    
1453
1893
    # StopChecker - method
 
1894
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1454
1895
    @dbus.service.method(_interface)
1455
1896
    def StopChecker(self):
1456
1897
        self.stop_checker()
1463
1904
        return dbus.Boolean(bool(self.approvals_pending))
1464
1905
    
1465
1906
    # ApprovedByDefault - property
1466
 
    @dbus_service_property(_interface, signature="b",
 
1907
    @dbus_service_property(_interface,
 
1908
                           signature="b",
1467
1909
                           access="readwrite")
1468
1910
    def ApprovedByDefault_dbus_property(self, value=None):
1469
1911
        if value is None:       # get
1471
1913
        self.approved_by_default = bool(value)
1472
1914
    
1473
1915
    # ApprovalDelay - property
1474
 
    @dbus_service_property(_interface, signature="t",
 
1916
    @dbus_service_property(_interface,
 
1917
                           signature="t",
1475
1918
                           access="readwrite")
1476
1919
    def ApprovalDelay_dbus_property(self, value=None):
1477
1920
        if value is None:       # get
1480
1923
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1481
1924
    
1482
1925
    # ApprovalDuration - property
1483
 
    @dbus_service_property(_interface, signature="t",
 
1926
    @dbus_service_property(_interface,
 
1927
                           signature="t",
1484
1928
                           access="readwrite")
1485
1929
    def ApprovalDuration_dbus_property(self, value=None):
1486
1930
        if value is None:       # get
1489
1933
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1490
1934
    
1491
1935
    # Name - property
 
1936
    @dbus_annotations(
 
1937
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1492
1938
    @dbus_service_property(_interface, signature="s", access="read")
1493
1939
    def Name_dbus_property(self):
1494
1940
        return dbus.String(self.name)
1495
1941
    
1496
1942
    # Fingerprint - property
 
1943
    @dbus_annotations(
 
1944
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1497
1945
    @dbus_service_property(_interface, signature="s", access="read")
1498
1946
    def Fingerprint_dbus_property(self):
1499
1947
        return dbus.String(self.fingerprint)
1500
1948
    
1501
1949
    # Host - property
1502
 
    @dbus_service_property(_interface, signature="s",
 
1950
    @dbus_service_property(_interface,
 
1951
                           signature="s",
1503
1952
                           access="readwrite")
1504
1953
    def Host_dbus_property(self, value=None):
1505
1954
        if value is None:       # get
1507
1956
        self.host = str(value)
1508
1957
    
1509
1958
    # Created - property
 
1959
    @dbus_annotations(
 
1960
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1510
1961
    @dbus_service_property(_interface, signature="s", access="read")
1511
1962
    def Created_dbus_property(self):
1512
1963
        return datetime_to_dbus(self.created)
1517
1968
        return datetime_to_dbus(self.last_enabled)
1518
1969
    
1519
1970
    # Enabled - property
1520
 
    @dbus_service_property(_interface, signature="b",
 
1971
    @dbus_service_property(_interface,
 
1972
                           signature="b",
1521
1973
                           access="readwrite")
1522
1974
    def Enabled_dbus_property(self, value=None):
1523
1975
        if value is None:       # get
1528
1980
            self.disable()
1529
1981
    
1530
1982
    # LastCheckedOK - property
1531
 
    @dbus_service_property(_interface, signature="s",
 
1983
    @dbus_service_property(_interface,
 
1984
                           signature="s",
1532
1985
                           access="readwrite")
1533
1986
    def LastCheckedOK_dbus_property(self, value=None):
1534
1987
        if value is not None:
1537
1990
        return datetime_to_dbus(self.last_checked_ok)
1538
1991
    
1539
1992
    # LastCheckerStatus - property
1540
 
    @dbus_service_property(_interface, signature="n",
1541
 
                           access="read")
 
1993
    @dbus_service_property(_interface, signature="n", access="read")
1542
1994
    def LastCheckerStatus_dbus_property(self):
1543
1995
        return dbus.Int16(self.last_checker_status)
1544
1996
    
1553
2005
        return datetime_to_dbus(self.last_approval_request)
1554
2006
    
1555
2007
    # Timeout - property
1556
 
    @dbus_service_property(_interface, signature="t",
 
2008
    @dbus_service_property(_interface,
 
2009
                           signature="t",
1557
2010
                           access="readwrite")
1558
2011
    def Timeout_dbus_property(self, value=None):
1559
2012
        if value is None:       # get
1572
2025
                    is None):
1573
2026
                    return
1574
2027
                gobject.source_remove(self.disable_initiator_tag)
1575
 
                self.disable_initiator_tag = (
1576
 
                    gobject.timeout_add(
1577
 
                        int((self.expires - now).total_seconds()
1578
 
                            * 1000), self.disable))
 
2028
                self.disable_initiator_tag = gobject.timeout_add(
 
2029
                    int((self.expires - now).total_seconds() * 1000),
 
2030
                    self.disable)
1579
2031
    
1580
2032
    # ExtendedTimeout - property
1581
 
    @dbus_service_property(_interface, signature="t",
 
2033
    @dbus_service_property(_interface,
 
2034
                           signature="t",
1582
2035
                           access="readwrite")
1583
2036
    def ExtendedTimeout_dbus_property(self, value=None):
1584
2037
        if value is None:       # get
1587
2040
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1588
2041
    
1589
2042
    # Interval - property
1590
 
    @dbus_service_property(_interface, signature="t",
 
2043
    @dbus_service_property(_interface,
 
2044
                           signature="t",
1591
2045
                           access="readwrite")
1592
2046
    def Interval_dbus_property(self, value=None):
1593
2047
        if value is None:       # get
1598
2052
        if self.enabled:
1599
2053
            # Reschedule checker run
1600
2054
            gobject.source_remove(self.checker_initiator_tag)
1601
 
            self.checker_initiator_tag = (gobject.timeout_add
1602
 
                                          (value, self.start_checker))
1603
 
            self.start_checker()    # Start one now, too
 
2055
            self.checker_initiator_tag = gobject.timeout_add(
 
2056
                value, self.start_checker)
 
2057
            self.start_checker() # Start one now, too
1604
2058
    
1605
2059
    # Checker - property
1606
 
    @dbus_service_property(_interface, signature="s",
 
2060
    @dbus_service_property(_interface,
 
2061
                           signature="s",
1607
2062
                           access="readwrite")
1608
2063
    def Checker_dbus_property(self, value=None):
1609
2064
        if value is None:       # get
1611
2066
        self.checker_command = str(value)
1612
2067
    
1613
2068
    # CheckerRunning - property
1614
 
    @dbus_service_property(_interface, signature="b",
 
2069
    @dbus_service_property(_interface,
 
2070
                           signature="b",
1615
2071
                           access="readwrite")
1616
2072
    def CheckerRunning_dbus_property(self, value=None):
1617
2073
        if value is None:       # get
1622
2078
            self.stop_checker()
1623
2079
    
1624
2080
    # ObjectPath - property
 
2081
    @dbus_annotations(
 
2082
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
2083
         "org.freedesktop.DBus.Deprecated": "true"})
1625
2084
    @dbus_service_property(_interface, signature="o", access="read")
1626
2085
    def ObjectPath_dbus_property(self):
1627
2086
        return self.dbus_object_path # is already a dbus.ObjectPath
1628
2087
    
1629
2088
    # Secret = property
1630
 
    @dbus_service_property(_interface, signature="ay",
1631
 
                           access="write", byte_arrays=True)
 
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)
1632
2096
    def Secret_dbus_property(self, value):
1633
2097
        self.secret = bytes(value)
1634
2098
    
1640
2104
        self._pipe = child_pipe
1641
2105
        self._pipe.send(('init', fpr, address))
1642
2106
        if not self._pipe.recv():
1643
 
            raise KeyError()
 
2107
            raise KeyError(fpr)
1644
2108
    
1645
2109
    def __getattribute__(self, name):
1646
2110
        if name == '_pipe':
1650
2114
        if data[0] == 'data':
1651
2115
            return data[1]
1652
2116
        if data[0] == 'function':
 
2117
            
1653
2118
            def func(*args, **kwargs):
1654
2119
                self._pipe.send(('funcall', name, args, kwargs))
1655
2120
                return self._pipe.recv()[1]
 
2121
            
1656
2122
            return func
1657
2123
    
1658
2124
    def __setattr__(self, name, value):
1674
2140
            logger.debug("Pipe FD: %d",
1675
2141
                         self.server.child_pipe.fileno())
1676
2142
            
1677
 
            session = (gnutls.connection
1678
 
                       .ClientSession(self.request,
1679
 
                                      gnutls.connection
1680
 
                                      .X509Credentials()))
1681
 
            
1682
 
            # Note: gnutls.connection.X509Credentials is really a
1683
 
            # generic GnuTLS certificate credentials object so long as
1684
 
            # no X.509 keys are added to it.  Therefore, we can use it
1685
 
            # here despite using OpenPGP certificates.
 
2143
            session = gnutls.ClientSession(self.request)
1686
2144
            
1687
2145
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1688
2146
            #                      "+AES-256-CBC", "+SHA1",
1692
2150
            priority = self.server.gnutls_priority
1693
2151
            if priority is None:
1694
2152
                priority = "NORMAL"
1695
 
            (gnutls.library.functions
1696
 
             .gnutls_priority_set_direct(session._c_object,
1697
 
                                         priority, None))
 
2153
            gnutls.priority_set_direct(session._c_object, priority,
 
2154
                                       None)
1698
2155
            
1699
2156
            # Start communication using the Mandos protocol
1700
2157
            # Get protocol number
1710
2167
            # Start GnuTLS connection
1711
2168
            try:
1712
2169
                session.handshake()
1713
 
            except gnutls.errors.GNUTLSError as error:
 
2170
            except gnutls.Error as error:
1714
2171
                logger.warning("Handshake failed: %s", error)
1715
2172
                # Do not run session.bye() here: the session is not
1716
2173
                # established.  Just abandon the request.
1720
2177
            approval_required = False
1721
2178
            try:
1722
2179
                try:
1723
 
                    fpr = self.fingerprint(self.peer_certificate
1724
 
                                           (session))
1725
 
                except (TypeError,
1726
 
                        gnutls.errors.GNUTLSError) as error:
 
2180
                    fpr = self.fingerprint(
 
2181
                        self.peer_certificate(session))
 
2182
                except (TypeError, gnutls.Error) as error:
1727
2183
                    logger.warning("Bad certificate: %s", error)
1728
2184
                    return
1729
2185
                logger.debug("Fingerprint: %s", fpr)
1742
2198
                while True:
1743
2199
                    if not client.enabled:
1744
2200
                        logger.info("Client %s is disabled",
1745
 
                                       client.name)
 
2201
                                    client.name)
1746
2202
                        if self.server.use_dbus:
1747
2203
                            # Emit D-Bus signal
1748
2204
                            client.Rejected("Disabled")
1787
2243
                    else:
1788
2244
                        delay -= time2 - time
1789
2245
                
1790
 
                sent_size = 0
1791
 
                while sent_size < len(client.secret):
1792
 
                    try:
1793
 
                        sent = session.send(client.secret[sent_size:])
1794
 
                    except gnutls.errors.GNUTLSError as error:
1795
 
                        logger.warning("gnutls send failed",
1796
 
                                       exc_info=error)
1797
 
                        return
1798
 
                    logger.debug("Sent: %d, remaining: %d",
1799
 
                                 sent, len(client.secret)
1800
 
                                 - (sent_size + sent))
1801
 
                    sent_size += sent
 
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
1802
2252
                
1803
2253
                logger.info("Sending secret to %s", client.name)
1804
2254
                # bump the timeout using extended_timeout
1812
2262
                    client.approvals_pending -= 1
1813
2263
                try:
1814
2264
                    session.bye()
1815
 
                except gnutls.errors.GNUTLSError as error:
 
2265
                except gnutls.Error as error:
1816
2266
                    logger.warning("GnuTLS bye failed",
1817
2267
                                   exc_info=error)
1818
2268
    
1820
2270
    def peer_certificate(session):
1821
2271
        "Return the peer's OpenPGP certificate as a bytestring"
1822
2272
        # If not an OpenPGP certificate...
1823
 
        if (gnutls.library.functions
1824
 
            .gnutls_certificate_type_get(session._c_object)
1825
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1826
 
            # ...do the normal thing
1827
 
            return session.peer_certificate
 
2273
        if (gnutls.certificate_type_get(session._c_object)
 
2274
            != gnutls.CRT_OPENPGP):
 
2275
            # ...return invalid data
 
2276
            return b""
1828
2277
        list_size = ctypes.c_uint(1)
1829
 
        cert_list = (gnutls.library.functions
1830
 
                     .gnutls_certificate_get_peers
 
2278
        cert_list = (gnutls.certificate_get_peers
1831
2279
                     (session._c_object, ctypes.byref(list_size)))
1832
2280
        if not bool(cert_list) and list_size.value != 0:
1833
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1834
 
                                            " certificate")
 
2281
            raise gnutls.Error("error getting peer certificate")
1835
2282
        if list_size.value == 0:
1836
2283
            return None
1837
2284
        cert = cert_list[0]
1841
2288
    def fingerprint(openpgp):
1842
2289
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1843
2290
        # New GnuTLS "datum" with the OpenPGP public key
1844
 
        datum = (gnutls.library.types
1845
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1846
 
                                             ctypes.POINTER
1847
 
                                             (ctypes.c_ubyte)),
1848
 
                                 ctypes.c_uint(len(openpgp))))
 
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)))
1849
2295
        # New empty GnuTLS certificate
1850
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1851
 
        (gnutls.library.functions
1852
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
2296
        crt = gnutls.openpgp_crt_t()
 
2297
        gnutls.openpgp_crt_init(ctypes.byref(crt))
1853
2298
        # Import the OpenPGP public key into the certificate
1854
 
        (gnutls.library.functions
1855
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1856
 
                                    gnutls.library.constants
1857
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
2299
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2300
                                  gnutls.OPENPGP_FMT_RAW)
1858
2301
        # Verify the self signature in the key
1859
2302
        crtverify = ctypes.c_uint()
1860
 
        (gnutls.library.functions
1861
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1862
 
                                         ctypes.byref(crtverify)))
 
2303
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2304
                                       ctypes.byref(crtverify))
1863
2305
        if crtverify.value != 0:
1864
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1865
 
            raise (gnutls.errors.CertificateSecurityError
1866
 
                   ("Verify failed"))
 
2306
            gnutls.openpgp_crt_deinit(crt)
 
2307
            raise gnutls.CertificateSecurityError("Verify failed")
1867
2308
        # New buffer for the fingerprint
1868
2309
        buf = ctypes.create_string_buffer(20)
1869
2310
        buf_len = ctypes.c_size_t()
1870
2311
        # Get the fingerprint from the certificate into the buffer
1871
 
        (gnutls.library.functions
1872
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1873
 
                                             ctypes.byref(buf_len)))
 
2312
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2313
                                           ctypes.byref(buf_len))
1874
2314
        # Deinit the certificate
1875
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2315
        gnutls.openpgp_crt_deinit(crt)
1876
2316
        # Convert the buffer to a Python bytestring
1877
2317
        fpr = ctypes.string_at(buf, buf_len.value)
1878
2318
        # Convert the bytestring to hexadecimal notation
1882
2322
 
1883
2323
class MultiprocessingMixIn(object):
1884
2324
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
2325
    
1885
2326
    def sub_process_main(self, request, address):
1886
2327
        try:
1887
2328
            self.finish_request(request, address)
1899
2340
 
1900
2341
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1901
2342
    """ adds a pipe to the MixIn """
 
2343
    
1902
2344
    def process_request(self, request, client_address):
1903
2345
        """Overrides and wraps the original process_request().
1904
2346
        
1925
2367
        interface:      None or a network interface name (string)
1926
2368
        use_ipv6:       Boolean; to use IPv6 or not
1927
2369
    """
 
2370
    
1928
2371
    def __init__(self, server_address, RequestHandlerClass,
1929
 
                 interface=None, use_ipv6=True, socketfd=None):
 
2372
                 interface=None,
 
2373
                 use_ipv6=True,
 
2374
                 socketfd=None):
1930
2375
        """If socketfd is set, use that file descriptor instead of
1931
2376
        creating a new one with socket.socket().
1932
2377
        """
1973
2418
                             self.interface)
1974
2419
            else:
1975
2420
                try:
1976
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1977
 
                                           SO_BINDTODEVICE,
1978
 
                                           (self.interface + "\0")
1979
 
                                           .encode("utf-8"))
 
2421
                    self.socket.setsockopt(
 
2422
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2423
                        (self.interface + "\0").encode("utf-8"))
1980
2424
                except socket.error as error:
1981
2425
                    if error.errno == errno.EPERM:
1982
2426
                        logger.error("No permission to bind to"
2000
2444
                self.server_address = (any_address,
2001
2445
                                       self.server_address[1])
2002
2446
            elif not self.server_address[1]:
2003
 
                self.server_address = (self.server_address[0],
2004
 
                                       0)
 
2447
                self.server_address = (self.server_address[0], 0)
2005
2448
#                 if self.interface:
2006
2449
#                     self.server_address = (self.server_address[0],
2007
2450
#                                            0, # port
2021
2464
    
2022
2465
    Assumes a gobject.MainLoop event loop.
2023
2466
    """
 
2467
    
2024
2468
    def __init__(self, server_address, RequestHandlerClass,
2025
 
                 interface=None, use_ipv6=True, clients=None,
2026
 
                 gnutls_priority=None, use_dbus=True, socketfd=None):
 
2469
                 interface=None,
 
2470
                 use_ipv6=True,
 
2471
                 clients=None,
 
2472
                 gnutls_priority=None,
 
2473
                 use_dbus=True,
 
2474
                 socketfd=None):
2027
2475
        self.enabled = False
2028
2476
        self.clients = clients
2029
2477
        if self.clients is None:
2035
2483
                                interface = interface,
2036
2484
                                use_ipv6 = use_ipv6,
2037
2485
                                socketfd = socketfd)
 
2486
    
2038
2487
    def server_activate(self):
2039
2488
        if self.enabled:
2040
2489
            return socketserver.TCPServer.server_activate(self)
2044
2493
    
2045
2494
    def add_pipe(self, parent_pipe, proc):
2046
2495
        # Call "handle_ipc" for both data and EOF events
2047
 
        gobject.io_add_watch(parent_pipe.fileno(),
2048
 
                             gobject.IO_IN | gobject.IO_HUP,
2049
 
                             functools.partial(self.handle_ipc,
2050
 
                                               parent_pipe =
2051
 
                                               parent_pipe,
2052
 
                                               proc = proc))
 
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
2502
    
2054
 
    def handle_ipc(self, source, condition, parent_pipe=None,
2055
 
                   proc = None, client_object=None):
 
2503
    def handle_ipc(self, source, condition,
 
2504
                   parent_pipe=None,
 
2505
                   proc = None,
 
2506
                   client_object=None):
2056
2507
        # error, or the other end of multiprocessing.Pipe has closed
2057
2508
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
2058
2509
            # Wait for other process to exit
2081
2532
                parent_pipe.send(False)
2082
2533
                return False
2083
2534
            
2084
 
            gobject.io_add_watch(parent_pipe.fileno(),
2085
 
                                 gobject.IO_IN | gobject.IO_HUP,
2086
 
                                 functools.partial(self.handle_ipc,
2087
 
                                                   parent_pipe =
2088
 
                                                   parent_pipe,
2089
 
                                                   proc = proc,
2090
 
                                                   client_object =
2091
 
                                                   client))
 
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))
2092
2542
            parent_pipe.send(True)
2093
2543
            # remove the old hook in favor of the new above hook on
2094
2544
            # same fileno
2100
2550
            
2101
2551
            parent_pipe.send(('data', getattr(client_object,
2102
2552
                                              funcname)(*args,
2103
 
                                                         **kwargs)))
 
2553
                                                        **kwargs)))
2104
2554
        
2105
2555
        if command == 'getattr':
2106
2556
            attrname = request[1]
2107
 
            if callable(client_object.__getattribute__(attrname)):
2108
 
                parent_pipe.send(('function',))
 
2557
            if isinstance(client_object.__getattribute__(attrname),
 
2558
                          collections.Callable):
 
2559
                parent_pipe.send(('function', ))
2109
2560
            else:
2110
 
                parent_pipe.send(('data', client_object
2111
 
                                  .__getattribute__(attrname)))
 
2561
                parent_pipe.send((
 
2562
                    'data', client_object.__getattribute__(attrname)))
2112
2563
        
2113
2564
        if command == 'setattr':
2114
2565
            attrname = request[1]
2145
2596
    # avoid excessive use of external libraries.
2146
2597
    
2147
2598
    # New type for defining tokens, syntax, and semantics all-in-one
2148
 
    Token = collections.namedtuple("Token",
2149
 
                                   ("regexp", # To match token; if
2150
 
                                              # "value" is not None,
2151
 
                                              # must have a "group"
2152
 
                                              # containing digits
2153
 
                                    "value",  # datetime.timedelta or
2154
 
                                              # None
2155
 
                                    "followers")) # Tokens valid after
2156
 
                                                  # this token
 
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
2157
2604
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2158
2605
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2159
2606
    token_end = Token(re.compile(r"$"), None, frozenset())
2160
2607
    token_second = Token(re.compile(r"(\d+)S"),
2161
2608
                         datetime.timedelta(seconds=1),
2162
 
                         frozenset((token_end,)))
 
2609
                         frozenset((token_end, )))
2163
2610
    token_minute = Token(re.compile(r"(\d+)M"),
2164
2611
                         datetime.timedelta(minutes=1),
2165
2612
                         frozenset((token_second, token_end)))
2181
2628
                       frozenset((token_month, token_end)))
2182
2629
    token_week = Token(re.compile(r"(\d+)W"),
2183
2630
                       datetime.timedelta(weeks=1),
2184
 
                       frozenset((token_end,)))
 
2631
                       frozenset((token_end, )))
2185
2632
    token_duration = Token(re.compile(r"P"), None,
2186
2633
                           frozenset((token_year, token_month,
2187
2634
                                      token_day, token_time,
2189
2636
    # Define starting values
2190
2637
    value = datetime.timedelta() # Value so far
2191
2638
    found_token = None
2192
 
    followers = frozenset((token_duration,)) # Following valid tokens
 
2639
    followers = frozenset((token_duration, )) # Following valid tokens
2193
2640
    s = duration                # String left to parse
2194
2641
    # Loop until end token is found
2195
2642
    while found_token is not token_end:
2212
2659
                break
2213
2660
        else:
2214
2661
            # No currently valid tokens were found
2215
 
            raise ValueError("Invalid RFC 3339 duration")
 
2662
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2663
                             .format(duration))
2216
2664
    # End token found
2217
2665
    return value
2218
2666
 
2255
2703
            elif suffix == "w":
2256
2704
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2257
2705
            else:
2258
 
                raise ValueError("Unknown suffix {!r}"
2259
 
                                 .format(suffix))
 
2706
                raise ValueError("Unknown suffix {!r}".format(suffix))
2260
2707
        except IndexError as e:
2261
2708
            raise ValueError(*(e.args))
2262
2709
        timevalue += delta
2278
2725
        # Close all standard open file descriptors
2279
2726
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2280
2727
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2281
 
            raise OSError(errno.ENODEV, "{} not a character device"
 
2728
            raise OSError(errno.ENODEV,
 
2729
                          "{} not a character device"
2282
2730
                          .format(os.devnull))
2283
2731
        os.dup2(null, sys.stdin.fileno())
2284
2732
        os.dup2(null, sys.stdout.fileno())
2350
2798
                        "port": "",
2351
2799
                        "debug": "False",
2352
2800
                        "priority":
2353
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
2801
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2802
                        ":+SIGN-DSA-SHA256",
2354
2803
                        "servicename": "Mandos",
2355
2804
                        "use_dbus": "True",
2356
2805
                        "use_ipv6": "True",
2360
2809
                        "statedir": "/var/lib/mandos",
2361
2810
                        "foreground": "False",
2362
2811
                        "zeroconf": "True",
2363
 
                        }
 
2812
                    }
2364
2813
    
2365
2814
    # Parse config file for server-global settings
2366
2815
    server_config = configparser.SafeConfigParser(server_defaults)
2367
2816
    del server_defaults
2368
 
    server_config.read(os.path.join(options.configdir,
2369
 
                                    "mandos.conf"))
 
2817
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
2370
2818
    # Convert the SafeConfigParser object to a dict
2371
2819
    server_settings = server_config.defaults()
2372
2820
    # Use the appropriate methods on the non-string config options
2390
2838
    # Override the settings from the config file with command line
2391
2839
    # options, if set.
2392
2840
    for option in ("interface", "address", "port", "debug",
2393
 
                   "priority", "servicename", "configdir",
2394
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2395
 
                   "statedir", "socket", "foreground", "zeroconf"):
 
2841
                   "priority", "servicename", "configdir", "use_dbus",
 
2842
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2843
                   "socket", "foreground", "zeroconf"):
2396
2844
        value = getattr(options, option)
2397
2845
        if value is not None:
2398
2846
            server_settings[option] = value
2413
2861
    
2414
2862
    ##################################################################
2415
2863
    
2416
 
    if (not server_settings["zeroconf"] and
2417
 
        not (server_settings["port"]
2418
 
             or server_settings["socket"] != "")):
2419
 
            parser.error("Needs port or socket to work without"
2420
 
                         " Zeroconf")
 
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")
2421
2868
    
2422
2869
    # For convenience
2423
2870
    debug = server_settings["debug"]
2439
2886
            initlogger(debug, level)
2440
2887
    
2441
2888
    if server_settings["servicename"] != "Mandos":
2442
 
        syslogger.setFormatter(logging.Formatter
2443
 
                               ('Mandos ({}) [%(process)d]:'
2444
 
                                ' %(levelname)s: %(message)s'
2445
 
                                .format(server_settings
2446
 
                                        ["servicename"])))
 
2889
        syslogger.setFormatter(
 
2890
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2891
                              ' %(levelname)s: %(message)s'.format(
 
2892
                                  server_settings["servicename"])))
2447
2893
    
2448
2894
    # Parse config file with clients
2449
2895
    client_config = configparser.SafeConfigParser(Client
2457
2903
    socketfd = None
2458
2904
    if server_settings["socket"] != "":
2459
2905
        socketfd = server_settings["socket"]
2460
 
    tcp_server = MandosServer((server_settings["address"],
2461
 
                               server_settings["port"]),
2462
 
                              ClientHandler,
2463
 
                              interface=(server_settings["interface"]
2464
 
                                         or None),
2465
 
                              use_ipv6=use_ipv6,
2466
 
                              gnutls_priority=
2467
 
                              server_settings["priority"],
2468
 
                              use_dbus=use_dbus,
2469
 
                              socketfd=socketfd)
 
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)
2470
2914
    if not foreground:
2471
2915
        pidfilename = "/run/mandos.pid"
2472
2916
        if not os.path.isdir("/run/."):
2473
2917
            pidfilename = "/var/run/mandos.pid"
2474
2918
        pidfile = None
2475
2919
        try:
2476
 
            pidfile = open(pidfilename, "w")
 
2920
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2477
2921
        except IOError as e:
2478
2922
            logger.error("Could not open file %r", pidfilename,
2479
2923
                         exc_info=e)
2500
2944
        
2501
2945
        # "Use a log level over 10 to enable all debugging options."
2502
2946
        # - GnuTLS manual
2503
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
2947
        gnutls.global_set_log_level(11)
2504
2948
        
2505
 
        @gnutls.library.types.gnutls_log_func
 
2949
        @gnutls.log_func
2506
2950
        def debug_gnutls(level, string):
2507
2951
            logger.debug("GnuTLS: %s", string[:-1])
2508
2952
        
2509
 
        (gnutls.library.functions
2510
 
         .gnutls_global_set_log_function(debug_gnutls))
 
2953
        gnutls.global_set_log_function(debug_gnutls)
2511
2954
        
2512
2955
        # Redirect stdin so all checkers get /dev/null
2513
2956
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2533
2976
    if use_dbus:
2534
2977
        try:
2535
2978
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2536
 
                                            bus, do_not_queue=True)
2537
 
            old_bus_name = (dbus.service.BusName
2538
 
                            ("se.bsnet.fukt.Mandos", bus,
2539
 
                             do_not_queue=True))
2540
 
        except dbus.exceptions.NameExistsException as e:
 
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:
2541
2985
            logger.error("Disabling D-Bus:", exc_info=e)
2542
2986
            use_dbus = False
2543
2987
            server_settings["use_dbus"] = False
2544
2988
            tcp_server.use_dbus = False
2545
2989
    if zeroconf:
2546
2990
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2547
 
        service = AvahiServiceToSyslog(name =
2548
 
                                       server_settings["servicename"],
2549
 
                                       servicetype = "_mandos._tcp",
2550
 
                                       protocol = protocol, bus = bus)
 
2991
        service = AvahiServiceToSyslog(
 
2992
            name = server_settings["servicename"],
 
2993
            servicetype = "_mandos._tcp",
 
2994
            protocol = protocol,
 
2995
            bus = bus)
2551
2996
        if server_settings["interface"]:
2552
 
            service.interface = (if_nametoindex
2553
 
                                 (server_settings["interface"]
2554
 
                                  .encode("utf-8")))
 
2997
            service.interface = if_nametoindex(
 
2998
                server_settings["interface"].encode("utf-8"))
2555
2999
    
2556
3000
    global multiprocessing_manager
2557
3001
    multiprocessing_manager = multiprocessing.Manager()
2576
3020
    if server_settings["restore"]:
2577
3021
        try:
2578
3022
            with open(stored_state_path, "rb") as stored_state:
2579
 
                clients_data, old_client_settings = (pickle.load
2580
 
                                                     (stored_state))
 
3023
                clients_data, old_client_settings = pickle.load(
 
3024
                    stored_state)
2581
3025
            os.remove(stored_state_path)
2582
3026
        except IOError as e:
2583
3027
            if e.errno == errno.ENOENT:
2584
 
                logger.warning("Could not load persistent state: {}"
2585
 
                                .format(os.strerror(e.errno)))
 
3028
                logger.warning("Could not load persistent state:"
 
3029
                               " {}".format(os.strerror(e.errno)))
2586
3030
            else:
2587
3031
                logger.critical("Could not load persistent state:",
2588
3032
                                exc_info=e)
2589
3033
                raise
2590
3034
        except EOFError as e:
2591
3035
            logger.warning("Could not load persistent state: "
2592
 
                           "EOFError:", exc_info=e)
 
3036
                           "EOFError:",
 
3037
                           exc_info=e)
2593
3038
    
2594
3039
    with PGPEngine() as pgp:
2595
3040
        for client_name, client in clients_data.items():
2607
3052
                    # For each value in new config, check if it
2608
3053
                    # differs from the old config value (Except for
2609
3054
                    # the "secret" attribute)
2610
 
                    if (name != "secret" and
2611
 
                        value != old_client_settings[client_name]
2612
 
                        [name]):
 
3055
                    if (name != "secret"
 
3056
                        and (value !=
 
3057
                             old_client_settings[client_name][name])):
2613
3058
                        client[name] = value
2614
3059
                except KeyError:
2615
3060
                    pass
2616
3061
            
2617
3062
            # Clients who has passed its expire date can still be
2618
 
            # enabled if its last checker was successful.  Clients
 
3063
            # enabled if its last checker was successful.  A Client
2619
3064
            # whose checker succeeded before we stored its state is
2620
3065
            # assumed to have successfully run all checkers during
2621
3066
            # downtime.
2624
3069
                    if not client["last_checked_ok"]:
2625
3070
                        logger.warning(
2626
3071
                            "disabling client {} - Client never "
2627
 
                            "performed a successful checker"
2628
 
                            .format(client_name))
 
3072
                            "performed a successful checker".format(
 
3073
                                client_name))
2629
3074
                        client["enabled"] = False
2630
3075
                    elif client["last_checker_status"] != 0:
2631
3076
                        logger.warning(
2632
3077
                            "disabling client {} - Client last"
2633
 
                            " checker failed with error code {}"
2634
 
                            .format(client_name,
2635
 
                                    client["last_checker_status"]))
 
3078
                            " checker failed with error code"
 
3079
                            " {}".format(
 
3080
                                client_name,
 
3081
                                client["last_checker_status"]))
2636
3082
                        client["enabled"] = False
2637
3083
                    else:
2638
 
                        client["expires"] = (datetime.datetime
2639
 
                                             .utcnow()
2640
 
                                             + client["timeout"])
 
3084
                        client["expires"] = (
 
3085
                            datetime.datetime.utcnow()
 
3086
                            + client["timeout"])
2641
3087
                        logger.debug("Last checker succeeded,"
2642
 
                                     " keeping {} enabled"
2643
 
                                     .format(client_name))
 
3088
                                     " keeping {} enabled".format(
 
3089
                                         client_name))
2644
3090
            try:
2645
 
                client["secret"] = (
2646
 
                    pgp.decrypt(client["encrypted_secret"],
2647
 
                                client_settings[client_name]
2648
 
                                ["secret"]))
 
3091
                client["secret"] = pgp.decrypt(
 
3092
                    client["encrypted_secret"],
 
3093
                    client_settings[client_name]["secret"])
2649
3094
            except PGPError:
2650
3095
                # If decryption fails, we use secret from new settings
2651
 
                logger.debug("Failed to decrypt {} old secret"
2652
 
                             .format(client_name))
2653
 
                client["secret"] = (
2654
 
                    client_settings[client_name]["secret"])
 
3096
                logger.debug("Failed to decrypt {} old secret".format(
 
3097
                    client_name))
 
3098
                client["secret"] = (client_settings[client_name]
 
3099
                                    ["secret"])
2655
3100
    
2656
3101
    # Add/remove clients based on new changes made to config
2657
3102
    for client_name in (set(old_client_settings)
2664
3109
    # Create all client objects
2665
3110
    for client_name, client in clients_data.items():
2666
3111
        tcp_server.clients[client_name] = client_class(
2667
 
            name = client_name, settings = client,
 
3112
            name = client_name,
 
3113
            settings = client,
2668
3114
            server_settings = server_settings)
2669
3115
    
2670
3116
    if not tcp_server.clients:
2672
3118
    
2673
3119
    if not foreground:
2674
3120
        if pidfile is not None:
 
3121
            pid = os.getpid()
2675
3122
            try:
2676
3123
                with pidfile:
2677
 
                    pid = os.getpid()
2678
 
                    pidfile.write("{}\n".format(pid).encode("utf-8"))
 
3124
                    print(pid, file=pidfile)
2679
3125
            except IOError:
2680
3126
                logger.error("Could not write to file %r with PID %d",
2681
3127
                             pidfilename, pid)
2686
3132
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2687
3133
    
2688
3134
    if use_dbus:
2689
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2690
 
                                        "se.bsnet.fukt.Mandos"})
2691
 
        class MandosDBusService(DBusObjectWithProperties):
 
3135
        
 
3136
        @alternate_dbus_interfaces(
 
3137
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
3138
        class MandosDBusService(DBusObjectWithObjectManager):
2692
3139
            """A D-Bus proxy object"""
 
3140
            
2693
3141
            def __init__(self):
2694
3142
                dbus.service.Object.__init__(self, bus, "/")
 
3143
            
2695
3144
            _interface = "se.recompile.Mandos"
2696
3145
            
2697
 
            @dbus_interface_annotations(_interface)
2698
 
            def _foo(self):
2699
 
                return { "org.freedesktop.DBus.Property"
2700
 
                         ".EmitsChangedSignal":
2701
 
                             "false"}
2702
 
            
2703
3146
            @dbus.service.signal(_interface, signature="o")
2704
3147
            def ClientAdded(self, objpath):
2705
3148
                "D-Bus signal"
2710
3153
                "D-Bus signal"
2711
3154
                pass
2712
3155
            
 
3156
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3157
                               "true"})
2713
3158
            @dbus.service.signal(_interface, signature="os")
2714
3159
            def ClientRemoved(self, objpath, name):
2715
3160
                "D-Bus signal"
2716
3161
                pass
2717
3162
            
 
3163
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3164
                               "true"})
2718
3165
            @dbus.service.method(_interface, out_signature="ao")
2719
3166
            def GetAllClients(self):
2720
3167
                "D-Bus method"
2721
 
                return dbus.Array(c.dbus_object_path
2722
 
                                  for c in
 
3168
                return dbus.Array(c.dbus_object_path for c in
2723
3169
                                  tcp_server.clients.itervalues())
2724
3170
            
 
3171
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3172
                               "true"})
2725
3173
            @dbus.service.method(_interface,
2726
3174
                                 out_signature="a{oa{sv}}")
2727
3175
            def GetAllClientsWithProperties(self):
2728
3176
                "D-Bus method"
2729
3177
                return dbus.Dictionary(
2730
 
                    { c.dbus_object_path: c.GetAll("")
 
3178
                    { c.dbus_object_path: c.GetAll(
 
3179
                        "se.recompile.Mandos.Client")
2731
3180
                      for c in tcp_server.clients.itervalues() },
2732
3181
                    signature="oa{sv}")
2733
3182
            
2738
3187
                    if c.dbus_object_path == object_path:
2739
3188
                        del tcp_server.clients[c.name]
2740
3189
                        c.remove_from_connection()
2741
 
                        # Don't signal anything except ClientRemoved
 
3190
                        # Don't signal the disabling
2742
3191
                        c.disable(quiet=True)
2743
 
                        # Emit D-Bus signal
2744
 
                        self.ClientRemoved(object_path, c.name)
 
3192
                        # Emit D-Bus signal for removal
 
3193
                        self.client_removed_signal(c)
2745
3194
                        return
2746
3195
                raise KeyError(object_path)
2747
3196
            
2748
3197
            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)
2749
3234
        
2750
3235
        mandos_dbus_service = MandosDBusService()
2751
3236
    
2774
3259
                # + secret.
2775
3260
                exclude = { "bus", "changedstate", "secret",
2776
3261
                            "checker", "server_settings" }
2777
 
                for name, typ in (inspect.getmembers
2778
 
                                  (dbus.service.Object)):
 
3262
                for name, typ in inspect.getmembers(dbus.service
 
3263
                                                    .Object):
2779
3264
                    exclude.add(name)
2780
3265
                
2781
3266
                client_dict["encrypted_secret"] = (client
2788
3273
                del client_settings[client.name]["secret"]
2789
3274
        
2790
3275
        try:
2791
 
            with (tempfile.NamedTemporaryFile
2792
 
                  (mode='wb', suffix=".pickle", prefix='clients-',
2793
 
                   dir=os.path.dirname(stored_state_path),
2794
 
                   delete=False)) as stored_state:
 
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:
2795
3282
                pickle.dump((clients, client_settings), stored_state)
2796
 
                tempname=stored_state.name
 
3283
                tempname = stored_state.name
2797
3284
            os.rename(tempname, stored_state_path)
2798
3285
        except (IOError, OSError) as e:
2799
3286
            if not debug:
2814
3301
            name, client = tcp_server.clients.popitem()
2815
3302
            if use_dbus:
2816
3303
                client.remove_from_connection()
2817
 
            # Don't signal anything except ClientRemoved
 
3304
            # Don't signal the disabling
2818
3305
            client.disable(quiet=True)
 
3306
            # Emit D-Bus signal for removal
2819
3307
            if use_dbus:
2820
 
                # Emit D-Bus signal
2821
 
                mandos_dbus_service.ClientRemoved(client
2822
 
                                                  .dbus_object_path,
2823
 
                                                  client.name)
 
3308
                mandos_dbus_service.client_removed_signal(client)
2824
3309
        client_settings.clear()
2825
3310
    
2826
3311
    atexit.register(cleanup)
2827
3312
    
2828
3313
    for client in tcp_server.clients.itervalues():
2829
3314
        if use_dbus:
2830
 
            # Emit D-Bus signal
2831
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3315
            # Emit D-Bus signal for adding
 
3316
            mandos_dbus_service.client_added_signal(client)
2832
3317
        # Need to initiate checking of clients
2833
3318
        if client.enabled:
2834
3319
            client.init_checker()
2879
3364
    # Must run before the D-Bus bus name gets deregistered
2880
3365
    cleanup()
2881
3366
 
 
3367
 
2882
3368
if __name__ == '__main__':
2883
3369
    main()