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