/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-05 21:42:56 UTC
  • Revision ID: teddy@recompile.se-20160305214256-79progf0wfkd9068
Add bug reporting information to manual pages

* bugs.xml: New file.
* intro.xml (BUGS): New section; include "bugs.xml".
* mandos-clients.conf.xml (BUGS): Include "bugs.xml".
* mandos-ctl.xml (BUGS): Uncommented; include "bugs.xml".
* mandos-keygen.xml (BUGS): - '' -
* mandos-monitor.xml (BUGS): Include "bugs.xml".
* mandos.conf.xml (BUGS): - '' -
* mandos.xml (BUGS): - '' -
* plugin-runner.xml (BUGS): - '' -
* plugins.d/askpass-fifo.xml (BUGS): New section; include
                                     "../bugs.xml".
* plugins.d/mandos-client.xml (BUGS): Uncommented; include
                                     "../bugs.xml".
* plugins.d/password-prompt.xml (BUGS): Include "../bugs.xml".
* plugins.d/plymouth.xml (BUGS): - '' -
* plugins.d/splashy.xml (BUGS): - '' -
* plugins.d/usplash.xml (BUGS): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2014 Teddy Hogeborn
15
 
# Copyright © 2008-2014 Björn Påhlsson
 
14
# Copyright © 2008-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
    from gi.repository import GObject
 
81
except ImportError:
 
82
    import gobject as GObject
76
83
import avahi
77
84
from dbus.mainloop.glib import DBusGMainLoop
78
85
import ctypes
88
95
    except ImportError:
89
96
        SO_BINDTODEVICE = None
90
97
 
91
 
version = "1.6.5"
 
98
if sys.version_info.major == 2:
 
99
    str = unicode
 
100
 
 
101
version = "1.7.3"
92
102
stored_state_file = "clients.pickle"
93
103
 
94
104
logger = logging.getLogger()
95
105
syslogger = None
96
106
 
97
107
try:
98
 
    if_nametoindex = (ctypes.cdll.LoadLibrary
99
 
                      (ctypes.util.find_library("c"))
100
 
                      .if_nametoindex)
 
108
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
109
        ctypes.util.find_library("c")).if_nametoindex
101
110
except (OSError, AttributeError):
 
111
    
102
112
    def if_nametoindex(interface):
103
113
        "Get an interface index the hard way, i.e. using fcntl()"
104
114
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
105
115
        with contextlib.closing(socket.socket()) as s:
106
116
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
 
                                struct.pack(str("16s16x"),
108
 
                                            interface))
109
 
        interface_index = struct.unpack(str("I"),
110
 
                                        ifreq[16:20])[0]
 
117
                                struct.pack(b"16s16x", interface))
 
118
        interface_index = struct.unpack("I", ifreq[16:20])[0]
111
119
        return interface_index
112
120
 
113
121
 
115
123
    """init logger and add loglevel"""
116
124
    
117
125
    global syslogger
118
 
    syslogger = (logging.handlers.SysLogHandler
119
 
                 (facility =
120
 
                  logging.handlers.SysLogHandler.LOG_DAEMON,
121
 
                  address = str("/dev/log")))
 
126
    syslogger = (logging.handlers.SysLogHandler(
 
127
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
128
        address = "/dev/log"))
122
129
    syslogger.setFormatter(logging.Formatter
123
130
                           ('Mandos [%(process)d]: %(levelname)s:'
124
131
                            ' %(message)s'))
141
148
 
142
149
class PGPEngine(object):
143
150
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
151
    
144
152
    def __init__(self):
145
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
146
165
        self.gnupgargs = ['--batch',
147
 
                          '--home', self.tempdir,
 
166
                          '--homedir', self.tempdir,
148
167
                          '--force-mdc',
149
168
                          '--quiet',
150
169
                          '--no-use-agent']
185
204
    
186
205
    def encrypt(self, data, password):
187
206
        passphrase = self.password_encode(password)
188
 
        with tempfile.NamedTemporaryFile(dir=self.tempdir
189
 
                                         ) as passfile:
 
207
        with tempfile.NamedTemporaryFile(
 
208
                dir=self.tempdir) as passfile:
190
209
            passfile.write(passphrase)
191
210
            passfile.flush()
