/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: 2014-02-16 02:42:42 UTC
  • Revision ID: teddy@recompile.se-20140216024242-9wiw1nkxgt7ohovj
Fix running of self-tests.

* debian/control (Build-Depends): Add Python dependencies to
                                  successfully run self-tests.
* debian/copyright: GPLv3 now has its own license file - use it.
* debian/watch: Set PGP signature URL.
* mandos (main): Bug fix: When running self-tests, set exit code.
* mandos-ctl (main): Cosmetic fix; use os.EX_OK instead of plain 0.

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-2016 Teddy Hogeborn
15
 
# Copyright © 2008-2016 Björn Påhlsson
 
14
# Copyright © 2008-2014 Teddy Hogeborn
 
15
# Copyright © 2008-2014 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
37
 
try:
38
 
    from future_builtins import *
39
 
except ImportError:
40
 
    pass
 
37
from future_builtins import *
41
38
 
42
 
try:
43
 
    import SocketServer as socketserver
44
 
except ImportError:
45
 
    import socketserver
 
39
import SocketServer as socketserver
46
40
import socket
47
41
import argparse
48
42
import datetime
49
43
import errno
50
 
try:
51
 
    import ConfigParser as configparser
52
 
except ImportError:
53
 
    import configparser
 
44
import gnutls.crypto
 
45
import gnutls.connection
 
46
import gnutls.errors
 
47
import gnutls.library.functions
 
48
import gnutls.library.constants
 
49
import gnutls.library.types
 
50
import ConfigParser as configparser
54
51
import sys
55
52
import re
56
53
import os
65
62
import struct
66
63
import fcntl
67
64
import functools
68
 
try:
69
 
    import cPickle as pickle
70
 
except ImportError:
71
 
    import pickle
 
65
import cPickle as pickle
72
66
import multiprocessing
73
67
import types
74
68
import binascii
75
69
import tempfile
76
70
import itertools
77
71
import collections
78
 
import codecs
79
72
 
80
73
import dbus
81
74
import dbus.service
82
 
try:
83
 
    from gi.repository import GObject
84
 
except ImportError:
85
 
    import gobject as GObject
 
75
import gobject
 
76
import avahi
86
77
from dbus.mainloop.glib import DBusGMainLoop
87
78
import ctypes
88
79
import ctypes.util
97
88
    except ImportError:
98
89
        SO_BINDTODEVICE = None
99
90
 
100
 
if sys.version_info.major == 2:
101
 
    str = unicode
102
 
 
103
 
version = "1.7.5"
 
91
version = "1.6.3"
104
92
stored_state_file = "clients.pickle"
105
93
 
106
94
logger = logging.getLogger()
107
 
syslogger = None
 
95
syslogger = (logging.handlers.SysLogHandler
 
96
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
97
              address = str("/dev/log")))
108
98
 
109
99
try:
110
 
    if_nametoindex = ctypes.cdll.LoadLibrary(
111
 
        ctypes.util.find_library("c")).if_nametoindex
 
100
    if_nametoindex = (ctypes.cdll.LoadLibrary
 
101
                      (ctypes.util.find_library("c"))
 
102
                      .if_nametoindex)
112
103
except (OSError, AttributeError):
113
 
    
114
104
    def if_nametoindex(interface):
115
105
        "Get an interface index the hard way, i.e. using fcntl()"
116
106
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
117
107
        with contextlib.closing(socket.socket()) as s:
118
108
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
119
 
                                struct.pack(b"16s16x", interface))
120
 
        interface_index = struct.unpack("I", ifreq[16:20])[0]
 
109
                                struct.pack(str("16s16x"),
 
110
                                            interface))
 
111
        interface_index = struct.unpack(str("I"),
 
112
                                        ifreq[16:20])[0]
121
113
        return interface_index
122
114
 
123
115
 
124
 
def copy_function(func):
125
 
    """Make a copy of a function"""
126
 
    if sys.version_info.major == 2:
127
 
        return types.FunctionType(func.func_code,
128
 
                                  func.func_globals,
129
 
                                  func.func_name,
130
 
                                  func.func_defaults,
131
 
                                  func.func_closure)
132
 
    else:
133
 
        return types.FunctionType(func.__code__,
134
 
                                  func.__globals__,
135
 
                                  func.__name__,
136
 
                                  func.__defaults__,
137
 
                                  func.__closure__)
138
 
 
139
 
 
140
116
def initlogger(debug, level=logging.WARNING):
141
117
    """init logger and add loglevel"""
142
118
    
143
 
    global syslogger
144
 
    syslogger = (logging.handlers.SysLogHandler(
145
 
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
146
 
        address = "/dev/log"))
147
119
    syslogger.setFormatter(logging.Formatter
148
120
                           ('Mandos [%(process)d]: %(levelname)s:'
149
121
                            ' %(message)s'))
166
138
 
167
139
class PGPEngine(object):
168
140
    """A simple class for OpenPGP symmetric encryption & decryption"""
169
 
    
170
141
    def __init__(self):
171
142
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
172
 
        self.gpg = "gpg"
173
 
        try:
174
 
            output = subprocess.check_output(["gpgconf"])
175
 
            for line in output.splitlines():
176
 
                name, text, path = line.split(b":")
177
 
                if name == "gpg":
178
 
                    self.gpg = path
179
 
                    break
180
 
        except OSError as e:
181
 
            if e.errno != errno.ENOENT:
182
 
                raise
183
143
        self.gnupgargs = ['--batch',
184
 
                          '--homedir', self.tempdir,
 
144
                          '--home', self.tempdir,
185
145
                          '--force-mdc',
186
146
                          '--quiet',
187
147
                          '--no-use-agent']
222
182
    
223
183
    def encrypt(self, data, password):
224
184
        passphrase = self.password_encode(password)
225
 
        with tempfile.NamedTemporaryFile(
226
 
                dir=self.tempdir) as passfile:
 
185
        with tempfile.NamedTemporaryFile(dir=self.tempdir
 
186
                                         ) as passfile:
227
187
            passfile.write(passphrase)
228
188
            passfile.flush()
