/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-03-13 22:46:30 UTC
  • mfrom: (340 release)
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 341.
  • Revision ID: teddy@recompile.se-20160313224630-nz8ng3zl82elmk1h
Merge from release branch

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