/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-05-26 22:56:38 UTC
  • mfrom: (589.1.1 socket-option)
  • Revision ID: teddy@recompile.se-20120526225638-4hvqyrvmj0036lfn
Merge "--socket" option for server.

This is suggested by the GNU Coding Standards' Table of Long Options,
and will probably also allow socket activation (e.g. by systemd(8)).

Show diffs side-by-side

added added

removed removed

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