229
 
            proc = subprocess.Popen([self.gpg, '--symmetric',
 
189
            proc = subprocess.Popen(['gpg', '--symmetric',
230
190
                                     '--passphrase-file',
231
191
                                     passfile.name]
232
192
                                    + self.gnupgargs,
240
200
    
241
201
    def decrypt(self, data, password):
242
202
        passphrase = self.password_encode(password)
243
 
        with tempfile.NamedTemporaryFile(
244
 
                dir = self.tempdir) as passfile:
 
203
        with tempfile.NamedTemporaryFile(dir = self.tempdir
 
204
                                         ) as passfile:
245
205
            passfile.write(passphrase)
246
206
            passfile.flush()
247
 
            proc = subprocess.Popen([self.gpg, '--decrypt',
 
207
            proc = subprocess.Popen(['gpg', '--decrypt',
248
208
                                     '--passphrase-file',
249
209
                                     passfile.name]
250
210
                                    + self.gnupgargs,
251
211
                                    stdin = subprocess.PIPE,
252
212
                                    stdout = subprocess.PIPE,
253
213
                                    stderr = subprocess.PIPE)
254
 
            decrypted_plaintext, err = proc.communicate(input = data)
 
214
            decrypted_plaintext, err = proc.communicate(input
 
215
                                                        = data)
255
216
        if proc.returncode != 0:
256
217
            raise PGPError(err)
257
218
        return decrypted_plaintext
258
219
 
259
 
# Pretend that we have an Avahi module
260
 
class Avahi(object):
261
 
    """This isn't so much a class as it is a module-like namespace.
262
 
    It is instantiated once, and simulates having an Avahi module."""
263
 
    IF_UNSPEC = -1              # avahi-common/address.h
264
 
    PROTO_UNSPEC = -1           # avahi-common/address.h
265
 
    PROTO_INET = 0              # avahi-common/address.h
266
 
    PROTO_INET6 = 1             # avahi-common/address.h
267
 
    DBUS_NAME = "org.freedesktop.Avahi"
268
 
    DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
269
 
    DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
270
 
    DBUS_PATH_SERVER = "/"
271
 
    def string_array_to_txt_array(self, t):
272
 
        return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
273
 
                           for s in t), signature="ay")
274
 
    ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
275
 
    ENTRY_GROUP_COLLISION = 3   # avahi-common/defs.h
276
 
    ENTRY_GROUP_FAILURE = 4     # avahi-common/defs.h
277
 
    SERVER_INVALID = 0          # avahi-common/defs.h
278
 
    SERVER_REGISTERING = 1      # avahi-common/defs.h
279
 
    SERVER_RUNNING = 2          # avahi-common/defs.h
280
 
    SERVER_COLLISION = 3        # avahi-common/defs.h
281
 
    SERVER_FAILURE = 4          # avahi-common/defs.h
282
 
avahi = Avahi()
283
220
 
284
221
class AvahiError(Exception):
285
222
    def __init__(self, value, *args, **kwargs):
286
223
        self.value = value
287
 
        return super(AvahiError, self).__init__(value, *args,
288
 
                                                **kwargs)
289
 
 
 
224
        super(AvahiError, self).__init__(value, *args, **kwargs)
 
225
    def __unicode__(self):
 
226
        return unicode(repr(self.value))
290
227
 
291
228
class AvahiServiceError(AvahiError):
292
229
    pass
293
230
 
294
 
 
295
231
class AvahiGroupError(AvahiError):
296
232
    pass
297
233
 
317
253
    bus: dbus.SystemBus()
318
254
    """
319
255
    
320
 
    def __init__(self,
321
 
                 interface = avahi.IF_UNSPEC,
322
 
                 name = None,
323
 
                 servicetype = None,
324
 
                 port = None,
325
 
                 TXT = None,
326
 
                 domain = "",
327
 
                 host = "",
328
 
                 max_renames = 32768,
329
 
                 protocol = avahi.PROTO_UNSPEC,
330
 
                 bus = None):
 
256
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
 
257
                 servicetype = None, port = None, TXT = None,
 
258
                 domain = "", host = "", max_renames = 32768,
 
259
                 protocol = avahi.PROTO_UNSPEC, bus = None):
331
260
        self.interface = interface
332
261
        self.name = name
333
262
        self.type = servicetype
343
272
        self.bus = bus
344
273
        self.entry_group_state_changed_match = None
345
274
    
346
 
    def rename(self, remove=True):
 
275
    def rename(self):
347
276
        """Derived from the Avahi example code"""
348
277
        if self.rename_count >= self.max_renames:
349
278
            logger.critical("No suitable Zeroconf service name found"
350
279
                            " after %i retries, exiting.",
351
280
                            self.rename_count)
352
281
            raise AvahiServiceError("Too many renames")
353
 
        self.name = str(
354
 
            self.server.GetAlternativeServiceName(self.name))
355
 
        self.rename_count += 1
 
282
        self.name = unicode(self.server
 
283
                            .GetAlternativeServiceName(self.name))
356
284
        logger.info("Changing Zeroconf service name to %r ...",
357
285
                    self.name)
358
 
        if remove:
359
 
            self.remove()
 
286
        self.remove()
360
287
        try:
361
288
            self.add()
362
289
        except dbus.exceptions.DBusException as error:
363
 
            if (error.get_dbus_name()
364
 
                == "org.freedesktop.Avahi.CollisionError"):
365
 
                logger.info("Local Zeroconf service name collision.")
366
 
                return self.rename(remove=False)
367
 
            else:
368
 
                logger.critical("D-Bus Exception", exc_info=error)
369
 
                self.cleanup()
370
 
                os._exit(1)
 
290
            logger.critical("D-Bus Exception", exc_info=error)
 
291
            self.cleanup()
 
292
            os._exit(1)
 
293
        self.rename_count += 1
371
294
    
372
295
    def remove(self):
373
296
        """Derived from the Avahi example code"""
411
334
            self.rename()
412
335
        elif state == avahi.ENTRY_GROUP_FAILURE:
413
336
            logger.critical("Avahi: Error in group state changed %s",
414
 
                            str(error))
415
 
            raise AvahiGroupError("State changed: {!s}".format(error))
 
337
                            unicode(error))
 
338
            raise AvahiGroupError("State changed: {0!s}"
 
339
                                  .format(error))
416
340
    
417
341
    def cleanup(self):
418
342
        """Derived from the Avahi example code"""
428
352
    def server_state_changed(self, state, error=None):
429
353
        """Derived from the Avahi example code"""
430
354
        logger.debug("Avahi server state change: %i", state)
431
 
        bad_states = {
432
 
            avahi.SERVER_INVALID: "Zeroconf server invalid",
433
 
            avahi.SERVER_REGISTERING: None,
434
 
            avahi.SERVER_COLLISION: "Zeroconf server name collision",
435
 
            avahi.SERVER_FAILURE: "Zeroconf server failure",
436
 
        }
 
355
        bad_states = { avahi.SERVER_INVALID:
 
356
                           "Zeroconf server invalid",
 
357
                       avahi.SERVER_REGISTERING: None,
 
358
                       avahi.SERVER_COLLISION:
 
359
                           "Zeroconf server name collision",
 
360
                       avahi.SERVER_FAILURE:
 
361
                           "Zeroconf server failure" }
437
362
        if state in bad_states:
438
363
            if bad_states[state] is not None:
439
364
                if error is None:
442
367
                    logger.error(bad_states[state] + ": %r", error)
443
368
            self.cleanup()
444
369
        elif state == avahi.SERVER_RUNNING:
445
 
            try:
446
 
                self.add()
447
 
            except dbus.exceptions.DBusException as error:
448
 
                if (error.get_dbus_name()
449
 
                    == "org.freedesktop.Avahi.CollisionError"):
450
 
                    logger.info("Local Zeroconf service name"
451
 
                                " collision.")
452
 
                    return self.rename(remove=False)
453
 
                else:
454
 
                    logger.critical("D-Bus Exception", exc_info=error)
455
 
                    self.cleanup()
456
 
                    os._exit(1)
 
370
            self.add()
457
371
        else:
458
372
            if error is None:
459
373
                logger.debug("Unknown state: %r", state)
469
383
                                    follow_name_owner_changes=True),
470
384
                avahi.DBUS_INTERFACE_SERVER)
471
385
        self.server.connect_to_signal("StateChanged",
472
 
                                      self.server_state_changed)
 
386
                                 self.server_state_changed)
473
387
        self.server_state_changed(self.server.GetState())
474
388
 
475
389
 
476
390
class AvahiServiceToSyslog(AvahiService):
477
 
    def rename(self, *args, **kwargs):
 
391
    def rename(self):
478
392
        """Add the new name to the syslog messages"""
479
 
        ret = AvahiService.rename(self, *args, **kwargs)
480
 
        syslogger.setFormatter(logging.Formatter(
481
 
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
482
 
            .format(self.name)))
 
393
        ret = AvahiService.rename(self)
 
394
        syslogger.setFormatter(logging.Formatter
 
395
                               ('Mandos ({0}) [%(process)d]:'
 
396
                                ' %(levelname)s: %(message)s'
 
397
                                .format(self.name)))
483
398
        return ret
484
399
 
485
 
# Pretend that we have a GnuTLS module
486
 
class GnuTLS(object):
487
 
    """This isn't so much a class as it is a module-like namespace.
488
 
    It is instantiated once, and simulates having a GnuTLS module."""
489
 
    
490
 
    _library = ctypes.cdll.LoadLibrary(
491
 
        ctypes.util.find_library("gnutls"))
492
 
    _need_version = b"3.3.0"
493
 
    def __init__(self):
494
 
        # Need to use class name "GnuTLS" here, since this method is
495
 
        # called before the assignment to the "gnutls" global variable
496
 
        # happens.
497
 
        if GnuTLS.check_version(self._need_version) is None:
498
 
            raise GnuTLS.Error("Needs GnuTLS {} or later"
499
 
                               .format(self._need_version))
500
 
    
501
 
    # Unless otherwise indicated, the constants and types below are
502
 
    # all from the gnutls/gnutls.h C header file.
503
 
    
504
 
    # Constants
505
 
    E_SUCCESS = 0
506
 
    E_INTERRUPTED = -52
507
 
    E_AGAIN = -28
508
 
    CRT_OPENPGP = 2
509
 
    CLIENT = 2
510
 
    SHUT_RDWR = 0
511
 
    CRD_CERTIFICATE = 1
512
 
    E_NO_CERTIFICATE_FOUND = -49
513
 
    OPENPGP_FMT_RAW = 0         # gnutls/openpgp.h
514
 
    
515
 
    # Types
516
 
    class session_int(ctypes.Structure):
517
 
        _fields_ = []
518
 
    session_t = ctypes.POINTER(session_int)
519
 
    class certificate_credentials_st(ctypes.Structure):
520
 
        _fields_ = []
521
 
    certificate_credentials_t = ctypes.POINTER(
522
 
        certificate_credentials_st)
523
 
    certificate_type_t = ctypes.c_int
524
 
    class datum_t(ctypes.Structure):
525
 
        _fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
526
 
                    ('size', ctypes.c_uint)]
527
 
    class openpgp_crt_int(ctypes.Structure):
528
 
        _fields_ = []
529
 
    openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
530
 
    openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
531
 
    log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
532
 
    credentials_type_t = ctypes.c_int
533
 
    transport_ptr_t = ctypes.c_void_p
534
 
    close_request_t = ctypes.c_int
535
 
    
536
 
    # Exceptions
537
 
    class Error(Exception):
538
 
        # We need to use the class name "GnuTLS" here, since this
539
 
        # exception might be raised from within GnuTLS.__init__,
540
 
        # which is called before the assignment to the "gnutls"
541
 
        # global variable has happened.
542
 
        def __init__(self, message = None, code = None, args=()):
543
 
            # Default usage is by a message string, but if a return
544
 
            # code is passed, convert it to a string with
545
 
            # gnutls.strerror()
546
 
            self.code = code
547
 
            if message is None and code is not None:
548
 
                message = GnuTLS.strerror(code)
549
 
            return super(GnuTLS.Error, self).__init__(
550
 
                message, *args)
551
 
    
552
 
    class CertificateSecurityError(Error):
553
 
        pass
554
 
    
555
 
    # Classes
556
 
    class Credentials(object):
557
 
        def __init__(self):
558
 
            self._c_object = gnutls.certificate_credentials_t()
559
 
            gnutls.certificate_allocate_credentials(
560
 
                ctypes.byref(self._c_object))
561
 
            self.type = gnutls.CRD_CERTIFICATE
562
 
        
563
 
        def __del__(self):
564
 
            gnutls.certificate_free_credentials(self._c_object)
565
 
    
566
 
    class ClientSession(object):
567
 
        def __init__(self, socket, credentials = None):
568
 
            self._c_object = gnutls.session_t()
569
 
            gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
570
 
            gnutls.set_default_priority(self._c_object)
571
 
            gnutls.transport_set_ptr(self._c_object, socket.fileno())
572
 
            gnutls.handshake_set_private_extensions(self._c_object,
573
 
                                                    True)
574
 
            self.socket = socket
575
 
            if credentials is None:
576
 
                credentials = gnutls.Credentials()
577
 
            gnutls.credentials_set(self._c_object, credentials.type,
578
 
                                   ctypes.cast(credentials._c_object,
579
 
                                               ctypes.c_void_p))
580
 
            self.credentials = credentials
581
 
        
582
 
        def __del__(self):
583
 
            gnutls.deinit(self._c_object)
584
 
        
585
 
        def handshake(self):
586
 
            return gnutls.handshake(self._c_object)
587
 
        
588
 
        def send(self, data):
589
 
            data = bytes(data)
590
 
            data_len = len(data)
591
 
            while data_len > 0:
592
 
                data_len -= gnutls.record_send(self._c_object,
593
 
                                               data[-data_len:],
594
 
                                               data_len)
595
 
        
596
 
        def bye(self):
597
 
            return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
598
 
    
599
 
    # Error handling functions
600
 
    def _error_code(result):
601
 
        """A function to raise exceptions on errors, suitable
602
 
        for the 'restype' attribute on ctypes functions"""
603
 
        if result >= 0:
604
 
            return result
605
 
        if result == gnutls.E_NO_CERTIFICATE_FOUND:
606
 
            raise gnutls.CertificateSecurityError(code = result)
607
 
        raise gnutls.Error(code = result)
608
 
    
609
 
    def _retry_on_error(result, func, arguments):
610
 
        """A function to retry on some errors, suitable
611
 
        for the 'errcheck' attribute on ctypes functions"""
612
 
        while result < 0:
613
 
            if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
614
 
                return _error_code(result)
615
 
            result = func(*arguments)
616
 
        return result
617
 
    
618
 
    # Unless otherwise indicated, the function declarations below are
619
 
    # all from the gnutls/gnutls.h C header file.
620
 
    
621
 
    # Functions
622
 
    priority_set_direct = _library.gnutls_priority_set_direct
623
 
    priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
624
 
                                    ctypes.POINTER(ctypes.c_char_p)]
625
 
    priority_set_direct.restype = _error_code
626
 
    
627
 
    init = _library.gnutls_init
628
 
    init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
629
 
    init.restype = _error_code
630
 
    
631
 
    set_default_priority = _library.gnutls_set_default_priority
632
 
    set_default_priority.argtypes = [session_t]
633
 
    set_default_priority.restype = _error_code
634
 
    
635
 
    record_send = _library.gnutls_record_send
636
 
    record_send.argtypes = [session_t, ctypes.c_void_p,
637
 
                            ctypes.c_size_t]
638
 
    record_send.restype = ctypes.c_ssize_t
639
 
    record_send.errcheck = _retry_on_error
640
 
    
641
 
    certificate_allocate_credentials = (
642
 
        _library.gnutls_certificate_allocate_credentials)
643
 
    certificate_allocate_credentials.argtypes = [
644
 
        ctypes.POINTER(certificate_credentials_t)]
645
 
    certificate_allocate_credentials.restype = _error_code
646
 
    
647
 
    certificate_free_credentials = (
648
 
        _library.gnutls_certificate_free_credentials)
649
 
    certificate_free_credentials.argtypes = [certificate_credentials_t]
650
 
    certificate_free_credentials.restype = None
651
 
    
652
 
    handshake_set_private_extensions = (
653
 
        _library.gnutls_handshake_set_private_extensions)
654
 
    handshake_set_private_extensions.argtypes = [session_t,
655
 
                                                 ctypes.c_int]
656
 
    handshake_set_private_extensions.restype = None
657
 
    
658
 
    credentials_set = _library.gnutls_credentials_set
659
 
    credentials_set.argtypes = [session_t, credentials_type_t,
660
 
                                ctypes.c_void_p]
661
 
    credentials_set.restype = _error_code
662
 
    
663
 
    strerror = _library.gnutls_strerror
664
 
    strerror.argtypes = [ctypes.c_int]
665
 
    strerror.restype = ctypes.c_char_p
666
 
    
667
 
    certificate_type_get = _library.gnutls_certificate_type_get
668
 
    certificate_type_get.argtypes = [session_t]
669
 
    certificate_type_get.restype = _error_code
670
 
    
671
 
    certificate_get_peers = _library.gnutls_certificate_get_peers
672
 
    certificate_get_peers.argtypes = [session_t,
673
 
                                      ctypes.POINTER(ctypes.c_uint)]
674
 
    certificate_get_peers.restype = ctypes.POINTER(datum_t)
675
 
    
676
 
    global_set_log_level = _library.gnutls_global_set_log_level
677
 
    global_set_log_level.argtypes = [ctypes.c_int]
678
 
    global_set_log_level.restype = None
679
 
    
680
 
    global_set_log_function = _library.gnutls_global_set_log_function
681
 
    global_set_log_function.argtypes = [log_func]
682
 
    global_set_log_function.restype = None
683
 
    
684
 
    deinit = _library.gnutls_deinit
685
 
    deinit.argtypes = [session_t]
686
 
    deinit.restype = None
687
 
    
688
 
    handshake = _library.gnutls_handshake
689
 
    handshake.argtypes = [session_t]
690
 
    handshake.restype = _error_code
691
 
    handshake.errcheck = _retry_on_error
692
 
    
693
 
    transport_set_ptr = _library.gnutls_transport_set_ptr
694
 
    transport_set_ptr.argtypes = [session_t, transport_ptr_t]
695
 
    transport_set_ptr.restype = None
696
 
    
697
 
    bye = _library.gnutls_bye
698
 
    bye.argtypes = [session_t, close_request_t]
699
 
    bye.restype = _error_code
700
 
    bye.errcheck = _retry_on_error
701
 
    
702
 
    check_version = _library.gnutls_check_version
703
 
    check_version.argtypes = [ctypes.c_char_p]
704
 
    check_version.restype = ctypes.c_char_p
705
 
    
706
 
    # All the function declarations below are from gnutls/openpgp.h
707
 
    
708
 
    openpgp_crt_init = _library.gnutls_openpgp_crt_init
709
 
    openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
710
 
    openpgp_crt_init.restype = _error_code
711
 
    
712
 
    openpgp_crt_import = _library.gnutls_openpgp_crt_import
713
 
    openpgp_crt_import.argtypes = [openpgp_crt_t,
714
 
                                   ctypes.POINTER(datum_t),
715
 
                                   openpgp_crt_fmt_t]
716
 
    openpgp_crt_import.restype = _error_code
717
 
    
718
 
    openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
719
 
    openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
720
 
                                        ctypes.POINTER(ctypes.c_uint)]
721
 
    openpgp_crt_verify_self.restype = _error_code
722
 
    
723
 
    openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
724
 
    openpgp_crt_deinit.argtypes = [openpgp_crt_t]
725
 
    openpgp_crt_deinit.restype = None
726
 
    
727
 
    openpgp_crt_get_fingerprint = (
728
 
        _library.gnutls_openpgp_crt_get_fingerprint)
729
 
    openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
730
 
                                            ctypes.c_void_p,
731
 
                                            ctypes.POINTER(
732
 
                                                ctypes.c_size_t)]
733
 
    openpgp_crt_get_fingerprint.restype = _error_code
734
 
    
735
 
    # Remove non-public functions
736
 
    del _error_code, _retry_on_error
737
 
# Create the global "gnutls" object, simulating a module
738
 
gnutls = GnuTLS()
739
 
 
740
 
def call_pipe(connection,       # : multiprocessing.Connection
741
 
              func, *args, **kwargs):
742
 
    """This function is meant to be called by multiprocessing.Process
743
 
    
744
 
    This function runs func(*args, **kwargs), and writes the resulting
745
 
    return value on the provided multiprocessing.Connection.
746
 
    """
747
 
    connection.send(func(*args, **kwargs))
748
 
    connection.close()
 
400
 
 
401
def timedelta_to_milliseconds(td):
 
402
    "Convert a datetime.timedelta() to milliseconds"
 
403
    return ((td.days * 24 * 60 * 60 * 1000)
 
404
            + (td.seconds * 1000)
 
405
            + (td.microseconds // 1000))
 
406
 
749
407
 
750
408
class Client(object):
751
409
    """A representation of a client host served by this server.
757
415
    checker:    subprocess.Popen(); a running checker process used
758
416
                                    to see if the client lives.
759
417
                                    'None' if no process is running.
760
 
    checker_callback_tag: a GObject event source tag, or None
 
418
    checker_callback_tag: a gobject event source tag, or None
761
419
    checker_command: string; External command which is run to check
762
420
                     if client lives.  %() expansions are done at
763
421
                     runtime with vars(self) as dict, so that for
764
422
                     instance %(name)s can be used in the command.
765
 
    checker_initiator_tag: a GObject event source tag, or None
 
423
    checker_initiator_tag: a gobject event source tag, or None
766
424
    created:    datetime.datetime(); (UTC) object creation
767
425
    client_structure: Object describing what attributes a client has
768
426
                      and is used for storing the client at exit
769
427
    current_checker_command: string; current running checker_command
770
 
    disable_initiator_tag: a GObject event source tag, or None
 
428
    disable_initiator_tag: a gobject event source tag, or None
771
429
    enabled:    bool()
772
430
    fingerprint: string (40 or 32 hexadecimal digits); used to
773
431
                 uniquely identify the client
778
436
    last_checker_status: integer between 0 and 255 reflecting exit
779
437
                         status of last checker. -1 reflects crashed
780
438
                         checker, -2 means no checker completed yet.
781
 
    last_checker_signal: The signal which killed the last checker, if
782
 
                         last_checker_status is -1
783
439
    last_enabled: datetime.datetime(); (UTC) or None
784
440
    name:       string; from the config file, used in log messages and
785
441
                        D-Bus identifiers
798
454
                          "fingerprint", "host", "interval",
799
455
                          "last_approval_request", "last_checked_ok",
800
456
                          "last_enabled", "name", "timeout")
801
 
    client_defaults = {
802
 
        "timeout": "PT5M",
803
 
        "extended_timeout": "PT15M",
804
 
        "interval": "PT2M",
805
 
        "checker": "fping -q -- %%(host)s",
806
 
        "host": "",
807
 
        "approval_delay": "PT0S",
808
 
        "approval_duration": "PT1S",
809
 
        "approved_by_default": "True",
810
 
        "enabled": "True",
811
 
    }
 
457
    client_defaults = { "timeout": "PT5M",
 
458
                        "extended_timeout": "PT15M",
 
459
                        "interval": "PT2M",
 
460
                        "checker": "fping -q -- %%(host)s",
 
461
                        "host": "",
 
462
                        "approval_delay": "PT0S",
 
463
                        "approval_duration": "PT1S",
 
464
                        "approved_by_default": "True",
 
465
                        "enabled": "True",
 
466
                        }
 
467
    
 
468
    def timeout_milliseconds(self):
 
469
        "Return the 'timeout' attribute in milliseconds"
 
470
        return timedelta_to_milliseconds(self.timeout)
 
471
    
 
472
    def extended_timeout_milliseconds(self):
 
473
        "Return the 'extended_timeout' attribute in milliseconds"
 
474
        return timedelta_to_milliseconds(self.extended_timeout)
 
475
    
 
476
    def interval_milliseconds(self):
 
477
        "Return the 'interval' attribute in milliseconds"
 
478
        return timedelta_to_milliseconds(self.interval)
 
479
    
 
480
    def approval_delay_milliseconds(self):
 
481
        return timedelta_to_milliseconds(self.approval_delay)
812
482
    
813
483
    @staticmethod
814
484
    def config_parser(config):
830
500
            client["enabled"] = config.getboolean(client_name,
831
501
                                                  "enabled")
832
502
            
833
 
            # Uppercase and remove spaces from fingerprint for later
834
 
            # comparison purposes with return value from the
835
 
            # fingerprint() function
836
503
            client["fingerprint"] = (section["fingerprint"].upper()
837
504
                                     .replace(" ", ""))
838
505
            if "secret" in section:
839
 
                client["secret"] = codecs.decode(section["secret"]
840
 
                                                 .encode("utf-8"),
841
 
                                                 "base64")
 
506
                client["secret"] = section["secret"].decode("base64")
842
507
            elif "secfile" in section:
843
508
                with open(os.path.expanduser(os.path.expandvars
844
509
                                             (section["secfile"])),
845
510
                          "rb") as secfile:
846
511
                    client["secret"] = secfile.read()
847
512
            else:
848
 
                raise TypeError("No secret or secfile for section {}"
 
513
                raise TypeError("No secret or secfile for section {0}"
849
514
                                .format(section))
850
515
            client["timeout"] = string_to_delta(section["timeout"])
851
516
            client["extended_timeout"] = string_to_delta(
868
533
            server_settings = {}
869
534
        self.server_settings = server_settings
870
535
        # adding all client settings
871
 
        for setting, value in settings.items():
 
536
        for setting, value in settings.iteritems():
872
537
            setattr(self, setting, value)
873
538
        
874
539
        if self.enabled:
882
547
            self.expires = None
883
548
        
884
549
        logger.debug("Creating client %r", self.name)
 
550
        # Uppercase and remove spaces from fingerprint for later
 
551
        # comparison purposes with return value from the fingerprint()
 
552
        # function
885
553
        logger.debug("  Fingerprint: %s", self.fingerprint)
886
554
        self.created = settings.get("created",
887
555
                                    datetime.datetime.utcnow())
894
562
        self.current_checker_command = None
895
563
        self.approved = None
896
564
        self.approvals_pending = 0
897
 
        self.changedstate = multiprocessing_manager.Condition(
898
 
            multiprocessing_manager.Lock())
899
 
        self.client_structure = [attr
900
 
                                 for attr in self.__dict__.keys()
 
565
        self.changedstate = (multiprocessing_manager
 
566
                             .Condition(multiprocessing_manager
 
567
                                        .Lock()))
 
568
        self.client_structure = [attr for attr in
 
569
                                 self.__dict__.iterkeys()
901
570
                                 if not attr.startswith("_")]
902
571
        self.client_structure.append("client_structure")
903
572
        
904
 
        for name, t in inspect.getmembers(
905
 
                type(self), lambda obj: isinstance(obj, property)):
 
573
        for name, t in inspect.getmembers(type(self),
 
574
                                          lambda obj:
 
575
                                              isinstance(obj,
 
576
                                                         property)):
906
577
            if not name.startswith("_"):
907
578
                self.client_structure.append(name)
908
579
    
929
600
        if not quiet:
930
601
            logger.info("Disabling client %s", self.name)
931
602
        if getattr(self, "disable_initiator_tag", None) is not None:
932
 
            GObject.source_remove(self.disable_initiator_tag)
 
603
            gobject.source_remove(self.disable_initiator_tag)
933
604
            self.disable_initiator_tag = None
934
605
        self.expires = None
935
606
        if getattr(self, "checker_initiator_tag", None) is not None:
936
 
            GObject.source_remove(self.checker_initiator_tag)
 
607
            gobject.source_remove(self.checker_initiator_tag)
937
608
            self.checker_initiator_tag = None
938
609
        self.stop_checker()
939
610
        self.enabled = False
940
611
        if not quiet:
941
612
            self.send_changedstate()
942
 
        # Do not run this again if called by a GObject.timeout_add
 
613
        # Do not run this again if called by a gobject.timeout_add
943
614
        return False
944
615
    
945
616
    def __del__(self):
949
620
        # Schedule a new checker to be started an 'interval' from now,
950
621
        # and every interval from then on.
951
622
        if self.checker_initiator_tag is not None:
952
 
            GObject.source_remove(self.checker_initiator_tag)
953
 
        self.checker_initiator_tag = GObject.timeout_add(
954
 
            int(self.interval.total_seconds() * 1000),
955
 
            self.start_checker)
 
623
            gobject.source_remove(self.checker_initiator_tag)
 
624
        self.checker_initiator_tag = (gobject.timeout_add
 
625
                                      (self.interval_milliseconds(),
 
626
                                       self.start_checker))
956
627
        # Schedule a disable() when 'timeout' has passed
957
628
        if self.disable_initiator_tag is not None:
958
 
            GObject.source_remove(self.disable_initiator_tag)
959
 
        self.disable_initiator_tag = GObject.timeout_add(
960
 
            int(self.timeout.total_seconds() * 1000), self.disable)
 
629
            gobject.source_remove(self.disable_initiator_tag)
 
630
        self.disable_initiator_tag = (gobject.timeout_add
 
631
                                   (self.timeout_milliseconds(),
 
632
                                    self.disable))
961
633
        # Also start a new checker *right now*.
962
634
        self.start_checker()
963
635
    
964
 
    def checker_callback(self, source, condition, connection,
965
 
                         command):
 
636
    def checker_callback(self, pid, condition, command):
966
637
        """The checker has completed, so take appropriate actions."""
967
638
        self.checker_callback_tag = None
968
639
        self.checker = None
969
 
        # Read return code from connection (see call_pipe)
970
 
        returncode = connection.recv()
971
 
        connection.close()
972
 
        
973
 
        if returncode >= 0:
974
 
            self.last_checker_status = returncode
975
 
            self.last_checker_signal = None
 
640
        if os.WIFEXITED(condition):
 
641
            self.last_checker_status = os.WEXITSTATUS(condition)
976
642
            if self.last_checker_status == 0:
977
643
                logger.info("Checker for %(name)s succeeded",
978
644
                            vars(self))
979
645
                self.checked_ok()
980
646
            else:
981
 
                logger.info("Checker for %(name)s failed", vars(self))
 
647
                logger.info("Checker for %(name)s failed",
 
648
                            vars(self))
982
649
        else:
983
650
            self.last_checker_status = -1
984
 
            self.last_checker_signal = -returncode
985
651
            logger.warning("Checker for %(name)s crashed?",
986
652
                           vars(self))
987
 
        return False
988
653
    
989
654
    def checked_ok(self):
990
655
        """Assert that the client has been seen, alive and well."""
991
656
        self.last_checked_ok = datetime.datetime.utcnow()
992
657
        self.last_checker_status = 0
993
 
        self.last_checker_signal = None
994
658
        self.bump_timeout()
995
659
    
996
660
    def bump_timeout(self, timeout=None):
998
662
        if timeout is None:
999
663
            timeout = self.timeout
1000
664
        if self.disable_initiator_tag is not None:
1001
 
            GObject.source_remove(self.disable_initiator_tag)
 
665
            gobject.source_remove(self.disable_initiator_tag)
1002
666
            self.disable_initiator_tag = None
1003
667
        if getattr(self, "enabled", False):
1004
 
            self.disable_initiator_tag = GObject.timeout_add(
1005
 
                int(timeout.total_seconds() * 1000), self.disable)
 
668
            self.disable_initiator_tag = (gobject.timeout_add
 
669
                                          (timedelta_to_milliseconds
 
670
                                           (timeout), self.disable))
1006
671
            self.expires = datetime.datetime.utcnow() + timeout
1007
672
    
1008
673
    def need_approval(self):
1022
687
        # than 'timeout' for the client to be disabled, which is as it
1023
688
        # should be.
1024
689
        
1025
 
        if self.checker is not None and not self.checker.is_alive():
1026
 
            logger.warning("Checker was not alive; joining")
1027
 
            self.checker.join()
1028
 
            self.checker = None
 
690
        # If a checker exists, make sure it is not a zombie
 
691
        try:
 
692
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
693
        except AttributeError:
 
694
            pass
 
695
        except OSError as error:
 
696
            if error.errno != errno.ECHILD:
 
697
                raise
 
698
        else:
 
699
            if pid:
 
700
                logger.warning("Checker was a zombie")
 
701
                gobject.source_remove(self.checker_callback_tag)
 
702
                self.checker_callback(pid, status,
 
703
                                      self.current_checker_command)
1029
704
        # Start a new checker if needed
1030
705
        if self.checker is None:
1031
706
            # Escape attributes for the shell
1032
 
            escaped_attrs = {
1033
 
                attr: re.escape(str(getattr(self, attr)))
1034
 
                for attr in self.runtime_expansions }
 
707
            escaped_attrs = dict(
 
708
                (attr, re.escape(unicode(getattr(self, attr))))
 
709
                for attr in
 
710
                self.runtime_expansions)
1035
711
            try:
1036
712
                command = self.checker_command % escaped_attrs
1037
713
            except TypeError as error:
1038
714
                logger.error('Could not format string "%s"',
1039
 
                             self.checker_command,
 
715
                             self.checker_command, exc_info=error)
 
716
                return True # Try again later
 
717
            self.current_checker_command = command
 
718
            try:
 
719
                logger.info("Starting checker %r for %s",
 
720
                            command, self.name)
 
721
                # We don't need to redirect stdout and stderr, since
 
722
                # in normal mode, that is already done by daemon(),
 
723
                # and in debug mode we don't want to.  (Stdin is
 
724
                # always replaced by /dev/null.)
 
725
                # The exception is when not debugging but nevertheless
 
726
                # running in the foreground; use the previously
 
727
                # created wnull.
 
728
                popen_args = {}
 
729
                if (not self.server_settings["debug"]
 
730
                    and self.server_settings["foreground"]):
 
731
                    popen_args.update({"stdout": wnull,
 
732
                                       "stderr": wnull })
 
733
                self.checker = subprocess.Popen(command,
 
734
                                                close_fds=True,
 
735
                                                shell=True, cwd="/",
 
736
                                                **popen_args)
 
737
            except OSError as error:
 
738
                logger.error("Failed to start subprocess",
1040
739
                             exc_info=error)
1041
 
                return True     # Try again later
1042
 
            self.current_checker_command = command
1043
 
            logger.info("Starting checker %r for %s", command,
1044
 
                        self.name)
1045
 
            # We don't need to redirect stdout and stderr, since
1046
 
            # in normal mode, that is already done by daemon(),
1047
 
            # and in debug mode we don't want to.  (Stdin is
1048
 
            # always replaced by /dev/null.)
1049
 
            # The exception is when not debugging but nevertheless
1050
 
            # running in the foreground; use the previously
1051
 
            # created wnull.
1052
 
            popen_args = { "close_fds": True,
1053
 
                           "shell": True,
1054
 
                           "cwd": "/" }
1055
 
            if (not self.server_settings["debug"]
1056
 
                and self.server_settings["foreground"]):
1057
 
                popen_args.update({"stdout": wnull,
1058
 
                                   "stderr": wnull })
1059
 
            pipe = multiprocessing.Pipe(duplex = False)
1060
 
            self.checker = multiprocessing.Process(
1061
 
                target = call_pipe,
1062
 
                args = (pipe[1], subprocess.call, command),
1063
 
                kwargs = popen_args)
1064
 
            self.checker.start()
1065
 
            self.checker_callback_tag = GObject.io_add_watch(
1066
 
                pipe[0].fileno(), GObject.IO_IN,
1067
 
                self.checker_callback, pipe[0], command)
1068
 
        # Re-run this periodically if run by GObject.timeout_add
 
740
                return True
 
741
            self.checker_callback_tag = (gobject.child_watch_add
 
742
                                         (self.checker.pid,
 
743
                                          self.checker_callback,
 
744
                                          data=command))
 
745
            # The checker may have completed before the gobject
 
746
            # watch was added.  Check for this.
 
747
            try:
 
748
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
749
            except OSError as error:
 
750
                if error.errno == errno.ECHILD:
 
751
                    # This should never happen
 
752
                    logger.error("Child process vanished",
 
753
                                 exc_info=error)
 
754
                    return True
 
755
                raise
 
756
            if pid:
 
757
                gobject.source_remove(self.checker_callback_tag)
 
758
                self.checker_callback(pid, status, command)
 
759
        # Re-run this periodically if run by gobject.timeout_add
1069
760
        return True
1070
761
    
1071
762
    def stop_checker(self):
1072
763
        """Force the checker process, if any, to stop."""
1073
764
        if self.checker_callback_tag:
1074
 
            GObject.source_remove(self.checker_callback_tag)
 
765
            gobject.source_remove(self.checker_callback_tag)
1075
766
            self.checker_callback_tag = None
1076
767
        if getattr(self, "checker", None) is None:
1077
768
            return
1078
769
        logger.debug("Stopping checker for %(name)s", vars(self))
1079
 
        self.checker.terminate()
 
770
        try:
 
771
            self.checker.terminate()
 
772
            #time.sleep(0.5)
 
773
            #if self.checker.poll() is None:
 
774
            #    self.checker.kill()
 
775
        except OSError as error:
 
776
            if error.errno != errno.ESRCH: # No such process
 
777
                raise
1080
778
        self.checker = None
1081
779
 
1082
780
 
1083
 
def dbus_service_property(dbus_interface,
1084
 
                          signature="v",
1085
 
                          access="readwrite",
1086
 
                          byte_arrays=False):
 
781
def dbus_service_property(dbus_interface, signature="v",
 
782
                          access="readwrite", byte_arrays=False):
1087
783
    """Decorators for marking methods of a DBusObjectWithProperties to
1088
784
    become properties on the D-Bus.
1089
785
    
1098
794
    # "Set" method, so we fail early here:
1099
795
    if byte_arrays and signature != "ay":
1100
796
        raise ValueError("Byte arrays not supported for non-'ay'"
1101
 
                         " signature {!r}".format(signature))
1102
 
    
 
797
                         " signature {0!r}".format(signature))
1103
798
    def decorator(func):
1104
799
        func._dbus_is_property = True
1105
800
        func._dbus_interface = dbus_interface
1110
805
            func._dbus_name = func._dbus_name[:-14]
1111
806
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
1112
807
        return func
1113
 
    
1114
808
    return decorator
1115
809
 
1116
810
 
1125
819
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
1126
820
                    "false"}
1127
821
    """
1128
 
    
1129
822
    def decorator(func):
1130
823
        func._dbus_is_interface = True
1131
824
        func._dbus_interface = dbus_interface
1132
825
        func._dbus_name = dbus_interface
1133
826
        return func
1134
 
    
1135
827
    return decorator
1136
828
 
1137
829
 
1139
831
    """Decorator to annotate D-Bus methods, signals or properties
1140
832
    Usage:
1141
833
    
1142
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1143
 
                       "org.freedesktop.DBus.Property."
1144
 
                       "EmitsChangedSignal": "false"})
1145
834
    @dbus_service_property("org.example.Interface", signature="b",
1146
835
                           access="r")
 
836
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
 
837
                        "org.freedesktop.DBus.Property."
 
838
                        "EmitsChangedSignal": "false"})
1147
839
    def Property_dbus_property(self):
1148
840
        return dbus.Boolean(False)
1149
 
    
1150
 
    See also the DBusObjectWithAnnotations class.
1151
841
    """
1152
 
    
1153
842
    def decorator(func):
1154
843
        func._dbus_annotations = annotations
1155
844
        return func
1156
 
    
1157
845
    return decorator
1158
846
 
1159
847
 
1160
848
class DBusPropertyException(dbus.exceptions.DBusException):
1161
849
    """A base class for D-Bus property-related exceptions
1162
850
    """
1163
 
    pass
 
851
    def __unicode__(self):
 
852
        return unicode(str(self))
1164
853
 
1165
854
 
1166
855
class DBusPropertyAccessException(DBusPropertyException):
1175
864
    pass
1176
865
 
1177
866
 
1178
 
class DBusObjectWithAnnotations(dbus.service.Object):
1179
 
    """A D-Bus object with annotations.
 
867
class DBusObjectWithProperties(dbus.service.Object):
 
868
    """A D-Bus object with properties.
1180
869
    
1181
 
    Classes inheriting from this can use the dbus_annotations
1182
 
    decorator to add annotations to methods or signals.
 
870
    Classes inheriting from this can use the dbus_service_property
 
871
    decorator to expose methods as D-Bus properties.  It exposes the
 
872
    standard Get(), Set(), and GetAll() methods on the D-Bus.
1183
873
    """
1184
874
    
1185
875
    @staticmethod
1189
879
        If called like _is_dbus_thing("method") it returns a function
1190
880
        suitable for use as predicate to inspect.getmembers().
1191
881
        """
1192
 
        return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
 
882
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
1193
883
                                   False)
1194
884
    
1195
885
    def _get_all_dbus_things(self, thing):
1196
886
        """Returns a generator of (name, attribute) pairs
1197
887
        """
1198
 
        return ((getattr(athing.__get__(self), "_dbus_name", name),
 
888
        return ((getattr(athing.__get__(self), "_dbus_name",
 
889
                         name),
1199
890
                 athing.__get__(self))
1200
891
                for cls in self.__class__.__mro__
1201
892
                for name, athing in
1202
 
                inspect.getmembers(cls, self._is_dbus_thing(thing)))
1203
 
    
1204
 
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1205
 
                         out_signature = "s",
1206
 
                         path_keyword = 'object_path',
1207
 
                         connection_keyword = 'connection')
1208
 
    def Introspect(self, object_path, connection):
1209
 
        """Overloading of standard D-Bus method.
1210
 
        
1211
 
        Inserts annotation tags on methods and signals.
1212
 
        """
1213
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
1214
 
                                                   connection)
1215
 
        try:
1216
 
            document = xml.dom.minidom.parseString(xmlstring)
1217
 
            
1218
 
            for if_tag in document.getElementsByTagName("interface"):
1219
 
                # Add annotation tags
1220
 
                for typ in ("method", "signal"):
1221
 
                    for tag in if_tag.getElementsByTagName(typ):
1222
 
                        annots = dict()
1223
 
                        for name, prop in (self.
1224
 
                                           _get_all_dbus_things(typ)):
1225
 
                            if (name == tag.getAttribute("name")
1226
 
                                and prop._dbus_interface
1227
 
                                == if_tag.getAttribute("name")):
1228
 
                                annots.update(getattr(
1229
 
                                    prop, "_dbus_annotations", {}))
1230
 
                        for name, value in annots.items():
1231
 
                            ann_tag = document.createElement(
1232
 
                                "annotation")
1233
 
                            ann_tag.setAttribute("name", name)
1234
 
                            ann_tag.setAttribute("value", value)
1235
 
                            tag.appendChild(ann_tag)
1236
 
                # Add interface annotation tags
1237
 
                for annotation, value in dict(
1238
 
                    itertools.chain.from_iterable(
1239
 
                        annotations().items()
1240
 
                        for name, annotations
1241
 
                        in self._get_all_dbus_things("interface")
1242
 
                        if name == if_tag.getAttribute("name")
1243
 
                        )).items():
1244
 
                    ann_tag = document.createElement("annotation")
1245
 
                    ann_tag.setAttribute("name", annotation)
1246
 
                    ann_tag.setAttribute("value", value)
1247
 
                    if_tag.appendChild(ann_tag)
1248
 
                # Fix argument name for the Introspect method itself
1249
 
                if (if_tag.getAttribute("name")
1250
 
                                == dbus.INTROSPECTABLE_IFACE):
1251
 
                    for cn in if_tag.getElementsByTagName("method"):
1252
 
                        if cn.getAttribute("name") == "Introspect":
1253
 
                            for arg in cn.getElementsByTagName("arg"):
1254
 
                                if (arg.getAttribute("direction")
1255
 
                                    == "out"):
1256
 
                                    arg.setAttribute("name",
1257
 
                                                     "xml_data")
1258
 
            xmlstring = document.toxml("utf-8")
1259
 
            document.unlink()
1260
 
        except (AttributeError, xml.dom.DOMException,
1261
 
                xml.parsers.expat.ExpatError) as error:
1262
 
            logger.error("Failed to override Introspection method",
1263
 
                         exc_info=error)
1264
 
        return xmlstring
1265
 
 
1266
 
 
1267
 
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1268
 
    """A D-Bus object with properties.
1269
 
    
1270
 
    Classes inheriting from this can use the dbus_service_property
1271
 
    decorator to expose methods as D-Bus properties.  It exposes the
1272
 
    standard Get(), Set(), and GetAll() methods on the D-Bus.
1273
 
    """
 
893
                inspect.getmembers(cls,
 
894
                                   self._is_dbus_thing(thing)))
1274
895
    
1275
896
    def _get_dbus_property(self, interface_name, property_name):
1276
897
        """Returns a bound method if one exists which is a D-Bus
1277
898
        property with the specified name and interface.
1278
899
        """
1279
 
        for cls in self.__class__.__mro__:
1280
 
            for name, value in inspect.getmembers(
1281
 
                    cls, self._is_dbus_thing("property")):
 
900
        for cls in  self.__class__.__mro__:
 
901
            for name, value in (inspect.getmembers
 
902
                                (cls,
 
903
                                 self._is_dbus_thing("property"))):
1282
904
                if (value._dbus_name == property_name
1283
905
                    and value._dbus_interface == interface_name):
1284
906
                    return value.__get__(self)
1285
907
        
1286
908
        # No such property
1287
 
        raise DBusPropertyNotFound("{}:{}.{}".format(
1288
 
            self.dbus_object_path, interface_name, property_name))
1289
 
    
1290
 
    @classmethod
1291
 
    def _get_all_interface_names(cls):
1292
 
        """Get a sequence of all interfaces supported by an object"""
1293
 
        return (name for name in set(getattr(getattr(x, attr),
1294
 
                                             "_dbus_interface", None)
1295
 
                                     for x in (inspect.getmro(cls))
1296
 
                                     for attr in dir(x))
1297
 
                if name is not None)
1298
 
    
1299
 
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1300
 
                         in_signature="ss",
 
909
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
 
910
                                   + interface_name + "."
 
911
                                   + property_name)
 
912
    
 
913
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1301
914
                         out_signature="v")
1302
915
    def Get(self, interface_name, property_name):
1303
916
        """Standard D-Bus property Get() method, see D-Bus standard.
1322
935
            # signatures other than "ay".
1323
936
            if prop._dbus_signature != "ay":
1324
937
                raise ValueError("Byte arrays not supported for non-"
1325
 
                                 "'ay' signature {!r}"
 
938
                                 "'ay' signature {0!r}"
1326
939
                                 .format(prop._dbus_signature))
1327
940
            value = dbus.ByteArray(b''.join(chr(byte)
1328
941
                                            for byte in value))
1329
942
        prop(value)
1330
943
    
1331
 
    @dbus.service.method(dbus.PROPERTIES_IFACE,
1332
 
                         in_signature="s",
 
944
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
1333
945
                         out_signature="a{sv}")
1334
946
    def GetAll(self, interface_name):
1335
947
        """Standard D-Bus property GetAll() method, see D-Bus
1350
962
            if not hasattr(value, "variant_level"):
1351
963
                properties[name] = value
1352
964
                continue
1353
 
            properties[name] = type(value)(
1354
 
                value, variant_level = value.variant_level + 1)
 
965
            properties[name] = type(value)(value, variant_level=
 
966
                                           value.variant_level+1)
1355
967
        return dbus.Dictionary(properties, signature="sv")
1356
968
    
1357
 
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1358
 
    def PropertiesChanged(self, interface_name, changed_properties,
1359
 
                          invalidated_properties):
1360
 
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
1361
 
        standard.
1362
 
        """
1363
 
        pass
1364
 
    
1365
969
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1366
970
                         out_signature="s",
1367
971
                         path_keyword='object_path',
1371
975
        
1372
976
        Inserts property tags and interface annotation tags.
1373
977
        """
1374
 
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
1375
 
                                                         object_path,
1376
 
                                                         connection)
 
