/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2014-07-14 21:41:08 UTC
  • Revision ID: teddy@recompile.se-20140714214108-awg7u6gaiy7d40dz
mandos-monitor: New "verbose" mode to see less important log messages.

* mandos-monitor (MandosClientWidget.__init__): Log client creation.
  (MandosClientWidget.checker_completed): Log a successful checker.
  (MandosClientWidget.checker_started): Log starting of a checker.
  (UserInterface.__init__): New optional "log_level" argument.
  (UserInterface.log_message, UserInterface.log_message_raw): Take
                                                              optional
                                                              "level"
                                                              arg.
  (UserInterface.toggle_log_display): Log visibility change.
  (UserInterface.change_log_display): Log wrap mode change.
  (UserInterface.process_input): Show new "v" key in help message and
                                 process "v" key if pressed.
* mandos-monitor.xml (KEYS): Document new "v" key.

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