/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: 2016-03-12 20:23:15 UTC
  • Revision ID: teddy@recompile.se-20160312202315-hu7b87ivetlxqbw3
Server: Fix minor thing with Python 3 compatibility

Fix another small thing with unpickling string values.

* mandos (main): When restoring pickled client data, only decode byte
                 string for "host" key if it really is a byte string.

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