/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: 2011-11-26 23:08:17 UTC
  • mto: (518.1.8 mandos-persistent)
  • mto: This revision was merged to the branch mainline in revision 524.
  • Revision ID: teddy@recompile.se-20111126230817-tv08v831s2yltbkd
Make "enabled" a client config option.

* DBUS-API: Fix wording on "Expires" option.
* clients.conf (enabled): New.
* mandos (Client): "last_enabled" can now be None.
  (Client.__init__): Get "enabled" from config.  Only set
                     "last_enabled" and "expires" if enabled.
  (ClientDBus.Created_dbus_property): Removed redundant dbus.String().
  (ClientDBus.Interval_dbus_property): If changed, only reschedule
                                       checker if enabled.
  (main/special_settings): Added "enabled".
* mandos-clients.conf (OPTIONS): Added "enabled".

Show diffs side-by-side

added added

removed removed

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