/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2016-03-19 03:48:56 UTC
  • Revision ID: teddy@recompile.se-20160319034856-d8rox0kdxekgr03g
Server: Make persistent state directory mode u=rwx,go=

The Makefile target "install-server" creates the server persistent
state directory /var/lib/mandos as mode u=rwx,go= (0700).  Make this
also the case for the Debian package (unless overridden by
dpkg-statoverride).

* debian/mandos.postinst (configure): Fix state directory permissions,
  but only if not listed by "dpkg-statoverride".

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
66
74
import binascii
67
75
import tempfile
 
76
import itertools
 
77
import collections
 
78
import codecs
68
79
 
69
80
import dbus
70
81
import dbus.service
71
 
import gobject
72
 
import avahi
 
82
from gi.repository import GLib
73
83
from dbus.mainloop.glib import DBusGMainLoop
74
84
import ctypes
75
85
import ctypes.util
76
86
import xml.dom.minidom
77
87
import inspect
78
 
import GnuPGInterface
79
88
 
80
89
try:
81
90
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
85
94
    except ImportError:
86
95
        SO_BINDTODEVICE = None
87
96
 
 
97
if sys.version_info.major == 2:
 
98
    str = unicode
88
99
 
89
 
version = "1.4.1"
 
100
version = "1.7.6"
90
101
stored_state_file = "clients.pickle"
91
102
 
92
103
logger = logging.getLogger()
93
 
syslogger = (logging.handlers.SysLogHandler
94
 
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
95
 
              address = str("/dev/log")))
 
104
syslogger = None
96
105
 
97
106
try:
98
 
    if_nametoindex = (ctypes.cdll.LoadLibrary
99
 
                      (ctypes.util.find_library("c"))
100
 
                      .if_nametoindex)
 
107
    if_nametoindex = ctypes.cdll.LoadLibrary(
 
108
        ctypes.util.find_library("c")).if_nametoindex
101
109
except (OSError, AttributeError):
 
110
    
102
111
    def if_nametoindex(interface):
103
112
        "Get an interface index the hard way, i.e. using fcntl()"
104
113
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
105
114
        with contextlib.closing(socket.socket()) as s:
106
115
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
 
                                struct.pack(str("16s16x"),
108
 
                                            interface))
109
 
        interface_index = struct.unpack(str("I"),
110
 
                                        ifreq[16:20])[0]
 
116
                                struct.pack(b"16s16x", interface))
 
117
        interface_index = struct.unpack("I", ifreq[16:20])[0]
111
118
        return interface_index
112
119
 
113
120
 
114
 
def initlogger(level=logging.WARNING):
 
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):
115
138
    """init logger and add loglevel"""
116
139
    
 
140
    global syslogger
 
141
    syslogger = (logging.handlers.SysLogHandler(
 
142
        facility = logging.handlers.SysLogHandler.LOG_DAEMON,
 
143
        address = "/dev/log"))
117
144
    syslogger.setFormatter(logging.Formatter
118
145
                           ('Mandos [%(process)d]: %(levelname)s:'
119
146
                            ' %(message)s'))
120
147
    logger.addHandler(syslogger)
121
148
    
122
 
    console = logging.StreamHandler()
123
 
    console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
124
 
                                           ' [%(process)d]:'
125
 
                                           ' %(levelname)s:'
126
 
                                           ' %(message)s'))
127
 
    logger.addHandler(console)
 
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)
128
156
    logger.setLevel(level)
129
157
 
130
158
 
131
 
class CryptoError(Exception):
 
159
class PGPError(Exception):
 
160
    """Exception if encryption/decryption fails"""
132
161
    pass
133
162
 
134
163
 
135
 
class Crypto(object):
 
164
class PGPEngine(object):
136
165
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
166
    
137
167
    def __init__(self):
138
 
        self.gnupg = GnuPGInterface.GnuPG()
139
168
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
140
 
        self.gnupg = GnuPGInterface.GnuPG()
141
 
        self.gnupg.options.meta_interactive = False
142
 
        self.gnupg.options.homedir = self.tempdir
143
 
        self.gnupg.options.extra_args.extend(['--force-mdc',
144
 
                                              '--quiet'])
 
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']
145
185
    
146
186
    def __enter__(self):
147
187
        return self
148
188
    
149
 
    def __exit__ (self, exc_type, exc_value, traceback):
 
189
    def __exit__(self, exc_type, exc_value, traceback):
150
190
        self._cleanup()
151
191
        return False
152
192
    
169
209
    def password_encode(self, password):
170
210
        # Passphrase can not be empty and can not contain newlines or
171
211
        # NUL bytes.  So we prefix it and hex encode it.
172
 
        return b"mandos" + binascii.hexlify(password)
 
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
173
219
    
174
220
    def encrypt(self, data, password):
175
 
        self.gnupg.passphrase = self.password_encode(password)
176
 
        with open(os.devnull) as devnull:
177
 
            try:
178
 
                proc = self.gnupg.run(['--symmetric'],
179
 
                                      create_fhs=['stdin', 'stdout'],
180
 
                                      attach_fhs={'stderr': devnull})
181
 
                with contextlib.closing(proc.handles['stdin']) as f:
182
 
                    f.write(data)
183
 
                with contextlib.closing(proc.handles['stdout']) as f:
184
 
                    ciphertext = f.read()
185
 
                proc.wait()
186
 
            except IOError as e:
187
 
                raise CryptoError(e)
188
 
        self.gnupg.passphrase = None
 
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)
189
236
        return ciphertext
190
237
    
191
238
    def decrypt(self, data, password):
192
 
        self.gnupg.passphrase = self.password_encode(password)
193
 
        with open(os.devnull) as devnull:
194
 
            try:
195
 
                proc = self.gnupg.run(['--decrypt'],
196
 
                                      create_fhs=['stdin', 'stdout'],
197
 
                                      attach_fhs={'stderr': devnull})
198
 
                with contextlib.closing(proc.handles['stdin'] ) as f:
199
 
                    f.write(data)
200
 
                with contextlib.closing(proc.handles['stdout']) as f:
201
 
                    decrypted_plaintext = f.read()
202
 
                proc.wait()
203
 
            except IOError as e:
204
 
                raise CryptoError(e)
205
 
        self.gnupg.passphrase = None
 
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)
206
254
        return decrypted_plaintext
207
255
 
208
 
 
 
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()
209
280
 
210
281
class AvahiError(Exception):
211
282
    def __init__(self, value, *args, **kwargs):
212
283
        self.value = value
213
 
        super(AvahiError, self).__init__(value, *args, **kwargs)
214
 
    def __unicode__(self):
215
 
        return unicode(repr(self.value))
 
284
        return super(AvahiError, self).__init__(value, *args,
 
285
                                                **kwargs)
 
286
 
216
287
 
217
288
class AvahiServiceError(AvahiError):
218
289
    pass
219
290
 
 
291
 
220
292
class AvahiGroupError(AvahiError):
221
293
    pass
222
294
 
229
301
               Used to optionally bind to the specified interface.
230
302
    name: string; Example: 'Mandos'
231
303
    type: string; Example: '_mandos._tcp'.
232
 
                  See <http://www.dns-sd.org/ServiceTypes.html>
 
304
     See <https://www.iana.org/assignments/service-names-port-numbers>
233
305
    port: integer; what port to announce
234
306
    TXT: list of strings; TXT record for the service
235
307
    domain: string; Domain to publish on, default to .local if empty.
241
313
    server: D-Bus Server
242
314
    bus: dbus.SystemBus()
243
315
    """
244
 
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
245
 
                 servicetype = None, port = None, TXT = None,
246
 
                 domain = "", host = "", max_renames = 32768,
247
 
                 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):
248
328
        self.interface = interface
249
329
        self.name = name
250
330
        self.type = servicetype
259
339
        self.server = None
260
340
        self.bus = bus
261
341
        self.entry_group_state_changed_match = None
262
 
    def rename(self):
 
342
    
 
343
    def rename(self, remove=True):
263
344
        """Derived from the Avahi example code"""
264
345
        if self.rename_count >= self.max_renames:
265
346
            logger.critical("No suitable Zeroconf service name found"
266
347
                            " after %i retries, exiting.",
267
348
                            self.rename_count)
268
349
            raise AvahiServiceError("Too many renames")
269
 
        self.name = unicode(self.server
270
 
                            .GetAlternativeServiceName(self.name))
 
350
        self.name = str(
 
351
            self.server.GetAlternativeServiceName(self.name))
 
352
        self.rename_count += 1
271
353
        logger.info("Changing Zeroconf service name to %r ...",
272
354
                    self.name)
273
 
        self.remove()
 
355
        if remove:
 
356
            self.remove()
274
357
        try:
275
358
            self.add()
276
359
        except dbus.exceptions.DBusException as error:
277
 
            logger.critical("DBusException: %s", error)
278
 
            self.cleanup()
279
 
            os._exit(1)
280
 
        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
    
281
369
    def remove(self):
282
370
        """Derived from the Avahi example code"""
283
371
        if self.entry_group_state_changed_match is not None:
285
373
            self.entry_group_state_changed_match = None
286
374
        if self.group is not None:
287
375
            self.group.Reset()
 
376
    
288
377
    def add(self):
289
378
        """Derived from the Avahi example code"""
290
379
        self.remove()
307
396
            dbus.UInt16(self.port),
308
397
            avahi.string_array_to_txt_array(self.TXT))
309
398
        self.group.Commit()
 
399
    
310
400
    def entry_group_state_changed(self, state, error):
311
401
        """Derived from the Avahi example code"""
312
402
        logger.debug("Avahi entry group state change: %i", state)
318
408
            self.rename()
319
409
        elif state == avahi.ENTRY_GROUP_FAILURE:
320
410
            logger.critical("Avahi: Error in group state changed %s",
321
 
                            unicode(error))
322
 
            raise AvahiGroupError("State changed: %s"
323
 
                                  % unicode(error))
 
411
                            str(error))
 
412
            raise AvahiGroupError("State changed: {!s}".format(error))
 
413
    
324
414
    def cleanup(self):
325
415
        """Derived from the Avahi example code"""
326
416
        if self.group is not None:
331
421
                pass
332
422
            self.group = None
333
423
        self.remove()
 
424
    
334
425
    def server_state_changed(self, state, error=None):
335
426
        """Derived from the Avahi example code"""
336
427
        logger.debug("Avahi server state change: %i", state)
337
 
        bad_states = { avahi.SERVER_INVALID:
338
 
                           "Zeroconf server invalid",
339
 
                       avahi.SERVER_REGISTERING: None,
340
 
                       avahi.SERVER_COLLISION:
341
 
                           "Zeroconf server name collision",
342
 
                       avahi.SERVER_FAILURE:
343
 
                           "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
        }
344
434
        if state in bad_states:
345
435
            if bad_states[state] is not None:
346
436
                if error is None:
349
439
                    logger.error(bad_states[state] + ": %r", error)
350
440
            self.cleanup()
351
441
        elif state == avahi.SERVER_RUNNING:
352
 
            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)
353
454
        else:
354
455
            if error is None:
355
456
                logger.debug("Unknown state: %r", state)
356
457
            else:
357
458
                logger.debug("Unknown state: %r: %r", state, error)
 
459
    
358
460
    def activate(self):
359
461
        """Derived from the Avahi example code"""
360
462
        if self.server is None:
364
466
                                    follow_name_owner_changes=True),
365
467
                avahi.DBUS_INTERFACE_SERVER)
366
468
        self.server.connect_to_signal("StateChanged",
367
 
                                 self.server_state_changed)
 
469
                                      self.server_state_changed)
368
470
        self.server_state_changed(self.server.GetState())
369
471
 
 
472
 
370
473
class AvahiServiceToSyslog(AvahiService):
371
 
    def rename(self):
 
474
    def rename(self, *args, **kwargs):
372
475
        """Add the new name to the syslog messages"""
373
 
        ret = AvahiService.rename(self)
374
 
        syslogger.setFormatter(logging.Formatter
375
 
                               ('Mandos (%s) [%%(process)d]:'
376
 
                                ' %%(levelname)s: %%(message)s'
377
 
                                % self.name))
 
476
        ret = AvahiService.rename(self, *args, **kwargs)
 
477
        syslogger.setFormatter(logging.Formatter(
 
478
            'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
 
479
            .format(self.name)))
378
480
        return ret
379
481
 
380
 
def _timedelta_to_milliseconds(td):
381
 
    "Convert a datetime.timedelta() to milliseconds"
382
 
    return ((td.days * 24 * 60 * 60 * 1000)
383
 
            + (td.seconds * 1000)
384
 
            + (td.microseconds // 1000))
385
 
        
 
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
 
386
747
class Client(object):
387
748
    """A representation of a client host served by this server.
388
749
    
389
750
    Attributes:
390
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
751
    approved:   bool(); 'None' if not yet approved/disapproved
391
752
    approval_delay: datetime.timedelta(); Time to wait for approval
392
753
    approval_duration: datetime.timedelta(); Duration of one approval
393
754
    checker:    subprocess.Popen(); a running checker process used
394
755
                                    to see if the client lives.
395
756
                                    'None' if no process is running.
396
 
    checker_callback_tag: a gobject event source tag, or None
 
757
    checker_callback_tag: a GLib event source tag, or None
397
758
    checker_command: string; External command which is run to check
398
759
                     if client lives.  %() expansions are done at