978
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
979
                                                   connection)
1377
980
        try:
1378
981
            document = xml.dom.minidom.parseString(xmlstring)
1379
 
            
1380
982
            def make_tag(document, name, prop):
1381
983
                e = document.createElement("property")
1382
984
                e.setAttribute("name", name)
1383
985
                e.setAttribute("type", prop._dbus_signature)
1384
986
                e.setAttribute("access", prop._dbus_access)
1385
987
                return e
1386
 
            
1387
988
            for if_tag in document.getElementsByTagName("interface"):
1388
989
                # Add property tags
1389
990
                for tag in (make_tag(document, name, prop)
1392
993
                            if prop._dbus_interface
1393
994
                            == if_tag.getAttribute("name")):
1394
995
                    if_tag.appendChild(tag)
1395
 
                # Add annotation tags for properties
1396
 
                for tag in if_tag.getElementsByTagName("property"):
1397
 
                    annots = dict()
1398
 
                    for name, prop in self._get_all_dbus_things(
1399
 
                            "property"):
1400
 
                        if (name == tag.getAttribute("name")
1401
 
                            and prop._dbus_interface
1402
 
                            == if_tag.getAttribute("name")):
1403
 
                            annots.update(getattr(
1404
 
                                prop, "_dbus_annotations", {}))