192
 
            proc = subprocess.Popen(['gpg', '--symmetric',
 
211
            proc = subprocess.Popen([self.gpg, '--symmetric',
193
212
                                     '--passphrase-file',
194
213
                                     passfile.name]
195
214
                                    + self.gnupgargs,
203
222
    
204
223
    def decrypt(self, data, password):
205
224
        passphrase = self.password_encode(password)
206
 
        with tempfile.NamedTemporaryFile(dir = self.tempdir
207
 
                                         ) as passfile:
 
225
        with tempfile.NamedTemporaryFile(
 
226
                dir = self.tempdir) as passfile:
208
227
            passfile.write(passphrase)
209
228
            passfile.flush()
210
 
            proc = subprocess.Popen(['gpg', '--decrypt',
 
229
            proc = subprocess.Popen([self.gpg, '--decrypt',
211
230
                                     '--passphrase-file',
212
231
                                     passfile.name]
213
232
                                    + self.gnupgargs,
214
233
                                    stdin = subprocess.PIPE,
215
234
                                    stdout = subprocess.PIPE,
216
235
                                    stderr = subprocess.PIPE)
217
 
            decrypted_plaintext, err = proc.communicate(input
218
 
                                                        = data)
 
236
            decrypted_plaintext, err = proc.communicate(input = data)
219
237
        if proc.returncode != 0:
220
238
            raise PGPError(err)
221
239
        return decrypted_plaintext
224
242
class AvahiError(Exception):
225
243
    def __init__(self, value, *args, **kwargs):
226
244
        self.value = value
227
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
228
 
    def __unicode__(self):
229
 
        return unicode(repr(self.value))
 
245
        return super(AvahiError, self).__init__(value, *args,
 
246
                                                **kwargs)
 
247
 
230
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 = unicode(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"""
337
369
            self.rename()
338
370
        elif state == avahi.ENTRY_GROUP_FAILURE:
339
371
            logger.critical("Avahi: Error in group state changed %s",
340
 
                            unicode(error))
341
 
            raise AvahiGroupError("State changed: {0!s}"
342
 
                                  .format(error))
 
372
                            str(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 ({0}) [%(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
 
403
 
 
404
 
def timedelta_to_milliseconds(td):
405
 
    "Convert a datetime.timedelta() to milliseconds"
406
 
    return ((td.days * 24 * 60 * 60 * 1000)
407
 
            + (td.seconds * 1000)
408
 
            + (td.microseconds // 1000))
409
 
 
 
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()
410
707
 
411
708
class Client(object):
412
709
    """A representation of a client host served by this server.
418
715
    checker:    subprocess.Popen(); a running checker process used
419
716
                                    to see if the client lives.
420
717
                                    'None' if no process is running.
421
 
    checker_callback_tag: a gobject event source tag, or None
 
718
    checker_callback_tag: a GObject event source tag, or None
422
719
    checker_command: string; External command which is run to check
423
720
                     if client lives.  %() expansions are done at
424
721
                     runtime with vars(self) as dict, so that for
425
722
                     instance %(name)s can be used in the command.
426
 
    checker_initiator_tag: a gobject event source tag, or None
 
723
    checker_initiator_tag: a GObject event source tag, or None
427
724
    created:    datetime.datetime(); (UTC) object creation
428
725
    client_structure: Object describing what attributes a client has
429
726
                      and is used for storing the client at exit
430
727
    current_checker_command: string; current running checker_command
431
 
    disable_initiator_tag: a gobject event source tag, or None
 
728
    disable_initiator_tag: a GObject event source tag, or None
432
729
    enabled:    bool()
433
730
    fingerprint: string (40 or 32 hexadecimal digits); used to
434
731
                 uniquely identify the client
439
736
    last_checker_status: integer between 0 and 255 reflecting exit
440
737
                         status of last checker. -1 reflects crashed
441
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
442
741
    last_enabled: datetime.datetime(); (UTC) or None
443
742
    name:       string; from the config file, used in log messages and
444
743
                        D-Bus identifiers
457
756
                          "fingerprint", "host", "interval",
458
757
                          "last_approval_request", "last_checked_ok",
459
758
                          "last_enabled", "name", "timeout")
460
 
    client_defaults = { "timeout": "PT5M",
461
 
                        "extended_timeout": "PT15M",
462
 
                        "interval": "PT2M",
463
 
                        "checker": "fping -q -- %%(host)s",
464
 
                        "host": "",
465
 
                        "approval_delay": "PT0S",
466
 
                        "approval_duration": "PT1S",
467
 
                        "approved_by_default": "True",
468
 
                        "enabled": "True",
469
 
                        }
470
 
    
471
 
    def timeout_milliseconds(self):
472
 
        "Return the 'timeout' attribute in milliseconds"
473
 
        return timedelta_to_milliseconds(self.timeout)
474
 
    
475
 
    def extended_timeout_milliseconds(self):
476
 
        "Return the 'extended_timeout' attribute in milliseconds"
477
 
        return timedelta_to_milliseconds(self.extended_timeout)
478
 
    
479
 
    def interval_milliseconds(self):
480
 
        "Return the 'interval' attribute in milliseconds"
481
 
        return timedelta_to_milliseconds(self.interval)
482
 
    
483
 
    def approval_delay_milliseconds(self):
484
 
        return timedelta_to_milliseconds(self.approval_delay)
 
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
    }
485
770
    
486
771
    @staticmethod
487
772
    def config_parser(config):
503
788
            client["enabled"] = config.getboolean(client_name,
504
789
                                                  "enabled")
505
790
            
 
791
            # Uppercase and remove spaces from fingerprint for later
 
792
            # comparison purposes with return value from the
 
793
            # fingerprint() function
506
794
            client["fingerprint"] = (section["fingerprint"].upper()
507
795
                                     .replace(" ", ""))
508
796
            if "secret" in section:
513
801
                          "rb") as secfile:
514
802
                    client["secret"] = secfile.read()
515
803
            else:
516
 
                raise TypeError("No secret or secfile for section {0}"
 
804
                raise TypeError("No secret or secfile for section {}"
517
805
                                .format(section))
518
806
            client["timeout"] = string_to_delta(section["timeout"])
519
807
            client["extended_timeout"] = string_to_delta(
536
824
            server_settings = {}
537
825
        self.server_settings = server_settings
538
826
        # adding all client settings
539
 
        for setting, value in settings.iteritems():
 
827
        for setting, value in settings.items():
540
828
            setattr(self, setting, value)
541
829
        
542
830
        if self.enabled:
550
838
            self.expires = None
551
839
        
552
840
        logger.debug("Creating client %r", self.name)
553
 
        # Uppercase and remove spaces from fingerprint for later
554
 
        # comparison purposes with return value from the fingerprint()
555
 
        # function
556
841
        logger.debug("  Fingerprint: %s", self.fingerprint)
557
842
        self.created = settings.get("created",
558
843
                                    datetime.datetime.utcnow())
565
850
        self.current_checker_command = None
566
851
        self.approved = None
567
852
        self.approvals_pending = 0
568
 
        self.changedstate = (multiprocessing_manager
569
 
                             .Condition(multiprocessing_manager
570
 
                                        .Lock()))
571
 
        self.client_structure = [attr for attr in
572
 
                                 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()
573
857
                                 if not attr.startswith("_")]
574
858
        self.client_structure.append("client_structure")
575
859
        
576
 
        for name, t in inspect.getmembers(type(self),
577
 
                                          lambda obj:
578
 
                                              isinstance(obj,
579
 
                                                         property)):
 
860
        for name, t in inspect.getmembers(
 
861
                type(self), lambda obj: isinstance(obj, property)):
580
862
            if not name.startswith("_"):
581
863
                self.client_structure.append(name)
582
864
    
603
885
        if not quiet:
604
886
            logger.info("Disabling client %s", self.name)
605
887
        if getattr(self, "disable_initiator_tag", None) is not None:
606
 
            gobject.source_remove(self.disable_initiator_tag)
 
888
            GObject.source_remove(self.disable_initiator_tag)
607
889
            self.disable_initiator_tag = None
608
890
        self.expires = None
609
891
        if getattr(self, "checker_initiator_tag", None) is not None:
610
 
            gobject.source_remove(self.checker_initiator_tag)
 
892
            GObject.source_remove(self.checker_initiator_tag)
611
893
            self.checker_initiator_tag = None
612
894
        self.stop_checker()
613
895
        self.enabled = False
614
896
        if not quiet:
615
897
            self.send_changedstate()
616
 
        # Do not run this again if called by a gobject.timeout_add
 
898
        # Do not run this again if called by a GObject.timeout_add
617
899
        return False
618
900
    
619
901
    def __del__(self):
623
905
        # Schedule a new checker to be started an 'interval' from now,
624
906
        # and every interval from then on.
625
907
        if self.checker_initiator_tag is not None:
626
 
            gobject.source_remove(self.checker_initiator_tag)
627
 
        self.checker_initiator_tag = (gobject.timeout_add
628
 
                                      (self.interval_milliseconds(),
629
 
                                       self.start_checker))
 
908
            GObject.source_remove(self.checker_initiator_tag)
 
909
        self.checker_initiator_tag = GObject.timeout_add(
 
910
            int(self.interval.total_seconds() * 1000),
 
911
            self.start_checker)
630
912
        # Schedule a disable() when 'timeout' has passed
631
913
        if self.disable_initiator_tag is not None:
632
 
            gobject.source_remove(self.disable_initiator_tag)
633
 
        self.disable_initiator_tag = (gobject.timeout_add
634
 
                                   (self.timeout_milliseconds(),
635
 
                                    self.disable))
 
914
            GObject.source_remove(self.disable_initiator_tag)
 
915
        self.disable_initiator_tag = GObject.timeout_add(
 
916
            int(self.timeout.total_seconds() * 1000), self.disable)
636
917
        # Also start a new checker *right now*.
637
918
        self.start_checker()
638
919
    
639
 
    def checker_callback(self, pid, condition, command):
 
920
    def checker_callback(self, source, condition, connection,
 
921
                         command):
640
922
        """The checker has completed, so take appropriate actions."""
641
923
        self.checker_callback_tag = None
642
924
        self.checker = None
643
 
        if os.WIFEXITED(condition):
644
 
            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
645
932
            if self.last_checker_status == 0:
646
933
                logger.info("Checker for %(name)s succeeded",
647
934
                            vars(self))
648
935
                self.checked_ok()
649
936
            else:
650
 
                logger.info("Checker for %(name)s failed",
651
 
                            vars(self))
 
937
                logger.info("Checker for %(name)s failed", vars(self))
652
938
        else:
653
939
            self.last_checker_status = -1
 
940
            self.last_checker_signal = -returncode
654
941
            logger.warning("Checker for %(name)s crashed?",
655
942
                           vars(self))
 
943
        return False
656
944
    
657
945
    def checked_ok(self):
658
946
        """Assert that the client has been seen, alive and well."""
659
947
        self.last_checked_ok = datetime.datetime.utcnow()
660
948
        self.last_checker_status = 0
 
949
        self.last_checker_signal = None
661
950
        self.bump_timeout()
662
951
    
663
952
    def bump_timeout(self, timeout=None):
665
954
        if timeout is None:
666
955
            timeout = self.timeout
667
956
        if self.disable_initiator_tag is not None:
668
 
            gobject.source_remove(self.disable_initiator_tag)
 
957
            GObject.source_remove(self.disable_initiator_tag)
669
958
            self.disable_initiator_tag = None
670
959
        if getattr(self, "enabled", False):
671
 
            self.disable_initiator_tag = (gobject.timeout_add
672
 
                                          (timedelta_to_milliseconds
673
 
                                           (timeout), self.disable))
 
960
            self.disable_initiator_tag = GObject.timeout_add(
 
961
                int(timeout.total_seconds() * 1000), self.disable)
674
962
            self.expires = datetime.datetime.utcnow() + timeout
675
963
    
676
964
    def need_approval(self):
690
978
        # than 'timeout' for the client to be disabled, which is as it
691
979
        # should be.
692
980
        
693
 
        # If a checker exists, make sure it is not a zombie
694
 
        try:
695
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
696
 
        except AttributeError:
697
 
            pass
698
 
        except OSError as error:
699
 
            if error.errno != errno.ECHILD:
700
 
                raise
701
 
        else:
702
 
            if pid:
703
 
                logger.warning("Checker was a zombie")
704
 
                gobject.source_remove(self.checker_callback_tag)
705
 
                self.checker_callback(pid, status,
706
 
                                      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
707
985
        # Start a new checker if needed
708
986
        if self.checker is None:
709
987
            # Escape attributes for the shell
710
 
            escaped_attrs = dict(
711
 
                (attr, re.escape(unicode(getattr(self, attr))))
712
 
                for attr in
713
 
                self.runtime_expansions)
 
988
            escaped_attrs = {
 
989
                attr: re.escape(str(getattr(self, attr)))
 
990
                for attr in self.runtime_expansions }
714
991
            try:
715
992
                command = self.checker_command % escaped_attrs
716
993
            except TypeError as error:
717
994
                logger.error('Could not format string "%s"',
718
 
                             self.checker_command, exc_info=error)
719
 
                return True # Try again later
 
995
                             self.checker_command,
 
996
                             exc_info=error)
 
997
                return True     # Try again later
720
998
            self.current_checker_command = command
721
 
            try:
722
 
                logger.info("Starting checker %r for %s",
723
 
                            command, self.name)
724
 
                # We don't need to redirect stdout and stderr, since
725
 
                # in normal mode, that is already done by daemon(),
726
 
                # and in debug mode we don't want to.  (Stdin is
727
 
                # always replaced by /dev/null.)
728
 
                # The exception is when not debugging but nevertheless
729
 
                # running in the foreground; use the previously
730
 
                # created wnull.
731
 
                popen_args = {}
732
 
                if (not self.server_settings["debug"]
733
 
                    and self.server_settings["foreground"]):
734
 
                    popen_args.update({"stdout": wnull,
735
 
                                       "stderr": wnull })
736
 
                self.checker = subprocess.Popen(command,
737
 
                                                close_fds=True,
738
 
                                                shell=True, cwd="/",
739
 
                                                **popen_args)
740
 
            except OSError as error:
741
 
                logger.error("Failed to start subprocess",
742
 
                             exc_info=error)
743
 
                return True
744
 
            self.checker_callback_tag = (gobject.child_watch_add
745
 
                                         (self.checker.pid,
746
 
                                          self.checker_callback,
747
 
                                          data=command))
748
 
            # The checker may have completed before the gobject
749
 
            # watch was added.  Check for this.
750
 
            try:
751
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
752
 
            except OSError as error:
753
 
                if error.errno == errno.ECHILD:
754
 
                    # This should never happen
755
 
                    logger.error("Child process vanished",
756
 
                                 exc_info=error)
757
 
                    return True
758
 
                raise
759
 
            if pid:
760
 
                gobject.source_remove(self.checker_callback_tag)
761
 
                self.checker_callback(pid, status, command)
762
 
        # Re-run this periodically if run by gobject.timeout_add
 
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)
 
1024
        # Re-run this periodically if run by GObject.timeout_add
763
1025
        return True
764
1026
    
765
1027
    def stop_checker(self):
766
1028
        """Force the checker process, if any, to stop."""
767
1029
        if self.checker_callback_tag:
768
 
            gobject.source_remove(self.checker_callback_tag)
 
1030
            GObject.source_remove(self.checker_callback_tag)
769
1031
            self.checker_callback_tag = None
770
1032
        if getattr(self, "checker", None) is None:
771
1033
            return
772
1034
        logger.debug("Stopping checker for %(name)s", vars(self))
773
 
        try:
774
 
            self.checker.terminate()
775
 
            #time.sleep(0.5)
776
 
            #if self.checker.poll() is None:
777
 
            #    self.checker.kill()
778
 
        except OSError as error:
779
 
            if error.errno != errno.ESRCH: # No such process
780
 
                raise
 
1035
        self.checker.terminate()
781
1036
        self.checker = None
782
1037
 
783
1038
 
784
 
def dbus_service_property(dbus_interface, signature="v",
785
 
                          access="readwrite", byte_arrays=False):
 
1039
def dbus_service_property(dbus_interface,
 
1040
                          signature="v",
 
1041
                          access="readwrite",
 
1042
                          byte_arrays=False):
786
1043
    """Decorators for marking methods of a DBusObjectWithProperties to
787
1044
    become properties on the D-Bus.
788
1045
    
797
1054
    # "Set" method, so we fail early here:
798
1055
    if byte_arrays and signature != "ay":
799
1056
        raise ValueError("Byte arrays not supported for non-'ay'"
800
 
                         " signature {0!r}".format(signature))
 
1057
                         " signature {!r}".format(signature))
 
1058
    
801
1059
    def decorator(func):
802
1060
        func._dbus_is_property = True
803
1061
        func._dbus_interface = dbus_interface
808
1066
            func._dbus_name = func._dbus_name[:-14]
809
1067
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
810
1068
        return func
 
1069
    
811
1070
    return decorator
812
1071
 
813
1072
 
822
1081
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
823
1082
                    "false"}
824
1083
    """
 
1084
    
825
1085
    def decorator(func):
826
1086
        func._dbus_is_interface = True
827
1087
        func._dbus_interface = dbus_interface
828
1088
        func._dbus_name = dbus_interface
829
1089
        return func
 
1090
    
830
1091
    return decorator
831
1092
 
832
1093
 
834
1095
    """Decorator to annotate D-Bus methods, signals or properties
835
1096
    Usage:
836
1097
    
 
1098
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
 
1099
                       "org.freedesktop.DBus.Property."
 
1100
                       "EmitsChangedSignal": "false"})
837
1101
    @dbus_service_property("org.example.Interface", signature="b",
838
1102
                           access="r")
839
 
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
840
 
                        "org.freedesktop.DBus.Property."
841
 
                        "EmitsChangedSignal": "false"})
842
1103
    def Property_dbus_property(self):
843
1104
        return dbus.Boolean(False)
 
1105
    
 
1106
    See also the DBusObjectWithAnnotations class.
844
1107
    """
 
1108
    
845
1109
    def decorator(func):
846
1110
        func._dbus_annotations = annotations
847
1111
        return func
 
1112
    
848
1113
    return decorator
849
1114
 
850
1115
 
851
1116
class DBusPropertyException(dbus.exceptions.DBusException):
852
1117
    """A base class for D-Bus property-related exceptions
853
1118
    """
854
 
    def __unicode__(self):
855
 
        return unicode(str(self))
 
1119
    pass
856
1120
 
857
1121
 
858
1122
class DBusPropertyAccessException(DBusPropertyException):
867
1131
    pass
868
1132
 
869
1133
 
870
 
class DBusObjectWithProperties(dbus.service.Object):
871
 
    """A D-Bus object with properties.
 
1134
class DBusObjectWithAnnotations(dbus.service.Object):
 
1135
    """A D-Bus object with annotations.
872
1136
    
873
 
    Classes inheriting from this can use the dbus_service_property
874
 
    decorator to expose methods as D-Bus properties.  It exposes the
875
 
    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.
876
1139
    """
877
1140
    
878
1141
    @staticmethod
882
1145
        If called like _is_dbus_thing("method") it returns a function
883
1146
        suitable for use as predicate to inspect.getmembers().
884
1147
        """
885
 
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
 
1148
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
886
1149
                                   False)
887
1150
    
888
1151
    def _get_all_dbus_things(self, thing):
889
1152
        """Returns a generator of (name, attribute) pairs
890
1153
        """
891
 
        return ((getattr(athing.__get__(self), "_dbus_name",
892
 
                         name),
 
1154
        return ((getattr(athing.__get__(self), "_dbus_name", name),
893
1155
                 athing.__get__(self))
894
1156
                for cls in self.__class__.__mro__
895
1157
                for name, athing in
896
 
                inspect.getmembers(cls,
897
 
                                   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
    """
898
1230
    
899
1231
    def _get_dbus_property(self, interface_name, property_name):
900
1232
        """Returns a bound method if one exists which is a D-Bus
901
1233
        property with the specified name and interface.
902
1234
        """
903
 
        for cls in  self.__class__.__mro__:
904
 
            for name, value in (inspect.getmembers
905
 
                                (cls,
906
 
                                 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")):
907
1238
                if (value._dbus_name == property_name
908
1239
                    and value._dbus_interface == interface_name):
909
1240
                    return value.__get__(self)
910
1241
        
911
1242
        # No such property
912
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
913
 
                                   + interface_name + "."
914
 
                                   + property_name)
915
 
    
916
 
    @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",
917
1257
                         out_signature="v")
918
1258
    def Get(self, interface_name, property_name):
919
1259
        """Standard D-Bus property Get() method, see D-Bus standard.
938
1278
            # signatures other than "ay".
939
1279
            if prop._dbus_signature != "ay":
940
1280
                raise ValueError("Byte arrays not supported for non-"
941
 
                                 "'ay' signature {0!r}"
 
1281
                                 "'ay' signature {!r}"
942
1282
                                 .format(prop._dbus_signature))
943
1283
            value = dbus.ByteArray(b''.join(chr(byte)
944
1284
                                            for byte in value))
945
1285
        prop(value)
946
1286
    
947
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
1287
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1288
                         in_signature="s",
948
1289
                         out_signature="a{sv}")
949
1290
    def GetAll(self, interface_name):
950
1291
        """Standard D-Bus property GetAll() method, see D-Bus
965
1306
            if not hasattr(value, "variant_level"):
966
1307
                properties[name] = value
967
1308
                continue
968
 
            properties[name] = type(value)(value, variant_level=
969
 
                                           value.variant_level+1)
 
1309
            properties[name] = type(value)(
 
1310
                value, variant_level = value.variant_level + 1)
970
1311
        return dbus.Dictionary(properties, signature="sv")
971
1312
    
 
1313
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
 
1314
    def PropertiesChanged(self, interface_name, changed_properties,
 
1315
                          invalidated_properties):
 
1316
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
 
1317
        standard.
 
1318
        """
 
1319
        pass
 
1320
    
972
1321
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
973
1322
                         out_signature="s",
974
1323
                         path_keyword='object_path',
978
1327
        
979
1328
        Inserts property tags and interface annotation tags.
980
1329
        """
981
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
982
 
                                                   connection)
 
1330
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1331
                                                         object_path,
 
1332
                                                         connection)
983
1333
        try:
984
1334
            document = xml.dom.minidom.parseString(xmlstring)
 
1335
            
985
1336
            def make_tag(document, name, prop):
986
1337
                e = document.createElement("property")
987
1338
                e.setAttribute("name", name)
988
1339
                e.setAttribute("type", prop._dbus_signature)
989
1340
                e.setAttribute("access", prop._dbus_access)
990
1341
                return e
 
1342
            
991
1343
            for if_tag in document.getElementsByTagName("interface"):
992
1344
                # Add property tags
993
1345
                for tag in (make_tag(document, name, prop)
996
1348
                            if prop._dbus_interface
997
1349
                            == if_tag.getAttribute("name")):
998
1350
                    if_tag.appendChild(tag)
999
 
                # Add annotation tags
1000
 
                for typ in ("method", "signal", "property"):
1001
 
                    for tag in if_tag.getElementsByTagName(typ):
1002
 
                        annots = dict()
1003
 
                        for name, prop in (self.
1004
 
                                           _get_all_dbus_things(typ)):
1005
 
                            if (name == tag.getAttribute("name")
1006
 
                                and prop._dbus_interface
1007
 
                                == if_tag.getAttribute("name")):
1008
 
                                annots.update(getattr
1009
 
                                              (prop,
1010
 
                                               "_dbus_annotations",
1011
 
                                               {}))
1012
 
                        for name, value in annots.iteritems():
1013
 
                            ann_tag = document.createElement(
1014
 
                                "annotation")
1015
 
                            ann_tag.setAttribute("name", name)
1016
 
                            ann_tag.setAttribute("value", value)
1017
 
                            tag.appendChild(ann_tag)
1018
 
                # Add interface annotation tags
1019
 
                for annotation, value in dict(
1020
 
                    itertools.chain.from_iterable(
1021
 
                        annotations().iteritems()
1022
 
                        for name, annotations in
1023
 
                        self._get_all_dbus_things("interface")
1024
 
                        if name == if_tag.getAttribute("name")
1025
 
                        )).iteritems():
1026
 
                    ann_tag = document.createElement("annotation")
1027
 
                    ann_tag.setAttribute("name", annotation)
1028
 
                    ann_tag.setAttribute("value", value)
1029
 
                    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)
1030
1367
                # Add the names to the return values for the
1031
1368
                # "org.freedesktop.DBus.Properties" methods
1032
1369
                if (if_tag.getAttribute("name")
1050
1387
                         exc_info=error)
1051
1388
        return xmlstring
1052
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
1053
1458
 
1054
1459
def datetime_to_dbus(dt, variant_level=0):
1055
1460
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1056
1461
    if dt is None:
1057
1462
        return dbus.String("", variant_level = variant_level)
1058
 
    return dbus.String(dt.isoformat(),
1059
 
                       variant_level=variant_level)
 
1463
    return dbus.String(dt.isoformat(), variant_level=variant_level)
1060
1464
 
1061
1465
 
1062
1466
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1082
1486
    (from DBusObjectWithProperties) and interfaces (from the
1083
1487
    dbus_interface_annotations decorator).
1084
1488
    """
 
1489
    
1085
1490
    def wrapper(cls):
1086
1491
        for orig_interface_name, alt_interface_name in (
1087
 
            alt_interface_names.iteritems()):
 
1492
                alt_interface_names.items()):
1088
1493
            attr = {}
1089
1494
            interface_names = set()
1090
1495
            # Go though all attributes of the class
1092
1497
                # Ignore non-D-Bus attributes, and D-Bus attributes
1093
1498
                # with the wrong interface name
1094
1499
                if (not hasattr(attribute, "_dbus_interface")
1095
 
                    or not attribute._dbus_interface
1096
 
                    .startswith(orig_interface_name)):
 
1500
                    or not attribute._dbus_interface.startswith(
 
1501
                        orig_interface_name)):
1097
1502
                    continue
1098
1503
                # Create an alternate D-Bus interface name based on
1099
1504
                # the current name
1100
 
                alt_interface = (attribute._dbus_interface
1101
 
                                 .replace(orig_interface_name,
1102
 
                                          alt_interface_name))
 
1505
                alt_interface = attribute._dbus_interface.replace(
 
1506
                    orig_interface_name, alt_interface_name)
1103
1507
                interface_names.add(alt_interface)
1104
1508
                # Is this a D-Bus signal?
1105
1509
                if getattr(attribute, "_dbus_is_signal", False):
1106
 
                    # Extract the original non-method undecorated
1107
 
                    # function by black magic
1108
 
                    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(
1109
1514
                            zip(attribute.func_code.co_freevars,
1110
 
                                attribute.__closure__))["func"]
1111
 
                                      .cell_contents)
 
1515
                                attribute.__closure__))
 
1516
                                          ["func"].cell_contents)
 
