/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

* network-hooks.d: New directory.
* network-hooks.d/bridge: New example hook.
* network-hooks.d/bridge.conf: Config file for bridge example hook.

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