1405
 
                    for name, value in annots.items():
1406
 
                        ann_tag = document.createElement(
1407
 
                            "annotation")
1408
 
                        ann_tag.setAttribute("name", name)
1409
 
                        ann_tag.setAttribute("value", value)
1410
 
                        tag.appendChild(ann_tag)
 
996
                # Add annotation tags
 
997
                for typ in ("method", "signal", "property"):
 
998
                    for tag in if_tag.getElementsByTagName(typ):
 
999
                        annots = dict()
 
1000
                        for name, prop in (self.
 
1001
                                           _get_all_dbus_things(typ)):
 
1002
                            if (name == tag.getAttribute("name")
 
1003
                                and prop._dbus_interface
 
1004
                                == if_tag.getAttribute("name")):
 
1005
                                annots.update(getattr
 
1006
                                              (prop,
 
1007
                                               "_dbus_annotations",
 
1008
                                               {}))
 
1009
                        for name, value in annots.iteritems():
 
1010
                            ann_tag = document.createElement(
 
1011
                                "annotation")
 
1012
                            ann_tag.setAttribute("name", name)
 
1013
                            ann_tag.setAttribute("value", value)
 
1014
                            tag.appendChild(ann_tag)
 
1015
                # Add interface annotation tags
 
1016
                for annotation, value in dict(
 
1017
                    itertools.chain.from_iterable(
 
1018
                        annotations().iteritems()
 
1019
                        for name, annotations in
 
1020
                        self._get_all_dbus_things("interface")
 
1021
                        if name == if_tag.getAttribute("name")
 
1022
                        )).iteritems():
 
1023
                    ann_tag = document.createElement("annotation")
 
1024
                    ann_tag.setAttribute("name", annotation)
 
1025
                    ann_tag.setAttribute("value", value)
 
1026
                    if_tag.appendChild(ann_tag)
1411
1027
                # Add the names to the return values for the
1412
1028
                # "org.freedesktop.DBus.Properties" methods
1413
1029
                if (if_tag.getAttribute("name")
1431
1047
                         exc_info=error)
1432
1048
        return xmlstring
1433
1049
 
1434
 
try:
1435
 
    dbus.OBJECT_MANAGER_IFACE
1436
 
except AttributeError:
1437
 
    dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1438
 
 
1439
 
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1440
 
    """A D-Bus object with an ObjectManager.
1441
 
    
1442
 
    Classes inheriting from this exposes the standard
1443
 
    GetManagedObjects call and the InterfacesAdded and
1444
 
    InterfacesRemoved signals on the standard
1445
 
    "org.freedesktop.DBus.ObjectManager" interface.
1446
 
    
1447
 
    Note: No signals are sent automatically; they must be sent
1448
 
    manually.
1449
 
    """
1450
 
    @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1451
 
                         out_signature = "a{oa{sa{sv}}}")
1452
 
    def GetManagedObjects(self):
1453
 
        """This function must be overridden"""
1454
 
        raise NotImplementedError()
1455
 
    
1456
 
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1457
 
                         signature = "oa{sa{sv}}")
1458
 
    def InterfacesAdded(self, object_path, interfaces_and_properties):
1459
 
        pass
1460
 
    
1461
 
    @dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1462
 
    def InterfacesRemoved(self, object_path, interfaces):
1463
 
        pass
1464
 
    
1465
 
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1466
 
                         out_signature = "s",
1467
 
                         path_keyword = 'object_path',
1468
 
                         connection_keyword = 'connection')
1469
 
    def Introspect(self, object_path, connection):
1470
 
        """Overloading of standard D-Bus method.
1471
 
        
1472
 
        Override return argument name of GetManagedObjects to be
1473
 
        "objpath_interfaces_and_properties"
1474
 
        """
1475
 
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
1476
 
                                                         object_path,
1477
 
                                                         connection)
1478
 
        try:
1479
 
            document = xml.dom.minidom.parseString(xmlstring)
1480
 
            
1481
 
            for if_tag in document.getElementsByTagName("interface"):
1482
 
                # Fix argument name for the GetManagedObjects method
1483
 
                if (if_tag.getAttribute("name")
1484
 
                                == dbus.OBJECT_MANAGER_IFACE):
1485
 
                    for cn in if_tag.getElementsByTagName("method"):
1486
 
                        if (cn.getAttribute("name")
1487
 
                            == "GetManagedObjects"):
1488
 
                            for arg in cn.getElementsByTagName("arg"):
1489
 
                                if (arg.getAttribute("direction")
1490
 
                                    == "out"):
1491
 
                                    arg.setAttribute(
1492
 
                                        "name",
1493
 
                                        "objpath_interfaces"
1494
 
                                        "_and_properties")
1495
 
            xmlstring = document.toxml("utf-8")
1496
 
            document.unlink()
1497
 
        except (AttributeError, xml.dom.DOMException,
1498
 
                xml.parsers.expat.ExpatError) as error:
1499
 
            logger.error("Failed to override Introspection method",
1500
 
                         exc_info = error)
1501
 
        return xmlstring
1502
1050
 
1503
1051
def datetime_to_dbus(dt, variant_level=0):
1504
1052
    """Convert a UTC datetime.datetime() to a D-Bus type."""
1505
1053
    if dt is None:
1506
1054
        return dbus.String("", variant_level = variant_level)
1507
 
    return dbus.String(dt.isoformat(), variant_level=variant_level)
 
1055
    return dbus.String(dt.isoformat(),
 
1056
                       variant_level=variant_level)
1508
1057
 
1509
1058
 
1510
1059
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1530
1079
    (from DBusObjectWithProperties) and interfaces (from the
1531
1080
    dbus_interface_annotations decorator).
1532
1081
    """
1533
 
    
1534
1082
    def wrapper(cls):
1535
1083
        for orig_interface_name, alt_interface_name in (
1536
 
                alt_interface_names.items()):
 
1084
            alt_interface_names.iteritems()):
1537
1085
            attr = {}
1538
1086
            interface_names = set()
1539
1087
            # Go though all attributes of the class
1541
1089
                # Ignore non-D-Bus attributes, and D-Bus attributes
1542
1090
                # with the wrong interface name
1543
1091
                if (not hasattr(attribute, "_dbus_interface")
1544
 
                    or not attribute._dbus_interface.startswith(
1545
 
                        orig_interface_name)):
 
1092
                    or not attribute._dbus_interface
 
1093
                    .startswith(orig_interface_name)):
1546
1094
                    continue
1547
1095
                # Create an alternate D-Bus interface name based on
1548
1096
                # the current name
1549
 
                alt_interface = attribute._dbus_interface.replace(
1550
 
                    orig_interface_name, alt_interface_name)
 
1097
                alt_interface = (attribute._dbus_interface
 
1098
                                 .replace(orig_interface_name,
 
1099
                                          alt_interface_name))
1551
1100
                interface_names.add(alt_interface)
1552
1101
                # Is this a D-Bus signal?
1553
1102
                if getattr(attribute, "_dbus_is_signal", False):
1554
1103
                    # Extract the original non-method undecorated
1555
1104
                    # function by black magic
1556
 
                    if sys.version_info.major == 2:
1557
 
                        nonmethod_func = (dict(
 
1105
                    nonmethod_func = (dict(
1558
1106
                            zip(attribute.func_code.co_freevars,
1559
 
                                attribute.__closure__))
1560
 
                                          ["func"].cell_contents)
1561
 
                    else:
1562
 
                        nonmethod_func = (dict(
1563
 
                            zip(attribute.__code__.co_freevars,
1564
 
                                attribute.__closure__))
1565
 
                                          ["func"].cell_contents)
 
1107
                                attribute.__closure__))["func"]
 
1108
                                      .cell_contents)
1566
1109
                    # Create a new, but exactly alike, function
1567
1110
                    # object, and decorate it to be a new D-Bus signal
1568
1111
                    # with the alternate D-Bus interface name
1569
 
                    new_function = copy_function(nonmethod_func)
1570
 
                    new_function = (dbus.service.signal(
1571
 
                        alt_interface,
1572
 
                        attribute._dbus_signature)(new_function))
 
1112
                    new_function = (dbus.service.signal
 
1113
                                    (alt_interface,
 
1114
                                     attribute._dbus_signature)
 
1115
                                    (types.FunctionType(
 
1116
                                nonmethod_func.func_code,
 
1117
                                nonmethod_func.func_globals,
 
1118
                                nonmethod_func.func_name,
 
1119
                                nonmethod_func.func_defaults,
 
1120
                                nonmethod_func.func_closure)))
1573
1121
                    # Copy annotations, if any
1574
1122
                    try:
1575
 
                        new_function._dbus_annotations = dict(
1576
 
                            attribute._dbus_annotations)
 
1123
                        new_function._dbus_annotations = (
 
1124
                            dict(attribute._dbus_annotations))
1577
1125
                    except AttributeError:
1578
1126
                        pass
1579
1127
                    # Define a creator of a function to call both the
1584
1132
                        """This function is a scope container to pass
1585
1133
                        func1 and func2 to the "call_both" function
1586
1134
                        outside of its arguments"""
1587
 
                        
1588
 
                        @functools.wraps(func2)
1589
1135
                        def call_both(*args, **kwargs):
1590
1136
                            """This function will emit two D-Bus
1591
1137
                            signals by calling func1 and func2"""
1592
1138
                            func1(*args, **kwargs)
1593
1139
                            func2(*args, **kwargs)
1594
 
                        # Make wrapper function look like a D-Bus signal
1595
 
                        for name, attr in inspect.getmembers(func2):
1596
 
                            if name.startswith("_dbus_"):
1597
 
                                setattr(call_both, name, attr)
1598
 
                        
1599
1140
                        return call_both
1600
1141
                    # Create the "call_both" function and add it to
1601
1142
                    # the class
1606
1147
                    # object.  Decorate it to be a new D-Bus method
1607
1148
                    # with the alternate D-Bus interface name.  Add it
1608
1149
                    # to the class.
1609
 
                    attr[attrname] = (
1610
 
                        dbus.service.method(
1611
 
                            alt_interface,
1612
 
                            attribute._dbus_in_signature,
1613
 
                            attribute._dbus_out_signature)
1614
 
                        (copy_function(attribute)))
 
1150
                    attr[attrname] = (dbus.service.method
 
1151
                                      (alt_interface,
 
1152
                                       attribute._dbus_in_signature,
 
1153
                                       attribute._dbus_out_signature)
 
1154
                                      (types.FunctionType
 
1155
                                       (attribute.func_code,
 
1156
                                        attribute.func_globals,
 
1157
                                        attribute.func_name,
 
1158
                                        attribute.func_defaults,
 
1159
                                        attribute.func_closure)))
1615
1160
                    # Copy annotations, if any
1616
1161
                    try:
1617
 
                        attr[attrname]._dbus_annotations = dict(
1618
 
                            attribute._dbus_annotations)
 
1162
                        attr[attrname]._dbus_annotations = (
 
1163
                            dict(attribute._dbus_annotations))
1619
1164
                    except AttributeError:
1620
1165
                        pass
1621
1166
                # Is this a D-Bus property?
1624
1169
                    # object, and decorate it to be a new D-Bus
1625
1170
                    # property with the alternate D-Bus interface
1626
1171
                    # name.  Add it to the class.
1627
 
                    attr[attrname] = (dbus_service_property(
1628
 
                        alt_interface, attribute._dbus_signature,
1629
 
                        attribute._dbus_access,
1630
 
                        attribute._dbus_get_args_options
1631
 
                        ["byte_arrays"])
1632
 
                                      (copy_function(attribute)))
 
1172
                    attr[attrname] = (dbus_service_property
 
1173
                                      (alt_interface,
 
1174
                                       attribute._dbus_signature,
 
1175
                                       attribute._dbus_access,
 
1176
                                       attribute
 
1177
                                       ._dbus_get_args_options
 
1178
                                       ["byte_arrays"])
 
1179
                                      (types.FunctionType
 
1180
                                       (attribute.func_code,
 
1181
                                        attribute.func_globals,
 
1182
                                        attribute.func_name,
 
1183
                                        attribute.func_defaults,
 
1184
                                        attribute.func_closure)))
1633
1185
                    # Copy annotations, if any
1634
1186
                    try:
1635
 
                        attr[attrname]._dbus_annotations = dict(
1636
 
                            attribute._dbus_annotations)
 
1187
                        attr[attrname]._dbus_annotations = (
 
1188
                            dict(attribute._dbus_annotations))
1637
1189
                    except AttributeError:
1638
1190
                        pass
1639
1191
                # Is this a D-Bus interface?
1642
1194
                    # object.  Decorate it to be a new D-Bus interface
1643
1195
                    # with the alternate D-Bus interface name.  Add it
1644
1196
                    # to the class.
1645
 
                    attr[attrname] = (
1646
 
                        dbus_interface_annotations(alt_interface)
1647
 
                        (copy_function(attribute)))
 
1197
                    attr[attrname] = (dbus_interface_annotations
 
1198
                                      (alt_interface)
 
1199
                                      (types.FunctionType
 
1200
                                       (attribute.func_code,
 
1201
                                        attribute.func_globals,
 
1202
                                        attribute.func_name,
 
1203
                                        attribute.func_defaults,
 
1204
                                        attribute.func_closure)))
1648
1205
            if deprecate:
1649
1206
                # Deprecate all alternate interfaces
1650
 
                iname="_AlternateDBusNames_interface_annotation{}"
 
1207
                iname="_AlternateDBusNames_interface_annotation{0}"
1651
1208
                for interface_name in interface_names:
1652
 
                    
1653
1209
                    @dbus_interface_annotations(interface_name)
1654
1210
                    def func(self):
1655
1211
                        return { "org.freedesktop.DBus.Deprecated":
1656
 
                                 "true" }
 
1212
                                     "true" }
1657
1213
                    # Find an unused name
1658
1214
                    for aname in (iname.format(i)
1659
1215
                                  for i in itertools.count()):
1663
1219
            if interface_names:
1664
1220
                # Replace the class with a new subclass of it with
1665
1221
                # methods, signals, etc. as created above.
1666
 
                if sys.version_info.major == 2:
1667
 
                    cls = type(b"{}Alternate".format(cls.__name__),
1668
 
                               (cls, ), attr)
1669
 
                else:
1670
 
                    cls = type("{}Alternate".format(cls.__name__),
1671
 
                               (cls, ), attr)
 
1222
                cls = type(b"{0}Alternate".format(cls.__name__),
 
1223
                           (cls,), attr)
1672
1224
        return cls
1673
 
    
1674
1225
    return wrapper
1675
1226
 
1676
1227
 
1677
1228
@alternate_dbus_interfaces({"se.recompile.Mandos":
1678
 
                            "se.bsnet.fukt.Mandos"})
 
1229
                                "se.bsnet.fukt.Mandos"})
1679
1230
class ClientDBus(Client, DBusObjectWithProperties):
1680
1231
    """A Client class using D-Bus