1517
                    else:
 
1518
                        nonmethod_func = attribute
1112
1519
                    # Create a new, but exactly alike, function
1113
1520
                    # object, and decorate it to be a new D-Bus signal
1114
1521
                    # with the alternate D-Bus interface name
1115
 
                    new_function = (dbus.service.signal
1116
 
                                    (alt_interface,
1117
 
                                     attribute._dbus_signature)
1118
 
                                    (types.FunctionType(
1119
 
                                nonmethod_func.func_code,
1120
 
                                nonmethod_func.func_globals,
1121
 
                                nonmethod_func.func_name,
1122
 
                                nonmethod_func.func_defaults,
1123
 
                                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))
1124
1539
                    # Copy annotations, if any
1125
1540
                    try:
1126
 
                        new_function._dbus_annotations = (
1127
 
                            dict(attribute._dbus_annotations))
 
1541
                        new_function._dbus_annotations = dict(
 
1542
                            attribute._dbus_annotations)
1128
1543
                    except AttributeError:
1129
1544
                        pass
1130
1545
                    # Define a creator of a function to call both the
1135
1550
                        """This function is a scope container to pass
1136
1551
                        func1 and func2 to the "call_both" function
1137
1552
                        outside of its arguments"""
 
1553
                        
 
1554
                        @functools.wraps(func2)
1138
1555
                        def call_both(*args, **kwargs):
1139
1556
                            """This function will emit two D-Bus
1140
1557
                            signals by calling func1 and func2"""
1141
1558
                            func1(*args, **kwargs)
1142
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
                        
1143
1565
                        return call_both
1144
1566
                    # Create the "call_both" function and add it to
1145
1567
                    # the class
1150
1572
                    # object.  Decorate it to be a new D-Bus method
1151
1573
                    # with the alternate D-Bus interface name.  Add it
1152
1574
                    # to the class.
1153
 
                    attr[attrname] = (dbus.service.method
1154
 
                                      (alt_interface,
1155
 
                                       attribute._dbus_in_signature,
1156
 
                                       attribute._dbus_out_signature)
1157
 
                                      (types.FunctionType
1158
 
                                       (attribute.func_code,
1159
 
                                        attribute.func_globals,
1160
 
                                        attribute.func_name,
1161
 
                                        attribute.func_defaults,
1162
 
                                        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)))
1163
1585
                    # Copy annotations, if any
1164
1586
                    try:
1165
 
                        attr[attrname]._dbus_annotations = (
1166
 
                            dict(attribute._dbus_annotations))
 
1587
                        attr[attrname]._dbus_annotations = dict(
 
1588
                            attribute._dbus_annotations)
1167
1589
                    except AttributeError:
1168
1590
                        pass
1169
1591
                # Is this a D-Bus property?
1172
1594
                    # object, and decorate it to be a new D-Bus
1173
1595
                    # property with the alternate D-Bus interface
1174
1596
                    # name.  Add it to the class.
1175
 
                    attr[attrname] = (dbus_service_property
1176
 
                                      (alt_interface,
1177
 
                                       attribute._dbus_signature,
1178
 
                                       attribute._dbus_access,
1179
 
                                       attribute
1180
 
                                       ._dbus_get_args_options
1181
 
                                       ["byte_arrays"])
1182
 
                                      (types.FunctionType
1183
 
                                       (attribute.func_code,
1184
 
                                        attribute.func_globals,
1185
 
                                        attribute.func_name,
1186
 
                                        attribute.func_defaults,
1187
 
                                        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)))
1188
1608
                    # Copy annotations, if any
1189
1609
                    try:
1190
 
                        attr[attrname]._dbus_annotations = (
1191
 
                            dict(attribute._dbus_annotations))
 
1610
                        attr[attrname]._dbus_annotations = dict(
 
1611
                            attribute._dbus_annotations)
1192
1612
                    except AttributeError:
1193
1613
                        pass
1194
1614
                # Is this a D-Bus interface?
1197
1617
                    # object.  Decorate it to be a new D-Bus interface
1198
1618
                    # with the alternate D-Bus interface name.  Add it
1199
1619
                    # to the class.
1200
 
                    attr[attrname] = (dbus_interface_annotations
1201
 
                                      (alt_interface)
1202
 
                                      (types.FunctionType
1203
 
                                       (attribute.func_code,
1204
 
                                        attribute.func_globals,
1205
 
                                        attribute.func_name,
1206
 
                                        attribute.func_defaults,
1207
 
                                        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)))
1208
1627
            if deprecate:
1209
1628
                # Deprecate all alternate interfaces
1210
 
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1629
                iname="_AlternateDBusNames_interface_annotation{}"
1211
1630
                for interface_name in interface_names:
 
1631
                    
1212
1632
                    @dbus_interface_annotations(interface_name)
1213
1633
                    def func(self):
1214
1634
                        return { "org.freedesktop.DBus.Deprecated":
1215
 
                                     "true" }
 
1635
                                 "true" }
