/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2012-06-23 00:58:49 UTC
  • Revision ID: teddy@recompile.se-20120623005849-02wj82cng433rt2k
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
* mandos: All client options for time intervals now take an RFC 3339
          duration.
  (rfc3339_duration_to_delta): New function.
  (string_to_delta): Try rfc3339_duration_to_delta first.
* mandos-clients.conf.xml (OPTIONS/timeout): Document new format.
  (EXAMPLE): Update to new interval format.
  (SEE ALSO): Reference RFC 3339.

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