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