1681
1232
    
1685
1236
    """
1686
1237
    
1687
1238
    runtime_expansions = (Client.runtime_expansions
1688
 
                          + ("dbus_object_path", ))
1689
 
    
1690
 
    _interface = "se.recompile.Mandos.Client"
 
1239
                          + ("dbus_object_path",))
1691
1240
    
1692
1241
    # dbus.service.Object doesn't use super(), so we can't either.
1693
1242
    
1696
1245
        Client.__init__(self, *args, **kwargs)
1697
1246
        # Only now, when this client is initialized, can it show up on
1698
1247
        # the D-Bus
1699
 
        client_object_name = str(self.name).translate(
 
1248
        client_object_name = unicode(self.name).translate(
1700
1249
            {ord("."): ord("_"),
1701
1250
             ord("-"): ord("_")})
1702
 
        self.dbus_object_path = dbus.ObjectPath(
1703
 
            "/clients/" + client_object_name)
 
1251
        self.dbus_object_path = (dbus.ObjectPath
 
1252
                                 ("/clients/" + client_object_name))
1704
1253
        DBusObjectWithProperties.__init__(self, self.bus,
1705
1254
                                          self.dbus_object_path)
1706
1255
    
1707
 
    def notifychangeproperty(transform_func, dbus_name,
1708
 
                             type_func=lambda x: x,
1709
 
                             variant_level=1,
1710
 
                             invalidate_only=False,
1711
 
                             _interface=_interface):
 
1256
    def notifychangeproperty(transform_func,
 
1257
                             dbus_name, type_func=lambda x: x,
 
1258
                             variant_level=1):
1712
1259
        """ Modify a variable so that it's a property which announces
1713
1260
        its changes to DBus.
1714
1261
        
1719
1266
                   to the D-Bus.  Default: no transform
1720
1267
        variant_level: D-Bus variant level.  Default: 1
1721
1268
        """
1722
 
        attrname = "_{}".format(dbus_name)
1723
 
        
 
1269
        attrname = "_{0}".format(dbus_name)
1724
1270
        def setter(self, value):
1725
1271
            if hasattr(self, "dbus_object_path"):
1726
1272
                if (not hasattr(self, attrname) or
1727
1273
                    type_func(getattr(self, attrname, None))
1728
1274
                    != type_func(value)):
1729
 
                    if invalidate_only:
1730
 
                        self.PropertiesChanged(
1731
 
                            _interface, dbus.Dictionary(),
1732
 
                            dbus.Array((dbus_name, )))
1733
 
                    else:
1734
 
                        dbus_value = transform_func(
1735
 
                            type_func(value),
1736
 
                            variant_level = variant_level)
1737
 
                        self.PropertyChanged(dbus.String(dbus_name),
1738
 
                                             dbus_value)
1739
 
                        self.PropertiesChanged(
1740
 
                            _interface,
1741
 
                            dbus.Dictionary({ dbus.String(dbus_name):
1742
 
                                              dbus_value }),
1743
 
                            dbus.Array())
 
1275
                    dbus_value = transform_func(type_func(value),
 
1276
                                                variant_level
 
1277
                                                =variant_level)
 
1278
                    self.PropertyChanged(dbus.String(dbus_name),
 
1279
                                         dbus_value)
1744
1280
            setattr(self, attrname, value)
1745
1281
        
1746
1282
        return property(lambda self: getattr(self, attrname), setter)
1752
1288
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1753
1289
    last_enabled = notifychangeproperty(datetime_to_dbus,
1754
1290
                                        "LastEnabled")
1755
 
    checker = notifychangeproperty(
1756
 
        dbus.Boolean, "CheckerRunning",
1757
 
        type_func = lambda checker: checker is not None)
 
1291
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
 
1292
                                   type_func = lambda checker:
 
1293
                                       checker is not None)
1758
1294
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1759
1295
                                           "LastCheckedOK")
1760
1296
    last_checker_status = notifychangeproperty(dbus.Int16,
1763
1299
        datetime_to_dbus, "LastApprovalRequest")
1764
1300
    approved_by_default = notifychangeproperty(dbus.Boolean,
1765
1301
                                               "ApprovedByDefault")
1766
 
    approval_delay = notifychangeproperty(
1767
 
        dbus.UInt64, "ApprovalDelay",
1768
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1302
    approval_delay = notifychangeproperty(dbus.UInt64,
 
1303
                                          "ApprovalDelay",
 
1304
                                          type_func =
 
1305
                                          timedelta_to_milliseconds)
1769
1306
    approval_duration = notifychangeproperty(
1770
1307
        dbus.UInt64, "ApprovalDuration",
1771
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1308
        type_func = timedelta_to_milliseconds)
1772
1309
    host = notifychangeproperty(dbus.String, "Host")
1773
 
    timeout = notifychangeproperty(
1774
 
        dbus.UInt64, "Timeout",
1775
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1310
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
1311
                                   type_func =
 
1312
                                   timedelta_to_milliseconds)
1776
1313
    extended_timeout = notifychangeproperty(
1777
1314
        dbus.UInt64, "ExtendedTimeout",
1778
 
        type_func = lambda td: td.total_seconds() * 1000)
1779
 
    interval = notifychangeproperty(
1780
 
        dbus.UInt64, "Interval",
1781
 
        type_func = lambda td: td.total_seconds() * 1000)
 
1315
        type_func = timedelta_to_milliseconds)
 
1316
    interval = notifychangeproperty(dbus.UInt64,
 
1317
                                    "Interval",
 
1318
                                    type_func =
 
1319
                                    timedelta_to_milliseconds)
1782
1320
    checker_command = notifychangeproperty(dbus.String, "Checker")
1783
 
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
1784
 
                                  invalidate_only=True)
1785
1321
    
1786
1322
    del notifychangeproperty
1787
1323
    
1794
1330
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1795
1331
        Client.__del__(self, *args, **kwargs)
1796
1332
    
1797
 
    def checker_callback(self, source, condition,
1798
 
                         connection, command, *args, **kwargs):
1799
 
        ret = Client.checker_callback(self, source, condition,
1800
 
                                      connection, command, *args,
1801
 
                                      **kwargs)
1802
 
        exitstatus = self.last_checker_status
1803
 
        if exitstatus >= 0:
 
1333
    def checker_callback(self, pid, condition, command,
 
1334
                         *args, **kwargs):
 
1335
        self.checker_callback_tag = None
 
1336
        self.checker = None
 
1337
        if os.WIFEXITED(condition):
 
1338
            exitstatus = os.WEXITSTATUS(condition)
1804
1339
            # Emit D-Bus signal
1805
1340
            self.CheckerCompleted(dbus.Int16(exitstatus),
1806
 
                                  # This is specific to GNU libC
1807
 
                                  dbus.Int64(exitstatus << 8),
 
1341
                                  dbus.Int64(condition),
1808
1342
                                  dbus.String(command))
1809
1343
        else:
1810
1344
            # Emit D-Bus signal
1811
1345
            self.CheckerCompleted(dbus.Int16(-1),
1812
 
                                  dbus.Int64(
1813
 
                                      # This is specific to GNU libC
1814
 
                                      (exitstatus << 8)
1815
 
                                      | self.last_checker_signal),
 
1346
                                  dbus.Int64(condition),
1816
1347
                                  dbus.String(command))
1817
 
        return ret
 
1348
        
 
1349
        return Client.checker_callback(self, pid, condition, command,
 
1350
                                       *args, **kwargs)
1818
1351
    
1819
1352
    def start_checker(self, *args, **kwargs):
1820
 
        old_checker_pid = getattr(self.checker, "pid", None)
 
1353
        old_checker = self.checker
 
1354
        if self.checker is not None:
 
1355
            old_checker_pid = self.checker.pid
 
1356
        else:
 
1357
            old_checker_pid = None
1821
1358
        r = Client.start_checker(self, *args, **kwargs)
1822
1359
        # Only if new checker process was started
1823
1360
        if (self.checker is not None
1832
1369
    
1833
1370
    def approve(self, value=True):
1834
1371
        self.approved = value
1835
 
        GObject.timeout_add(int(self.approval_duration.total_seconds()
1836
 
                                * 1000), self._reset_approved)
 
1372
        gobject.timeout_add(timedelta_to_milliseconds
 
1373
                            (self.approval_duration),
 
1374
                            self._reset_approved)
1837
1375
        self.send_changedstate()
1838
1376
    
1839
1377
    ## D-Bus methods, signals & properties
 
1378
    _interface = "se.recompile.Mandos.Client"
1840
1379
    
1841
1380
    ## Interfaces
1842
1381
    
 
1382
    @dbus_interface_annotations(_interface)
 
1383
    def _foo(self):
 
1384
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1385
                     "false"}
 
1386
    
1843
1387
    ## Signals
1844
1388
    
1845
1389
    # CheckerCompleted - signal
1855
1399
        pass
1856
1400
    
1857
1401
    # PropertyChanged - signal
1858
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1859
1402
    @dbus.service.signal(_interface, signature="sv")
1860
1403
    def PropertyChanged(self, property, value):
1861
1404
        "D-Bus signal"
1895
1438
        self.checked_ok()
1896
1439
    
1897
1440
    # Enable - method
1898
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1899
1441
    @dbus.service.method(_interface)
1900
1442
    def Enable(self):
1901
1443
        "D-Bus method"
1902
1444
        self.enable()
1903
1445
    
1904
1446
    # StartChecker - method
1905
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1906
1447
    @dbus.service.method(_interface)
1907
1448
    def StartChecker(self):
1908
1449
        "D-Bus method"
1909
1450
        self.start_checker()
1910
1451
    
1911
1452
    # Disable - method
1912
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1913
1453
    @dbus.service.method(_interface)
1914
1454
    def Disable(self):
1915
1455
        "D-Bus method"
1916
1456
        self.disable()
1917
1457
    
1918
1458
    # StopChecker - method
1919
 
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1920
1459
    @dbus.service.method(_interface)
1921
1460
    def StopChecker(self):
1922
1461
        self.stop_checker()
1929
1468
        return dbus.Boolean(bool(self.approvals_pending))
1930
1469
    
1931
1470
    # ApprovedByDefault - property
1932
 
    @dbus_service_property(_interface,
1933
 
                           signature="b",
 
1471
    @dbus_service_property(_interface, signature="b",
1934
1472
                           access="readwrite")
1935
1473
    def ApprovedByDefault_dbus_property(self, value=None):
1936
1474
        if value is None:       # get
1938
1476
        self.approved_by_default = bool(value)
1939
1477
    
1940
1478
    # ApprovalDelay - property
1941
 
    @dbus_service_property(_interface,
1942
 
                           signature="t",
 
1479
    @dbus_service_property(_interface, signature="t",
1943
1480
                           access="readwrite")
1944
1481
    def ApprovalDelay_dbus_property(self, value=None):
1945
1482
        if value is None:       # get
1946
 
            return dbus.UInt64(self.approval_delay.total_seconds()
1947
 
                               * 1000)
 
1483
            return dbus.UInt64(self.approval_delay_milliseconds())
1948
1484
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1949
1485
    
1950
1486
    # ApprovalDuration - property
1951
 
    @dbus_service_property(_interface,
1952
 
                           signature="t",
 
1487
    @dbus_service_property(_interface, signature="t",
1953
1488
                           access="readwrite")
1954
1489
    def ApprovalDuration_dbus_property(self, value=None):
1955
1490
        if value is None:       # get
1956
 
            return dbus.UInt64(self.approval_duration.total_seconds()
1957
 
                               * 1000)
 
1491
            return dbus.UInt64(timedelta_to_milliseconds(
 
1492
                    self.approval_duration))
1958
1493
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1959
1494
    
1960
1495
    # Name - property
1961
 
    @dbus_annotations(
1962
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1963
1496
    @dbus_service_property(_interface, signature="s", access="read")
1964
1497
    def Name_dbus_property(self):
1965
1498
        return dbus.String(self.name)
1966
1499
    
1967
1500
    # Fingerprint - property
1968
 
    @dbus_annotations(
1969
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1970
1501
    @dbus_service_property(_interface, signature="s", access="read")
1971
1502
    def Fingerprint_dbus_property(self):
1972
1503
        return dbus.String(self.fingerprint)
1973
1504
    
1974
1505
    # Host - property
1975
 
    @dbus_service_property(_interface,
1976
 
                           signature="s",
 
1506
    @dbus_service_property(_interface, signature="s",
1977
1507
                           access="readwrite")
1978
1508
    def Host_dbus_property(self, value=None):
1979
1509
        if value is None:       # get
1980
1510
            return dbus.String(self.host)
1981
 
        self.host = str(value)
 
1511
        self.host = unicode(value)
1982
1512
    
1983
1513
    # Created - property
1984
 
    @dbus_annotations(
1985
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1986
1514
    @dbus_service_property(_interface, signature="s", access="read")
1987
1515
    def Created_dbus_property(self):
1988
1516
        return datetime_to_dbus(self.created)
1993
1521
        return datetime_to_dbus(self.last_enabled)
1994
1522
    
1995
1523
    # Enabled - property
1996
 
    @dbus_service_property(_interface,
1997
 
                           signature="b",
 
1524
    @dbus_service_property(_interface, signature="b",
1998
1525
                           access="readwrite")
1999
1526
    def Enabled_dbus_property(self, value=None):
2000
1527
        if value is None:       # get
2005
1532
            self.disable()
2006
1533
    
2007
1534
    # LastCheckedOK - property
2008
 
    @dbus_service_property(_interface,
2009
 
                           signature="s",
 
1535
    @dbus_service_property(_interface, signature="s",
2010
1536
                           access="readwrite")
2011
1537
    def LastCheckedOK_dbus_property(self, value=None):
2012
1538
        if value is not None:
2015
1541
        return datetime_to_dbus(self.last_checked_ok)
2016
1542
    
2017
1543
    # LastCheckerStatus - property
2018
 
    @dbus_service_property(_interface, signature="n", access="read")
 
1544
    @dbus_service_property(_interface, signature="n",
 
1545
                           access="read")
2019
1546
    def LastCheckerStatus_dbus_property(self):
2020
1547
        return dbus.Int16(self.last_checker_status)
2021
1548
    
2030
1557
        return datetime_to_dbus(self.last_approval_request)
2031
1558
    
2032
1559
    # Timeout - property
2033
 
    @dbus_service_property(_interface,
2034
 
                           signature="t",
 
1560
    @dbus_service_property(_interface, signature="t",
2035
1561
                           access="readwrite")
2036
1562
    def Timeout_dbus_property(self, value=None):
2037
1563
        if value is None:       # get
2038
 
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
1564
            return dbus.UInt64(self.timeout_milliseconds())
2039
1565
        old_timeout = self.timeout
2040
1566
        self.timeout = datetime.timedelta(0, 0, 0, value)
2041
1567
        # Reschedule disabling
2049
1575
                if (getattr(self, "disable_initiator_tag", None)
2050
1576
                    is None):
2051
1577
                    return
2052
 
                GObject.source_remove(self.disable_initiator_tag)
2053
 
                self.disable_initiator_tag = GObject.timeout_add(
2054
 
                    int((self.expires - now).total_seconds() * 1000),
2055
 
                    self.disable)
 
1578
                gobject.source_remove(self.disable_initiator_tag)
 
1579
                self.disable_initiator_tag = (
 
1580
                    gobject.timeout_add(
 
1581
                        timedelta_to_milliseconds(self.expires - now),
 
1582
                        self.disable))
2056
1583
    
2057
1584
    # ExtendedTimeout - property
2058
 
    @dbus_service_property(_interface,
2059
 
                           signature="t",
 
1585
    @dbus_service_property(_interface, signature="t",
2060
1586
                           access="readwrite")
2061
1587
    def ExtendedTimeout_dbus_property(self, value=None):
2062
1588
        if value is None:       # get
2063
 
            return dbus.UInt64(self.extended_timeout.total_seconds()
2064
 
                               * 1000)
 
1589
            return dbus.UInt64(self.extended_timeout_milliseconds())
2065
1590
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2066
1591
    
2067
1592
    # Interval - property
2068
 
    @dbus_service_property(_interface,
2069
 
                           signature="t",
 
1593
    @dbus_service_property(_interface, signature="t",
2070
1594
                           access="readwrite")
2071
1595
    def Interval_dbus_property(self, value=None):
2072
1596
        if value is None:       # get
2073
 
            return dbus.UInt64(self.interval.total_seconds() * 1000)
 
1597
            return dbus.UInt64(self.interval_milliseconds())
2074
1598
        self.interval = datetime.timedelta(0, 0, 0, value)
2075
1599
        if getattr(self, "checker_initiator_tag", None) is None:
2076
1600
            return
2077
1601
        if self.enabled:
2078
1602
            # Reschedule checker run
2079
 
            GObject.source_remove(self.checker_initiator_tag)
2080
 
            self.checker_initiator_tag = GObject.timeout_add(
2081
 
                value, self.start_checker)
2082
 
            self.start_checker() # Start one now, too
 
1603
            gobject.source_remove(self.checker_initiator_tag)
 
1604
            self.checker_initiator_tag = (gobject.timeout_add
 
1605
                                          (value, self.start_checker))
 
1606
            self.start_checker()    # Start one now, too
2083
1607
    
2084
1608
    # Checker - property
2085
 
    @dbus_service_property(_interface,
2086
 
                           signature="s",
 
1609
    @dbus_service_property(_interface, signature="s",
2087
1610
                           access="readwrite")
2088
1611
    def Checker_dbus_property(self, value=None):
2089
1612
        if value is None:       # get
2090
1613
            return dbus.String(self.checker_command)
2091
 
        self.checker_command = str(value)
 
1614
        self.checker_command = unicode(value)
2092
1615
    
2093
1616
    # CheckerRunning - property
2094
 
    @dbus_service_property(_interface,
2095
 
                           signature="b",
 
1617
    @dbus_service_property(_interface, signature="b",
2096
1618
                           access="readwrite")
2097
1619
    def CheckerRunning_dbus_property(self, value=None):
2098
1620
        if value is None:       # get
2103
1625
            self.stop_checker()
2104
1626
    
2105
1627
    # ObjectPath - property
2106
 
    @dbus_annotations(
2107
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2108
 
         "org.freedesktop.DBus.Deprecated": "true"})
2109
1628
    @dbus_service_property(_interface, signature="o", access="read")
2110
1629
    def ObjectPath_dbus_property(self):
2111
1630
        return self.dbus_object_path # is already a dbus.ObjectPath
2112
1631
    
2113
1632
    # Secret = property
2114
 
    @dbus_annotations(
2115
 
        {"org.freedesktop.DBus.Property.EmitsChangedSignal":
2116
 
         "invalidates"})
2117
 
    @dbus_service_property(_interface,
2118
 
                           signature="ay",
2119
 
                           access="write",
2120
 
                           byte_arrays=True)
 
1633
    @dbus_service_property(_interface, signature="ay",
 
1634
                           access="write", byte_arrays=True)
2121
1635
    def Secret_dbus_property(self, value):
2122
 
        self.secret = bytes(value)
 
1636
        self.secret = str(value)
2123
1637
    
2124
1638
    del _interface
2125
1639
 
2129
1643
        self._pipe = child_pipe
2130
1644
        self._pipe.send(('init', fpr, address))
2131
1645
        if not self._pipe.recv():
2132
 
            raise KeyError(fpr)
 
1646
            raise KeyError()
2133
1647
    
2134
1648
    def __getattribute__(self, name):
2135
1649
        if name == '_pipe':
2139
1653
        if data[0] == 'data':
2140
1654
            return data[1]
2141
1655
        if data[0] == 'function':
2142
 
            
2143
1656
            def func(*args, **kwargs):
2144
1657
                self._pipe.send(('funcall', name, args, kwargs))
2145
1658
                return self._pipe.recv()[1]
2146
 
            
2147
1659
            return func
2148
1660
    
2149
1661
    def __setattr__(self, name, value):
2161
1673
    def handle(self):
2162
1674
        with contextlib.closing(self.server.child_pipe) as child_pipe:
2163
1675
            logger.info("TCP connection from: %s",
2164
 
                        str(self.client_address))
 
1676
                        unicode(self.client_address))
2165
1677
            logger.debug("Pipe FD: %d",
2166
1678
                         self.server.child_pipe.fileno())
2167
1679
            
2168
 
            session = gnutls.ClientSession(self.request)
 
1680
            session = (gnutls.connection
 
1681
                       .ClientSession(self.request,
 
1682
                                      gnutls.connection
 
1683
                                      .X509Credentials()))
 
1684
            
 
1685
            # Note: gnutls.connection.X509Credentials is really a
 
1686
            # generic GnuTLS certificate credentials object so long as
 
1687
            # no X.509 keys are added to it.  Therefore, we can use it
 
1688
            # here despite using OpenPGP certificates.
2169
1689
            
2170
1690
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
2171
1691
            #                      "+AES-256-CBC", "+SHA1",
2175
1695
            priority = self.server.gnutls_priority
2176
1696
            if priority is None:
2177
1697
                priority = "NORMAL"
2178
 
            gnutls.priority_set_direct(session._c_object, priority,
2179
 
                                       None)
 
1698
            (gnutls.library.functions
 
1699
             .gnutls_priority_set_direct(session._c_object,
 
1700
                                         priority, None))
2180
1701
            
2181
1702
            # Start communication using the Mandos protocol
2182
1703
            # Get protocol number
2192
1713
            # Start GnuTLS connection
2193
1714
            try:
2194
1715
                session.handshake()
2195
 
            except gnutls.Error as error:
 
1716
            except gnutls.errors.GNUTLSError as error:
2196
1717
                logger.warning("Handshake failed: %s", error)
2197
1718
                # Do not run session.bye() here: the session is not
2198
1719
                # established.  Just abandon the request.
2202
1723
            approval_required = False
2203
1724
            try:
2204
1725
                try:
2205
 
                    fpr = self.fingerprint(
2206
 
                        self.peer_certificate(session))
2207
 
                except (TypeError, gnutls.Error) as error:
 
1726
                    fpr = self.fingerprint(self.peer_certificate
 
1727
                                           (session))
 
1728
                except (TypeError,
 
1729
                        gnutls.errors.GNUTLSError) as error:
2208
1730
                    logger.warning("Bad certificate: %s", error)
2209
1731
                    return
2210
1732
                logger.debug("Fingerprint: %s", fpr)
2223
1745
                while True:
2224
1746
                    if not client.enabled:
2225
1747
                        logger.info("Client %s is disabled",
2226
 
                                    client.name)
 
1748
                                       client.name)
2227
1749
                        if self.server.use_dbus:
2228
1750
                            # Emit D-Bus signal
2229
1751
                            client.Rejected("Disabled")
2238
1760
                        if self.server.use_dbus:
2239
1761
                            # Emit D-Bus signal
2240
1762
                            client.NeedApproval(
2241
 
                                client.approval_delay.total_seconds()
2242
 
                                * 1000, client.approved_by_default)
 
1763
                                client.approval_delay_milliseconds(),
 
1764
                                client.approved_by_default)
2243
1765
                    else:
2244
1766
                        logger.warning("Client %s was not approved",
2245
1767
                                       client.name)
2251
1773
                    #wait until timeout or approved
2252
1774
                    time = datetime.datetime.now()
2253
1775
                    client.changedstate.acquire()
2254
 
                    client.changedstate.wait(delay.total_seconds())
 
1776
                    client.changedstate.wait(
 
1777
                        float(timedelta_to_milliseconds(delay)
 
1778
                              / 1000))
2255
1779
                    client.changedstate.release()
2256
1780
                    time2 = datetime.datetime.now()
2257
1781
                    if (time2 - time) >= delay:
2268
1792
                    else:
2269
1793
                        delay -= time2 - time
2270
1794
                
2271
 
                try:
2272
 
                    session.send(client.secret)
2273
 
                except gnutls.Error as error:
2274
 
                    logger.warning("gnutls send failed",
2275
 
                                   exc_info = error)
2276
 
                    return
 
1795
                sent_size = 0
 
1796
                while sent_size < len(client.secret):
 
1797
                    try:
 
1798
                        sent = session.send(client.secret[sent_size:])
 
1799
                    except gnutls.errors.GNUTLSError as error:
 
1800
                        logger.warning("gnutls send failed",
 
1801
                                       exc_info=error)
 
1802
                        return
 
1803
                    logger.debug("Sent: %d, remaining: %d",
 
1804
                                 sent, len(client.secret)
 
1805
                                 - (sent_size + sent))
 
1806
                    sent_size += sent
2277
1807
                
2278
1808
                logger.info("Sending secret to %s", client.name)
2279
1809
                # bump the timeout using extended_timeout
2287
1817
                    client.approvals_pending -= 1
2288
1818
                try:
2289
1819
                    session.bye()
2290
 
                except gnutls.Error as error:
 
1820
                except gnutls.errors.GNUTLSError as error:
2291
1821
                    logger.warning("GnuTLS bye failed",
2292
1822
                                   exc_info=error)
2293
1823
    
2295
1825
    def peer_certificate(session):
2296
1826
        "Return the peer's OpenPGP certificate as a bytestring"
2297
1827
        # If not an OpenPGP certificate...
2298
 
        if (gnutls.certificate_type_get(session._c_object)
2299
 
            != gnutls.CRT_OPENPGP):
2300
 
            # ...return invalid data
2301
 
            return b""
 
1828
        if (gnutls.library.functions
 
1829
            .gnutls_certificate_type_get(session._c_object)
 
1830
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
 
1831
            # ...do the normal thing
 
1832
            return session.peer_certificate
2302
1833
        list_size = ctypes.c_uint(1)
2303
 
        cert_list = (gnutls.certificate_get_peers
 
1834
        cert_list = (gnutls.library.functions
 
1835
                     .gnutls_certificate_get_peers
2304
1836
                     (session._c_object, ctypes.byref(list_size)))
2305
1837
        if not bool(cert_list) and list_size.value != 0:
2306
 
            raise gnutls.Error("error getting peer certificate")
 
1838
            raise gnutls.errors.GNUTLSError("error getting peer"
 
1839
                                            " certificate")
2307
1840
        if list_size.value == 0:
2308
1841
            return None
2309
1842
        cert = cert_list[0]
2313
1846
    def fingerprint(openpgp):
2314
1847
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
2315
1848
        # New GnuTLS "datum" with the OpenPGP public key
2316
 
        datum = gnutls.datum_t(
2317
 
            ctypes.cast(ctypes.c_char_p(openpgp),
2318
 
                        ctypes.POINTER(ctypes.c_ubyte)),
2319
 
            ctypes.c_uint(len(openpgp)))
 
1849
        datum = (gnutls.library.types
 
1850
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
 
1851
                                             ctypes.POINTER
 
1852
                                             (ctypes.c_ubyte)),
 
1853
                                 ctypes.c_uint(len(openpgp))))
2320
1854
        # New empty GnuTLS certificate
2321
 
        crt = gnutls.openpgp_crt_t()
2322
 
        gnutls.openpgp_crt_init(ctypes.byref(crt))
 
1855
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
 
1856
        (gnutls.library.functions
 
1857
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
2323
1858
        # Import the OpenPGP public key into the certificate
2324
 
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2325
 
                                  gnutls.OPENPGP_FMT_RAW)
 
1859
        (gnutls.library.functions
 
1860
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
 
1861
                                    gnutls.library.constants
 
1862
                                    .GNUTLS_OPENPGP_FMT_RAW))
2326
1863
        # Verify the self signature in the key
2327
1864
        crtverify = ctypes.c_uint()
2328
 
        gnutls.openpgp_crt_verify_self(crt, 0,
2329
 
                                       ctypes.byref(crtverify))
 
1865
        (gnutls.library.functions
 
1866
         .gnutls_openpgp_crt_verify_self(crt, 0,
 
1867
                                         ctypes.byref(crtverify)))
2330
1868
        if crtverify.value != 0:
2331
 
            gnutls.openpgp_crt_deinit(crt)
2332
 
            raise gnutls.CertificateSecurityError("Verify failed")
 
1869
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
1870
            raise (gnutls.errors.CertificateSecurityError
 
1871
                   ("Verify failed"))
2333
1872
        # New buffer for the fingerprint
2334
1873
        buf = ctypes.create_string_buffer(20)
2335
1874
        buf_len = ctypes.c_size_t()
2336
1875
        # Get the fingerprint from the certificate into the buffer
2337
 
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2338
 
                                           ctypes.byref(buf_len))
 
1876
        (gnutls.library.functions
 
1877
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
1878
                                             ctypes.byref(buf_len)))
2339
1879
        # Deinit the certificate
2340
 
        gnutls.openpgp_crt_deinit(crt)
 
1880
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2341
1881
        # Convert the buffer to a Python bytestring
2342
1882
        fpr = ctypes.string_at(buf, buf_len.value)
2343
1883
        # Convert the bytestring to hexadecimal notation
2347
1887
 
2348
1888
class MultiprocessingMixIn(object):
2349
1889
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
2350
 
    
2351
1890
    def sub_process_main(self, request, address):
2352
1891
        try:
2353
1892
            self.finish_request(request, address)
2365
1904
 
2366
1905
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2367
1906
    """ adds a pipe to the MixIn """
2368
 
    
2369
1907
    def process_request(self, request, client_address):
2370
1908
        """Overrides and wraps the original process_request().