1216
1636
                    # Find an unused name
1217
1637
                    for aname in (iname.format(i)
1218
1638
                                  for i in itertools.count()):
1222
1642
            if interface_names:
1223
1643
                # Replace the class with a new subclass of it with
1224
1644
                # methods, signals, etc. as created above.
1225
 
                cls = type(b"{0}Alternate".format(cls.__name__),
1226
 
                           (cls,), attr)
 
1645
                cls = type(b"{}Alternate".format(cls.__name__),
 
1646
                           (cls, ), attr)
1227
1647
        return cls
 
1648
    
1228
1649
    return wrapper
1229
1650
 
1230
1651
 
1231
1652
@alternate_dbus_interfaces({"se.recompile.Mandos":
1232
 
                                "se.bsnet.fukt.Mandos"})
 
1653
                            "se.bsnet.fukt.Mandos"})
1233
1654
class ClientDBus(Client, DBusObjectWithProperties):
1234
1655
    """A Client class using D-Bus
1235
1656
    
1239
1660
    """
1240
1661
    
1241
1662
    runtime_expansions = (Client.runtime_expansions
1242
 
                          + ("dbus_object_path",))
 
1663
                          + ("dbus_object_path", ))
 
1664
    
 
1665
    _interface = "se.recompile.Mandos.Client"
1243
1666
    
1244
1667
    # dbus.service.Object doesn't use super(), so we can't either.
1245
1668
    
1248
1671
        Client.__init__(self, *args, **kwargs)
1249
1672
        # Only now, when this client is initialized, can it show up on
1250
1673
        # the D-Bus
1251
 
        client_object_name = unicode(self.name).translate(
 
1674
        client_object_name = str(self.name).translate(
1252
1675
            {ord("."): ord("_"),
1253
1676
             ord("-"): ord("_")})
1254
 
        self.dbus_object_path = (dbus.ObjectPath
1255
 
                                 ("/clients/" + client_object_name))
 
1677
        self.dbus_object_path = dbus.ObjectPath(
 
1678
            "/clients/" + client_object_name)
1256
1679
        DBusObjectWithProperties.__init__(self, self.bus,
1257
1680
                                          self.dbus_object_path)
1258
1681
    
1259
 
    def notifychangeproperty(transform_func,
1260
 
                             dbus_name, type_func=lambda x: x,
1261
 
                             variant_level=1):
 
1682
    def notifychangeproperty(transform_func, dbus_name,
 
1683
                             type_func=lambda x: x,
 
1684
                             variant_level=1,
 
1685
                             invalidate_only=False,
 
1686
                             _interface=_interface):
1262
1687
        """ Modify a variable so that it's a property which announces
1263
1688
        its changes to DBus.
1264
1689
        
1269
1694
                   to the D-Bus.  Default: no transform
1270
1695
        variant_level: D-Bus variant level.  Default: 1
1271
1696
        """
1272
 
        attrname = "_{0}".format(dbus_name)
 
1697
        attrname = "_{}".format(dbus_name)
 
1698
        
1273
1699
        def setter(self, value):
1274
1700
            if hasattr(self, "dbus_object_path"):
1275
1701
                if (not hasattr(self, attrname) or
1276
1702
                    type_func(getattr(self, attrname, None))
1277
1703
                    != type_func(value)):
1278
 
                    dbus_value = transform_func(type_func(value),
1279
 
                                                variant_level
1280
 
                                                =variant_level)
1281
 
                    self.PropertyChanged(dbus.String(dbus_name),
1282
 
                                         dbus_value)
 
1704
                    if invalidate_only:
 
1705
                        self.PropertiesChanged(
 
1706
                            _interface, dbus.Dictionary(),
 
1707
                            dbus.Array((dbus_name, )))
 
1708
                    else:
 
1709
                        dbus_value = transform_func(
 
1710
                            type_func(value),
 
1711
                            variant_level = variant_level)
 
1712
                        self.PropertyChanged(dbus.String(dbus_name),
 
1713
                                             dbus_value)
 
1714
                        self.PropertiesChanged(
 
1715
                            _interface,
 
1716
                            dbus.Dictionary({ dbus.String(dbus_name):
 
1717
                                              dbus_value }),
 
1718
                            dbus.Array())
1283
1719
            setattr(self, attrname, value)
1284
1720
        
1285
1721
        return property(lambda self: getattr(self, attrname), setter)
1291
1727
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1292
1728
    last_enabled = notifychangeproperty(datetime_to_dbus,
1293
1729
                                        "LastEnabled")
1294
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1295
 
                                   type_func = lambda checker:
1296
 
                                       checker is not None)
 
1730
    checker = notifychangeproperty(
 
1731
        dbus.Boolean, "CheckerRunning",
 
1732
        type_func = lambda checker: checker is not None)
1297
1733
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1298
1734
                                           "LastCheckedOK")
1299
1735
    last_checker_status = notifychangeproperty(dbus.Int16,
1302
1738
        datetime_to_dbus, "LastApprovalRequest")
1303
1739
    approved_by_default = notifychangeproperty(dbus.Boolean,
1304
1740
                                               "ApprovedByDefault")
1305
 
    approval_delay = notifychangeproperty(dbus.UInt64,
1306
 
                                          "ApprovalDelay",
1307
 
                                          type_func =
1308
 
                                          timedelta_to_milliseconds)
 
1741
    approval_delay = notifychangeproperty(
 
1742
        dbus.UInt64, "ApprovalDelay",
 
1743
        type_func = lambda td: td.total_seconds() * 1000)
1309
1744
    approval_duration = notifychangeproperty(
1310
1745
        dbus.UInt64, "ApprovalDuration",
1311
 
        type_func = timedelta_to_milliseconds)
 
1746
        type_func = lambda td: td.total_seconds() * 1000)
1312
1747
    host = notifychangeproperty(dbus.String, "Host")
1313
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1314
 
                                   type_func =
1315
 
                                   timedelta_to_milliseconds)
 
1748
    timeout = notifychangeproperty(
 
1749
        dbus.UInt64, "Timeout",
 
1750
        type_func = lambda td: td.total_seconds() * 1000)
1316
1751
    extended_timeout = notifychangeproperty(
1317
1752
        dbus.UInt64, "ExtendedTimeout",
1318
 
        type_func = timedelta_to_milliseconds)
1319
 
    interval = notifychangeproperty(dbus.UInt64,
1320
 
                                    "Interval",
1321
 
                                    type_func =
1322
 
                                    timedelta_to_milliseconds)
 
1753
        type_func = lambda td: td.total_seconds() * 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")
 
1758
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1759
                                  invalidate_only=True)
1324
1760
    
1325
1761
    del notifychangeproperty
1326
1762
    
1333
1769
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1334
1770
        Client.__del__(self, *args, **kwargs)
1335
1771
    
1336
 
    def checker_callback(self, pid, condition, command,
1337
 
                         *args, **kwargs):
1338
 
        self.checker_callback_tag = None
1339
 
        self.checker = None
1340
 
        if os.WIFEXITED(condition):
1341
 
            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:
1342
1779
            # Emit D-Bus signal
1343
1780
            self.CheckerCompleted(dbus.Int16(exitstatus),
1344
 
                                  dbus.Int64(condition),
 
1781
                                  # This is specific to GNU libC
 
1782
                                  dbus.Int64(exitstatus << 8),
1345
1783
                                  dbus.String(command))
1346
1784
        else:
1347
1785
            # Emit D-Bus signal
1348
1786
            self.CheckerCompleted(dbus.Int16(-1),
1349
 
                                  dbus.Int64(condition),
 
1787
                                  dbus.Int64(
 
1788
                                      # This is specific to GNU libC
 
1789
                                      (exitstatus << 8)
 
1790
                                      | self.last_checker_signal),
1350
1791
                                  dbus.String(command))
1351
 
        
1352
 
        return Client.checker_callback(self, pid, condition, command,
1353
 
                                       *args, **kwargs)
 
1792
        return ret
1354
1793
    
1355
1794
    def start_checker(self, *args, **kwargs):
1356
1795
        old_checker_pid = getattr(self.checker, "pid", None)
1368
1807
    
1369
1808
    def approve(self, value=True):
1370
1809
        self.approved = value
1371
 
        gobject.timeout_add(timedelta_to_milliseconds
1372
 
                            (self.approval_duration),
1373
 
                            self._reset_approved)
 
1810
        GObject.timeout_add(int(self.approval_duration.total_seconds()
 
1811
                                * 1000), self._reset_approved)
1374
1812
        self.send_changedstate()
1375
1813
    
1376
1814
    ## D-Bus methods, signals & properties
1377
 
    _interface = "se.recompile.Mandos.Client"
1378
1815
    
1379
1816
    ## Interfaces
1380
1817
    
1381
 
    @dbus_interface_annotations(_interface)
1382
 
    def _foo(self):
1383
 
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1384
 
                     "false"}
1385
 
    
1386
1818
    ## Signals
1387
1819
    
1388
1820
    # CheckerCompleted - signal
1398
1830
        pass
1399
1831
    
1400
1832
    # PropertyChanged - signal
 
1833
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1401
1834
    @dbus.service.signal(_interface, signature="sv")
1402
1835
    def PropertyChanged(self, property, value):
1403
1836
        "D-Bus signal"
1437
1870
        self.checked_ok()
1438
1871
    
1439
1872
    # Enable - method
 
1873
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1440
1874
    @dbus.service.method(_interface)
1441
1875
    def Enable(self):
1442
1876
        "D-Bus method"
1443
1877
        self.enable()
1444
1878
    
1445
1879
    # StartChecker - method
 
1880
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1446
1881
    @dbus.service.method(_interface)
1447
1882
    def StartChecker(self):
1448
1883
        "D-Bus method"
1449
1884
        self.start_checker()
1450
1885
    
1451
1886
    # Disable - method
 
1887
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1452
1888
    @dbus.service.method(_interface)
1453
1889
    def Disable(self):
1454
1890
        "D-Bus method"
1455
1891
        self.disable()
1456
1892
    
1457
1893
    # StopChecker - method
 
1894
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1458
1895
    @dbus.service.method(_interface)
1459
1896
    def StopChecker(self):
1460
1897
        self.stop_checker()
1467
1904
        return dbus.Boolean(bool(self.approvals_pending))
1468
1905
    
1469
1906
    # ApprovedByDefault - property