399
760
                     runtime with vars(self) as dict, so that for
400
761
                     instance %(name)s can be used in the command.
401
 
    checker_initiator_tag: a gobject event source tag, or None
 
762
    checker_initiator_tag: a GLib event source tag, or None
402
763
    created:    datetime.datetime(); (UTC) object creation
403
764
    client_structure: Object describing what attributes a client has
404
765
                      and is used for storing the client at exit
405
766
    current_checker_command: string; current running checker_command
406
 
    disable_initiator_tag: a gobject event source tag, or None
 
767
    disable_initiator_tag: a GLib event source tag, or None
407
768
    enabled:    bool()
408
769
    fingerprint: string (40 or 32 hexadecimal digits); used to
409
770
                 uniquely identify the client
411
772
    interval:   datetime.timedelta(); How often to start a new checker
412
773
    last_approval_request: datetime.datetime(); (UTC) or None
413
774
    last_checked_ok: datetime.datetime(); (UTC) or None
414
 
 
415
775
    last_checker_status: integer between 0 and 255 reflecting exit
416
776
                         status of last checker. -1 reflects crashed
417
 
                         checker, or None.
418
 
    last_enabled: datetime.datetime(); (UTC)
 
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
419
781
    name:       string; from the config file, used in log messages and
420
782
                        D-Bus identifiers
421
783
    secret:     bytestring; sent verbatim (over TLS) to client
422
784
    timeout:    datetime.timedelta(); How long from last_checked_ok
423
785
                                      until this client is disabled
424
 
    extended_timeout:   extra long timeout when password has been sent
 
786
    extended_timeout:   extra long timeout when secret has been sent
425
787
    runtime_expansions: Allowed attributes for runtime expansion.
426
788
    expires:    datetime.datetime(); time (UTC) when a client will be
427
789
                disabled, or None
 
790
    server_settings: The server_settings dict from main()
428
791
    """
429
792
    
430
793
    runtime_expansions = ("approval_delay", "approval_duration",
431
 
                          "created", "enabled", "fingerprint",
432
 
                          "host", "interval", "last_checked_ok",
 
794
                          "created", "enabled", "expires",
 
795
                          "fingerprint", "host", "interval",
 
796
                          "last_approval_request", "last_checked_ok",
433
797
                          "last_enabled", "name", "timeout")
434
 
    
435
 
    def timeout_milliseconds(self):
436
 
        "Return the 'timeout' attribute in milliseconds"
437
 
        return _timedelta_to_milliseconds(self.timeout)
438
 
    
439
 
    def extended_timeout_milliseconds(self):
440
 
        "Return the 'extended_timeout' attribute in milliseconds"
441
 
        return _timedelta_to_milliseconds(self.extended_timeout)
442
 
    
443
 
    def interval_milliseconds(self):
444
 
        "Return the 'interval' attribute in milliseconds"
445
 
        return _timedelta_to_milliseconds(self.interval)
446
 
    
447
 
    def approval_delay_milliseconds(self):
448
 
        return _timedelta_to_milliseconds(self.approval_delay)
449
 
    
450
 
    def __init__(self, name = None, config=None):
451
 
        """Note: the 'checker' key in 'config' sets the
452
 
        'checker_command' attribute and *not* the 'checker'
453
 
        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):
454
863
        self.name = name
455
 
        if config is None:
456
 
            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
        
457
881
        logger.debug("Creating client %r", self.name)
458
 
        # Uppercase and remove spaces from fingerprint for later
459
 
        # comparison purposes with return value from the fingerprint()
460
 
        # function
461
 
        self.fingerprint = (config["fingerprint"].upper()
462
 
                            .replace(" ", ""))
463
882
        logger.debug("  Fingerprint: %s", self.fingerprint)
464
 
        if "secret" in config:
465
 
            self.secret = config["secret"].decode("base64")
466
 
        elif "secfile" in config:
467
 
            with open(os.path.expanduser(os.path.expandvars
468
 
                                         (config["secfile"])),
469
 
                      "rb") as secfile:
470
 
                self.secret = secfile.read()
471
 
        else:
472
 
            raise TypeError("No secret or secfile for client %s"
473
 
                            % self.name)
474
 
        self.host = config.get("host", "")
475
 
        self.created = datetime.datetime.utcnow()
476
 
        self.enabled = True
477
 
        self.last_approval_request = None
478
 
        self.last_enabled = datetime.datetime.utcnow()
479
 
        self.last_checked_ok = None
480
 
        self.last_checker_status = None
481
 
        self.timeout = string_to_delta(config["timeout"])
482
 
        self.extended_timeout = string_to_delta(config
483
 
                                                ["extended_timeout"])
484
 
        self.interval = string_to_delta(config["interval"])
 
883
        self.created = settings.get("created",
 
884
                                    datetime.datetime.utcnow())
 
885
        
 
886
        # attributes specific for this server instance
485
887
        self.checker = None
486
888
        self.checker_initiator_tag = None
487
889
        self.disable_initiator_tag = None
488
 
        self.expires = datetime.datetime.utcnow() + self.timeout
489
890
        self.checker_callback_tag = None
490
 
        self.checker_command = config["checker"]
491
891
        self.current_checker_command = None
492
 
        self._approved = None
493
 
        self.approved_by_default = config.get("approved_by_default",
494
 
                                              True)
 
892
        self.approved = None
495
893
        self.approvals_pending = 0
496
 
        self.approval_delay = string_to_delta(
497
 
            config["approval_delay"])
498
 
        self.approval_duration = string_to_delta(
499
 
            config["approval_duration"])
500
 
        self.changedstate = (multiprocessing_manager
501
 
                             .Condition(multiprocessing_manager
502
 
                                        .Lock()))
503
 
        self.client_structure = [attr for attr in
504
 
                                 self.__dict__.iterkeys()
 
894
        self.changedstate = multiprocessing_manager.Condition(
 
895
            multiprocessing_manager.Lock())
 
896
        self.client_structure = [attr
 
897
                                 for attr in self.__dict__.keys()
505
898
                                 if not attr.startswith("_")]
506
899
        self.client_structure.append("client_structure")
507
900
        
508
 
        for name, t in inspect.getmembers(type(self),
509
 
                                          lambda obj:
510
 
                                              isinstance(obj,
511
 
                                                         property)):
 
901
        for name, t in inspect.getmembers(
 
902
                type(self), lambda obj: isinstance(obj, property)):
512
903
            if not name.startswith("_"):
513
904
                self.client_structure.append(name)
514
905
    
522
913
        if getattr(self, "enabled", False):
523
914
            # Already enabled
524
915
            return
525
 
        self.send_changedstate()
526
916
        self.expires = datetime.datetime.utcnow() + self.timeout
527
917
        self.enabled = True
528
918
        self.last_enabled = datetime.datetime.utcnow()
529
919
        self.init_checker()
 
920
        self.send_changedstate()
530
921
    
531
922
    def disable(self, quiet=True):
532
923
        """Disable this client."""
533
924
        if not getattr(self, "enabled", False):
534
925
            return False
535
926
        if not quiet:
536
 
            self.send_changedstate()
537
 
        if not quiet:
538
927
            logger.info("Disabling client %s", self.name)
539
 
        if getattr(self, "disable_initiator_tag", False):
540
 
            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)
541
930
            self.disable_initiator_tag = None
542
931
        self.expires = None
543
 
        if getattr(self, "checker_initiator_tag", False):
544
 
            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)
545
934
            self.checker_initiator_tag = None
546
935
        self.stop_checker()
547
936
        self.enabled = False
548
 
        # 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
549
940
        return False
550
941
    
551
942
    def __del__(self):
554
945
    def init_checker(self):
555
946
        # Schedule a new checker to be started an 'interval' from now,
556
947
        # and every interval from then on.
557
 
        self.checker_initiator_tag = (gobject.timeout_add
558
 
                                      (self.interval_milliseconds(),
559
 
                                       self.start_checker))
 
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)
560
953
        # Schedule a disable() when 'timeout' has passed
561
 
        self.disable_initiator_tag = (gobject.timeout_add
562
 
                                   (self.timeout_milliseconds(),
563
 
                                    self.disable))
 
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)
564
958
        # Also start a new checker *right now*.
565
959
        self.start_checker()
566
960
    
567
 
    def checker_callback(self, pid, condition, command):
 
961
    def checker_callback(self, source, condition, connection,
 
962
                         command):
568
963
        """The checker has completed, so take appropriate actions."""
569
964
        self.checker_callback_tag = None
570
965
        self.checker = None
571
 
        if os.WIFEXITED(condition):
572
 
            self.last_checker_status =  os.WEXITSTATUS(condition)
 
966
        # Read return code from connection (see call_pipe)
 
967
        returncode = connection.recv()
 
968
        connection.close()
 
969
        
 
970
        if returncode >= 0:
 
971
            self.last_checker_status = returncode
 
972
            self.last_checker_signal = None
573
973
            if self.last_checker_status == 0:
574
974
                logger.info("Checker for %(name)s succeeded",
575
975
                            vars(self))
576
976
                self.checked_ok()
577
977
            else:
578
 
                logger.info("Checker for %(name)s failed",
579
 
                            vars(self))
 
978
                logger.info("Checker for %(name)s failed", vars(self))
580
979
        else:
581
980
            self.last_checker_status = -1
 
981
            self.last_checker_signal = -returncode
582
982
            logger.warning("Checker for %(name)s crashed?",
583
983
                           vars(self))
584
 
    
585
 
    def checked_ok(self, timeout=None):
586
 
        """Bump up the timeout for this client.
587
 
        
588
 
        This should only be called when the client has been seen,
589
 
        alive and well.
590
 
        """
 
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."""
591
995
        if timeout is None:
592
996
            timeout = self.timeout
593
 
        self.last_checked_ok = datetime.datetime.utcnow()
594
997
        if self.disable_initiator_tag is not None:
595
 
            gobject.source_remove(self.disable_initiator_tag)
 
998
            GLib.source_remove(self.disable_initiator_tag)
 
999
            self.disable_initiator_tag = None
596
1000
        if getattr(self, "enabled", False):
597
 
            self.disable_initiator_tag = (gobject.timeout_add
598
 
                                          (_timedelta_to_milliseconds
599
 
                                           (timeout), self.disable))
 
1001
            self.disable_initiator_tag = GLib.timeout_add(
 
1002
                int(timeout.total_seconds() * 1000), self.disable)
600
1003
            self.expires = datetime.datetime.utcnow() + timeout
601
1004
    
602
1005
    def need_approval(self):
608
1011
        If a checker already exists, leave it running and do
609
1012
        nothing."""
610
1013
        # The reason for not killing a running checker is that if we
611
 
        # did that, then if a checker (for some reason) started
612
 
        # running slowly and taking more than 'interval' time, the
613
 
        # client would inevitably timeout, since no checker would get
614
 
        # 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
615
1018
        # checkers alone, the checker would have to take more time
616
1019
        # than 'timeout' for the client to be disabled, which is as it
617
1020
        # should be.
618
1021
        
619
 
        # If a checker exists, make sure it is not a zombie
620
 
        try:
621
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
622
 
        except (AttributeError, OSError) as error:
623
 
            if (isinstance(error, OSError)
624
 
                and error.errno != errno.ECHILD):
625
 
                raise error
626
 
        else:
627
 
            if pid:
628
 
                logger.warning("Checker was a zombie")
629
 
                gobject.source_remove(self.checker_callback_tag)
630
 
                self.checker_callback(pid, status,
631
 
                                      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
632
1026
        # Start a new checker if needed
633
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 }
634
1032
            try:
635
 
                # In case checker_command has exactly one % operator
636
 
                command = self.checker_command % self.host
637
 
            except TypeError:
638
 
                # Escape attributes for the shell
639
 
                escaped_attrs = dict(
640
 
                    (attr,
641
 
                     re.escape(unicode(str(getattr(self, attr, "")),
642
 
                                       errors=
643
 
                                       'replace')))
644
 
                    for attr in
645
 
                    self.runtime_expansions)
646
 
                
647
 
                try:
648
 
                    command = self.checker_command % escaped_attrs
649
 
                except TypeError as error:
650
 
                    logger.error('Could not format string "%s":'
651
 
                                 ' %s', self.checker_command, error)
652
 
                    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
653
1039
            self.current_checker_command = command
654
 
            try:
655
 
                logger.info("Starting checker %r for %s",
656
 
                            command, self.name)
657
 
                # We don't need to redirect stdout and stderr, since
658
 
                # in normal mode, that is already done by daemon(),
659
 
                # and in debug mode we don't want to.  (Stdin is
660
 
                # always replaced by /dev/null.)
661
 
                self.checker = subprocess.Popen(command,
662
 
                                                close_fds=True,
663
 
                                                shell=True, cwd="/")
664
 
                self.checker_callback_tag = (gobject.child_watch_add
665
 
                                             (self.checker.pid,
666
 
                                              self.checker_callback,
667
 
                                              data=command))
668
 
                # The checker may have completed before the gobject
669
 
                # watch was added.  Check for this.
670
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
671
 
                if pid:
672
 
                    gobject.source_remove(self.checker_callback_tag)
673
 
                    self.checker_callback(pid, status, command)
674
 
            except OSError as error:
675
 
                logger.error("Failed to start subprocess: %s",
676
 
                             error)
677
 
        # 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
678
1066
        return True
679
1067
    
680
1068
    def stop_checker(self):