2371
1909
        
2392
1930
        interface:      None or a network interface name (string)
2393
1931
        use_ipv6:       Boolean; to use IPv6 or not
2394
1932
    """
2395
 
    
2396
1933
    def __init__(self, server_address, RequestHandlerClass,
2397
 
                 interface=None,
2398
 
                 use_ipv6=True,
2399
 
                 socketfd=None):
 
1934
                 interface=None, use_ipv6=True, socketfd=None):
2400
1935
        """If socketfd is set, use that file descriptor instead of
2401
1936
        creating a new one with socket.socket().
2402
1937
        """
2443
1978
                             self.interface)
2444
1979
            else:
2445
1980
                try:
2446
 
                    self.socket.setsockopt(
2447
 
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
2448
 
                        (self.interface + "\0").encode("utf-8"))
 
1981
                    self.socket.setsockopt(socket.SOL_SOCKET,
 
1982
                                           SO_BINDTODEVICE,
 
1983
                                           str(self.interface + '\0'))
2449
1984
                except socket.error as error:
2450
1985
                    if error.errno == errno.EPERM:
2451
1986
                        logger.error("No permission to bind to"
2469
2004
                self.server_address = (any_address,
2470
2005
                                       self.server_address[1])
2471
2006
            elif not self.server_address[1]:
2472
 
                self.server_address = (self.server_address[0], 0)
 
2007
                self.server_address = (self.server_address[0],
 
2008
                                       0)
2473
2009
#                 if self.interface:
2474
2010
#                     self.server_address = (self.server_address[0],
2475
2011
#                                            0, # port
2487
2023
        gnutls_priority GnuTLS priority string
2488
2024
        use_dbus:       Boolean; to emit D-Bus signals or not
2489
2025
    
2490
 
    Assumes a GObject.MainLoop event loop.
 
2026
    Assumes a gobject.MainLoop event loop.
2491
2027
    """
2492
 
    
2493
2028
    def __init__(self, server_address, RequestHandlerClass,
2494
 
                 interface=None,
2495
 
                 use_ipv6=True,
2496
 
                 clients=None,
2497
 
                 gnutls_priority=None,
2498
 
                 use_dbus=True,
2499
 
                 socketfd=None):
 
2029
                 interface=None, use_ipv6=True, clients=None,
 
2030
                 gnutls_priority=None, use_dbus=True, socketfd=None):
2500
2031
        self.enabled = False
2501
2032
        self.clients = clients
2502
2033
        if self.clients is None:
2508
2039
                                interface = interface,
2509
2040
                                use_ipv6 = use_ipv6,
2510
2041
                                socketfd = socketfd)
2511
 
    
2512
2042
    def server_activate(self):
2513
2043
        if self.enabled:
2514
2044
            return socketserver.TCPServer.server_activate(self)
2518
2048
    
2519
2049
    def add_pipe(self, parent_pipe, proc):
2520
2050
        # Call "handle_ipc" for both data and EOF events
2521
 
        GObject.io_add_watch(
2522
 
            parent_pipe.fileno(),
2523
 
            GObject.IO_IN | GObject.IO_HUP,
2524
 
            functools.partial(self.handle_ipc,
2525
 
                              parent_pipe = parent_pipe,
2526
 
                              proc = proc))
 
2051
        gobject.io_add_watch(parent_pipe.fileno(),
 
2052
                             gobject.IO_IN | gobject.IO_HUP,
 
2053
                             functools.partial(self.handle_ipc,
 
2054
                                               parent_pipe =
 
2055
                                               parent_pipe,
 
2056
                                               proc = proc))
2527
2057
    
2528
 
    def handle_ipc(self, source, condition,
2529
 
                   parent_pipe=None,
2530
 
                   proc = None,
2531
 
                   client_object=None):
 
2058
    def handle_ipc(self, source, condition, parent_pipe=None,
 
2059
                   proc = None, client_object=None):
2532
2060
        # error, or the other end of multiprocessing.Pipe has closed
2533
 
        if condition & (GObject.IO_ERR | GObject.IO_HUP):
 
2061
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
2534
2062
            # Wait for other process to exit
2535
2063
            proc.join()
2536
2064
            return False
2543
2071
            fpr = request[1]
2544
2072
            address = request[2]
2545
2073
            
2546
 
            for c in self.clients.values():
 
2074
            for c in self.clients.itervalues():