1470
 
    @dbus_service_property(_interface, signature="b",
 
1907
    @dbus_service_property(_interface,
 
1908
                           signature="b",
1471
1909
                           access="readwrite")
1472
1910
    def ApprovedByDefault_dbus_property(self, value=None):
1473
1911
        if value is None:       # get
1475
1913
        self.approved_by_default = bool(value)
1476
1914
    
1477
1915
    # ApprovalDelay - property
1478
 
    @dbus_service_property(_interface, signature="t",
 
1916
    @dbus_service_property(_interface,
 
1917
                           signature="t",
1479
1918
                           access="readwrite")
1480
1919
    def ApprovalDelay_dbus_property(self, value=None):
1481
1920
        if value is None:       # get
1482
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1921
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1922
                               * 1000)
1483
1923
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1484
1924
    
1485
1925
    # ApprovalDuration - property
1486
 
    @dbus_service_property(_interface, signature="t",
 
1926
    @dbus_service_property(_interface,
 
1927
                           signature="t",
1487
1928
                           access="readwrite")
1488
1929
    def ApprovalDuration_dbus_property(self, value=None):
1489
1930
        if value is None:       # get
1490
 
            return dbus.UInt64(timedelta_to_milliseconds(
1491
 
                    self.approval_duration))
 
1931
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1932
                               * 1000)
1492
1933
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1493
1934
    
1494
1935
    # Name - property
 
1936
    @dbus_annotations(
 
1937
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1495
1938
    @dbus_service_property(_interface, signature="s", access="read")
1496
1939
    def Name_dbus_property(self):
1497
1940
        return dbus.String(self.name)
1498
1941
    
1499
1942
    # Fingerprint - property
 
1943
    @dbus_annotations(
 
1944
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1500
1945
    @dbus_service_property(_interface, signature="s", access="read")
1501
1946
    def Fingerprint_dbus_property(self):
1502
1947
        return dbus.String(self.fingerprint)
1503
1948
    
1504
1949
    # Host - property
1505
 
    @dbus_service_property(_interface, signature="s",
 
1950
    @dbus_service_property(_interface,
 
1951
                           signature="s",
1506
1952
                           access="readwrite")
1507
1953
    def Host_dbus_property(self, value=None):
1508
1954
        if value is None:       # get
1509
1955
            return dbus.String(self.host)
1510
 
        self.host = unicode(value)
 
1956
        self.host = str(value)
1511
1957
    
1512
1958
    # Created - property
 
1959
    @dbus_annotations(
 
1960
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1513
1961
    @dbus_service_property(_interface, signature="s", access="read")
1514
1962
    def Created_dbus_property(self):
1515
1963
        return datetime_to_dbus(self.created)
1520
1968
        return datetime_to_dbus(self.last_enabled)
1521
1969
    
1522
1970
    # Enabled - property
1523
 
    @dbus_service_property(_interface, signature="b",
 
1971
    @dbus_service_property(_interface,
 
1972
                           signature="b",
1524
1973
                           access="readwrite")
1525
1974
    def Enabled_dbus_property(self, value=None):
1526
1975
        if value is None:       # get
1531
1980
            self.disable()
1532
1981
    
1533
1982
    # LastCheckedOK - property
1534
 
    @dbus_service_property(_interface, signature="s",
 
1983
    @dbus_service_property(_interface,
 
1984
                           signature="s",
1535
1985
                           access="readwrite")
1536
1986
    def LastCheckedOK_dbus_property(self, value=None):
1537
1987
        if value is not None:
1540
1990
        return datetime_to_dbus(self.last_checked_ok)
1541
1991
    
1542
1992
    # LastCheckerStatus - property
1543
 
    @dbus_service_property(_interface, signature="n",
1544
 
                           access="read")
 
1993
    @dbus_service_property(_interface, signature="n", access="read")
1545
1994
    def LastCheckerStatus_dbus_property(self):
1546
1995
        return dbus.Int16(self.last_checker_status)
1547
1996
    
1556
2005
        return datetime_to_dbus(self.last_approval_request)
1557
2006
    
1558
2007
    # Timeout - property
1559
 
    @dbus_service_property(_interface, signature="t",
 
2008
    @dbus_service_property(_interface,
 
2009
                           signature="t",
1560
2010
                           access="readwrite")
1561
2011
    def Timeout_dbus_property(self, value=None):
1562
2012
        if value is None:       # get
1563
 
            return dbus.UInt64(self.timeout_milliseconds())
 
2013
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
1564
2014
        old_timeout = self.timeout
1565
2015
        self.timeout = datetime.timedelta(0, 0, 0, value)
1566
2016
        # Reschedule disabling
1574
2024
                if (getattr(self, "disable_initiator_tag", None)
1575
2025
                    is None):
1576
2026
                    return
1577
 
                gobject.source_remove(self.disable_initiator_tag)
1578
 
                self.disable_initiator_tag = (
1579
 
                    gobject.timeout_add(
1580
 
                        timedelta_to_milliseconds(self.expires - now),
1581
 
                        self.disable))
 
2027
                GObject.source_remove(self.disable_initiator_tag)
 
2028
                self.disable_initiator_tag = GObject.timeout_add(
 
2029
                    int((self.expires - now).total_seconds() * 1000),
 
2030
                    self.disable)
1582
2031
    
1583
2032
    # ExtendedTimeout - property
1584
 
    @dbus_service_property(_interface, signature="t",
 
2033
    @dbus_service_property(_interface,
 
2034
                           signature="t",
1585
2035
                           access="readwrite")
1586
2036
    def ExtendedTimeout_dbus_property(self, value=None):
1587
2037
        if value is None:       # get
1588
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
2038
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
2039
                               * 1000)
1589
2040
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1590
2041
    
1591
2042
    # Interval - property
1592
 
    @dbus_service_property(_interface, signature="t",
 
2043
    @dbus_service_property(_interface,
 
2044
                           signature="t",
1593
2045
                           access="readwrite")
1594
2046
    def Interval_dbus_property(self, value=None):
1595
2047
        if value is None:       # get
1596
 
            return dbus.UInt64(self.interval_milliseconds())
 
2048
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1597
2049
        self.interval = datetime.timedelta(0, 0, 0, value)
1598
2050
        if getattr(self, "checker_initiator_tag", None) is None:
1599
2051
            return
1600
2052
        if self.enabled:
1601
2053
            # Reschedule checker run
1602
 
            gobject.source_remove(self.checker_initiator_tag)
1603
 
            self.checker_initiator_tag = (gobject.timeout_add
1604
 
                                          (value, self.start_checker))
1605
 
            self.start_checker()    # Start one now, too
 
2054
            GObject.source_remove(self.checker_initiator_tag)
 
2055
            self.checker_initiator_tag = GObject.timeout_add(
 
2056
                value, self.start_checker)
 
2057
            self.start_checker() # Start one now, too
1606
2058
    
1607
2059
    # Checker - property
1608
 
    @dbus_service_property(_interface, signature="s",
 
2060
    @dbus_service_property(_interface,
 
2061
                           signature="s",
1609
2062
                           access="readwrite")
1610
2063
    def Checker_dbus_property(self, value=None):
1611
2064
        if value is None:       # get
1612
2065
            return dbus.String(self.checker_command)
1613
 
        self.checker_command = unicode(value)
 
2066
        self.checker_command = str(value)
1614
2067
    
1615
2068
    # CheckerRunning - property
1616
 
    @dbus_service_property(_interface, signature="b",
 
2069
    @dbus_service_property(_interface,
 
2070
                           signature="b",
1617
2071
                           access="readwrite")
1618
2072
    def CheckerRunning_dbus_property(self, value=None):
1619
2073
        if value is None:       # get
1624
2078
            self.stop_checker()
1625
2079
    
1626
2080
    # ObjectPath - property
 
2081
    @dbus_annotations(
 
2082
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
2083
         "org.freedesktop.DBus.Deprecated": "true"})
1627
2084
    @dbus_service_property(_interface, signature="o", access="read")
1628
2085
    def ObjectPath_dbus_property(self):
1629
2086
        return self.dbus_object_path # is already a dbus.ObjectPath
1630
2087
    
1631
2088
    # Secret = property
1632
 
    @dbus_service_property(_interface, signature="ay",
1633
 
                           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)
1634
2096
    def Secret_dbus_property(self, value):
1635
 
        self.secret = str(value)
 
2097
        self.secret = bytes(value)
1636
2098
    
1637
2099
    del _interface
1638
2100
 
1642
2104
        self._pipe = child_pipe
1643
2105
        self._pipe.send(('init', fpr, address))
1644
2106
        if not self._pipe.recv():
1645
 
            raise KeyError()
 
2107
            raise KeyError(fpr)
1646
2108
    
1647
2109
    def __getattribute__(self, name):
1648
2110
        if name == '_pipe':
1652
2114
        if data[0] == 'data':
1653
2115
            return data[1]
1654
2116
        if data[0] == 'function':
 
2117
            
1655
2118
            def func(*args, **kwargs):
1656
2119
                self._pipe.send(('funcall', name, args, kwargs))
1657
2120
                return self._pipe.recv()[1]
 
2121
            
1658
2122
            return func
1659
2123
    
1660
2124
    def __setattr__(self, name, value):
1672
2136
    def handle(self):
1673
2137
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1674
2138
            logger.info("TCP connection from: %s",
1675
 
                        unicode(self.client_address))
 
2139
                        str(self.client_address))
1676
2140
            logger.debug("Pipe FD: %d",
1677
2141
                         self.server.child_pipe.fileno())
1678
2142
            
1679
 
            session = (gnutls.connection
1680
 
                       .ClientSession(self.request,
1681
 
                                      gnutls.connection
1682
 
                                      .X509Credentials()))
1683
 
            
1684
 
            # Note: gnutls.connection.X509Credentials is really a
1685
 
            # generic GnuTLS certificate credentials object so long as
1686
 
            # no X.509 keys are added to it.  Therefore, we can use it
1687
 
            # here despite using OpenPGP certificates.
 
2143
            session = gnutls.ClientSession(self.request)
1688
2144
            
1689
2145
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1690
2146
            #                      "+AES-256-CBC", "+SHA1",
1694
2150
            priority = self.server.gnutls_priority
1695
2151
            if priority is None:
1696
2152
                priority = "NORMAL"
1697
 
            (gnutls.library.functions
1698
 
             .gnutls_priority_set_direct(session._c_object,
1699
 
                                         priority, None))
 
2153
            gnutls.priority_set_direct(session._c_object, priority,
 
2154
                                       None)
1700
2155
            
1701
2156
            # Start communication using the Mandos protocol
1702
2157
            # Get protocol number
1712
2167
            # Start GnuTLS connection
1713
2168
            try:
1714
2169
                session.handshake()
1715
 
            except gnutls.errors.GNUTLSError as error:
 
2170
            except gnutls.Error as error:
1716
2171
                logger.warning("Handshake failed: %s", error)
1717
2172
                # Do not run session.bye() here: the session is not
1718
2173
                # established.  Just abandon the request.
1722
2177
            approval_required = False
1723
2178
            try:
1724
2179
                try:
1725
 
                    fpr = self.fingerprint(self.peer_certificate
1726
 
                                           (session))
1727
 
                except (TypeError,
1728
 
                        gnutls.errors.GNUTLSError) as error:
 
2180
                    fpr = self.fingerprint(
 
2181
                        self.peer_certificate(session))
 
2182
                except (TypeError, gnutls.Error) as error:
1729
2183
                    logger.warning("Bad certificate: %s", error)
1730
2184
                    return
1731
2185
                logger.debug("Fingerprint: %s", fpr)
1744
2198
                while True:
1745
2199
                    if not client.enabled:
1746
2200
                        logger.info("Client %s is disabled",
1747
 
                                       client.name)
 
2201
                                    client.name)
1748
2202
                        if self.server.use_dbus:
1749
2203
                            # Emit D-Bus signal
1750
2204
                            client.Rejected("Disabled")
1759
2213
                        if self.server.use_dbus:
1760
2214
                            # Emit D-Bus signal
1761
2215
                            client.NeedApproval(
1762
 
                                client.approval_delay_milliseconds(),
1763
 
                                client.approved_by_default)
 
2216
                                client.approval_delay.total_seconds()
 
2217
                                * 1000, client.approved_by_default)
1764
2218
                    else:
1765
2219
                        logger.warning("Client %s was not approved",
1766
2220
                                       client.name)
1772
2226
                    #wait until timeout or approved
1773
2227
                    time = datetime.datetime.now()
1774
2228
                    client.changedstate.acquire()
1775
 
                    client.changedstate.wait(
1776
 
                        float(timedelta_to_milliseconds(delay)
1777
 
                              / 1000))
 
2229
                    client.changedstate.wait(delay.total_seconds())
1778
2230
                    client.changedstate.release()
1779
2231
                    time2 = datetime.datetime.now()
1780
2232
                    if (time2 - time) >= delay:
1791
2243
                    else:
1792
2244
                        delay -= time2 - time
1793
2245
                
1794
 
                sent_size = 0
1795
 
                while sent_size < len(client.secret):
1796
 
                    try:
1797
 
                        sent = session.send(client.secret[sent_size:])
1798
 
                    except gnutls.errors.GNUTLSError as error:
1799
 
                        logger.warning("gnutls send failed",
1800
 
                                       exc_info=error)
1801
 
                        return
1802
 
                    logger.debug("Sent: %d, remaining: %d",
1803
 
                                 sent, len(client.secret)
1804
 
                                 - (sent_size + sent))
1805
 
                    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
1806
2252
                
1807
2253
                logger.info("Sending secret to %s", client.name)
1808
2254
                # bump the timeout using extended_timeout
1816
2262
                    client.approvals_pending -= 1
1817
2263
                try:
1818
2264
                    session.bye()
1819
 
                except gnutls.errors.GNUTLSError as error:
 
2265
                except gnutls.Error as error:
1820
2266
                    logger.warning("GnuTLS bye failed",
1821
2267
                                   exc_info=error)
1822
2268
    
1824
2270
    def peer_certificate(session):
1825
2271
        "Return the peer's OpenPGP certificate as a bytestring"
1826
2272
        # If not an OpenPGP certificate...
1827
 
        if (gnutls.library.functions
1828
 
            .gnutls_certificate_type_get(session._c_object)
1829
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1830
 
            # ...do the normal thing
1831
 
            return session.peer_certificate
 
2273
        if (gnutls.certificate_type_get(session._c_object)
 
2274
            != gnutls.CRT_OPENPGP):
 
2275
            # ...return invalid data
 
2276
            return b""
1832
2277
        list_size = ctypes.c_uint(1)
1833
 
        cert_list = (gnutls.library.functions
1834
 
                     .gnutls_certificate_get_peers
 
2278
        cert_list = (gnutls.certificate_get_peers
1835
2279
                     (session._c_object, ctypes.byref(list_size)))
1836
2280
        if not bool(cert_list) and list_size.value != 0:
1837
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1838
 
                                            " certificate")
 
2281
            raise gnutls.Error("error getting peer certificate")
1839
2282
        if list_size.value == 0:
1840
2283
            return None
1841
2284
        cert = cert_list[0]
1845
2288
    def fingerprint(openpgp):
1846
2289
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1847
2290
        # New GnuTLS "datum" with the OpenPGP public key
1848
 
        datum = (gnutls.library.types
1849
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1850
 
                                             ctypes.POINTER
1851
 
                                             (ctypes.c_ubyte)),
1852
 
                                 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)))
1853
2295
        # New empty GnuTLS certificate
1854
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1855
 
        (gnutls.library.functions
1856
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
2296
        crt = gnutls.openpgp_crt_t()
 
2297
        gnutls.openpgp_crt_init(ctypes.byref(crt))
1857
2298
        # Import the OpenPGP public key into the certificate
1858
 
        (gnutls.library.functions
1859
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1860
 
                                    gnutls.library.constants
1861
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
2299
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2300
                                  gnutls.OPENPGP_FMT_RAW)
1862
2301
        # Verify the self signature in the key
1863
2302
        crtverify = ctypes.c_uint()
1864
 
        (gnutls.library.functions
1865
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1866
 
                                         ctypes.byref(crtverify)))
 
2303
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2304
                                       ctypes.byref(crtverify))
1867
2305
        if crtverify.value != 0:
1868
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1869
 
            raise (gnutls.errors.CertificateSecurityError
1870
 
                   ("Verify failed"))
 
2306
            gnutls.openpgp_crt_deinit(crt)
 
2307
            raise gnutls.CertificateSecurityError("Verify failed")
1871
2308
        # New buffer for the fingerprint
1872
2309
        buf = ctypes.create_string_buffer(20)
1873
2310
        buf_len = ctypes.c_size_t()
1874
2311
        # Get the fingerprint from the certificate into the buffer
1875
 
        (gnutls.library.functions
1876
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1877
 
                                             ctypes.byref(buf_len)))
 
2312
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2313
                                           ctypes.byref(buf_len))
1878
2314
        # Deinit the certificate
1879
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2315
        gnutls.openpgp_crt_deinit(crt)
1880
2316
        # Convert the buffer to a Python bytestring
1881
2317
        fpr = ctypes.string_at(buf, buf_len.value)
1882
2318
        # Convert the bytestring to hexadecimal notation
1886
2322
 
1887
2323
class MultiprocessingMixIn(object):
1888
2324
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
2325
    
1889
2326
    def sub_process_main(self, request, address):
1890
2327
        try:
1891
2328
            self.finish_request(request, address)
1903
2340
 
1904
2341
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1905
2342
    """ adds a pipe to the MixIn """
 
2343
    
1906
2344
    def process_request(self, request, client_address):
1907
2345
        """Overrides and wraps the original process_request().
1908
2346
        
1929
2367
        interface:      None or a network interface name (string)
1930
2368
        use_ipv6:       Boolean; to use IPv6 or not
1931
2369
    """
 
2370
    
1932
2371
    def __init__(self, server_address, RequestHandlerClass,
1933
 
                 interface=None, use_ipv6=True, socketfd=None):
 
2372
                 interface=None,
 
2373
                 use_ipv6=True,
 
2374
                 socketfd=None):
1934
2375
        """If socketfd is set, use that file descriptor instead of
1935
2376
        creating a new one with socket.socket().
1936
2377
        """
1977
2418
                             self.interface)