681
1069
        """Force the checker process, if any, to stop."""
682
1070
        if self.checker_callback_tag:
683
 
            gobject.source_remove(self.checker_callback_tag)
 
1071
            GLib.source_remove(self.checker_callback_tag)
684
1072
            self.checker_callback_tag = None
685
1073
        if getattr(self, "checker", None) is None:
686
1074
            return
687
1075
        logger.debug("Stopping checker for %(name)s", vars(self))
688
 
        try:
689
 
            os.kill(self.checker.pid, signal.SIGTERM)
690
 
            #time.sleep(0.5)
691
 
            #if self.checker.poll() is None:
692
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
693
 
        except OSError as error:
694
 
            if error.errno != errno.ESRCH: # No such process
695
 
                raise
 
1076
        self.checker.terminate()
696
1077
        self.checker = None
697
1078
 
698
1079
 
699
 
def dbus_service_property(dbus_interface, signature="v",
700
 
                          access="readwrite", byte_arrays=False):
 
1080
def dbus_service_property(dbus_interface,
 
1081
                          signature="v",
 
1082
                          access="readwrite",
 
1083
                          byte_arrays=False):
701
1084
    """Decorators for marking methods of a DBusObjectWithProperties to
702
1085
    become properties on the D-Bus.
703
1086
    
712
1095
    # "Set" method, so we fail early here:
713
1096
    if byte_arrays and signature != "ay":
714
1097
        raise ValueError("Byte arrays not supported for non-'ay'"
715
 
                         " signature %r" % signature)
 
1098
                         " signature {!r}".format(signature))
 
1099
    
716
1100
    def decorator(func):
717
1101
        func._dbus_is_property = True
718
1102
        func._dbus_interface = dbus_interface
723
1107
            func._dbus_name = func._dbus_name[:-14]
724
1108
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
725
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
    
726
1154
    return decorator
727
1155
 
728
1156
 
729
1157
class DBusPropertyException(dbus.exceptions.DBusException):
730
1158
    """A base class for D-Bus property-related exceptions
731
1159
    """
732
 
    def __unicode__(self):
733
 
        return unicode(str(self))
 
1160
    pass
734
1161
 
735
1162
 
736
1163
class DBusPropertyAccessException(DBusPropertyException):
745
1172
    pass
746
1173
 
747
1174
 
748
 
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):
749
1265
    """A D-Bus object with properties.
750
1266
    
751
1267
    Classes inheriting from this can use the dbus_service_property
753
1269
    standard Get(), Set(), and GetAll() methods on the D-Bus.
754
1270
    """
755
1271
    
756
 
    @staticmethod
757
 
    def _is_dbus_property(obj):
758
 
        return getattr(obj, "_dbus_is_property", False)
759
 
    
760
 
    def _get_all_dbus_properties(self):
761
 
        """Returns a generator of (name, attribute) pairs
762
 
        """
763
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
764
 
                for cls in self.__class__.__mro__
765
 
                for name, prop in
766
 
                inspect.getmembers(cls, self._is_dbus_property))
767
 
    
768
1272
    def _get_dbus_property(self, interface_name, property_name):
769
1273
        """Returns a bound method if one exists which is a D-Bus
770
1274
        property with the specified name and interface.
771
1275
        """
772
 
        for cls in  self.__class__.__mro__:
773
 
            for name, value in (inspect.getmembers
774
 
                                (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")):
775
1279
                if (value._dbus_name == property_name
776
1280
                    and value._dbus_interface == interface_name):
777
1281
                    return value.__get__(self)
778
1282
        
779
1283
        # No such property
780
 
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
781
 
                                   + interface_name + "."
782
 
                                   + property_name)
783
 
    
784
 
    @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",
785
1298
                         out_signature="v")
786
1299
    def Get(self, interface_name, property_name):
787
1300
        """Standard D-Bus property Get() method, see D-Bus standard.
805
1318
            # The byte_arrays option is not supported yet on
806
1319
            # signatures other than "ay".
807
1320
            if prop._dbus_signature != "ay":
808
 
                raise ValueError
809
 
            value = dbus.ByteArray(''.join(unichr(byte)
810
 
                                           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))
811
1326
        prop(value)
812
1327
    
813
 
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
1328
    @dbus.service.method(dbus.PROPERTIES_IFACE,
 
1329
                         in_signature="s",
814
1330
                         out_signature="a{sv}")
815
1331
    def GetAll(self, interface_name):
816
1332
        """Standard D-Bus property GetAll() method, see D-Bus
819
1335
        Note: Will not include properties with access="write".
820
1336
        """
821
1337
        properties = {}
822
 
        for name, prop in self._get_all_dbus_properties():
 
1338
        for name, prop in self._get_all_dbus_things("property"):
823
1339
            if (interface_name
824
1340
                and interface_name != prop._dbus_interface):
825
1341
                # Interface non-empty but did not match
831
1347
            if not hasattr(value, "variant_level"):
832
1348
                properties[name] = value
833
1349
                continue
834
 
            properties[name] = type(value)(value, variant_level=
835
 
                                           value.variant_level+1)
 
1350
            properties[name] = type(value)(
 
1351
                value, variant_level = value.variant_level + 1)
836
1352
        return dbus.Dictionary(properties, signature="sv")
837
1353
    
 
1354
    @dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
 
1355
    def PropertiesChanged(self, interface_name, changed_properties,
 
1356
                          invalidated_properties):
 
1357
        """Standard D-Bus PropertiesChanged() signal, see D-Bus
 
1358
        standard.
 
1359
        """
 
1360
        pass
 
1361
    
838
1362
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
839
1363
                         out_signature="s",
840
1364
                         path_keyword='object_path',
841
1365
                         connection_keyword='connection')
842
1366
    def Introspect(self, object_path, connection):
843
 
        """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.
844
1370
        """
845
 
        xmlstring = dbus.service.Object.Introspect(self, object_path,
846
 
                                                   connection)
 
1371
        xmlstring = DBusObjectWithAnnotations.Introspect(self,
 
1372
                                                         object_path,
 
1373
                                                         connection)
847
1374
        try:
848
1375
            document = xml.dom.minidom.parseString(xmlstring)
 
1376
            
849
1377
            def make_tag(document, name, prop):
850
1378
                e = document.createElement("property")
851
1379
                e.setAttribute("name", name)
852
1380
                e.setAttribute("type", prop._dbus_signature)
853
1381
                e.setAttribute("access", prop._dbus_access)
854
1382
                return e
 
1383
            
855
1384
            for if_tag in document.getElementsByTagName("interface"):
 
1385
                # Add property tags
856
1386
                for tag in (make_tag(document, name, prop)
857
1387
                            for name, prop
858
 
                            in self._get_all_dbus_properties()
 
1388
                            in self._get_all_dbus_things("property")
859
1389
                            if prop._dbus_interface
860
1390
                            == if_tag.getAttribute("name")):
861
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)
862
1408
                # Add the names to the return values for the
863
1409
                # "org.freedesktop.DBus.Properties" methods
864
1410
                if (if_tag.getAttribute("name")
879
1425
        except (AttributeError, xml.dom.DOMException,
880
1426
                xml.parsers.expat.ExpatError) as error:
881
1427
            logger.error("Failed to override Introspection method",
882
 
                         error)
883
 
        return xmlstring
884
 
 
885
 
 
886
 
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):
887
1501
    """Convert a UTC datetime.datetime() to a D-Bus type."""
888
1502
    if dt is None:
889
1503
        return dbus.String("", variant_level = variant_level)
890
 
    return dbus.String(dt.isoformat(),
891
 
                       variant_level=variant_level)
892
 
 
893
 
 
894
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
895
 
                                  .__metaclass__):
896
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
897
 
    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).
898
1529
    """
899
 
    def __new__(mcs, name, bases, attr):
900
 
        # Go through all the base classes which could have D-Bus
901
 
        # methods, signals, or properties in them
902
 
        for base in (b for b in bases
903
 
                     if issubclass(b, dbus.service.Object)):
904
 
            # Go though all attributes of the base class
905
 
            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):
906
1538
                # Ignore non-D-Bus attributes, and D-Bus attributes
907
1539
                # with the wrong interface name
908
1540
                if (not hasattr(attribute, "_dbus_interface")
909
 
                    or not attribute._dbus_interface
910
 
                    .startswith("se.recompile.Mandos")):
 
1541
                    or not attribute._dbus_interface.startswith(
 
1542
                        orig_interface_name)):
911
1543
                    continue
912
1544
                # Create an alternate D-Bus interface name based on
913
1545
                # the current name
914
 
                alt_interface = (attribute._dbus_interface
915
 
                                 .replace("se.recompile.Mandos",
916
 
                                          "se.bsnet.fukt.Mandos"))
 
1546
                alt_interface = attribute._dbus_interface.replace(
 
1547
                    orig_interface_name, alt_interface_name)
 
1548
                interface_names.add(alt_interface)
917
1549
                # Is this a D-Bus signal?
918
1550
                if getattr(attribute, "_dbus_is_signal", False):
919
 
                    # Extract the original non-method function by
920
 
                    # black magic
921
 
                    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(
922
1555
                            zip(attribute.func_code.co_freevars,
923
 
                                attribute.__closure__))["func"]
924
 
                                      .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)
925
1563
                    # Create a new, but exactly alike, function
926
1564
                    # object, and decorate it to be a new D-Bus signal
927
1565
                    # with the alternate D-Bus interface name
928
 
                    new_function = (dbus.service.signal
929
 
                                    (alt_interface,
930
 
                                     attribute._dbus_signature)
931
 
                                    (types.FunctionType(
932
 
                                nonmethod_func.func_code,
933
 
                                nonmethod_func.func_globals,
934
 
                                nonmethod_func.func_name,
935
 
                                nonmethod_func.func_defaults,
936
 
                                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
937
1576
                    # Define a creator of a function to call both the
938
 
                    # old and new functions, so both the old and new
939
 
                    # 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
940
1580
                    def fixscope(func1, func2):
941
1581
                        """This function is a scope container to pass
942
1582
                        func1 and func2 to the "call_both" function
943
1583
                        outside of its arguments"""
 
1584
                        
 
1585
                        @functools.wraps(func2)
944
1586
                        def call_both(*args, **kwargs):
945
1587
                            """This function will emit two D-Bus
946
1588
                            signals by calling func1 and func2"""
947
1589
                            func1(*args, **kwargs)
948
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
                        
949
1596
                        return call_both
950
1597
                    # Create the "call_both" function and add it to
951
1598
                    # the class
952
 
                    attr[attrname] = fixscope(attribute,
953
 
                                              new_function)
 
1599
                    attr[attrname] = fixscope(attribute, new_function)
954
1600
                # Is this a D-Bus method?
955
1601
                elif getattr(attribute, "_dbus_is_method", False):
956
1602
                    # Create a new, but exactly alike, function
957
1603
                    # object.  Decorate it to be a new D-Bus method
958
1604
                    # with the alternate D-Bus interface name.  Add it
959
1605
                    # to the class.
960
 
                    attr[attrname] = (dbus.service.method
961
 
                                      (alt_interface,
962
 
                                       attribute._dbus_in_signature,
963
 
                                       attribute._dbus_out_signature)
964
 
                                      (types.FunctionType
965
 
                                       (attribute.func_code,
966
 
                                        attribute.func_globals,
967
 
                                        attribute.func_name,
968
 
                                        attribute.func_defaults,
969
 
                                        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
970
1618
                # Is this a D-Bus property?
971
1619
                elif getattr(attribute, "_dbus_is_property", False):
972
1620
                    # Create a new, but exactly alike, function
973
1621
                    # object, and decorate it to be a new D-Bus
974
1622
                    # property with the alternate D-Bus interface
975
1623
                    # name.  Add it to the class.
976
 
                    attr[attrname] = (dbus_service_property
977
 
                                      (alt_interface,
978
 
                                       attribute._dbus_signature,
979
 
                                       attribute._dbus_access,
980
 
                                       attribute
981
 
                                       ._dbus_get_args_options
982
 
                                       ["byte_arrays"])
983
 
                                      (types.FunctionType
984
 
                                       (attribute.func_code,
985
 
                                        attribute.func_globals,
986
 
                                        attribute.func_name,
987
 
                                        attribute.func_defaults,
988
 
                                        attribute.func_closure)))
989
 
        return type.__new__(mcs, name, bases, attr)
990
 
 
991
 
 
 
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"})
992
1676
class ClientDBus(Client, DBusObjectWithProperties):
993
1677
    """A Client class using D-Bus
994
1678
    
998
1682
    """
999
1683
    
1000
1684
    runtime_expansions = (Client.runtime_expansions
1001
 
                          + ("dbus_object_path",))
 
1685
                          + ("dbus_object_path", ))
 
1686
    
 
1687
    _interface = "se.recompile.Mandos.Client"
1002
1688
    
1003
1689
    # dbus.service.Object doesn't use super(), so we can't either.
1004
1690
    
1005
1691
    def __init__(self, bus = None, *args, **kwargs):
1006
1692
        self.bus = bus
1007
1693
        Client.__init__(self, *args, **kwargs)
1008
 
        
1009
 
        self._approvals_pending = 0
1010
1694
        # Only now, when this client is initialized, can it show up on
1011
1695
        # the D-Bus
1012
 
        client_object_name = unicode(self.name).translate(
 
1696
        client_object_name = str(self.name).translate(
1013
1697
            {ord("."): ord("_"),
1014
1698
             ord("-"): ord("_")})
1015
 
        self.dbus_object_path = (dbus.ObjectPath
1016
 
                                 ("/clients/" + client_object_name))
 
1699
        self.dbus_object_path = dbus.ObjectPath(
 
1700
            "/clients/" + client_object_name)
1017
1701
        DBusObjectWithProperties.__init__(self, self.bus,
1018
1702
                                          self.dbus_object_path)
1019
 
        
1020
 
    def notifychangeproperty(transform_func,
1021
 
                             dbus_name, type_func=lambda x: x,
1022
 
                             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):
1023
1709
        """ Modify a variable so that it's a property which announces
