/mandos/release

To get this branch, use:
bzr branch http://bzr.recompile.se/loggerhead/mandos/release

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-03-13 21:50:42 UTC
  • mfrom: (237.7.379 trunk)
  • Revision ID: teddy@recompile.se-20160313215042-hw6du2ka2a9ycp7f
Merge from trunk

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