2547
2075
                if c.fingerprint == fpr:
2548
2076
                    client = c
2549
2077
                    break
2557
2085
                parent_pipe.send(False)
2558
2086
                return False
2559
2087
            
2560
 
            GObject.io_add_watch(
2561
 
                parent_pipe.fileno(),
2562
 
                GObject.IO_IN | GObject.IO_HUP,
2563
 
                functools.partial(self.handle_ipc,
2564
 
                                  parent_pipe = parent_pipe,
2565
 
                                  proc = proc,
2566
 
                                  client_object = client))
 
2088
            gobject.io_add_watch(parent_pipe.fileno(),
 
2089
                                 gobject.IO_IN | gobject.IO_HUP,
 
2090
                                 functools.partial(self.handle_ipc,
 
2091
                                                   parent_pipe =
 
2092
                                                   parent_pipe,
 
2093
                                                   proc = proc,
 
2094
                                                   client_object =
 
2095
                                                   client))
2567
2096
            parent_pipe.send(True)
2568
2097
            # remove the old hook in favor of the new above hook on
2569
2098
            # same fileno
2575
2104
            
2576
2105
            parent_pipe.send(('data', getattr(client_object,
2577
2106
                                              funcname)(*args,
2578
 
                                                        **kwargs)))
 
2107
                                                         **kwargs)))
2579
2108
        
2580
2109
        if command == 'getattr':
2581
2110
            attrname = request[1]
2582
 
            if isinstance(client_object.__getattribute__(attrname),
2583
 
                          collections.Callable):
2584
 
                parent_pipe.send(('function', ))
 
2111
            if callable(client_object.__getattribute__(attrname)):
 
2112
                parent_pipe.send(('function',))
2585
2113
            else:
2586
 
                parent_pipe.send((
2587
 
                    'data', client_object.__getattribute__(attrname)))
 
2114
                parent_pipe.send(('data', client_object
 
2115
                                  .__getattribute__(attrname)))
2588
2116
        
2589
2117
        if command == 'setattr':
2590
2118
            attrname = request[1]
2621
2149
    # avoid excessive use of external libraries.
2622
2150
    
2623
2151
    # New type for defining tokens, syntax, and semantics all-in-one
2624
 
    Token = collections.namedtuple("Token", (
2625
 
        "regexp",  # To match token; if "value" is not None, must have
2626
 
                   # a "group" containing digits
2627
 
        "value",   # datetime.timedelta or None
2628
 
        "followers"))           # Tokens valid after this token
 
2152
    Token = collections.namedtuple("Token",
 
2153
                                   ("regexp", # To match token; if
 
2154
                                              # "value" is not None,
 
2155
                                              # must have a "group"
 
2156
                                              # containing digits
 
2157
                                    "value",  # datetime.timedelta or
 
2158
                                              # None
 
2159
                                    "followers")) # Tokens valid after
 
2160
                                                  # this token
2629
2161
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
2630
2162
    # the "duration" ABNF definition in RFC 3339, Appendix A.
2631
2163
    token_end = Token(re.compile(r"$"), None, frozenset())
2632
2164
    token_second = Token(re.compile(r"(\d+)S"),
2633
2165
                         datetime.timedelta(seconds=1),
2634
 
                         frozenset((token_end, )))
 
2166
                         frozenset((token_end,)))
2635
2167
    token_minute = Token(re.compile(r"(\d+)M"),
2636
2168
                         datetime.timedelta(minutes=1),
2637
2169
                         frozenset((token_second, token_end)))
2653
2185
                       frozenset((token_month, token_end)))
2654
2186
    token_week = Token(re.compile(r"(\d+)W"),
2655
2187
                       datetime.timedelta(weeks=1),
2656
 
                       frozenset((token_end, )))
 
2188
                       frozenset((token_end,)))
2657
2189
    token_duration = Token(re.compile(r"P"), None,
2658
2190
                           frozenset((token_year, token_month,
2659
2191
                                      token_day, token_time,
2660
 
                                      token_week)))
 
2192
                                      token_week))),
2661
2193
    # Define starting values
2662
2194
    value = datetime.timedelta() # Value so far
2663
2195
    found_token = None
2664
 
    followers = frozenset((token_duration, )) # Following valid tokens
 
2196
    followers = frozenset(token_duration,) # Following valid tokens
2665
2197
    s = duration                # String left to parse
2666
2198
    # Loop until end token is found
2667
2199
    while found_token is not token_end:
2684
2216
                break
2685
2217
        else:
2686
2218
            # No currently valid tokens were found
2687
 
            raise ValueError("Invalid RFC 3339 duration: {!r}"
2688
 
                             .format(duration))
 
2219
            raise ValueError("Invalid RFC 3339 duration")
2689
2220
    # End token found
2690
2221
    return value
2691
2222
 
2715
2246
    timevalue = datetime.timedelta(0)
2716
2247
    for s in interval.split():
2717
2248
        try:
2718
 
            suffix = s[-1]
 
2249
            suffix = unicode(s[-1])
2719
2250
            value = int(s[:-1])
2720
2251
            if suffix == "d":
2721
2252
                delta = datetime.timedelta(value)
2728
2259
            elif suffix == "w":
2729
2260
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2730
2261
            else:
2731
 
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2262
                raise ValueError("Unknown suffix {0!r}"
 
2263
                                 .format(suffix))
2732
2264
        except IndexError as e:
2733
2265
            raise ValueError(*(e.args))
2734
2266
        timevalue += delta
2751
2283
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2752
2284
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2753
2285
            raise OSError(errno.ENODEV,
2754
 
                          "{} not a character device"
 
2286
                          "{0} not a character device"
2755
2287
                          .format(os.devnull))
2756
2288
        os.dup2(null, sys.stdin.fileno())
2757
2289
        os.dup2(null, sys.stdout.fileno())
2767
2299
    
2768
2300
    parser = argparse.ArgumentParser()
2769
2301
    parser.add_argument("-v", "--version", action="version",
2770
 
                        version = "%(prog)s {}".format(version),
 
2302
                        version = "%(prog)s {0}".format(version),
2771
2303
                        help="show version number and exit")
2772
2304
    parser.add_argument("-i", "--interface", metavar="IF",
2773
2305
                        help="Bind to interface IF")
2806
2338
                        help="Directory to save/restore state in")
2807
2339
    parser.add_argument("--foreground", action="store_true",
2808
2340
                        help="Run in foreground", default=None)
2809
 
    parser.add_argument("--no-zeroconf", action="store_false",
2810
 
                        dest="zeroconf", help="Do not use Zeroconf",
2811
 
                        default=None)
2812
2341
    
2813
2342
    options = parser.parse_args()
2814
2343
    
2823
2352
                        "port": "",
2824
2353
                        "debug": "False",
2825
2354
                        "priority":
2826
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2827
 
                        ":+SIGN-DSA-SHA256",
 
2355
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2828
2356
                        "servicename": "Mandos",
2829
2357
                        "use_dbus": "True",
2830
2358
                        "use_ipv6": "True",
2833
2361
                        "socket": "",
2834
2362
                        "statedir": "/var/lib/mandos",
2835
2363
                        "foreground": "False",
2836
 
                        "zeroconf": "True",
2837
 
                    }
 
2364
                        }
2838
2365
    
2839
2366
    # Parse config file for server-global settings
2840
2367
    server_config = configparser.SafeConfigParser(server_defaults)
2841
2368
    del server_defaults
2842
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
2369
    server_config.read(os.path.join(options.configdir,
 
2370
                                    "mandos.conf"))
2843
2371
    # Convert the SafeConfigParser object to a dict
2844
2372
    server_settings = server_config.defaults()
2845
2373
    # Use the appropriate methods on the non-string config options
2863
2391
    # Override the settings from the config file with command line
2864
2392
    # options, if set.
2865
2393
    for option in ("interface", "address", "port", "debug",
2866
 
                   "priority", "servicename", "configdir", "use_dbus",
2867
 
                   "use_ipv6", "debuglevel", "restore", "statedir",
2868
 
                   "socket", "foreground", "zeroconf"):
 
2394
                   "priority", "servicename", "configdir",
 
2395
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2396
                   "statedir", "socket", "foreground"):
2869
2397
        value = getattr(options, option)
2870
2398
        if value is not None:
2871
2399
            server_settings[option] = value
2872
2400
    del options
2873
2401
    # Force all strings to be unicode
2874
2402
    for option in server_settings.keys():
2875
 
        if isinstance(server_settings[option], bytes):
2876
 
            server_settings[option] = (server_settings[option]
2877
 
                                       .decode("utf-8"))
 
2403
        if type(server_settings[option]) is str:
 
2404
            server_settings[option] = unicode(server_settings[option])
2878
2405
    # Force all boolean options to be boolean
2879
2406
    for option in ("debug", "use_dbus", "use_ipv6", "restore",
2880
 
                   "foreground", "zeroconf"):
 
2407
                   "foreground"):
2881
2408
        server_settings[option] = bool(server_settings[option])
2882
2409
    # Debug implies foreground
2883
2410
    if server_settings["debug"]:
2886
2413
    
2887
2414
    ##################################################################
2888
2415
    
2889
 
    if (not server_settings["zeroconf"]
2890
 
        and not (server_settings["port"]
2891
 
                 or server_settings["socket"] != "")):
2892
 
        parser.error("Needs port or socket to work without Zeroconf")
2893
 
    
2894
2416
    # For convenience
2895
2417
    debug = server_settings["debug"]
2896
2418
    debuglevel = server_settings["debuglevel"]
2899
2421
    stored_state_path = os.path.join(server_settings["statedir"],
2900
2422
                                     stored_state_file)
2901
2423
    foreground = server_settings["foreground"]
2902
 
    zeroconf = server_settings["zeroconf"]
2903
2424
    
2904
2425
    if debug:
2905
2426
        initlogger(debug, logging.DEBUG)
2911
2432
            initlogger(debug, level)
2912
2433
    
2913
2434
    if server_settings["servicename"] != "Mandos":
2914
 
        syslogger.setFormatter(
2915
 
            logging.Formatter('Mandos ({}) [%(process)d]:'
2916
 
                              ' %(levelname)s: %(message)s'.format(
2917
 
                                  server_settings["servicename"])))
 
2435
        syslogger.setFormatter(logging.Formatter
 
2436
                               ('Mandos ({0}) [%(process)d]:'
 
2437
                                ' %(levelname)s: %(message)s'
 
2438
                                .format(server_settings
 
2439
                                        ["servicename"])))
2918
2440
    
2919
2441
    # Parse config file with clients
2920
2442
    client_config = configparser.SafeConfigParser(Client
2925
2447
    global mandos_dbus_service
2926
2448
    mandos_dbus_service = None
2927
2449
    
2928
 
    socketfd = None
2929
 
    if server_settings["socket"] != "":
2930
 
        socketfd = server_settings["socket"]
2931
 
    tcp_server = MandosServer(
2932
 
        (server_settings["address"], server_settings["port"]),
2933
 
        ClientHandler,
2934
 
        interface=(server_settings["interface"] or None),
2935
 
        use_ipv6=use_ipv6,
2936
 
        gnutls_priority=server_settings["priority"],
2937
 
        use_dbus=use_dbus,
2938
 
        socketfd=socketfd)
 
2450
    tcp_server = MandosServer((server_settings["address"],
 
2451
                               server_settings["port"]),
 
2452
                              ClientHandler,
 
2453
                              interface=(server_settings["interface"]
 
2454
                                         or None),
 
2455
                              use_ipv6=use_ipv6,
 
2456
                              gnutls_priority=
 
2457
                              server_settings["priority"],
 
2458
                              use_dbus=use_dbus,
 
2459
                              socketfd=(server_settings["socket"]
 
2460
                                        or None))
2939
2461
    if not foreground:
2940
2462
        pidfilename = "/run/mandos.pid"
2941
2463
        if not os.path.isdir("/run/."):
2942
2464
            pidfilename = "/var/run/mandos.pid"
2943
2465
        pidfile = None
2944
2466
        try:
2945
 
            pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
 
2467
            pidfile = open(pidfilename, "w")
2946
2468
        except IOError as e:
2947
2469
            logger.error("Could not open file %r", pidfilename,
2948
2470
                         exc_info=e)
2949
2471
    
2950
 
    for name, group in (("_mandos", "_mandos"),
2951
 
                        ("mandos", "mandos"),
2952
 
                        ("nobody", "nogroup")):
 
2472
    for name in ("_mandos", "mandos", "nobody"):
2953
2473
        try:
2954
2474
            uid = pwd.getpwnam(name).pw_uid
2955
 
            gid = pwd.getpwnam(group).pw_gid
 
2475
            gid = pwd.getpwnam(name).pw_gid
2956
2476
            break
2957
2477
        except KeyError:
2958
2478
            continue
2962
2482
    try:
2963
2483
        os.setgid(gid)
2964
2484
        os.setuid(uid)
2965
 
        if debug:
2966
 
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
2967
 
                                                             gid))
2968
2485
    except OSError as error:
2969
 
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
2970
 
                       .format(uid, gid, os.strerror(error.errno)))
2971
2486
        if error.errno != errno.EPERM:
2972
2487
            raise
2973
2488
    
2976
2491
        
2977
2492
        # "Use a log level over 10 to enable all debugging options."
2978
2493
        # - GnuTLS manual
2979
 
        gnutls.global_set_log_level(11)
 
2494
        gnutls.library.functions.gnutls_global_set_log_level(11)
2980
2495
        
2981
 
        @gnutls.log_func
 
2496
        @gnutls.library.types.gnutls_log_func
2982
2497
        def debug_gnutls(level, string):
2983
2498
            logger.debug("GnuTLS: %s", string[:-1])
2984
2499
        
2985
 
        gnutls.global_set_log_function(debug_gnutls)
 
2500
        (gnutls.library.functions
 
2501
         .gnutls_global_set_log_function(debug_gnutls))
2986
2502
        
2987
2503
        # Redirect stdin so all checkers get /dev/null
2988
2504
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2995
2511
        # Close all input and output, do double fork, etc.
2996
2512
        daemon()
2997
2513
    
2998
 
    # multiprocessing will use threads, so before we use GObject we
2999
 
    # need to inform GObject that threads will be used.
3000
 
    GObject.threads_init()
 
2514
    # multiprocessing will use threads, so before we use gobject we
 
2515
    # need to inform gobject that threads will be used.
 
2516
    gobject.threads_init()
3001
2517
    
3002
2518
    global main_loop
3003
2519
    # From the Avahi example code
3004
2520
    DBusGMainLoop(set_as_default=True)
3005
 
    main_loop = GObject.MainLoop()
 
2521
    main_loop = gobject.MainLoop()
3006
2522
    bus = dbus.SystemBus()
3007
2523
    # End of Avahi example code
3008
2524
    if use_dbus:
3009
2525
        try:
3010
2526
            bus_name = dbus.service.BusName("se.recompile.Mandos",
3011
 
                                            bus,
3012
 
                                            do_not_queue=True)
3013
 
            old_bus_name = dbus.service.BusName(
3014
 
                "se.bsnet.fukt.Mandos", bus,
3015
 
                do_not_queue=True)
3016
 
        except dbus.exceptions.DBusException as e:
 
2527
                                            bus, do_not_queue=True)
 
2528
            old_bus_name = (dbus.service.BusName
 
2529
                            ("se.bsnet.fukt.Mandos", bus,
 
2530
                             do_not_queue=True))
 
2531
        except dbus.exceptions.NameExistsException as e:
3017
2532
            logger.error("Disabling D-Bus:", exc_info=e)
3018
2533
            use_dbus = False
3019
2534
            server_settings["use_dbus"] = False
3020
2535
            tcp_server.use_dbus = False
3021
 
    if zeroconf:
3022
 
        protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3023
 
        service = AvahiServiceToSyslog(
3024
 
            name = server_settings["servicename"],
3025
 
            servicetype = "_mandos._tcp",
3026
 
            protocol = protocol,
3027
 
            bus = bus)
3028
 
        if server_settings["interface"]:
3029
 
            service.interface = if_nametoindex(
3030
 
                server_settings["interface"].encode("utf-8"))
 
2536
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2537
    service = AvahiServiceToSyslog(name =
 
2538
                                   server_settings["servicename"],
 
2539
                                   servicetype = "_mandos._tcp",
 
2540
                                   protocol = protocol, bus = bus)
 
2541
    if server_settings["interface"]:
 
2542
        service.interface = (if_nametoindex
 
2543
                             (str(server_settings["interface"])))
3031
2544
    
3032
2545
    global multiprocessing_manager
3033
2546
    multiprocessing_manager = multiprocessing.Manager()
3052
2565
    if server_settings["restore"]:
3053
2566
        try:
3054
2567
            with open(stored_state_path, "rb") as stored_state:
3055
 
                if sys.version_info.major == 2:                
3056
 
                    clients_data, old_client_settings = pickle.load(
3057
 
                        stored_state)
3058
 
                else:
3059
 
                    bytes_clients_data, bytes_old_client_settings = (
3060
 
                        pickle.load(stored_state, encoding = "bytes"))
3061
 
                    ### Fix bytes to strings
3062
 
                    ## clients_data
3063
 
                    # .keys()
3064
 
                    clients_data = { (key.decode("utf-8")
3065
 
                                      if isinstance(key, bytes)
3066
 
                                      else key): value
3067
 
                                     for key, value in
3068
 
                                     bytes_clients_data.items() }