1024
1710
        its changes to DBus.
1025
1711
        
1030
1716
                   to the D-Bus.  Default: no transform
1031
1717
        variant_level: D-Bus variant level.  Default: 1
1032
1718
        """
1033
 
        attrname = "_{0}".format(dbus_name)
 
1719
        attrname = "_{}".format(dbus_name)
 
1720
        
1034
1721
        def setter(self, value):
1035
1722
            if hasattr(self, "dbus_object_path"):
1036
1723
                if (not hasattr(self, attrname) or
1037
1724
                    type_func(getattr(self, attrname, None))
1038
1725
                    != type_func(value)):
1039
 
                    dbus_value = transform_func(type_func(value),
1040
 
                                                variant_level
1041
 
                                                =variant_level)
1042
 
                    self.PropertyChanged(dbus.String(dbus_name),
1043
 
                                         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())
1044
1741
            setattr(self, attrname, value)
1045
1742
        
1046
1743
        return property(lambda self: getattr(self, attrname), setter)
1047
1744
    
1048
 
    
1049
1745
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1050
1746
    approvals_pending = notifychangeproperty(dbus.Boolean,
1051
1747
                                             "ApprovalPending",
1053
1749
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1054
1750
    last_enabled = notifychangeproperty(datetime_to_dbus,
1055
1751
                                        "LastEnabled")
1056
 
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1057
 
                                   type_func = lambda checker:
1058
 
                                       checker is not None)
 
1752
    checker = notifychangeproperty(
 
1753
        dbus.Boolean, "CheckerRunning",
 
1754
        type_func = lambda checker: checker is not None)
1059
1755
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1060
1756
                                           "LastCheckedOK")
 
1757
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1758
                                               "LastCheckerStatus")
1061
1759
    last_approval_request = notifychangeproperty(
1062
1760
        datetime_to_dbus, "LastApprovalRequest")
1063
1761
    approved_by_default = notifychangeproperty(dbus.Boolean,
1064
1762
                                               "ApprovedByDefault")
1065
 
    approval_delay = notifychangeproperty(dbus.UInt16,
1066
 
                                          "ApprovalDelay",
1067
 
                                          type_func =
1068
 
                                          _timedelta_to_milliseconds)
 
1763
    approval_delay = notifychangeproperty(
 
1764
        dbus.UInt64, "ApprovalDelay",
 
1765
        type_func = lambda td: td.total_seconds() * 1000)
1069
1766
    approval_duration = notifychangeproperty(
1070
 
        dbus.UInt16, "ApprovalDuration",
1071
 
        type_func = _timedelta_to_milliseconds)
 
1767
        dbus.UInt64, "ApprovalDuration",
 
1768
        type_func = lambda td: td.total_seconds() * 1000)
1072
1769
    host = notifychangeproperty(dbus.String, "Host")
1073
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1074
 
                                   type_func =
1075
 
                                   _timedelta_to_milliseconds)
 
1770
    timeout = notifychangeproperty(
 
1771
        dbus.UInt64, "Timeout",
 
1772
        type_func = lambda td: td.total_seconds() * 1000)
1076
1773
    extended_timeout = notifychangeproperty(
1077
 
        dbus.UInt16, "ExtendedTimeout",
1078
 
        type_func = _timedelta_to_milliseconds)
1079
 
    interval = notifychangeproperty(dbus.UInt16,
1080
 
                                    "Interval",
1081
 
                                    type_func =
1082
 
                                    _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)
1083
1779
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1780
    secret = notifychangeproperty(dbus.ByteArray, "Secret",
 
1781
                                  invalidate_only=True)
1084
1782
    
1085
1783
    del notifychangeproperty
1086
1784
    
1093
1791
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
1094
1792
        Client.__del__(self, *args, **kwargs)
1095
1793
    
1096
 
    def checker_callback(self, pid, condition, command,
1097
 
                         *args, **kwargs):
1098
 
        self.checker_callback_tag = None
1099
 
        self.checker = None
1100
 
        if os.WIFEXITED(condition):
1101
 
            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:
1102
1801
            # Emit D-Bus signal
1103
1802
            self.CheckerCompleted(dbus.Int16(exitstatus),
1104
 
                                  dbus.Int64(condition),
 
1803
                                  # This is specific to GNU libC
 
1804
                                  dbus.Int64(exitstatus << 8),
1105
1805
                                  dbus.String(command))
1106
1806
        else:
1107
1807
            # Emit D-Bus signal
1108
1808
            self.CheckerCompleted(dbus.Int16(-1),
1109
 
                                  dbus.Int64(condition),
 
1809
                                  dbus.Int64(
 
1810
                                      # This is specific to GNU libC
 
1811
                                      (exitstatus << 8)
 
1812
                                      | self.last_checker_signal),
1110
1813
                                  dbus.String(command))
1111
 
        
1112
 
        return Client.checker_callback(self, pid, condition, command,
1113
 
                                       *args, **kwargs)
 
1814
        return ret
1114
1815
    
1115
1816
    def start_checker(self, *args, **kwargs):
1116
 
        old_checker = self.checker
1117
 
        if self.checker is not None:
1118
 
            old_checker_pid = self.checker.pid
1119
 
        else:
1120
 
            old_checker_pid = None
 
1817
        old_checker_pid = getattr(self.checker, "pid", None)
1121
1818
        r = Client.start_checker(self, *args, **kwargs)
1122
1819
        # Only if new checker process was started
1123
1820
        if (self.checker is not None
1127
1824
        return r
1128
1825
    
1129
1826
    def _reset_approved(self):
1130
 
        self._approved = None
 
1827
        self.approved = None
1131
1828
        return False
1132
1829
    
1133
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)
1134
1834
        self.send_changedstate()
1135
 
        self._approved = value
1136
 
        gobject.timeout_add(_timedelta_to_milliseconds
1137
 
                            (self.approval_duration),
1138
 
                            self._reset_approved)
1139
 
    
1140
1835
    
1141
1836
    ## D-Bus methods, signals & properties
1142
 
    _interface = "se.recompile.Mandos.Client"
 
1837
    
 
1838
    ## Interfaces
1143
1839
    
1144
1840
    ## Signals
1145
1841
    
1156
1852
        pass
1157
1853
    
1158
1854
    # PropertyChanged - signal
 
1855
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1159
1856
    @dbus.service.signal(_interface, signature="sv")
1160
1857
    def PropertyChanged(self, property, value):
1161
1858
        "D-Bus signal"
1182
1879
        "D-Bus signal"
1183
1880
        return self.need_approval()
1184
1881
    
1185
 
    # NeRwequest - signal
1186
 
    @dbus.service.signal(_interface, signature="s")
1187
 
    def NewRequest(self, ip):
1188
 
        """D-Bus signal
1189
 
        Is sent after a client request a password.
1190
 
        """
1191
 
        pass
1192
 
    
1193
1882
    ## Methods
1194
1883
    
1195
1884
    # Approve - method
1203
1892
        self.checked_ok()
1204
1893
    
1205
1894
    # Enable - method
 
1895
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1206
1896
    @dbus.service.method(_interface)
1207
1897
    def Enable(self):
1208
1898
        "D-Bus method"
1209
1899
        self.enable()
1210
1900
    
1211
1901
    # StartChecker - method
 
1902
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1212
1903
    @dbus.service.method(_interface)
1213
1904
    def StartChecker(self):
1214
1905
        "D-Bus method"
1215
1906
        self.start_checker()
1216
1907
    
1217
1908
    # Disable - method
 
1909
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1218
1910
    @dbus.service.method(_interface)
1219
1911
    def Disable(self):
1220
1912
        "D-Bus method"
1221
1913
        self.disable()
1222
1914
    
1223
1915
    # StopChecker - method
 
1916
    @dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1224
1917
    @dbus.service.method(_interface)
1225
1918
    def StopChecker(self):
1226
1919
        self.stop_checker()
1233
1926
        return dbus.Boolean(bool(self.approvals_pending))
1234
1927
    
1235
1928
    # ApprovedByDefault - property
1236
 
    @dbus_service_property(_interface, signature="b",
 
1929
    @dbus_service_property(_interface,
 
1930
                           signature="b",
1237
1931
                           access="readwrite")
1238
1932
    def ApprovedByDefault_dbus_property(self, value=None):
1239
1933
        if value is None:       # get
1241
1935
        self.approved_by_default = bool(value)
1242
1936
    
1243
1937
    # ApprovalDelay - property
1244
 
    @dbus_service_property(_interface, signature="t",
 
1938
    @dbus_service_property(_interface,
 
1939
                           signature="t",
1245
1940
                           access="readwrite")
1246
1941
    def ApprovalDelay_dbus_property(self, value=None):
1247
1942
        if value is None:       # get
1248
 
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1943
            return dbus.UInt64(self.approval_delay.total_seconds()
 
1944
                               * 1000)
1249
1945
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1250
1946
    
1251
1947
    # ApprovalDuration - property
1252
 
    @dbus_service_property(_interface, signature="t",
 
1948
    @dbus_service_property(_interface,
 
1949
                           signature="t",
1253
1950
                           access="readwrite")
1254
1951
    def ApprovalDuration_dbus_property(self, value=None):
1255
1952
        if value is None:       # get
1256
 
            return dbus.UInt64(_timedelta_to_milliseconds(
1257
 
                    self.approval_duration))
 
1953
            return dbus.UInt64(self.approval_duration.total_seconds()
 
1954
                               * 1000)
1258
1955
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1259
1956
    
1260
1957
    # Name - property
 
1958
    @dbus_annotations(
 
1959
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1261
1960
    @dbus_service_property(_interface, signature="s", access="read")
1262
1961
    def Name_dbus_property(self):
1263
1962
        return dbus.String(self.name)
1264
1963
    
1265
1964
    # Fingerprint - property
 
1965
    @dbus_annotations(
 
1966
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1266
1967
    @dbus_service_property(_interface, signature="s", access="read")
1267
1968
    def Fingerprint_dbus_property(self):
1268
1969
        return dbus.String(self.fingerprint)
1269
1970
    
1270
1971
    # Host - property
1271
 
    @dbus_service_property(_interface, signature="s",
 
1972
    @dbus_service_property(_interface,
 
1973
                           signature="s",
1272
1974
                           access="readwrite")
1273
1975
    def Host_dbus_property(self, value=None):
1274
1976
        if value is None:       # get
1275
1977
            return dbus.String(self.host)
1276
 
        self.host = value
 
1978
        self.host = str(value)
1277
1979
    
1278
1980
    # Created - property
 
1981
    @dbus_annotations(
 
1982
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1279
1983
    @dbus_service_property(_interface, signature="s", access="read")
1280
1984
    def Created_dbus_property(self):
1281
 
        return dbus.String(datetime_to_dbus(self.created))
 
1985
        return datetime_to_dbus(self.created)
1282
1986
    
1283
1987
    # LastEnabled - property
1284
1988
    @dbus_service_property(_interface, signature="s", access="read")
1286
1990
        return datetime_to_dbus(self.last_enabled)
1287
1991
    
1288
1992
    # Enabled - property
1289
 
    @dbus_service_property(_interface, signature="b",
 
1993
    @dbus_service_property(_interface,
 
1994
                           signature="b",
1290
1995
                           access="readwrite")
1291
1996
    def Enabled_dbus_property(self, value=None):
1292
1997
        if value is None:       # get
1297
2002
            self.disable()
1298
2003
    
1299
2004
    # LastCheckedOK - property
1300
 
    @dbus_service_property(_interface, signature="s",
 
2005
    @dbus_service_property(_interface,
 
2006
                           signature="s",
1301
2007
                           access="readwrite")
1302
2008
    def LastCheckedOK_dbus_property(self, value=None):
1303
2009
        if value is not None:
1305
2011
            return
1306
2012
        return datetime_to_dbus(self.last_checked_ok)
1307
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
    
1308
2019
    # Expires - property
1309
2020
    @dbus_service_property(_interface, signature="s", access="read")
1310
2021
    def Expires_dbus_property(self):
1316
2027
        return datetime_to_dbus(self.last_approval_request)
1317
2028
    
1318
2029
    # Timeout - property
1319
 
    @dbus_service_property(_interface, signature="t",
 
2030
    @dbus_service_property(_interface,
 
2031
                           signature="t",
1320
2032
                           access="readwrite")
1321
2033
    def Timeout_dbus_property(self, value=None):
1322
2034
        if value is None:       # get
1323
 
            return dbus.UInt64(self.timeout_milliseconds())
 
2035
            return dbus.UInt64(self.timeout.total_seconds() * 1000)
 
2036
        old_timeout = self.timeout
1324
2037
        self.timeout = datetime.timedelta(0, 0, 0, value)
1325
 
        if getattr(self, "disable_initiator_tag", None) is None:
1326
 
            return
1327
 
        # Reschedule timeout
1328
 
        gobject.source_remove(self.disable_initiator_tag)
1329
 
        self.disable_initiator_tag = None
1330
 
        self.expires = None
1331
 
        time_to_die = _timedelta_to_milliseconds((self
1332
 
                                                  .last_checked_ok
1333
 
                                                  + self.timeout)
1334
 
                                                 - datetime.datetime
1335
 
                                                 .utcnow())
1336
 
        if time_to_die <= 0:
1337
 
            # The timeout has passed
1338
 
            self.disable()
1339
 
        else:
1340
 
            self.expires = (datetime.datetime.utcnow()
1341
 
                            + datetime.timedelta(milliseconds =
1342
 
                                                 time_to_die))
1343
 
            self.disable_initiator_tag = (gobject.timeout_add
1344
 
                                          (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)
1345
2053
    
1346
2054
    # ExtendedTimeout - property
1347
 
    @dbus_service_property(_interface, signature="t",
 
2055
    @dbus_service_property(_interface,
 
2056
                           signature="t",
1348
2057
                           access="readwrite")
1349
2058
    def ExtendedTimeout_dbus_property(self, value=None):
1350
2059
        if value is None:       # get
1351
 
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
2060
            return dbus.UInt64(self.extended_timeout.total_seconds()
 
2061
                               * 1000)
1352
2062
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1353
2063
    
1354
2064
    # Interval - property
1355
 
    @dbus_service_property(_interface, signature="t",
 
2065
    @dbus_service_property(_interface,
 
2066
                           signature="t",
1356
2067
                           access="readwrite")
1357
2068
    def Interval_dbus_property(self, value=None):
1358
2069
        if value is None:       # get
1359
 
            return dbus.UInt64(self.interval_milliseconds())
 
2070
            return dbus.UInt64(self.interval.total_seconds() * 1000)
1360
2071
        self.interval = datetime.timedelta(0, 0, 0, value)
1361
2072
        if getattr(self, "checker_initiator_tag", None) is None:
1362
2073
            return
1363
 
        # Reschedule checker run
1364
 
        gobject.source_remove(self.checker_initiator_tag)
1365
 
        self.checker_initiator_tag = (gobject.timeout_add
1366
 
                                      (value, self.start_checker))
1367
 
        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
1368
2080
    
1369
2081
    # Checker - property
1370
 
    @dbus_service_property(_interface, signature="s",
 
2082
    @dbus_service_property(_interface,
 
2083
                           signature="s",
1371
2084
                           access="readwrite")
1372
2085
    def Checker_dbus_property(self, value=None):
1373
2086
        if value is None:       # get
1374
2087
            return dbus.String(self.checker_command)
1375
 
        self.checker_command = value
 
2088
        self.checker_command = str(value)
1376
2089
    
1377
2090
    # CheckerRunning - property
1378
 
    @dbus_service_property(_interface, signature="b",
 
2091
    @dbus_service_property(_interface,
 
2092
                           signature="b",
1379
2093
                           access="readwrite")
1380
2094
    def CheckerRunning_dbus_property(self, value=None):
1381
2095
        if value is None:       # get
1386
2100
            self.stop_checker()
1387
2101
    
1388
2102
    # ObjectPath - property
 
2103
    @dbus_annotations(
 
2104
        {"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
 
2105
         "org.freedesktop.DBus.Deprecated": "true"})
1389
2106
    @dbus_service_property(_interface, signature="o", access="read")
1390
2107
    def ObjectPath_dbus_property(self):
1391
2108
        return self.dbus_object_path # is already a dbus.ObjectPath
1392
2109
    
1393
2110
    # Secret = property
1394
 
    @dbus_service_property(_interface, signature="ay",
1395
 
                           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)
1396
2118
    def Secret_dbus_property(self, value):
1397
 
        self.secret = str(value)
 
2119
        self.secret = bytes(value)
1398
2120
    
1399
2121
    del _interface
1400
2122
 
1404
2126
        self._pipe = child_pipe
1405
2127
        self._pipe.send(('init', fpr, address))
1406
2128
        if not self._pipe.recv():
1407
 
            raise KeyError()
 
2129
            raise KeyError(fpr)
1408
2130
    
1409
2131
    def __getattribute__(self, name):
1410
 
        if(name == '_pipe'):
 
2132
        if name == '_pipe':
1411
2133
            return super(ProxyClient, self).__getattribute__(name)
1412
2134
        self._pipe.send(('getattr', name))
1413
2135
        data = self._pipe.recv()
1414
2136
        if data[0] == 'data':
1415
2137
            return data[1]
1416
2138
        if data[0] == 'function':
 
2139
            
1417
2140
            def func(*args, **kwargs):
1418
2141
                self._pipe.send(('funcall', name, args, kwargs))
1419
2142
                return self._pipe.recv()[1]
 
2143
            
1420
2144
            return func
1421
2145
    
1422
2146
    def __setattr__(self, name, value):
1423
 
        if(name == '_pipe'):
 
2147
        if name == '_pipe':
1424
2148
            return super(ProxyClient, self).__setattr__(name, value)
1425
2149
        self._pipe.send(('setattr', name, value))
1426
2150
 
1427
2151
 
1428
 
class ClientDBusTransitional(ClientDBus):
1429
 
    __metaclass__ = AlternateDBusNamesMetaclass
1430
 
 
1431
 
 
1432
2152
class ClientHandler(socketserver.BaseRequestHandler, object):
1433
2153
    """A class to handle client connections.
