/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: 2013-10-27 17:42:23 UTC
  • Revision ID: teddy@recompile.se-20131027174223-mq3a1h8xi5jcv9e6
Bug fix: Make sure systemd service file is installed.

* Makefile (install-server): Fix typo causing syntax error.
* debian/mandos.dirs (lib/systemd/system): New.

Show diffs side-by-side

added added

removed removed

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