/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-03-12 20:23:15 UTC
  • Revision ID: teddy@recompile.se-20160312202315-hu7b87ivetlxqbw3
Server: Fix minor thing with Python 3 compatibility

Fix another small thing with unpickling string values.

* mandos (main): When restoring pickled client data, only decode byte
                 string for "host" key if it really is a byte string.

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