1434
2154
    
1438
2158
    def handle(self):
1439
2159
        with contextlib.closing(self.server.child_pipe) as child_pipe:
1440
2160
            logger.info("TCP connection from: %s",
1441
 
                        unicode(self.client_address))
 
2161
                        str(self.client_address))
1442
2162
            logger.debug("Pipe FD: %d",
1443
2163
                         self.server.child_pipe.fileno())
1444
2164
            
1445
 
            session = (gnutls.connection
1446
 
                       .ClientSession(self.request,
1447
 
                                      gnutls.connection
1448
 
                                      .X509Credentials()))
1449
 
            
1450
 
            # Note: gnutls.connection.X509Credentials is really a
1451
 
            # generic GnuTLS certificate credentials object so long as
1452
 
            # no X.509 keys are added to it.  Therefore, we can use it
1453
 
            # here despite using OpenPGP certificates.
 
2165
            session = gnutls.ClientSession(self.request)
1454
2166
            
1455
2167
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1456
2168
            #                      "+AES-256-CBC", "+SHA1",
1460
2172
            priority = self.server.gnutls_priority
1461
2173
            if priority is None:
1462
2174
                priority = "NORMAL"
1463
 
            (gnutls.library.functions
1464
 
             .gnutls_priority_set_direct(session._c_object,
1465
 
                                         priority, None))
 
2175
            gnutls.priority_set_direct(session._c_object, priority,
 
2176
                                       None)
1466
2177
            
1467
2178
            # Start communication using the Mandos protocol
1468
2179
            # Get protocol number
1470
2181
            logger.debug("Protocol version: %r", line)
1471
2182
            try:
1472
2183
                if int(line.strip().split()[0]) > 1:
1473
 
                    raise RuntimeError
 
2184
                    raise RuntimeError(line)
1474
2185
            except (ValueError, IndexError, RuntimeError) as error:
1475
2186
                logger.error("Unknown protocol version: %s", error)
1476
2187
                return
1478
2189
            # Start GnuTLS connection
1479
2190
            try:
1480
2191
                session.handshake()
1481
 
            except gnutls.errors.GNUTLSError as error:
 
2192
            except gnutls.Error as error:
1482
2193
                logger.warning("Handshake failed: %s", error)
1483
2194
                # Do not run session.bye() here: the session is not
1484
2195
                # established.  Just abandon the request.
1488
2199
            approval_required = False
1489
2200
            try:
1490
2201
                try:
1491
 
                    fpr = self.fingerprint(self.peer_certificate
1492
 
                                           (session))
1493
 
                except (TypeError,
1494
 
                        gnutls.errors.GNUTLSError) as error:
 
2202
                    fpr = self.fingerprint(
 
2203
                        self.peer_certificate(session))
 
2204
                except (TypeError, gnutls.Error) as error:
1495
2205
                    logger.warning("Bad certificate: %s", error)
1496
2206
                    return
1497
2207
                logger.debug("Fingerprint: %s", fpr)
1498
 
                if self.server.use_dbus:
1499
 
                    # Emit D-Bus signal
1500
 
                    client.NewRequest(str(self.client_address))
1501
2208
                
1502
2209
                try:
1503
2210
                    client = ProxyClient(child_pipe, fpr,
1513
2220
                while True:
1514
2221
                    if not client.enabled:
1515
2222
                        logger.info("Client %s is disabled",
1516
 
                                       client.name)
 
2223
                                    client.name)
1517
2224
                        if self.server.use_dbus:
1518
2225
                            # Emit D-Bus signal
1519
2226
                            client.Rejected("Disabled")
1520
2227
                        return
1521
2228
                    
1522
 
                    if client._approved or not client.approval_delay:
 
2229
                    if client.approved or not client.approval_delay:
1523
2230
                        #We are approved or approval is disabled
1524
2231
                        break
1525
 
                    elif client._approved is None:
 
2232
                    elif client.approved is None:
1526
2233
                        logger.info("Client %s needs approval",
1527
2234
                                    client.name)
1528
2235
                        if self.server.use_dbus:
1529
2236
                            # Emit D-Bus signal
1530
2237
                            client.NeedApproval(
1531
 
                                client.approval_delay_milliseconds(),
1532
 
                                client.approved_by_default)
 
2238
                                client.approval_delay.total_seconds()
 
2239
                                * 1000, client.approved_by_default)
1533
2240
                    else:
1534
2241
                        logger.warning("Client %s was not approved",
1535
2242
                                       client.name)
1541
2248
                    #wait until timeout or approved
1542
2249
                    time = datetime.datetime.now()
1543
2250
                    client.changedstate.acquire()
1544
 
                    (client.changedstate.wait
1545
 
                     (float(client._timedelta_to_milliseconds(delay)
1546
 
                            / 1000)))
 
2251
                    client.changedstate.wait(delay.total_seconds())
1547
2252
                    client.changedstate.release()
1548
2253
                    time2 = datetime.datetime.now()
1549
2254
                    if (time2 - time) >= delay:
1560
2265
                    else:
1561
2266
                        delay -= time2 - time
1562
2267
                
1563
 
                sent_size = 0
1564
 
                while sent_size < len(client.secret):
1565
 
                    try:
1566
 
                        sent = session.send(client.secret[sent_size:])
1567
 
                    except gnutls.errors.GNUTLSError as error:
1568
 
                        logger.warning("gnutls send failed")
1569
 
                        return
1570
 
                    logger.debug("Sent: %d, remaining: %d",
1571
 
                                 sent, len(client.secret)
1572
 
                                 - (sent_size + sent))
1573
 
                    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
1574
2274
                
1575
2275
                logger.info("Sending secret to %s", client.name)
1576
2276
                # bump the timeout using extended_timeout
1577
 
                client.checked_ok(client.extended_timeout)
 
2277
                client.bump_timeout(client.extended_timeout)
1578
2278
                if self.server.use_dbus:
1579
2279
                    # Emit D-Bus signal
1580
2280
                    client.GotSecret()
1584
2284
                    client.approvals_pending -= 1
1585
2285
                try:
1586
2286
                    session.bye()
1587
 
                except gnutls.errors.GNUTLSError as error:
1588
 
                    logger.warning("GnuTLS bye failed")
 
2287
                except gnutls.Error as error:
 
2288
                    logger.warning("GnuTLS bye failed",
 
2289
                                   exc_info=error)
1589
2290
    
1590
2291
    @staticmethod
1591
2292
    def peer_certificate(session):
1592
2293
        "Return the peer's OpenPGP certificate as a bytestring"
1593
2294
        # If not an OpenPGP certificate...
1594
 
        if (gnutls.library.functions
1595
 
            .gnutls_certificate_type_get(session._c_object)
1596
 
            != gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1597
 
            # ...do the normal thing
1598
 
            return session.peer_certificate
 
2295
        if (gnutls.certificate_type_get(session._c_object)
 
2296
            != gnutls.CRT_OPENPGP):
 
2297
            # ...return invalid data
 
2298
            return b""
1599
2299
        list_size = ctypes.c_uint(1)
1600
 
        cert_list = (gnutls.library.functions
1601
 
                     .gnutls_certificate_get_peers
 
2300
        cert_list = (gnutls.certificate_get_peers
1602
2301
                     (session._c_object, ctypes.byref(list_size)))
1603
2302
        if not bool(cert_list) and list_size.value != 0:
1604
 
            raise gnutls.errors.GNUTLSError("error getting peer"
1605
 
                                            " certificate")
 
2303
            raise gnutls.Error("error getting peer certificate")
1606
2304
        if list_size.value == 0:
1607
2305
            return None
1608
2306
        cert = cert_list[0]
1612
2310
    def fingerprint(openpgp):
1613
2311
        "Convert an OpenPGP bytestring to a hexdigit fingerprint"
1614
2312
        # New GnuTLS "datum" with the OpenPGP public key
1615
 
        datum = (gnutls.library.types
1616
 
                 .gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1617
 
                                             ctypes.POINTER
1618
 
                                             (ctypes.c_ubyte)),
1619
 
                                 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)))