3069
 
                    for key in clients_data:
3070
 
                        value = { (k.decode("utf-8")
3071
 
                                   if isinstance(k, bytes) else k): v
3072
 
                                  for k, v in
3073
 
                                  clients_data[key].items() }
3074
 
                        clients_data[key] = value
3075
 
                        # .client_structure
3076
 
                        value["client_structure"] = [
3077
 
                            (s.decode("utf-8")
3078
 
                             if isinstance(s, bytes)
3079
 
                             else s) for s in
3080
 
                            value["client_structure"] ]
3081
 
                        # .name & .host
3082
 
                        for k in ("name", "host"):
3083
 
                            if isinstance(value[k], bytes):
3084
 
                                value[k] = value[k].decode("utf-8")
3085
 
                    ## old_client_settings
3086
 
                    # .keys
3087
 
                    old_client_settings = {
3088
 
                        (key.decode("utf-8")
3089
 
                         if isinstance(key, bytes)
3090
 
                         else key): value
3091
 
                        for key, value in
3092
 
                        bytes_old_client_settings.items() }
3093
 
                    # .host
3094
 
                    for value in old_client_settings.values():
3095
 
                        value["host"] = value["host"].decode("utf-8")
 
2568
                clients_data, old_client_settings = (pickle.load
 
2569
                                                     (stored_state))
3096
2570
            os.remove(stored_state_path)
3097
2571
        except IOError as e:
3098
2572
            if e.errno == errno.ENOENT:
3099
 
                logger.warning("Could not load persistent state:"
3100
 
                               " {}".format(os.strerror(e.errno)))
 
2573
                logger.warning("Could not load persistent state: {0}"
 
2574
                                .format(os.strerror(e.errno)))
3101
2575
            else:
3102
2576
                logger.critical("Could not load persistent state:",
3103
2577
                                exc_info=e)
3104
2578
                raise
3105
2579
        except EOFError as e:
3106
2580
            logger.warning("Could not load persistent state: "
3107
 
                           "EOFError:",
3108
 
                           exc_info=e)
 
2581
                           "EOFError:", exc_info=e)
3109
2582
    
3110
2583
    with PGPEngine() as pgp:
3111
 
        for client_name, client in clients_data.items():
 
2584
        for client_name, client in clients_data.iteritems():
3112
2585
            # Skip removed clients
3113
2586
            if client_name not in client_settings:
3114
2587
                continue
3123
2596
                    # For each value in new config, check if it
3124
2597
                    # differs from the old config value (Except for
3125
2598
                    # the "secret" attribute)
3126
 
                    if (name != "secret"
3127
 
                        and (value !=
3128
 
                             old_client_settings[client_name][name])):
 
2599
                    if (name != "secret" and
 
2600
                        value != old_client_settings[client_name]
 
2601
                        [name]):
3129
2602
                        client[name] = value
3130
2603
                except KeyError:
3131
2604
                    pass
3132
2605
            
3133
2606
            # Clients who has passed its expire date can still be
3134
 
            # enabled if its last checker was successful.  A Client
 
2607
            # enabled if its last checker was successful.  Clients
3135
2608
            # whose checker succeeded before we stored its state is
3136
2609
            # assumed to have successfully run all checkers during
3137
2610
            # downtime.
3139
2612
                if datetime.datetime.utcnow() >= client["expires"]:
3140
2613
                    if not client["last_checked_ok"]:
3141
2614
                        logger.warning(
3142
 
                            "disabling client {} - Client never "
3143
 
                            "performed a successful checker".format(
3144
 
                                client_name))
 
2615
                            "disabling client {0} - Client never "
 
2616
                            "performed a successful checker"
 
2617
                            .format(client_name))
3145
2618
                        client["enabled"] = False
3146
2619
                    elif client["last_checker_status"] != 0:
3147
2620
                        logger.warning(
3148
 
                            "disabling client {} - Client last"
3149
 
                            " checker failed with error code"
3150
 
                            " {}".format(
3151
 
                                client_name,
3152
 
                                client["last_checker_status"]))
 
2621
                            "disabling client {0} - Client "
 
2622
                            "last checker failed with error code {1}"
 
2623
                            .format(client_name,
 
2624
                                    client["last_checker_status"]))
3153
2625
                        client["enabled"] = False
3154
2626
                    else:
3155
 
                        client["expires"] = (
3156
 
                            datetime.datetime.utcnow()
3157
 
                            + client["timeout"])
 
2627
                        client["expires"] = (datetime.datetime
 
2628
                                             .utcnow()
 
2629
                                             + client["timeout"])
3158
2630
                        logger.debug("Last checker succeeded,"
3159
 
                                     " keeping {} enabled".format(
3160
 
                                         client_name))
 
2631
                                     " keeping {0} enabled"
 
2632
                                     .format(client_name))
3161
2633
            try:
3162
 
                client["secret"] = pgp.decrypt(
3163
 
                    client["encrypted_secret"],
3164
 
                    client_settings[client_name]["secret"])
 
2634
                client["secret"] = (
 
2635
                    pgp.decrypt(client["encrypted_secret"],
 
2636
                                client_settings[client_name]
 
2637
                                ["secret"]))
3165
2638
            except PGPError:
3166
2639
                # If decryption fails, we use secret from new settings
3167
 
                logger.debug("Failed to decrypt {} old secret".format(
3168
 
                    client_name))
3169
 
                client["secret"] = (client_settings[client_name]
3170
 
                                    ["secret"])
 
2640
                logger.debug("Failed to decrypt {0} old secret"
 
2641
                             .format(client_name))
 
2642
                client["secret"] = (
 
2643
                    client_settings[client_name]["secret"])
3171
2644
    
3172
2645
    # Add/remove clients based on new changes made to config
3173
2646
    for client_name in (set(old_client_settings)
3178
2651
        clients_data[client_name] = client_settings[client_name]
3179
2652
    
3180
2653
    # Create all client objects
3181
 
    for client_name, client in clients_data.items():
 
2654
    for client_name, client in clients_data.iteritems():
3182
2655
        tcp_server.clients[client_name] = client_class(
3183
 
            name = client_name,
3184
 
            settings = client,
 
2656
            name = client_name, settings = client,
3185
2657
            server_settings = server_settings)
3186
2658
    
3187
2659
    if not tcp_server.clients:
3189
2661
    
3190
2662
    if not foreground:
3191
2663
        if pidfile is not None:
3192
 
            pid = os.getpid()
3193
2664
            try:
3194
2665
                with pidfile:
3195
 
                    print(pid, file=pidfile)
 
2666
                    pid = os.getpid()
 
2667
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
3196
2668
            except IOError:
3197
2669
                logger.error("Could not write to file %r with PID %d",
3198
2670
                             pidfilename, pid)
3203
2675
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3204
2676
    
3205
2677
    if use_dbus:
3206
 
        
3207
 
        @alternate_dbus_interfaces(
3208
 
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
3209
 
        class MandosDBusService(DBusObjectWithObjectManager):
 
2678
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2679
                                        "se.bsnet.fukt.Mandos"})
 
2680
        class MandosDBusService(DBusObjectWithProperties):
3210
2681
            """A D-Bus proxy object"""
3211
 
            
3212
2682
            def __init__(self):
3213
2683
                dbus.service.Object.__init__(self, bus, "/")
3214
 
            
3215
2684
            _interface = "se.recompile.Mandos"
3216
2685
            
 
2686
            @dbus_interface_annotations(_interface)
 
2687
            def _foo(self):
 
2688
                return { "org.freedesktop.DBus.Property"
 
2689
                         ".EmitsChangedSignal":
 
2690
                             "false"}
 
2691
            
3217
2692
            @dbus.service.signal(_interface, signature="o")
3218
2693
            def ClientAdded(self, objpath):
3219
2694
                "D-Bus signal"
3224
2699
                "D-Bus signal"
3225
2700
                pass
3226
2701
            
3227
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3228
 
                               "true"})
3229
2702
            @dbus.service.signal(_interface, signature="os")
3230
2703
            def ClientRemoved(self, objpath, name):
3231
2704
                "D-Bus signal"
3232
2705
                pass
3233
2706
            
3234
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3235
 
                               "true"})
3236
2707
            @dbus.service.method(_interface, out_signature="ao")
3237
2708
            def GetAllClients(self):
3238
2709
                "D-Bus method"
3239
 
                return dbus.Array(c.dbus_object_path for c in
3240
 
                                  tcp_server.clients.values())
 
2710
                return dbus.Array(c.dbus_object_path
 
2711
                                  for c in
 
2712
                                  tcp_server.clients.itervalues())
3241
2713
            
3242
 
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
3243
 
                               "true"})
3244
2714
            @dbus.service.method(_interface,
3245
2715
                                 out_signature="a{oa{sv}}")
3246
2716
            def GetAllClientsWithProperties(self):
3247
2717
                "D-Bus method"
3248
2718
                return dbus.Dictionary(
3249
 
                    { c.dbus_object_path: c.GetAll(
3250
 
                        "se.recompile.Mandos.Client")
3251
 
                      for c in tcp_server.clients.values() },
 
2719
                    ((c.dbus_object_path, c.GetAll(""))
 
2720
                     for c in tcp_server.clients.itervalues()),
3252
2721
                    signature="oa{sv}")
3253
2722
            
3254
2723
            @dbus.service.method(_interface, in_signature="o")
3255
2724
            def RemoveClient(self, object_path):
3256
2725
                "D-Bus method"
3257
 
                for c in tcp_server.clients.values():
 
2726
                for c in tcp_server.clients.itervalues():
3258
2727
                    if c.dbus_object_path == object_path:
3259
2728
                        del tcp_server.clients[c.name]
3260
2729
                        c.remove_from_connection()
3261
 
                        # Don't signal the disabling
 
2730
                        # Don't signal anything except ClientRemoved
3262
2731
                        c.disable(quiet=True)
3263
 
                        # Emit D-Bus signal for removal
3264
 
                        self.client_removed_signal(c)
 
2732
                        # Emit D-Bus signal
 
2733
                        self.ClientRemoved(object_path, c.name)
3265
2734
                        return
3266
2735
                raise KeyError(object_path)
3267
2736
            
3268
2737
            del _interface
3269
 
            
3270
 
            @dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3271
 
                                 out_signature = "a{oa{sa{sv}}}")
3272
 
            def GetManagedObjects(self):
3273
 
                """D-Bus method"""
3274
 
                return dbus.Dictionary(
3275
 
                    { client.dbus_object_path:
3276
 
                      dbus.Dictionary(
3277
 
                          { interface: client.GetAll(interface)
3278
 
                            for interface in
3279
 
                                 client._get_all_interface_names()})
3280
 
                      for client in tcp_server.clients.values()})
3281
 
            
3282
 
            def client_added_signal(self, client):
3283
 
                """Send the new standard signal and the old signal"""
3284
 
                if use_dbus:
3285
 
                    # New standard signal
3286
 
                    self.InterfacesAdded(
3287
 
                        client.dbus_object_path,
3288
 
                        dbus.Dictionary(
3289
 
                            { interface: client.GetAll(interface)
3290
 
                              for interface in
3291
 
                              client._get_all_interface_names()}))
3292
 
                    # Old signal
3293
 
                    self.ClientAdded(client.dbus_object_path)
3294
 
            
3295
 
            def client_removed_signal(self, client):
3296
 
                """Send the new standard signal and the old signal"""
3297
 
                if use_dbus:
3298
 
                    # New standard signal
3299
 
                    self.InterfacesRemoved(
3300
 
                        client.dbus_object_path,
3301
 
                        client._get_all_interface_names())
3302
 
                    # Old signal
3303
 
                    self.ClientRemoved(client.dbus_object_path,
3304
 
                                       client.name)
3305
2738
        
3306
2739
        mandos_dbus_service = MandosDBusService()
3307
2740
    
3308
2741
    def cleanup():
3309
2742
        "Cleanup function; run on exit"
3310
 
        if zeroconf:
3311
 
            service.cleanup()
 
2743
        service.cleanup()
3312
2744
        
3313
2745
        multiprocessing.active_children()
3314
2746
        wnull.close()
3320
2752
        # removed/edited, old secret will thus be unrecovable.
3321
2753
        clients = {}
3322
2754
        with PGPEngine() as pgp:
3323
 
            for client in tcp_server.clients.values():
 
2755
            for client in tcp_server.clients.itervalues():
3324
2756
                key = client_settings[client.name]["secret"]
3325
2757
                client.encrypted_secret = pgp.encrypt(client.secret,
3326
2758
                                                      key)
3328
2760
                
3329
2761
                # A list of attributes that can not be pickled
3330
2762
                # + secret.
3331
 
                exclude = { "bus", "changedstate", "secret",
3332
 
                            "checker", "server_settings" }
3333
 
                for name, typ in inspect.getmembers(dbus.service
3334
 
                                                    .Object):
 
2763
                exclude = set(("bus", "changedstate", "secret",
 
2764
                               "checker", "server_settings"))
 
2765
                for name, typ in (inspect.getmembers
 
2766
                                  (dbus.service.Object)):
3335
2767
                    exclude.add(name)
3336
2768
                
3337
2769
                client_dict["encrypted_secret"] = (client
3344
2776
                del client_settings[client.name]["secret"]
3345
2777
        
3346
2778
        try:
3347
 
            with tempfile.NamedTemporaryFile(
3348
 
                    mode='wb',
3349
 
                    suffix=".pickle",
3350
 
                    prefix='clients-',
3351
 
                    dir=os.path.dirname(stored_state_path),
3352
 
                    delete=False) as stored_state:
3353
 
                pickle.dump((clients, client_settings), stored_state,
3354
 
                            protocol = 2)
3355
 
                tempname = stored_state.name
 
2779
            with (tempfile.NamedTemporaryFile
 
2780
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2781
                   dir=os.path.dirname(stored_state_path),
 
2782
                   delete=False)) as stored_state:
 
2783
                pickle.dump((clients, client_settings), stored_state)
 
2784
                tempname=stored_state.name
3356
2785
            os.rename(tempname, stored_state_path)
3357
2786
        except (IOError, OSError) as e:
3358
2787
            if not debug:
3361
2790
                except NameError:
3362
2791
                    pass
3363
2792
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3364
 
                logger.warning("Could not save persistent state: {}"
 
2793
                logger.warning("Could not save persistent state: {0}"
3365
2794
                               .format(os.strerror(e.errno)))
3366
2795
            else:
3367
2796
                logger.warning("Could not save persistent state:",
3373
2802
            name, client = tcp_server.clients.popitem()
3374
2803
            if use_dbus:
3375
2804
                client.remove_from_connection()
3376
 
            # Don't signal the disabling
 
2805
            # Don't signal anything except ClientRemoved
3377
2806
            client.disable(quiet=True)
3378
 
            # Emit D-Bus signal for removal
3379
2807
            if use_dbus:
3380
 
                mandos_dbus_service.client_removed_signal(client)
 
2808
                # Emit D-Bus signal
 
2809
                mandos_dbus_service.ClientRemoved(client
 
2810
                                                  .dbus_object_path,
 
2811
                                                  client.name)
3381
2812
        client_settings.clear()
3382
2813
    
3383
2814
    atexit.register(cleanup)
3384
2815
    
3385
 
    for client in tcp_server.clients.values():
 
2816
    for client in tcp_server.clients.itervalues():
3386
2817
        if use_dbus:
3387
 
            # Emit D-Bus signal for adding
3388
 
            mandos_dbus_service.client_added_signal(client)
 
2818
            # Emit D-Bus signal
 
2819
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
3389
2820
        # Need to initiate checking of clients
3390
2821
        if client.enabled:
3391
2822
            client.init_checker()
3394
2825
    tcp_server.server_activate()
3395
2826
    
3396
2827
    # Find out what port we got
3397
 
    if zeroconf:
3398
 
        service.port = tcp_server.socket.getsockname()[1]
 
2828
    service.port = tcp_server.socket.getsockname()[1]
3399
2829
    if use_ipv6:
3400
2830
        logger.info("Now listening on address %r, port %d,"
3401
2831
                    " flowinfo %d, scope_id %d",
3407
2837
    #service.interface = tcp_server.socket.getsockname()[3]
3408
2838
    
3409
2839
    try:
3410
 
        if zeroconf:
3411
 
            # From the Avahi example code
3412
 
            try:
3413
 
                service.activate()
3414
 
            except dbus.exceptions.DBusException as error:
3415
 
                logger.critical("D-Bus Exception", exc_info=error)
3416
 
                cleanup()
3417
 
                sys.exit(1)
3418
 
            # End of Avahi example code
 
2840
        # From the Avahi example code
 
2841
        try:
 
2842
            service.activate()
 
2843
        except dbus.exceptions.DBusException as error:
 
2844
            logger.critical("D-Bus Exception", exc_info=error)
 
2845
            cleanup()
 
2846
            sys.exit(1)
 
2847
        # End of Avahi example code
3419
2848
        
3420
 
        GObject.io_add_watch(tcp_server.fileno(), GObject.IO_IN,
 
2849
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
3421
2850
                             lambda *args, **kwargs:
3422
2851
                             (tcp_server.handle_request
3423
2852
                              (*args[2:], **kwargs) or True))
3436
2865
    # Must run before the D-Bus bus name gets deregistered
3437
2866
    cleanup()
3438
2867
 
3439
 
 
3440
2868
if __name__ == '__main__':
3441
2869
    main()