/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

* mandos: Use all new builtins.
* mandos-ctl: - '' -
* mandos-monitor: - '' -

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