1620
2317
        # New empty GnuTLS certificate
1621
 
        crt = gnutls.library.types.gnutls_openpgp_crt_t()
1622
 
        (gnutls.library.functions
1623
 
         .gnutls_openpgp_crt_init(ctypes.byref(crt)))
 
2318
        crt = gnutls.openpgp_crt_t()
 
2319
        gnutls.openpgp_crt_init(ctypes.byref(crt))
1624
2320
        # Import the OpenPGP public key into the certificate
1625
 
        (gnutls.library.functions
1626
 
         .gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1627
 
                                    gnutls.library.constants
1628
 
                                    .GNUTLS_OPENPGP_FMT_RAW))
 
2321
        gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
 
2322
                                  gnutls.OPENPGP_FMT_RAW)
1629
2323
        # Verify the self signature in the key
1630
2324
        crtverify = ctypes.c_uint()
1631
 
        (gnutls.library.functions
1632
 
         .gnutls_openpgp_crt_verify_self(crt, 0,
1633
 
                                         ctypes.byref(crtverify)))
 
2325
        gnutls.openpgp_crt_verify_self(crt, 0,
 
2326
                                       ctypes.byref(crtverify))
1634
2327
        if crtverify.value != 0:
1635
 
            gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1636
 
            raise (gnutls.errors.CertificateSecurityError
1637
 
                   ("Verify failed"))
 
2328
            gnutls.openpgp_crt_deinit(crt)
 
2329
            raise gnutls.CertificateSecurityError("Verify failed")
1638
2330
        # New buffer for the fingerprint
1639
2331
        buf = ctypes.create_string_buffer(20)
1640
2332
        buf_len = ctypes.c_size_t()
1641
2333
        # Get the fingerprint from the certificate into the buffer
1642
 
        (gnutls.library.functions
1643
 
         .gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1644
 
                                             ctypes.byref(buf_len)))
 
2334
        gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
 
2335
                                           ctypes.byref(buf_len))
1645
2336
        # Deinit the certificate
1646
 
        gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
 
2337
        gnutls.openpgp_crt_deinit(crt)
1647
2338
        # Convert the buffer to a Python bytestring
1648
2339
        fpr = ctypes.string_at(buf, buf_len.value)
1649
2340
        # Convert the bytestring to hexadecimal notation
1653
2344
 
1654
2345
class MultiprocessingMixIn(object):
1655
2346
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
2347
    
1656
2348
    def sub_process_main(self, request, address):
1657
2349
        try:
1658
2350
            self.finish_request(request, address)
1659
 
        except:
 
2351
        except Exception:
1660
2352
            self.handle_error(request, address)
1661
2353
        self.close_request(request)
1662
2354
    
1663
2355
    def process_request(self, request, address):
1664
2356
        """Start a new process to process the request."""
1665
2357
        proc = multiprocessing.Process(target = self.sub_process_main,
1666
 
                                       args = (request,
1667
 
                                               address))
 
2358
                                       args = (request, address))
1668
2359
        proc.start()
1669
2360
        return proc
1670
2361
 
1671
2362
 
1672
2363
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1673
2364
    """ adds a pipe to the MixIn """
 
2365
    
1674
2366
    def process_request(self, request, client_address):
1675
2367
        """Overrides and wraps the original process_request().
1676
2368
        
1685
2377
    
1686
2378
    def add_pipe(self, parent_pipe, proc):
1687
2379
        """Dummy function; override as necessary"""
1688
 
        raise NotImplementedError
 
2380
        raise NotImplementedError()
1689
2381
 
1690
2382
 
1691
2383
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1697
2389
        interface:      None or a network interface name (string)
1698
2390
        use_ipv6:       Boolean; to use IPv6 or not
1699
2391
    """
 
2392
    
1700
2393
    def __init__(self, server_address, RequestHandlerClass,
1701
 
                 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
        """
1702
2400
        self.interface = interface
1703
2401
        if use_ipv6:
1704
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.
1705
2429
        socketserver.TCPServer.__init__(self, server_address,
1706
2430
                                        RequestHandlerClass)
 
2431
    
1707
2432
    def server_bind(self):
1708
2433
        """This overrides the normal server_bind() function
1709
2434
        to bind to an interface if one was specified, and also NOT to
1715
2440
                             self.interface)
1716
2441
            else:
1717
2442
                try:
1718
 
                    self.socket.setsockopt(socket.SOL_SOCKET,
1719
 
                                           SO_BINDTODEVICE,
1720
 
                                           str(self.interface
1721
 
                                               + '\0'))
 
2443
                    self.socket.setsockopt(
 
2444
                        socket.SOL_SOCKET, SO_BINDTODEVICE,
 
2445
                        (self.interface + "\0").encode("utf-8"))
1722
2446
                except socket.error as error:
1723
 
                    if error[0] == errno.EPERM:
1724
 
                        logger.error("No permission to"
1725
 
                                     " bind to interface %s",
1726
 
                                     self.interface)
1727
 
                    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:
1728
2451
                        logger.error("SO_BINDTODEVICE not available;"
1729
2452
                                     " cannot bind to interface %s",
1730
2453
                                     self.interface)
 
2454
                    elif error.errno == errno.ENODEV:
 
2455
                        logger.error("Interface %s does not exist,"
 
2456
                                     " cannot bind", self.interface)
1731
2457
                    else:
1732
2458
                        raise
1733
2459
        # Only bind(2) the socket if we really need to.
1736
2462
                if self.address_family == socket.AF_INET6:
1737
2463
                    any_address = "::" # in6addr_any
1738
2464
                else:
1739
 
                    any_address = socket.INADDR_ANY
 
2465
                    any_address = "0.0.0.0" # INADDR_ANY
1740
2466
                self.server_address = (any_address,
1741
2467
                                       self.server_address[1])
1742
2468
            elif not self.server_address[1]:
1743
 
                self.server_address = (self.server_address[0],
1744
 
                                       0)
 
2469
                self.server_address = (self.server_address[0], 0)
1745
2470
#                 if self.interface:
1746
2471
#                     self.server_address = (self.server_address[0],
1747
2472
#                                            0, # port
1759
2484
        gnutls_priority GnuTLS priority string
1760
2485
        use_dbus:       Boolean; to emit D-Bus signals or not
1761
2486
    
1762
 
    Assumes a gobject.MainLoop event loop.
 
2487
    Assumes a GLib.MainLoop event loop.
1763
2488
    """
 
2489
    
1764
2490
    def __init__(self, server_address, RequestHandlerClass,
1765
 
                 interface=None, use_ipv6=True, clients=None,
1766
 
                 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):
1767
2497
        self.enabled = False
1768
2498
        self.clients = clients
1769
2499
        if self.clients is None:
1773
2503
        IPv6_TCPServer.__init__(self, server_address,
1774
2504
                                RequestHandlerClass,
1775
2505
                                interface = interface,
1776
 
                                use_ipv6 = use_ipv6)
 
2506
                                use_ipv6 = use_ipv6,
 
2507
                                socketfd = socketfd)
 
2508
    
1777
2509
    def server_activate(self):
1778
2510
        if self.enabled:
1779
2511
            return socketserver.TCPServer.server_activate(self)
1783
2515
    
1784
2516
    def add_pipe(self, parent_pipe, proc):
1785
2517
        # Call "handle_ipc" for both data and EOF events
1786
 
        gobject.io_add_watch(parent_pipe.fileno(),
1787
 
                             gobject.IO_IN | gobject.IO_HUP,
1788
 
                             functools.partial(self.handle_ipc,
1789
 
                                               parent_pipe =
1790
 
                                               parent_pipe,
1791
 
                                               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))
1792
2524
    
1793
 
    def handle_ipc(self, source, condition, parent_pipe=None,
1794
 
                   proc = None, client_object=None):
1795
 
        condition_names = {
1796
 
            gobject.IO_IN: "IN",   # There is data to read.
1797
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1798
 
                                    # blocking).
1799
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1800
 
            gobject.IO_ERR: "ERR", # Error condition.
1801
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1802
 
                                    # broken, usually for pipes and
1803
 
                                    # sockets).
1804
 
            }
1805
 
        conditions_string = ' | '.join(name
1806
 
                                       for cond, name in
1807
 
                                       condition_names.iteritems()
1808
 
                                       if cond & condition)
 
2525
    def handle_ipc(self, source, condition,
 
2526
                   parent_pipe=None,
 
2527
                   proc = None,
 
2528
                   client_object=None):
1809
2529
        # error, or the other end of multiprocessing.Pipe has closed
1810
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2530
        if condition & (GLib.IO_ERR | GLib.IO_HUP):
1811
2531
            # Wait for other process to exit
1812
2532
            proc.join()
1813
2533
            return False
1820
2540
            fpr = request[1]
1821
2541
            address = request[2]
1822
2542
            
1823
 
            for c in self.clients.itervalues():
 
2543
            for c in self.clients.values():
1824
2544
                if c.fingerprint == fpr:
1825
2545
                    client = c
1826
2546
                    break
1834
2554
                parent_pipe.send(False)
1835
2555
                return False
1836
2556
            
1837
 
            gobject.io_add_watch(parent_pipe.fileno(),
1838
 
                                 gobject.IO_IN | gobject.IO_HUP,
1839
 
                                 functools.partial(self.handle_ipc,
1840
 
                                                   parent_pipe =
1841
 
                                                   parent_pipe,
1842
 
                                                   proc = proc,
1843
 
                                                   client_object =
1844
 
                                                   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))
1845
2564
            parent_pipe.send(True)
1846
2565
            # remove the old hook in favor of the new above hook on
1847
2566
            # same fileno
1853
2572
            
1854
2573
            parent_pipe.send(('data', getattr(client_object,
1855
2574
                                              funcname)(*args,
1856
 
                                                         **kwargs)))
 
2575
                                                        **kwargs)))
1857
2576
        
1858
2577
        if command == 'getattr':
1859
2578
            attrname = request[1]
1860
 
            if callable(client_object.__getattribute__(attrname)):
1861
 
                parent_pipe.send(('function',))
 
2579
            if isinstance(client_object.__getattribute__(attrname),
 
2580
                          collections.Callable):
 
2581
                parent_pipe.send(('function', ))
1862
2582
            else:
1863
 
                parent_pipe.send(('data', client_object
1864
 
                                  .__getattribute__(attrname)))
 
2583
                parent_pipe.send((
 
2584
                    'data', client_object.__getattribute__(attrname)))
1865
2585
        
1866
2586
        if command == 'setattr':
1867
2587
            attrname = request[1]
1871
2591
        return True
1872
2592
 
1873
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
 
1874
2690
def string_to_delta(interval):
1875
2691
    """Parse a string and return a datetime.timedelta
1876
2692
    
1887
2703
    >>> string_to_delta('5m 30s')
1888
2704
    datetime.timedelta(0, 330)