1978
2419
            else:
1979
2420
                try:
1980
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1981
 
                                           SO_BINDTODEVICE,
1982
 
                                           str(self.interface + '\0'))
 
2421
                    self.socket.setsockopt(
 
2422
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2423
                        (self.interface + "\0").encode("utf-8"))
1983
2424
                except socket.error as error:
1984
2425
                    if error.errno == errno.EPERM:
1985
2426
                        logger.error("No permission to bind to"
2003
2444
                self.server_address = (any_address,
2004
2445
                                       self.server_address[1])
2005
2446
            elif not self.server_address[1]:
2006
 
                self.server_address = (self.server_address[0],
2007
 
                                       0)
 
2447
                self.server_address = (self.server_address[0], 0)
2008
2448
#                 if self.interface:
2009
2449
#                     self.server_address = (self.server_address[0],
2010
2450
#                                            0, # port
2022
2462
        gnutls_priority GnuTLS priority string
2023
2463
        use_dbus:       Boolean; to emit D-Bus signals or not
2024
2464
    
2025
 
    Assumes a gobject.MainLoop event loop.
 
2465
    Assumes a GObject.MainLoop event loop.
2026
2466
    """
 
2467
    
2027
2468
    def __init__(self, server_address, RequestHandlerClass,
2028
 
                 interface=None, use_ipv6=True, clients=None,
2029
 
                 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):
2030
2475
        self.enabled = False
2031
2476
        self.clients = clients
2032
2477
        if self.clients is None:
2038
2483
                                interface = interface,
2039
2484
                                use_ipv6 = use_ipv6,
2040
2485
                                socketfd = socketfd)
 
2486
    
2041
2487
    def server_activate(self):
2042
2488
        if self.enabled:
2043
2489
            return socketserver.TCPServer.server_activate(self)
2047
2493
    
2048
2494
    def add_pipe(self, parent_pipe, proc):
2049
2495
        # Call "handle_ipc" for both data and EOF events
2050
 
        gobject.io_add_watch(parent_pipe.fileno(),
2051
 
                             gobject.IO_IN | gobject.IO_HUP,
2052
 
                             functools.partial(self.handle_ipc,
2053
 
                                               parent_pipe =
2054
 
                                               parent_pipe,
2055
 
                                               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))
2056
2502
    
2057
 
    def handle_ipc(self, source, condition, parent_pipe=None,
2058
 
                   proc = None, client_object=None):
 
2503
    def handle_ipc(self, source, condition,
 
2504
                   parent_pipe=None,
 
2505
                   proc = None,
 
2506
                   client_object=None):
2059
2507
        # error, or the other end of multiprocessing.Pipe has closed
2060
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2508
        if condition & (GObject.IO_ERR | GObject.IO_HUP):
2061
2509
            # Wait for other process to exit
2062
2510
            proc.join()
2063
2511
            return False
2084
2532
                parent_pipe.send(False)
2085
2533
                return False
2086
2534
            
2087
 
            gobject.io_add_watch(parent_pipe.fileno(),
2088
 
                                 gobject.IO_IN | gobject.IO_HUP,
2089
 
                                 functools.partial(self.handle_ipc,
2090
 
                                                   parent_pipe =
2091
 
                                                   parent_pipe,
2092
 
                                                   proc = proc,
2093
 
                                                   client_object =
2094
 
                                                   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))
2095
2542
            parent_pipe.send(True)
2096
2543
            # remove the old hook in favor of the new above hook on
2097
2544
            # same fileno
2103
2550
            
2104
2551
            parent_pipe.send(('data', getattr(client_object,
2105
2552
                                              funcname)(*args,
2106
 
                                                         **kwargs)))
 
2553
                                                        **kwargs)))
2107
2554
        
2108
2555
        if command == 'getattr':
2109
2556
            attrname = request[1]
2110
 
            if callable(client_object.__getattribute__(attrname)):
2111
 
                parent_pipe.send(('function',))
 
2557
            if isinstance(client_object.__getattribute__(attrname),
 
2558
                          collections.Callable):
 
2559
                parent_pipe.send(('function', ))
2112
2560
            else:
2113
 
                parent_pipe.send(('data', client_object
2114
 
                                  .__getattribute__(attrname)))
 
2561
                parent_pipe.send((
 
2562
                    'data', client_object.__getattribute__(attrname)))
2115
2563
        
2116
2564
        if command == 'setattr':
2117
2565
            attrname = request[1]
2148
2596
    # avoid excessive use of external libraries.
2149
2597
    
2150
2598
    # New type for defining tokens, syntax, and semantics all-in-one
2151
 
    Token = collections.namedtuple("Token",
2152
 
                                   ("regexp", # To match token; if
2153
 
                                              # "value" is not None,
2154
 
                                              # must have a "group"
2155
 
                                              # containing digits
2156
 
                                    "value",  # datetime.timedelta or
2157
 
                                              # None
2158
 
                                    "followers")) # Tokens valid after
2159
 
                                                  # 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
2160
2604
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2161
2605
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2162
2606
    token_end = Token(re.compile(r"$"), None, frozenset())
2163
2607
    token_second = Token(re.compile(r"(\d+)S"),
2164
2608
                         datetime.timedelta(seconds=1),
2165
 
                         frozenset((token_end,)))
 
2609
                         frozenset((token_end, )))
2166
2610
    token_minute = Token(re.compile(r"(\d+)M"),
2167
2611
                         datetime.timedelta(minutes=1),
2168
2612
                         frozenset((token_second, token_end)))
2184
2628
                       frozenset((token_month, token_end)))
2185
2629
    token_week = Token(re.compile(r"(\d+)W"),
2186
2630
                       datetime.timedelta(weeks=1),
2187
 
                       frozenset((token_end,)))
 
2631
                       frozenset((token_end, )))
2188
2632
    token_duration = Token(re.compile(r"P"), None,
2189
2633
                           frozenset((token_year, token_month,
2190
2634
                                      token_day, token_time,
2191
 
                                      token_week))),
 
2635
                                      token_week)))
2192
2636
    # Define starting values
2193
2637
    value = datetime.timedelta() # Value so far
2194
2638
    found_token = None
2195
 
    followers = frozenset(token_duration,) # Following valid tokens
 
2639
    followers = frozenset((token_duration, )) # Following valid tokens
2196
2640
    s = duration                # String left to parse
2197
2641
    # Loop until end token is found
2198
2642
    while found_token is not token_end:
2215
2659
                break
2216
2660
        else:
2217
2661
            # No currently valid tokens were found
2218
 
            raise ValueError("Invalid RFC 3339 duration")
 
2662
            raise ValueError("Invalid RFC 3339 duration: {!r}"
 
2663
                             .format(duration))
2219
2664
    # End token found
2220
2665
    return value
2221
2666
 
2245
2690
    timevalue = datetime.timedelta(0)
2246
2691
    for s in interval.split():
2247
2692
        try:
2248
 
            suffix = unicode(s[-1])
 
2693
            suffix = s[-1]
2249
2694
            value = int(s[:-1])
2250
2695
            if suffix == "d":
2251
2696
                delta = datetime.timedelta(value)
2258
2703
            elif suffix == "w":
2259
2704
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2260
2705
            else:
2261
 
                raise ValueError("Unknown suffix {0!r}"
2262
 
                                 .format(suffix))
 
2706
                raise ValueError("Unknown suffix {!r}".format(suffix))
2263
2707
        except IndexError as e:
2264
2708
            raise ValueError(*(e.args))
2265
2709
        timevalue += delta
2282
2726
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2283
2727
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2284
2728
            raise OSError(errno.ENODEV,
2285
 
                          "{0} not a character device"
 
2729
                          "{} not a character device"
2286
2730
                          .format(os.devnull))
2287
2731
        os.dup2(null, sys.stdin.fileno())
2288
2732
        os.dup2(null, sys.stdout.fileno())
2298
2742
    
2299
2743
    parser = argparse.ArgumentParser()
2300
2744
    parser.add_argument("-v", "--version", action="version",
2301
 
                        version = "%(prog)s {0}".format(version),
 
2745
                        version = "%(prog)s {}".format(version),
2302
2746
                        help="show version number and exit")
2303
2747
    parser.add_argument("-i", "--interface", metavar="IF",
2304
2748
                        help="Bind to interface IF")
2354
2798
                        "port": "",
2355
2799
                        "debug": "False",
2356
2800
                        "priority":
2357
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
 
2801
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2802
                        ":+SIGN-DSA-SHA256",
2358
2803
                        "servicename": "Mandos",
2359
2804
                        "use_dbus": "True",
2360
2805
                        "use_ipv6": "True",
2364
2809
                        "statedir": "/var/lib/mandos",
2365
2810
                        "foreground": "False",
2366
2811
                        "zeroconf": "True",
2367
 
                        }
 
2812
                    }
2368
2813
    
2369
2814
    # Parse config file for server-global settings
2370
2815
    server_config = configparser.SafeConfigParser(server_defaults)
2371
2816
    del server_defaults
2372
 
    server_config.read(os.path.join(options.configdir,
2373
 
                                    "mandos.conf"))
 
2817
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
2374
2818
    # Convert the SafeConfigParser object to a dict
2375
2819
    server_settings = server_config.defaults()
2376
2820
    # Use the appropriate methods on the non-string config options
2394
2838
    # Override the settings from the config file with command line
2395
2839
    # options, if set.
2396
2840
    for option in ("interface", "address", "port", "debug",
2397
 
                   "priority", "servicename", "configdir",
2398
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2399
 
                   "statedir", "socket", "foreground", "zeroconf"):
 
2841
                   "priority", "servicename", "configdir", "use_dbus",
 
2842
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2843
                   "socket", "foreground", "zeroconf"):
2400
2844
        value = getattr(options, option)
2401
2845
        if value is not None:
2402
2846
            server_settings[option] = value
2403
2847
    del options
2404
2848
    # Force all strings to be unicode
2405
2849
    for option in server_settings.keys():
2406
 
        if type(server_settings[option]) is str:
2407
 
            server_settings[option] = unicode(server_settings[option])
 
2850
        if isinstance(server_settings[option], bytes):
 
2851
            server_settings[option] = (server_settings[option]
 
2852
                                       .decode("utf-8"))
2408
2853
    # Force all boolean options to be boolean
2409
2854
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
2410
2855
                   "foreground", "zeroconf"):
2416
2861
    
2417
2862
    ##################################################################
2418
2863
    
2419
 
    if (not server_settings["zeroconf"] and
2420
 
        not (server_settings["port"]
2421
 
             or server_settings["socket"] != "")):
2422
 
            parser.error("Needs port or socket to work without"
2423
 
                         " 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")
2424
2868
    
2425
2869
    # For convenience
2426
2870
    debug = server_settings["debug"]
2442
2886
            initlogger(debug, level)
2443
2887
    
2444
2888
    if server_settings["servicename"] != "Mandos":
2445
 
        syslogger.setFormatter(logging.Formatter
2446
 
                               ('Mandos ({0}) [%(process)d]:'
2447
 
                                ' %(levelname)s: %(message)s'
2448
 
                                .format(server_settings
2449
 
                                        ["servicename"])))
 
2889
        syslogger.setFormatter(
 
2890
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2891
                              ' %(levelname)s: %(message)s'.format(
 
2892
                                  server_settings["servicename"])))
2450
2893
    
2451
2894
    # Parse config file with clients
2452
2895
    client_config = configparser.SafeConfigParser(Client
2460
2903
    socketfd = None
2461
2904
    if server_settings["socket"] != "":
2462
2905
        socketfd = server_settings["socket"]
2463
 
    tcp_server = MandosServer((server_settings["address"],
2464
 
                               server_settings["port"]),
2465
 
                              ClientHandler,
2466
 
                              interface=(server_settings["interface"]
2467
 
                                         or None),
2468
 
                              use_ipv6=use_ipv6,
2469
 
                              gnutls_priority=
2470
 
                              server_settings["priority"],
2471
 
                              use_dbus=use_dbus,
2472
 
                              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)
2473
2914
    if not foreground:
2474
2915
        pidfilename = "/run/mandos.pid"
2475
2916
        if not os.path.isdir("/run/."):
2476
2917
            pidfilename = "/var/run/mandos.pid"
2477
2918
        pidfile = None
2478
2919
        try:
2479
 
            pidfile = open(pidfilename, "w")
 
2920
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2480
2921
        except IOError as e:
2481
2922
            logger.error("Could not open file %r", pidfilename,
2482
2923
                         exc_info=e)
2483
2924
    
2484
 
    for name in ("_mandos", "mandos", "nobody"):
 
2925
    for name, group in (("_mandos", "_mandos"),
 
2926
                        ("mandos", "mandos"),
 
2927
                        ("nobody", "nogroup")):
2485
2928
        try:
2486
2929
            uid = pwd.getpwnam(name).pw_uid
2487
 
            gid = pwd.getpwnam(name).pw_gid
 
2930
            gid = pwd.getpwnam(group).pw_gid
2488
2931
            break
2489
2932
        except KeyError:
2490
2933
            continue
2503
2946
        
2504
2947
        # "Use a log level over 10 to enable all debugging options."
2505
2948
        # - GnuTLS manual
2506
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
2949
        gnutls.global_set_log_level(11)
2507
2950
        
2508
 
        @gnutls.library.types.gnutls_log_func
 
2951
        @gnutls.log_func
2509
2952
        def debug_gnutls(level, string):
2510
2953
            logger.debug("GnuTLS: %s", string[:-1])
2511
2954
        
2512
 
        (gnutls.library.functions
2513
 
         .gnutls_global_set_log_function(debug_gnutls))
 
2955
        gnutls.global_set_log_function(debug_gnutls)
2514
2956
        
2515
2957
        # Redirect stdin so all checkers get /dev/null
2516
2958
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2523
2965
        # Close all input and output, do double fork, etc.
2524
2966
        daemon()
2525
2967
    
2526
 
    # multiprocessing will use threads, so before we use gobject we
2527
 
    # need to inform gobject that threads will be used.
2528
 
    gobject.threads_init()
 
2968
    # multiprocessing will use threads, so before we use GObject we
 
2969
    # need to inform GObject that threads will be used.
 
2970
    GObject.threads_init()
2529
2971
    
2530
2972
    global main_loop
2531
2973
    # From the Avahi example code
2532
2974
    DBusGMainLoop(set_as_default=True)
2533
 
    main_loop = gobject.MainLoop()
 
2975
    main_loop = GObject.MainLoop()
2534
2976
    bus = dbus.SystemBus()
2535
2977
    # End of Avahi example code
2536
2978
    if use_dbus:
2537
2979
        try:
2538
2980
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2539
 
                                            bus, do_not_queue=True)
2540
 
            old_bus_name = (dbus.service.BusName
2541
 
                            ("se.bsnet.fukt.Mandos", bus,
2542
 
                             do_not_queue=True))
2543
 
        except dbus.exceptions.NameExistsException as e:
 
2981
                                            bus,
 
2982
                                            do_not_queue=True)
 
2983
            old_bus_name = dbus.service.BusName(
 
2984
                "se.bsnet.fukt.Mandos", bus,
 
2985
                do_not_queue=True)
 
2986
        except dbus.exceptions.DBusException as e:
2544
2987
            logger.error("Disabling D-Bus:", exc_info=e)
2545
2988
            use_dbus = False
2546
2989
            server_settings["use_dbus"] = False
2547
2990
            tcp_server.use_dbus = False
2548
2991
    if zeroconf:
2549
2992
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2550
 
        service = AvahiServiceToSyslog(name =
2551
 
                                       server_settings["servicename"],
2552
 
                                       servicetype = "_mandos._tcp",
2553
 
                                       protocol = protocol, bus = bus)
 
2993
        service = AvahiServiceToSyslog(
 
2994
            name = server_settings["servicename"],
 
2995
            servicetype = "_mandos._tcp",
 
2996
            protocol = protocol,
 
2997
            bus = bus)
2554
2998
        if server_settings["interface"]:
2555
 
            service.interface = (if_nametoindex
2556
 
                                 (str(server_settings["interface"])))
 
2999
            service.interface = if_nametoindex(
 
3000
                server_settings["interface"].encode("utf-8"))
2557
3001
    
2558
3002
    global multiprocessing_manager
2559
3003
    multiprocessing_manager = multiprocessing.Manager()
2578
3022
    if server_settings["restore"]:
2579
3023
        try:
2580
3024
            with open(stored_state_path, "rb") as stored_state:
2581
 
                clients_data, old_client_settings = (pickle.load
2582
 
                                                     (stored_state))
 
3025
                clients_data, old_client_settings = pickle.load(
 
3026
                    stored_state)
2583
3027
            os.remove(stored_state_path)
2584
3028
        except IOError as e:
2585
3029
            if e.errno == errno.ENOENT:
2586
 
                logger.warning("Could not load persistent state: {0}"
2587
 
                                .format(os.strerror(e.errno)))
 
3030
                logger.warning("Could not load persistent state:"
 
3031
                               " {}".format(os.strerror(e.errno)))
2588
3032
            else:
2589
3033
                logger.critical("Could not load persistent state:",
2590
3034
                                exc_info=e)
2591
3035
                raise
2592
3036
        except EOFError as e:
2593
3037
            logger.warning("Could not load persistent state: "
2594
 
                           "EOFError:", exc_info=e)
 
3038
                           "EOFError:",
 
3039
                           exc_info=e)
2595
3040
    
2596
3041
    with PGPEngine() as pgp:
2597
 
        for client_name, client in clients_data.iteritems():
 
3042
        for client_name, client in clients_data.items():
2598
3043
            # Skip removed clients
2599
3044
            if client_name not in client_settings:
2600
3045
                continue
2609
3054
                    # For each value in new config, check if it
2610
3055
                    # differs from the old config value (Except for
2611
3056
                    # the "secret" attribute)
2612
 
                    if (name != "secret" and
2613
 
                        value != old_client_settings[client_name]
2614
 
                        [name]):
 
3057
                    if (name != "secret"
 
3058
                        and (value !=
 
3059
                             old_client_settings[client_name][name])):
2615
3060
                        client[name] = value
2616
3061
                except KeyError:
2617
3062
                    pass
2618
3063
            
2619
3064
            # Clients who has passed its expire date can still be
2620
 
            # enabled if its last checker was successful.  Clients
 
3065
            # enabled if its last checker was successful.  A Client
2621
3066
            # whose checker succeeded before we stored its state is
2622
3067
            # assumed to have successfully run all checkers during
2623
3068
            # downtime.
2625
3070
                if datetime.datetime.utcnow() >= client["expires"]:
2626
3071
                    if not client["last_checked_ok"]:
2627
3072
                        logger.warning(
2628
 
                            "disabling client {0} - Client never "
2629
 
                            "performed a successful checker"
2630
 
                            .format(client_name))
 
3073
                            "disabling client {} - Client never "
 
3074
                            "performed a successful checker".format(
 
3075
                                client_name))
2631
3076
                        client["enabled"] = False
2632
3077
                    elif client["last_checker_status"] != 0:
2633
3078
                        logger.warning(
2634
 
                            "disabling client {0} - Client "
2635
 
                            "last checker failed with error code {1}"
2636
 
                            .format(client_name,
2637
 
                                    client["last_checker_status"]))
 
3079
                            "disabling client {} - Client last"
 
3080
                            " checker failed with error code"
 
3081
                            " {}".format(
 
3082
                                client_name,
 
3083
                                client["last_checker_status"]))
2638
3084
                        client["enabled"] = False
2639
3085
                    else:
2640
 
                        client["expires"] = (datetime.datetime
2641
 
                                             .utcnow()
2642
 
                                             + client["timeout"])
 
3086
                        client["expires"] = (
 
3087
                            datetime.datetime.utcnow()
 
3088
                            + client["timeout"])
2643
3089
                        logger.debug("Last checker succeeded,"
2644
 
                                     " keeping {0} enabled"
2645
 
                                     .format(client_name))
 
3090
                                     " keeping {} enabled".format(
 
3091
                                         client_name))
2646
3092
            try:
2647
 
                client["secret"] = (
2648
 
                    pgp.decrypt(client["encrypted_secret"],
2649
 
                                client_settings[client_name]
2650
 
                                ["secret"]))
 
3093
                client["secret"] = pgp.decrypt(
 
3094
                    client["encrypted_secret"],
 
3095
                    client_settings[client_name]["secret"])
2651
3096
            except PGPError:
2652
3097
                # If decryption fails, we use secret from new settings
2653
 
                logger.debug("Failed to decrypt {0} old secret"
2654
 
                             .format(client_name))
2655
 
                client["secret"] = (
2656
 
                    client_settings[client_name]["secret"])
 
3098
                logger.debug("Failed to decrypt {} old secret".format(
 
3099
                    client_name))
 
3100
                client["secret"] = (client_settings[client_name]
 
3101
                                    ["secret"])
2657
3102
    
2658
3103
    # Add/remove clients based on new changes made to config
2659
3104
    for client_name in (set(old_client_settings)
2664
3109
        clients_data[client_name] = client_settings[client_name]
2665
3110
    
2666
3111
    # Create all client objects
2667
 
    for client_name, client in clients_data.iteritems():
 
3112
    for client_name, client in clients_data.items():
2668
3113
        tcp_server.clients[client_name] = client_class(
2669
 
            name = client_name, settings = client,
 
3114
            name = client_name,
 
3115
            settings = client,
2670
3116
            server_settings = server_settings)
2671
3117
    
2672
3118
    if not tcp_server.clients:
2674
3120
    
2675
3121
    if not foreground:
2676
3122
        if pidfile is not None:
 
3123
            pid = os.getpid()
2677
3124
            try:
2678
3125
                with pidfile:
2679
 
                    pid = os.getpid()
2680
 
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
3126
                    print(pid, file=pidfile)
2681
3127
            except IOError:
2682
3128
                logger.error("Could not write to file %r with PID %d",
2683
3129
                             pidfilename, pid)
2688
3134
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2689
3135
    
2690
3136
    if use_dbus:
2691
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2692
 
                                        "se.bsnet.fukt.Mandos"})
2693
 
        class MandosDBusService(DBusObjectWithProperties):
 
3137
        
 
3138
        @alternate_dbus_interfaces(
 
3139
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
3140
        class MandosDBusService(DBusObjectWithObjectManager):
2694
3141
            """A D-Bus proxy object"""
 
3142
            
2695
3143
            def __init__(self):
2696
3144
                dbus.service.Object.__init__(self, bus, "/")
 
3145
            
2697
3146
            _interface = "se.recompile.Mandos"
2698
3147
            
2699
 
            @dbus_interface_annotations(_interface)
2700
 
            def _foo(self):
2701
 
                return { "org.freedesktop.DBus.Property"
2702
 
                         ".EmitsChangedSignal":
2703
 
                             "false"}
2704
 
            
2705
3148
            @dbus.service.signal(_interface, signature="o")
2706
3149
            def ClientAdded(self, objpath):
2707
3150
                "D-Bus signal"
2712
3155
                "D-Bus signal"
2713
3156
                pass
2714
3157
            
 
3158
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3159
                               "true"})
2715
3160
            @dbus.service.signal(_interface, signature="os")
2716
3161
            def ClientRemoved(self, objpath, name):
2717
3162
                "D-Bus signal"
2718
3163
                pass
2719
3164
            
 
3165
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3166
                               "true"})
2720
3167
            @dbus.service.method(_interface, out_signature="ao")
2721
3168
            def GetAllClients(self):
2722
3169
                "D-Bus method"
2723
 
                return dbus.Array(c.dbus_object_path
2724
 
                                  for c in
 
3170
                return dbus.Array(c.dbus_object_path for c in
2725
3171
                                  tcp_server.clients.itervalues())
2726
3172
            
 
3173
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3174
                               "true"})
2727
3175
            @dbus.service.method(_interface,
2728
3176
                                 out_signature="a{oa{sv}}")
2729
3177
            def GetAllClientsWithProperties(self):
2730
3178
                "D-Bus method"
2731
3179
                return dbus.Dictionary(
2732
 
                    ((c.dbus_object_path, c.GetAll(""))
2733
 
                     for c in tcp_server.clients.itervalues()),
 
3180
                    { c.dbus_object_path: c.GetAll(
 
3181
                        "se.recompile.Mandos.Client")
 
3182
                      for c in tcp_server.clients.itervalues() },
2734
3183
                    signature="oa{sv}")
2735
3184
            
2736
3185
            @dbus.service.method(_interface, in_signature="o")
2740
3189
                    if c.dbus_object_path == object_path:
2741
3190
                        del tcp_server.clients[c.name]
2742
3191
                        c.remove_from_connection()
2743
 
                        # Don't signal anything except ClientRemoved
 
3192
                        # Don't signal the disabling
2744
3193
                        c.disable(quiet=True)
2745
 
                        # Emit D-Bus signal
2746
 
                        self.ClientRemoved(object_path, c.name)
 
3194
                        # Emit D-Bus signal for removal
 
3195
                        self.client_removed_signal(c)
2747
3196
                        return
2748
3197
                raise KeyError(object_path)
2749
3198
            
2750
3199
            del _interface
 
3200
            
 
3201
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
 
3202
                                 out_signature = "a{oa{sa{sv}}}")
 
3203
            def GetManagedObjects(self):
 
3204
                """D-Bus method"""
 
3205
                return dbus.Dictionary(
 
3206
                    { client.dbus_object_path:
 
3207
                      dbus.Dictionary(
 
3208
                          { interface: client.GetAll(interface)
 
3209
                            for interface in
 
3210
                                 client._get_all_interface_names()})
 
3211
                      for client in tcp_server.clients.values()})
 
3212
            
 
3213
            def client_added_signal(self, client):
 
3214
                """Send the new standard signal and the old signal"""
 
3215
                if use_dbus:
 
3216
                    # New standard signal
 
3217
                    self.InterfacesAdded(
 
3218
                        client.dbus_object_path,
 
3219
                        dbus.Dictionary(
 
3220
                            { interface: client.GetAll(interface)
 
3221
                              for interface in
 
3222
                              client._get_all_interface_names()}))
 
3223
                    # Old signal
 
3224
                    self.ClientAdded(client.dbus_object_path)
 
3225
            
 
3226
            def client_removed_signal(self, client):
 
3227
                """Send the new standard signal and the old signal"""
 
3228
                if use_dbus:
 
3229
                    # New standard signal
 
3230
                    self.InterfacesRemoved(
 
3231
                        client.dbus_object_path,
 
3232
                        client._get_all_interface_names())
 
3233
                    # Old signal
 
3234
                    self.ClientRemoved(client.dbus_object_path,
 
3235
                                       client.name)
2751
3236
        
2752
3237
        mandos_dbus_service = MandosDBusService()
2753
3238
    
2774
3259
                
2775
3260
                # A list of attributes that can not be pickled
2776
3261
                # + secret.
2777
 
                exclude = set(("bus", "changedstate", "secret",
2778
 
                               "checker", "server_settings"))
2779
 
                for name, typ in (inspect.getmembers
2780
 
                                  (dbus.service.Object)):
 
3262
                exclude = { "bus", "changedstate", "secret",
 
3263
                            "checker", "server_settings" }
 
3264
                for name, typ in inspect.getmembers(dbus.service
 
3265
                                                    .Object):
2781
3266
                    exclude.add(name)
2782
3267
                
2783
3268
                client_dict["encrypted_secret"] = (client
2790
3275
                del client_settings[client.name]["secret"]
2791
3276
        
2792
3277
        try:
2793
 
            with (tempfile.NamedTemporaryFile
2794
 
                  (mode='wb', suffix=".pickle", prefix='clients-',
2795
 
                   dir=os.path.dirname(stored_state_path),
2796
 
                   delete=False)) as stored_state:
 
3278
            with tempfile.NamedTemporaryFile(
 
3279
                    mode='wb',
 
3280
                    suffix=".pickle",
 
3281
                    prefix='clients-',
 
3282
                    dir=os.path.dirname(stored_state_path),
 
3283
                    delete=False) as stored_state:
2797
3284
                pickle.dump((clients, client_settings), stored_state)
2798
 
                tempname=stored_state.name
 
3285
                tempname = stored_state.name
2799
3286
            os.rename(tempname, stored_state_path)
2800
3287
        except (IOError, OSError) as e:
2801
3288
            if not debug:
2804
3291
                except NameError:
2805
3292
                    pass
2806
3293
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2807
 
                logger.warning("Could not save persistent state: {0}"
 
3294
                logger.warning("Could not save persistent state: {}"
2808
3295
                               .format(os.strerror(e.errno)))
2809
3296
            else:
2810
3297
                logger.warning("Could not save persistent state:",
2816
3303
            name, client = tcp_server.clients.popitem()
2817
3304
            if use_dbus:
2818
3305
                client.remove_from_connection()
2819
 
            # Don't signal anything except ClientRemoved
 
3306
            # Don't signal the disabling
2820
3307
            client.disable(quiet=True)
 
3308
            # Emit D-Bus signal for removal
2821
3309
            if use_dbus:
2822
 
                # Emit D-Bus signal
2823
 
                mandos_dbus_service.ClientRemoved(client
2824
 
                                                  .dbus_object_path,
2825
 
                                                  client.name)
 
3310
                mandos_dbus_service.client_removed_signal(client)
2826
3311
        client_settings.clear()
2827
3312
    
2828
3313
    atexit.register(cleanup)
2829
3314
    
2830
3315
    for client in tcp_server.clients.itervalues():
2831
3316
        if use_dbus:
2832
 
            # Emit D-Bus signal
2833
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3317
            # Emit D-Bus signal for adding
 
3318
            mandos_dbus_service.client_added_signal(client)
2834
3319
        # Need to initiate checking of clients
2835
3320
        if client.enabled:
2836
3321
            client.init_checker()
2862
3347
                sys.exit(1)
2863
3348
            # End of Avahi example code
2864
3349
        
2865
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
 
3350
        GObject.io_add_watch(tcp_server.fileno(), GObject.IO_IN,
2866
3351
                             lambda *args, **kwargs:
2867
3352
                             (tcp_server.handle_request
2868
3353
                              (*args[2:], **kwargs) or True))
2881
3366
    # Must run before the D-Bus bus name gets deregistered
2882
3367
    cleanup()
2883
3368
 
 
3369
 
2884
3370
if __name__ == '__main__':
2885
3371
    main()