/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-17 20:40:55 UTC
  • Revision ID: teddy@recompile.se-20160317204055-bhsh5xsidq7w5cxu
Client: Fix plymouth agent; broken since 1.7.2.

Fix an very old memory bug in the plymouth agent (which has been
present since its apperance in version 1.2), but which was only
recently detected at run time due to the new -fsanitize=address
compile- time flag, which has been used since version 1.7.2.  This
detection of a memory access violation causes the program to abort,
making the Plymouth graphical boot system unable to accept interactive
input of passwords when using the Mandos client.

* plugins.d/plymouth.c (exec_and_wait): Fix memory allocation bug when
  allocating new_argv.  Also tolerate a zero-length argv.

Show diffs side-by-side

added added

removed removed

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