1889
2705
    """
 
2706
    
 
2707
    try:
 
2708
        return rfc3339_duration_to_delta(interval)
 
2709
    except ValueError:
 
2710
        pass
 
2711
    
1890
2712
    timevalue = datetime.timedelta(0)
1891
2713
    for s in interval.split():
1892
2714
        try:
1893
 
            suffix = unicode(s[-1])
 
2715
            suffix = s[-1]
1894
2716
            value = int(s[:-1])
1895
2717
            if suffix == "d":
1896
2718
                delta = datetime.timedelta(value)
1903
2725
            elif suffix == "w":
1904
2726
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1905
2727
            else:
1906
 
                raise ValueError("Unknown suffix %r" % suffix)
1907
 
        except (ValueError, IndexError) as e:
 
2728
                raise ValueError("Unknown suffix {!r}".format(suffix))
 
2729
        except IndexError as e:
1908
2730
            raise ValueError(*(e.args))
1909
2731
        timevalue += delta
1910
2732
    return timevalue
1923
2745
        sys.exit()
1924
2746
    if not noclose:
1925
2747
        # Close all standard open file descriptors
1926
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2748
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1927
2749
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1928
2750
            raise OSError(errno.ENODEV,
1929
 
                          "%s not a character device"
1930
 
                          % os.path.devnull)
 
2751
                          "{} not a character device"
 
2752
                          .format(os.devnull))
1931
2753
        os.dup2(null, sys.stdin.fileno())
1932
2754
        os.dup2(null, sys.stdout.fileno())
1933
2755
        os.dup2(null, sys.stderr.fileno())
1942
2764
    
1943
2765
    parser = argparse.ArgumentParser()
1944
2766
    parser.add_argument("-v", "--version", action="version",
1945
 
                        version = "%%(prog)s %s" % version,
 
2767
                        version = "%(prog)s {}".format(version),
1946
2768
                        help="show version number and exit")
1947
2769
    parser.add_argument("-i", "--interface", metavar="IF",
1948
2770
                        help="Bind to interface IF")
1954
2776
                        help="Run self-test")
1955
2777
    parser.add_argument("--debug", action="store_true",
1956
2778
                        help="Debug mode; run in foreground and log"
1957
 
                        " to terminal")
 
2779
                        " to terminal", default=None)
1958
2780
    parser.add_argument("--debuglevel", metavar="LEVEL",
1959
2781
                        help="Debug level for stdout output")
1960
2782
    parser.add_argument("--priority", help="GnuTLS"
1967
2789
                        " files")
1968
2790
    parser.add_argument("--no-dbus", action="store_false",
1969
2791
                        dest="use_dbus", help="Do not provide D-Bus"
1970
 
                        " system bus interface")
 
2792
                        " system bus interface", default=None)
1971
2793
    parser.add_argument("--no-ipv6", action="store_false",
1972
 
                        dest="use_ipv6", help="Do not use IPv6")
 
2794
                        dest="use_ipv6", help="Do not use IPv6",
 
2795
                        default=None)
1973
2796
    parser.add_argument("--no-restore", action="store_false",
1974
2797
                        dest="restore", help="Do not restore stored"
1975
 
                        " state")
 
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")
1976
2802
    parser.add_argument("--statedir", metavar="DIR",
1977
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)
1978
2809
    
1979
2810
    options = parser.parse_args()
1980
2811
    
1981
2812
    if options.check:
1982
2813
        import doctest
1983
 
        doctest.testmod()
1984
 
        sys.exit()
 
2814
        fail_count, test_count = doctest.testmod()
 
2815
        sys.exit(os.EX_OK if fail_count == 0 else 1)
1985
2816
    
1986
2817
    # Default values for config file for server-global settings
1987
2818
    server_defaults = { "interface": "",
1989
2820
                        "port": "",
1990
2821
                        "debug": "False",
1991
2822
                        "priority":
1992
 
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
 
2823
                        "SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
 
2824
                        ":+SIGN-DSA-SHA256",
1993
2825
                        "servicename": "Mandos",
1994
2826
                        "use_dbus": "True",
1995
2827
                        "use_ipv6": "True",
1996
2828
                        "debuglevel": "",
1997
2829
                        "restore": "True",
1998
 
                        "statedir": "/var/lib/mandos"
1999
 
                        }
 
2830
                        "socket": "",
 
2831
                        "statedir": "/var/lib/mandos",
 
2832
                        "foreground": "False",
 
2833
                        "zeroconf": "True",
 
2834
                    }
2000
2835
    
2001
2836
    # Parse config file for server-global settings
2002
2837
    server_config = configparser.SafeConfigParser(server_defaults)
2003
2838
    del server_defaults
2004
 
    server_config.read(os.path.join(options.configdir,
2005
 
                                    "mandos.conf"))
 
2839
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
2006
2840
    # Convert the SafeConfigParser object to a dict
2007
2841
    server_settings = server_config.defaults()
2008
2842
    # Use the appropriate methods on the non-string config options
2009
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2843
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2010
2844
        server_settings[option] = server_config.getboolean("DEFAULT",
2011
2845
                                                           option)
2012
2846
    if server_settings["port"]:
2013
2847
        server_settings["port"] = server_config.getint("DEFAULT",
2014
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"])
2015
2858
    del server_config
2016
2859
    
2017
2860
    # Override the settings from the config file with command line
2018
2861
    # options, if set.
2019
2862
    for option in ("interface", "address", "port", "debug",
2020
 
                   "priority", "servicename", "configdir",
2021
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2022
 
                   "statedir"):
 
2863
                   "priority", "servicename", "configdir", "use_dbus",
 
2864
                   "use_ipv6", "debuglevel", "restore", "statedir",
 
2865
                   "socket", "foreground", "zeroconf"):
2023
2866
        value = getattr(options, option)
2024
2867
        if value is not None:
2025
2868
            server_settings[option] = value
2026
2869
    del options
2027
2870
    # Force all strings to be unicode
2028
2871
    for option in server_settings.keys():
2029
 
        if type(server_settings[option]) is str:
2030
 
            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
2031
2882
    # Now we have our good server settings in "server_settings"
2032
2883
    
2033
2884
    ##################################################################
2034
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
    
2035
2891
    # For convenience
2036
2892
    debug = server_settings["debug"]
2037
2893
    debuglevel = server_settings["debuglevel"]
2039
2895
    use_ipv6 = server_settings["use_ipv6"]
2040
2896
    stored_state_path = os.path.join(server_settings["statedir"],
2041
2897
                                     stored_state_file)
 
2898
    foreground = server_settings["foreground"]
 
2899
    zeroconf = server_settings["zeroconf"]
2042
2900
    
2043
2901
    if debug:
2044
 
        initlogger(logging.DEBUG)
 
2902
        initlogger(debug, logging.DEBUG)
2045
2903
    else:
2046
2904
        if not debuglevel:
2047
 
            initlogger()
 
2905
            initlogger(debug)
2048
2906
        else:
2049
2907
            level = getattr(logging, debuglevel.upper())
2050
 
            initlogger(level)
 
2908
            initlogger(debug, level)
2051
2909
    
2052
2910
    if server_settings["servicename"] != "Mandos":
2053
 
        syslogger.setFormatter(logging.Formatter
2054
 
                               ('Mandos (%s) [%%(process)d]:'
2055
 
                                ' %%(levelname)s: %%(message)s'
2056
 
                                % server_settings["servicename"]))
 
2911
        syslogger.setFormatter(
 
2912
            logging.Formatter('Mandos ({}) [%(process)d]:'
 
2913
                              ' %(levelname)s: %(message)s'.format(
 
2914
                                  server_settings["servicename"])))
2057
2915
    
2058
2916
    # Parse config file with clients
2059
 
    client_defaults = { "timeout": "5m",
2060
 
                        "extended_timeout": "15m",
2061
 
                        "interval": "2m",
2062
 
                        "checker": "fping -q -- %%(host)s",
2063
 
                        "host": "",
2064
 
                        "approval_delay": "0s",
2065
 
                        "approval_duration": "1s",
2066
 
                        }
2067
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2917
    client_config = configparser.SafeConfigParser(Client
 
2918
                                                  .client_defaults)
2068
2919
    client_config.read(os.path.join(server_settings["configdir"],
2069
2920
                                    "clients.conf"))
2070
2921
    
2071
2922
    global mandos_dbus_service
2072
2923
    mandos_dbus_service = None
2073
2924
    
2074
 
    tcp_server = MandosServer((server_settings["address"],
2075
 
                               server_settings["port"]),
2076
 
                              ClientHandler,
2077
 
                              interface=(server_settings["interface"]
2078
 
                                         or None),
2079
 
                              use_ipv6=use_ipv6,
2080
 
                              gnutls_priority=
2081
 
                              server_settings["priority"],
2082
 
                              use_dbus=use_dbus)
2083
 
    if not debug:
2084
 
        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
2085
2941
        try:
2086
 
            pidfile = open(pidfilename, "w")
2087
 
        except IOError:
2088
 
            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)
2089
2946
    
2090
 
    try:
2091
 
        uid = pwd.getpwnam("_mandos").pw_uid
2092
 
        gid = pwd.getpwnam("_mandos").pw_gid
2093
 
    except KeyError:
 
2947
    for name, group in (("_mandos", "_mandos"),
 
2948
                        ("mandos", "mandos"),
 
2949
                        ("nobody", "nogroup")):
2094
2950
        try:
2095
 
            uid = pwd.getpwnam("mandos").pw_uid
2096
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2951
            uid = pwd.getpwnam(name).pw_uid
 
2952
            gid = pwd.getpwnam(group).pw_gid
 
2953
            break
2097
2954
        except KeyError:
2098
 
            try:
2099
 
                uid = pwd.getpwnam("nobody").pw_uid
2100
 
                gid = pwd.getpwnam("nobody").pw_gid
2101
 
            except KeyError:
2102
 
                uid = 65534
2103
 
                gid = 65534
 
2955
            continue
 
2956
    else:
 
2957
        uid = 65534
 
2958
        gid = 65534
2104
2959
    try:
2105
2960
        os.setgid(gid)
2106
2961
        os.setuid(uid)
 
2962
        if debug:
 
2963
            logger.debug("Did setuid/setgid to {}:{}".format(uid,
 
2964
                                                             gid))
2107
2965
    except OSError as error:
2108
 
        if error[0] != errno.EPERM:
2109
 
            raise error
 
2966
        logger.warning("Failed to setuid/setgid to {}:{}: {}"
 
2967
                       .format(uid, gid, os.strerror(error.errno)))
 
2968
        if error.errno != errno.EPERM:
 
2969
            raise
2110
2970
    
2111
2971
    if debug:
2112
2972
        # Enable all possible GnuTLS debugging
2113
2973
        
2114
2974
        # "Use a log level over 10 to enable all debugging options."
2115
2975
        # - GnuTLS manual
2116
 
        gnutls.library.functions.gnutls_global_set_log_level(11)
 
2976
        gnutls.global_set_log_level(11)
2117
2977
        
2118
 
        @gnutls.library.types.gnutls_log_func
 
2978
        @gnutls.log_func
2119
2979
        def debug_gnutls(level, string):
2120
2980
            logger.debug("GnuTLS: %s", string[:-1])
2121
2981
        
2122
 
        (gnutls.library.functions
2123
 
         .gnutls_global_set_log_function(debug_gnutls))
 
2982
        gnutls.global_set_log_function(debug_gnutls)
2124
2983
        
2125
2984
        # Redirect stdin so all checkers get /dev/null
2126
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2985
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2127
2986
        os.dup2(null, sys.stdin.fileno())
2128
2987
        if null > 2:
2129
2988
            os.close(null)
2130
 
    else:
2131
 
        # No console logging
2132
 
        logger.removeHandler(console)
2133
2989
    
2134
2990
    # Need to fork before connecting to D-Bus
2135
 
    if not debug:
 
2991
    if not foreground:
2136
2992
        # Close all input and output, do double fork, etc.
2137
2993
        daemon()
2138
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
    
2139
2999
    global main_loop
2140
3000
    # From the Avahi example code
2141
 
    DBusGMainLoop(set_as_default=True )
2142
 
    main_loop = gobject.MainLoop()
 
3001
    DBusGMainLoop(set_as_default=True)
 
3002
    main_loop = GLib.MainLoop()
2143
3003
    bus = dbus.SystemBus()
2144
3004
    # End of Avahi example code
2145
3005
    if use_dbus:
2146
3006
        try:
2147
3007
            bus_name = dbus.service.BusName("se.recompile.Mandos",
2148
 
                                            bus, do_not_queue=True)
2149
 
            old_bus_name = (dbus.service.BusName
2150
 
                            ("se.bsnet.fukt.Mandos", bus,
2151
 
                             do_not_queue=True))
2152
 
        except dbus.exceptions.NameExistsException as e:
2153
 
            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)
2154
3015
            use_dbus = False
2155
3016
            server_settings["use_dbus"] = False
2156
3017
            tcp_server.use_dbus = False
2157
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2158
 
    service = AvahiServiceToSyslog(name =
2159
 
                                   server_settings["servicename"],
2160
 
                                   servicetype = "_mandos._tcp",
2161
 
                                   protocol = protocol, bus = bus)
2162
 
    if server_settings["interface"]:
2163
 
        service.interface = (if_nametoindex
2164
 
                             (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"))
2165
3028
    
2166
3029
    global multiprocessing_manager
2167
3030
    multiprocessing_manager = multiprocessing.Manager()
2168
3031
    
2169
3032
    client_class = Client
2170
3033
    if use_dbus:
2171
 
        client_class = functools.partial(ClientDBusTransitional,
2172
 
                                         bus = bus)
2173
 
    
2174
 
    special_settings = {
2175
 
        # Some settings need to be accessd by special methods;
2176
 
        # booleans need .getboolean(), etc.  Here is a list of them:
2177
 
        "approved_by_default":
2178
 
            lambda section:
2179
 
            client_config.getboolean(section, "approved_by_default"),
2180
 
        }
2181
 
    # Construct a new dict of client settings of this form:
2182
 
    # { client_name: {setting_name: value, ...}, ...}
2183
 
    # with exceptions for any special settings as defined above
2184
 
    client_settings = dict((clientname,
2185
 
                           dict((setting,
2186
 
                                 (value
2187
 
                                  if setting not in special_settings
2188
 
                                  else special_settings[setting]
2189
 
                                  (clientname)))
2190
 
                                for setting, value in
2191
 
                                client_config.items(clientname)))
2192
 
                          for clientname in client_config.sections())
2193
 
    
 
3034
        client_class = functools.partial(ClientDBus, bus = bus)
 
3035
    
 
3036
    client_settings = Client.config_parser(client_config)
2194
3037
    old_client_settings = {}
2195
 
    clients_data = []
 
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()
2196
3047
    
2197
3048
    # Get client data and settings from last running state.
2198
3049
    if server_settings["restore"]:
2199
3050
        try:
2200
3051
            with open(stored_state_path, "rb") as stored_state:
2201
 
                clients_data, old_client_settings = (pickle.load
2202
 
                                                     (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"))
2203
3097
            os.remove(stored_state_path)
2204
3098
        except IOError as e:
2205
 
            logger.warning("Could not load persistent state: {0}"
2206
 
                           .format(e))
2207
 
            if e.errno != errno.ENOENT:
 
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)
2208
3105
                raise
 
3106
        except EOFError as e:
 
3107
            logger.warning("Could not load persistent state: "
 
3108
                           "EOFError:",
 
3109
                           exc_info=e)
2209
3110
    
2210
 
    with Crypto() as crypt:
2211
 
        for client in clients_data:
2212
 
            client_name = client["name"]
 
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
2213
3116
            
2214
3117
            # Decide which value to use after restoring saved state.
2215
3118
            # We have three different values: Old config file,
2221
3124
                    # For each value in new config, check if it
2222
3125
                    # differs from the old config value (Except for
2223
3126
                    # the "secret" attribute)
2224
 
                    if (name != "secret" and
2225
 
                        value != old_client_settings[client_name]
2226
 
                        [name]):
2227
 
                        setattr(client, name, value)
 
3127
                    if (name != "secret"
 
3128
                        and (value !=
 
3129
                             old_client_settings[client_name][name])):
 
3130
                        client[name] = value
2228
3131
                except KeyError:
2229
3132
                    pass
2230
3133
            
2231
3134
            # Clients who has passed its expire date can still be
2232
 
            # enabled if its last checker was sucessful.  Clients
2233
 
            # whose checker failed before we stored its state is
2234
 
            # assumed to have failed all checkers during downtime.
2235
 
            if client["enabled"] and client["last_checked_ok"]:
2236
 
                if ((datetime.datetime.utcnow()
2237
 
                     - client["last_checked_ok"])
2238
 
                    > client["interval"]):
2239
 
                    if client["last_checker_status"] != 0:
 
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"]))
2240
3154
                        client["enabled"] = False
2241
3155
                    else:
2242
 
                        client["expires"] = (datetime.datetime
2243
 
                                             .utcnow()
2244
 
                                             + client["timeout"])
2245
 
            
2246
 
            client["changedstate"] = (multiprocessing_manager
2247
 
                                      .Condition
2248
 
                                      (multiprocessing_manager
2249
 
                                       .Lock()))
2250
 
            if use_dbus:
2251
 
                new_client = (ClientDBusTransitional.__new__
2252
 
                              (ClientDBusTransitional))
2253
 
                tcp_server.clients[client_name] = new_client
2254
 
                new_client.bus = bus
2255
 
                for name, value in client.iteritems():
2256
 
                    setattr(new_client, name, value)
2257
 
                client_object_name = unicode(client_name).translate(
2258
 
                    {ord("."): ord("_"),
2259
 
                     ord("-"): ord("_")})
2260
 
                new_client.dbus_object_path = (dbus.ObjectPath
2261
 
                                               ("/clients/"
2262
 
                                                + client_object_name))
2263
 
                DBusObjectWithProperties.__init__(new_client,
2264
 
                                                  new_client.bus,
2265
 
                                                  new_client
2266
 
                                                  .dbus_object_path)
2267
 
            else:
2268
 
                tcp_server.clients[client_name] = (Client.__new__
2269
 
                                                   (Client))
2270
 
                for name, value in client.iteritems():
2271
 
                    setattr(tcp_server.clients[client_name],
2272
 
                            name, value)
2273
 
            
 
3156
                        client["expires"] = (
 
3157
                            datetime.datetime.utcnow()
 
3158
                            + client["timeout"])
 
3159
                        logger.debug("Last checker succeeded,"
 
3160
                                     " keeping {} enabled".format(
 
3161
                                         client_name))
2274
3162
            try:
2275
 
                tcp_server.clients[client_name].secret = (
2276
 
                    crypt.decrypt(tcp_server.clients[client_name]
2277
 
                                  .encrypted_secret,
2278
 
                                  client_settings[client_name]
2279
 
                                  ["secret"]))
2280
 
            except CryptoError:
 
3163
                client["secret"] = pgp.decrypt(
 
3164
                    client["encrypted_secret"],
 
3165
                    client_settings[client_name]["secret"])
 
3166
            except PGPError:
2281
3167
                # If decryption fails, we use secret from new settings
2282
 
                tcp_server.clients[client_name].secret = (
2283
 
                    client_settings[client_name]["secret"])
2284
 
    
2285
 
    # Create/remove clients based on new changes made to config
2286
 
    for clientname in set(old_client_settings) - set(client_settings):
2287
 
        del tcp_server.clients[clientname]
2288
 
    for clientname in set(client_settings) - set(old_client_settings):
2289
 
        tcp_server.clients[clientname] = (client_class(name
2290
 
                                                       = clientname,
2291
 
                                                       config =
2292
 
                                                       client_settings
2293
 
                                                       [clientname]))
 
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)
2294
3187
    
2295
3188
    if not tcp_server.clients:
2296
3189
        logger.warning("No clients defined")
2297
 
        
2298
 
    if not debug:
2299
 
        try:
2300
 
            with pidfile:
2301
 
                pid = os.getpid()
2302
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2303
 
            del pidfile
2304
 
        except IOError:
2305
 
            logger.error("Could not write to file %r with PID %d",
2306
 
                         pidfilename, pid)
2307
 
        except NameError:
2308
 
            # "pidfile" was never created
2309
 
            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
2310
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:
2311
3208
        
2312
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2313
 
    
2314
 
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2315
 
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2316
 
    
2317
 
    if use_dbus:
2318
 
        class MandosDBusService(dbus.service.Object):
 
3209
        @alternate_dbus_interfaces(
 
3210
            { "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
 
3211
        class MandosDBusService(DBusObjectWithObjectManager):
2319
3212
            """A D-Bus proxy object"""
 
3213
            
2320
3214
            def __init__(self):
2321
3215
                dbus.service.Object.__init__(self, bus, "/")
 
3216
            
2322
3217
            _interface = "se.recompile.Mandos"
2323
3218
            
2324
3219
            @dbus.service.signal(_interface, signature="o")
2331
3226
                "D-Bus signal"
2332
3227
                pass
2333
3228
            
 
3229
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3230
                               "true"})
2334
3231
            @dbus.service.signal(_interface, signature="os")
2335
3232
            def ClientRemoved(self, objpath, name):
2336
3233
                "D-Bus signal"
2337
3234
                pass
2338
3235
            
 
3236
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3237
                               "true"})
2339
3238
            @dbus.service.method(_interface, out_signature="ao")
2340
3239
            def GetAllClients(self):
2341
3240
                "D-Bus method"
2342
 
                return dbus.Array(c.dbus_object_path
2343
 
                                  for c in
2344
 
                                  tcp_server.clients.itervalues())
 
3241
                return dbus.Array(c.dbus_object_path for c in
 
3242
                                  tcp_server.clients.values())
2345
3243
            
 
3244
            @dbus_annotations({"org.freedesktop.DBus.Deprecated":
 
3245
                               "true"})
2346
3246
            @dbus.service.method(_interface,
2347
3247
                                 out_signature="a{oa{sv}}")
2348
3248
            def GetAllClientsWithProperties(self):
2349
3249
                "D-Bus method"
2350
3250
                return dbus.Dictionary(
2351
 
                    ((c.dbus_object_path, c.GetAll(""))
2352
 
                     for c in tcp_server.clients.itervalues()),
 
3251
                    { c.dbus_object_path: c.GetAll(
 
3252
                        "se.recompile.Mandos.Client")
 
3253
                      for c in tcp_server.clients.values() },
2353
3254
                    signature="oa{sv}")
2354
3255
            
2355
3256
            @dbus.service.method(_interface, in_signature="o")
2356
3257
            def RemoveClient(self, object_path):
2357
3258
                "D-Bus method"
2358
 
                for c in tcp_server.clients.itervalues():
 
3259
                for c in tcp_server.clients.values():
2359
3260
                    if c.dbus_object_path == object_path:
2360
3261
                        del tcp_server.clients[c.name]
2361
3262
                        c.remove_from_connection()
2362
 
                        # Don't signal anything except ClientRemoved
 
3263
                        # Don't signal the disabling
2363
3264
                        c.disable(quiet=True)
2364
 
                        # Emit D-Bus signal
2365
 
                        self.ClientRemoved(object_path, c.name)
 
3265
                        # Emit D-Bus signal for removal
 
3266
                        self.client_removed_signal(c)
2366
3267
                        return
2367
3268
                raise KeyError(object_path)
2368
3269
            
2369
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)
2370
3307
        
2371
 
        class MandosDBusServiceTransitional(MandosDBusService):
2372
 
            __metaclass__ = AlternateDBusNamesMetaclass
2373
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
3308
        mandos_dbus_service = MandosDBusService()
2374
3309
    
2375
3310
    def cleanup():
2376
3311
        "Cleanup function; run on exit"
2377
 
        service.cleanup()
 
3312
        if zeroconf:
 
3313
            service.cleanup()
2378
3314
        
2379
3315
        multiprocessing.active_children()
 
3316
        wnull.close()
2380
3317
        if not (tcp_server.clients or client_settings):
2381
3318
            return
2382
3319
        
2383
3320
        # Store client before exiting. Secrets are encrypted with key
2384
3321
        # based on what config file has. If config file is
2385
3322
        # removed/edited, old secret will thus be unrecovable.
2386
 
        clients = []
2387
 
        with Crypto() as crypt:
2388
 
            for client in tcp_server.clients.itervalues():
 
3323
        clients = {}
 
3324
        with PGPEngine() as pgp:
 
3325
            for client in tcp_server.clients.values():
2389
3326
                key = client_settings[client.name]["secret"]
2390
 
                client.encrypted_secret = crypt.encrypt(client.secret,
2391
 
                                                        key)
 
3327
                client.encrypted_secret = pgp.encrypt(client.secret,
 
3328
                                                      key)
2392
3329
                client_dict = {}
2393
3330
                
2394
 
                # A list of attributes that will not be stored when
2395
 
                # shutting down.
2396
 
                exclude = set(("bus", "changedstate", "secret"))
2397
 
                for name, typ in (inspect.getmembers
2398
 
                                  (dbus.service.Object)):
 
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):
2399
3337
                    exclude.add(name)
2400
3338
                
2401
3339
                client_dict["encrypted_secret"] = (client
2404
3342
                    if attr not in exclude:
2405
3343
                        client_dict[attr] = getattr(client, attr)
2406
3344
                
2407
 
                clients.append(client_dict)
 
3345
                clients[client.name] = client_dict
2408
3346
                del client_settings[client.name]["secret"]
2409
3347
        
2410
3348
        try:
2411
 
            with os.fdopen(os.open(stored_state_path,
2412
 
                                   os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2413
 
                                   0600), "wb") as stored_state:
2414
 
                pickle.dump((clients, client_settings), stored_state)
 
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)
2415
3359
        except (IOError, OSError) as e:
2416
 
            logger.warning("Could not save persistent state: {0}"
2417
 
                           .format(e))
2418
 
            if e.errno not in (errno.ENOENT, errno.EACCES):
 
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)
2419
3371
                raise
2420
3372
        
2421
3373
        # Delete all clients, and settings from config
2423
3375
            name, client = tcp_server.clients.popitem()
2424
3376
            if use_dbus:
2425
3377
                client.remove_from_connection()
2426
 
            # Don't signal anything except ClientRemoved
 
3378
            # Don't signal the disabling
2427
3379
            client.disable(quiet=True)
 
3380
            # Emit D-Bus signal for removal
2428
3381
            if use_dbus:
2429
 
                # Emit D-Bus signal
2430
 
                mandos_dbus_service.ClientRemoved(client
2431
 
                                                  .dbus_object_path,
2432
 
                                                  client.name)
 
3382
                mandos_dbus_service.client_removed_signal(client)
2433
3383
        client_settings.clear()
2434
3384
    
2435
3385
    atexit.register(cleanup)
2436
3386
    
2437
 
    for client in tcp_server.clients.itervalues():
 
3387
    for client in tcp_server.clients.values():
2438
3388
        if use_dbus:
2439
 
            # Emit D-Bus signal
2440
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
3389
            # Emit D-Bus signal for adding
 
3390
            mandos_dbus_service.client_added_signal(client)
2441
3391
        # Need to initiate checking of clients
2442
3392
        if client.enabled:
2443
3393
            client.init_checker()
2446
3396
    tcp_server.server_activate()
2447
3397
    
2448
3398
    # Find out what port we got
2449
 
    service.port = tcp_server.socket.getsockname()[1]
 
3399
    if zeroconf:
 
3400
        service.port = tcp_server.socket.getsockname()[1]
2450
3401
    if use_ipv6:
2451
3402
        logger.info("Now listening on address %r, port %d,"
2452
 
                    " flowinfo %d, scope_id %d"
2453
 
                    % tcp_server.socket.getsockname())
 
3403
                    " flowinfo %d, scope_id %d",
 
3404
                    *tcp_server.socket.getsockname())
2454
3405
    else:                       # IPv4
2455
 
        logger.info("Now listening on address %r, port %d"
2456
 
                    % tcp_server.socket.getsockname())
 
3406
        logger.info("Now listening on address %r, port %d",
 
3407
                    *tcp_server.socket.getsockname())
2457
3408
    
2458
3409
    #service.interface = tcp_server.socket.getsockname()[3]
2459
3410
    
2460
3411
    try:
2461
 
        # From the Avahi example code
2462
 
        try:
2463
 
            service.activate()
2464
 
        except dbus.exceptions.DBusException as error:
2465
 
            logger.critical("DBusException: %s", error)
2466
 
            cleanup()
2467
 
            sys.exit(1)
2468
 
        # 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
2469
3421
        
2470
 
        gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2471
 
                             lambda *args, **kwargs:
2472
 
                             (tcp_server.handle_request
2473
 
                              (*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))
2474
3426
        
2475
3427
        logger.debug("Starting main loop")
2476
3428
        main_loop.run()
2477
3429
    except AvahiError as error:
2478
 
        logger.critical("AvahiError: %s", error)
 
3430
        logger.critical("Avahi Error", exc_info=error)
2479
3431
        cleanup()
2480
3432
        sys.exit(1)
2481
3433
    except KeyboardInterrupt: