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