/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: 2012-06-17 22:26:40 UTC
  • mfrom: (301.1.1 release)
  • Revision ID: teddy@recompile.se-20120617222640-49scfn0husnrr5bi
Tags: version-1.6.0-1
* Makefile (version): Changed to "1.6.0".
* NEWS (Version 1.6.0): New entry.
* debian/changelog (1.6.0-1): - '' -

Show diffs side-by-side

added added

removed removed

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