/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2012-06-17 22:26:40 UTC
  • mfrom: (301.1.1 release)
  • Revision ID: teddy@recompile.se-20120617222640-49scfn0husnrr5bi
Tags: version-1.6.0-1
* Makefile (version): Changed to "1.6.0".
* NEWS (Version 1.6.0): New entry.
* debian/changelog (1.6.0-1): - '' -

Show diffs side-by-side

added added

removed removed

Lines of Context:
6
6
# This program is partly derived from an example program for an Avahi
7
7
# service publisher, downloaded from
8
8
# <http://avahi.org/wiki/PythonPublishExample>.  This includes the
9
 
# methods "add" and "remove" in the "AvahiService" class, the
10
 
# "server_state_changed" and "entry_group_state_changed" functions,
11
 
# and some lines in "main".
 
9
# methods "add", "remove", "server_state_changed",
 
10
# "entry_group_state_changed", "cleanup", and "activate" in the
 
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008,2009 Teddy Hogeborn
15
 
# Copyright © 2008,2009 Björn Påhlsson
 
14
# Copyright © 2008-2012 Teddy Hogeborn
 
15
# Copyright © 2008-2012 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
28
28
# along with this program.  If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
31
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
31
# Contact the authors at <mandos@recompile.se>.
32
32
33
33
 
34
 
from __future__ import division, with_statement, absolute_import
35
 
 
36
 
import SocketServer
 
34
from __future__ import (division, absolute_import, print_function,
 
35
                        unicode_literals)
 
36
 
 
37
from future_builtins import *
 
38
 
 
39
import SocketServer as socketserver
37
40
import socket
38
 
import optparse
 
41
import argparse
39
42
import datetime
40
43
import errno
41
44
import gnutls.crypto
44
47
import gnutls.library.functions
45
48
import gnutls.library.constants
46
49
import gnutls.library.types
47
 
import ConfigParser
 
50
import ConfigParser as configparser
48
51
import sys
49
52
import re
50
53
import os
51
54
import signal
52
 
from sets import Set
53
55
import subprocess
54
56
import atexit
55
57
import stat
56
58
import logging
57
59
import logging.handlers
58
60
import pwd
59
 
from contextlib import closing
 
61
import contextlib
 
62
import struct
 
63
import fcntl
 
64
import functools
 
65
import cPickle as pickle
 
66
import multiprocessing
 
67
import types
 
68
import binascii
 
69
import tempfile
 
70
import itertools
60
71
 
61
72
import dbus
62
73
import dbus.service
65
76
from dbus.mainloop.glib import DBusGMainLoop
66
77
import ctypes
67
78
import ctypes.util
68
 
 
69
 
version = "1.0.8"
70
 
 
71
 
logger = logging.Logger('mandos')
 
79
import xml.dom.minidom
 
80
import inspect
 
81
import GnuPGInterface
 
82
 
 
83
try:
 
84
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
 
85
except AttributeError:
 
86
    try:
 
87
        from IN import SO_BINDTODEVICE
 
88
    except ImportError:
 
89
        SO_BINDTODEVICE = None
 
90
 
 
91
version = "1.6.0"
 
92
stored_state_file = "clients.pickle"
 
93
 
 
94
logger = logging.getLogger()
72
95
syslogger = (logging.handlers.SysLogHandler
73
96
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
74
 
              address = "/dev/log"))
75
 
syslogger.setFormatter(logging.Formatter
76
 
                       ('Mandos [%(process)d]: %(levelname)s:'
77
 
                        ' %(message)s'))
78
 
logger.addHandler(syslogger)
79
 
 
80
 
console = logging.StreamHandler()
81
 
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
82
 
                                       ' %(levelname)s: %(message)s'))
83
 
logger.addHandler(console)
 
97
              address = str("/dev/log")))
 
98
 
 
99
try:
 
100
    if_nametoindex = (ctypes.cdll.LoadLibrary
 
101
                      (ctypes.util.find_library("c"))
 
102
                      .if_nametoindex)
 
103
except (OSError, AttributeError):
 
104
    def if_nametoindex(interface):
 
105
        "Get an interface index the hard way, i.e. using fcntl()"
 
106
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
107
        with contextlib.closing(socket.socket()) as s:
 
108
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
109
                                struct.pack(str("16s16x"),
 
110
                                            interface))
 
111
        interface_index = struct.unpack(str("I"),
 
112
                                        ifreq[16:20])[0]
 
113
        return interface_index
 
114
 
 
115
 
 
116
def initlogger(debug, level=logging.WARNING):
 
117
    """init logger and add loglevel"""
 
118
    
 
119
    syslogger.setFormatter(logging.Formatter
 
120
                           ('Mandos [%(process)d]: %(levelname)s:'
 
121
                            ' %(message)s'))
 
122
    logger.addHandler(syslogger)
 
123
    
 
124
    if debug:
 
125
        console = logging.StreamHandler()
 
126
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
127
                                               ' [%(process)d]:'
 
128
                                               ' %(levelname)s:'
 
129
                                               ' %(message)s'))
 
130
        logger.addHandler(console)
 
131
    logger.setLevel(level)
 
132
 
 
133
 
 
134
class PGPError(Exception):
 
135
    """Exception if encryption/decryption fails"""
 
136
    pass
 
137
 
 
138
 
 
139
class PGPEngine(object):
 
140
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
141
    def __init__(self):
 
142
        self.gnupg = GnuPGInterface.GnuPG()
 
143
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
144
        self.gnupg = GnuPGInterface.GnuPG()
 
145
        self.gnupg.options.meta_interactive = False
 
146
        self.gnupg.options.homedir = self.tempdir
 
147
        self.gnupg.options.extra_args.extend(['--force-mdc',
 
148
                                              '--quiet',
 
149
                                              '--no-use-agent'])
 
150
    
 
151
    def __enter__(self):
 
152
        return self
 
153
    
 
154
    def __exit__(self, exc_type, exc_value, traceback):
 
155
        self._cleanup()
 
156
        return False
 
157
    
 
158
    def __del__(self):
 
159
        self._cleanup()
 
160
    
 
161
    def _cleanup(self):
 
162
        if self.tempdir is not None:
 
163
            # Delete contents of tempdir
 
164
            for root, dirs, files in os.walk(self.tempdir,
 
165
                                             topdown = False):
 
166
                for filename in files:
 
167
                    os.remove(os.path.join(root, filename))
 
168
                for dirname in dirs:
 
169
                    os.rmdir(os.path.join(root, dirname))
 
170
            # Remove tempdir
 
171
            os.rmdir(self.tempdir)
 
172
            self.tempdir = None
 
173
    
 
174
    def password_encode(self, password):
 
175
        # Passphrase can not be empty and can not contain newlines or
 
176
        # NUL bytes.  So we prefix it and hex encode it.
 
177
        return b"mandos" + binascii.hexlify(password)
 
178
    
 
179
    def encrypt(self, data, password):
 
180
        self.gnupg.passphrase = self.password_encode(password)
 
181
        with open(os.devnull, "w") as devnull:
 
182
            try:
 
183
                proc = self.gnupg.run(['--symmetric'],
 
184
                                      create_fhs=['stdin', 'stdout'],
 
185
                                      attach_fhs={'stderr': devnull})
 
186
                with contextlib.closing(proc.handles['stdin']) as f:
 
187
                    f.write(data)
 
188
                with contextlib.closing(proc.handles['stdout']) as f:
 
189
                    ciphertext = f.read()
 
190
                proc.wait()
 
191
            except IOError as e:
 
192
                raise PGPError(e)
 
193
        self.gnupg.passphrase = None
 
194
        return ciphertext
 
195
    
 
196
    def decrypt(self, data, password):
 
197
        self.gnupg.passphrase = self.password_encode(password)
 
198
        with open(os.devnull, "w") as devnull:
 
199
            try:
 
200
                proc = self.gnupg.run(['--decrypt'],
 
201
                                      create_fhs=['stdin', 'stdout'],
 
202
                                      attach_fhs={'stderr': devnull})
 
203
                with contextlib.closing(proc.handles['stdin']) as f:
 
204
                    f.write(data)
 
205
                with contextlib.closing(proc.handles['stdout']) as f:
 
206
                    decrypted_plaintext = f.read()
 
207
                proc.wait()
 
208
            except IOError as e:
 
209
                raise PGPError(e)
 
210
        self.gnupg.passphrase = None
 
211
        return decrypted_plaintext
 
212
 
84
213
 
85
214
class AvahiError(Exception):
86
215
    def __init__(self, value, *args, **kwargs):
98
227
 
99
228
class AvahiService(object):
100
229
    """An Avahi (Zeroconf) service.
 
230
    
101
231
    Attributes:
102
232
    interface: integer; avahi.IF_UNSPEC or an interface index.
103
233
               Used to optionally bind to the specified interface.
111
241
    max_renames: integer; maximum number of renames
112
242
    rename_count: integer; counter so we only rename after collisions
113
243
                  a sensible number of times
 
244
    group: D-Bus Entry Group
 
245
    server: D-Bus Server
 
246
    bus: dbus.SystemBus()
114
247
    """
 
248
    
115
249
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
116
250
                 servicetype = None, port = None, TXT = None,
117
251
                 domain = "", host = "", max_renames = 32768,
118
 
                 protocol = avahi.PROTO_UNSPEC):
 
252
                 protocol = avahi.PROTO_UNSPEC, bus = None):
119
253
        self.interface = interface
120
254
        self.name = name
121
255
        self.type = servicetype
126
260
        self.rename_count = 0
127
261
        self.max_renames = max_renames
128
262
        self.protocol = protocol
 
263
        self.group = None       # our entry group
 
264
        self.server = None
 
265
        self.bus = bus
 
266
        self.entry_group_state_changed_match = None
 
267
    
129
268
    def rename(self):
130
269
        """Derived from the Avahi example code"""
131
270
        if self.rename_count >= self.max_renames:
132
 
            logger.critical(u"No suitable Zeroconf service name found"
133
 
                            u" after %i retries, exiting.",
 
271
            logger.critical("No suitable Zeroconf service name found"
 
272
                            " after %i retries, exiting.",
134
273
                            self.rename_count)
135
 
            raise AvahiServiceError(u"Too many renames")
136
 
        self.name = server.GetAlternativeServiceName(self.name)
137
 
        logger.info(u"Changing Zeroconf service name to %r ...",
138
 
                    str(self.name))
139
 
        syslogger.setFormatter(logging.Formatter
140
 
                               ('Mandos (%s) [%%(process)d]:'
141
 
                                ' %%(levelname)s: %%(message)s'
142
 
                                % self.name))
 
274
            raise AvahiServiceError("Too many renames")
 
275
        self.name = unicode(self.server
 
276
                            .GetAlternativeServiceName(self.name))
 
277
        logger.info("Changing Zeroconf service name to %r ...",
 
278
                    self.name)
143
279
        self.remove()
144
 
        self.add()
 
280
        try:
 
281
            self.add()
 
282
        except dbus.exceptions.DBusException as error:
 
283
            logger.critical("D-Bus Exception", exc_info=error)
 
284
            self.cleanup()
 
285
            os._exit(1)
145
286
        self.rename_count += 1
 
287
    
146
288
    def remove(self):
147
289
        """Derived from the Avahi example code"""
148
 
        if group is not None:
149
 
            group.Reset()
 
290
        if self.entry_group_state_changed_match is not None:
 
291
            self.entry_group_state_changed_match.remove()
 
292
            self.entry_group_state_changed_match = None
 
293
        if self.group is not None:
 
294
            self.group.Reset()
 
295
    
150
296
    def add(self):
151
297
        """Derived from the Avahi example code"""
152
 
        global group
153
 
        if group is None:
154
 
            group = dbus.Interface(bus.get_object
155
 
                                   (avahi.DBUS_NAME,
156
 
                                    server.EntryGroupNew()),
157
 
                                   avahi.DBUS_INTERFACE_ENTRY_GROUP)
158
 
            group.connect_to_signal('StateChanged',
159
 
                                    entry_group_state_changed)
160
 
        logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
161
 
                     service.name, service.type)
162
 
        group.AddService(
163
 
                self.interface,         # interface
164
 
                self.protocol,          # protocol
165
 
                dbus.UInt32(0),         # flags
166
 
                self.name, self.type,
167
 
                self.domain, self.host,
168
 
                dbus.UInt16(self.port),
169
 
                avahi.string_array_to_txt_array(self.TXT))
170
 
        group.Commit()
171
 
 
172
 
# From the Avahi example code:
173
 
group = None                            # our entry group
174
 
# End of Avahi example code
175
 
 
176
 
 
177
 
def _datetime_to_dbus(dt, variant_level=0):
178
 
    """Convert a UTC datetime.datetime() to a D-Bus type."""
179
 
    return dbus.String(dt.isoformat(), variant_level=variant_level)
 
298
        self.remove()
 
299
        if self.group is None:
 
300
            self.group = dbus.Interface(
 
301
                self.bus.get_object(avahi.DBUS_NAME,
 
302
                                    self.server.EntryGroupNew()),
 
303
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
304
        self.entry_group_state_changed_match = (
 
305
            self.group.connect_to_signal(
 
306
                'StateChanged', self.entry_group_state_changed))
 
307
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
 
308
                     self.name, self.type)
 
309
        self.group.AddService(
 
310
            self.interface,
 
311
            self.protocol,
 
312
            dbus.UInt32(0),     # flags
 
313
            self.name, self.type,
 
314
            self.domain, self.host,
 
315
            dbus.UInt16(self.port),
 
316
            avahi.string_array_to_txt_array(self.TXT))
 
317
        self.group.Commit()
 
318
    
 
319
    def entry_group_state_changed(self, state, error):
 
320
        """Derived from the Avahi example code"""
 
321
        logger.debug("Avahi entry group state change: %i", state)
 
322
        
 
323
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
 
324
            logger.debug("Zeroconf service established.")
 
325
        elif state == avahi.ENTRY_GROUP_COLLISION:
 
326
            logger.info("Zeroconf service name collision.")
 
327
            self.rename()
 
328
        elif state == avahi.ENTRY_GROUP_FAILURE:
 
329
            logger.critical("Avahi: Error in group state changed %s",
 
330
                            unicode(error))
 
331
            raise AvahiGroupError("State changed: {0!s}"
 
332
                                  .format(error))
 
333
    
 
334
    def cleanup(self):
 
335
        """Derived from the Avahi example code"""
 
336
        if self.group is not None:
 
337
            try:
 
338
                self.group.Free()
 
339
            except (dbus.exceptions.UnknownMethodException,
 
340
                    dbus.exceptions.DBusException):
 
341
                pass
 
342
            self.group = None
 
343
        self.remove()
 
344
    
 
345
    def server_state_changed(self, state, error=None):
 
346
        """Derived from the Avahi example code"""
 
347
        logger.debug("Avahi server state change: %i", state)
 
348
        bad_states = { avahi.SERVER_INVALID:
 
349
                           "Zeroconf server invalid",
 
350
                       avahi.SERVER_REGISTERING: None,
 
351
                       avahi.SERVER_COLLISION:
 
352
                           "Zeroconf server name collision",
 
353
                       avahi.SERVER_FAILURE:
 
354
                           "Zeroconf server failure" }
 
355
        if state in bad_states:
 
356
            if bad_states[state] is not None:
 
357
                if error is None:
 
358
                    logger.error(bad_states[state])
 
359
                else:
 
360
                    logger.error(bad_states[state] + ": %r", error)
 
361
            self.cleanup()
 
362
        elif state == avahi.SERVER_RUNNING:
 
363
            self.add()
 
364
        else:
 
365
            if error is None:
 
366
                logger.debug("Unknown state: %r", state)
 
367
            else:
 
368
                logger.debug("Unknown state: %r: %r", state, error)
 
369
    
 
370
    def activate(self):
 
371
        """Derived from the Avahi example code"""
 
372
        if self.server is None:
 
373
            self.server = dbus.Interface(
 
374
                self.bus.get_object(avahi.DBUS_NAME,
 
375
                                    avahi.DBUS_PATH_SERVER,
 
376
                                    follow_name_owner_changes=True),
 
377
                avahi.DBUS_INTERFACE_SERVER)
 
378
        self.server.connect_to_signal("StateChanged",
 
379
                                 self.server_state_changed)
 
380
        self.server_state_changed(self.server.GetState())
 
381
 
 
382
 
 
383
class AvahiServiceToSyslog(AvahiService):
 
384
    def rename(self):
 
385
        """Add the new name to the syslog messages"""
 
386
        ret = AvahiService.rename(self)
 
387
        syslogger.setFormatter(logging.Formatter
 
388
                               ('Mandos ({0}) [%(process)d]:'
 
389
                                ' %(levelname)s: %(message)s'
 
390
                                .format(self.name)))
 
391
        return ret
 
392
 
 
393
 
 
394
def timedelta_to_milliseconds(td):
 
395
    "Convert a datetime.timedelta() to milliseconds"
 
396
    return ((td.days * 24 * 60 * 60 * 1000)
 
397
            + (td.seconds * 1000)
 
398
            + (td.microseconds // 1000))
180
399
 
181
400
 
182
401
class Client(object):
183
402
    """A representation of a client host served by this server.
 
403
    
184
404
    Attributes:
185
 
    name:       string; from the config file, used in log messages and
186
 
                        D-Bus identifiers
187
 
    fingerprint: string (40 or 32 hexadecimal digits); used to
188
 
                 uniquely identify the client
189
 
    secret:     bytestring; sent verbatim (over TLS) to client
190
 
    host:       string; available for use by the checker command
191
 
    created:    datetime.datetime(); (UTC) object creation
192
 
    last_enabled: datetime.datetime(); (UTC)
193
 
    enabled:    bool()
194
 
    last_checked_ok: datetime.datetime(); (UTC) or None
195
 
    timeout:    datetime.timedelta(); How long from last_checked_ok
196
 
                                      until this client is invalid
197
 
    interval:   datetime.timedelta(); How often to start a new checker
198
 
    disable_hook:  If set, called by disable() as disable_hook(self)
 
405
    approved:   bool(); 'None' if not yet approved/disapproved
 
406
    approval_delay: datetime.timedelta(); Time to wait for approval
 
407
    approval_duration: datetime.timedelta(); Duration of one approval
199
408
    checker:    subprocess.Popen(); a running checker process used
200
409
                                    to see if the client lives.
201
410
                                    'None' if no process is running.
202
 
    checker_initiator_tag: a gobject event source tag, or None
203
 
    disable_initiator_tag:    - '' -
204
 
    checker_callback_tag:  - '' -
205
 
    checker_command: string; External command which is run to check if
206
 
                     client lives.  %() expansions are done at
 
411
    checker_callback_tag: a gobject event source tag, or None
 
412
    checker_command: string; External command which is run to check
 
413
                     if client lives.  %() expansions are done at
207
414
                     runtime with vars(self) as dict, so that for
208
415
                     instance %(name)s can be used in the command.
 
416
    checker_initiator_tag: a gobject event source tag, or None
 
417
    created:    datetime.datetime(); (UTC) object creation
 
418
    client_structure: Object describing what attributes a client has
 
419
                      and is used for storing the client at exit
209
420
    current_checker_command: string; current running checker_command
 
421
    disable_initiator_tag: a gobject event source tag, or None
 
422
    enabled:    bool()
 
423
    fingerprint: string (40 or 32 hexadecimal digits); used to
 
424
                 uniquely identify the client
 
425
    host:       string; available for use by the checker command
 
426
    interval:   datetime.timedelta(); How often to start a new checker
 
427
    last_approval_request: datetime.datetime(); (UTC) or None
 
428
    last_checked_ok: datetime.datetime(); (UTC) or None
 
429
    last_checker_status: integer between 0 and 255 reflecting exit
 
430
                         status of last checker. -1 reflects crashed
 
431
                         checker, -2 means no checker completed yet.
 
432
    last_enabled: datetime.datetime(); (UTC) or None
 
433
    name:       string; from the config file, used in log messages and
 
434
                        D-Bus identifiers
 
435
    secret:     bytestring; sent verbatim (over TLS) to client
 
436
    timeout:    datetime.timedelta(); How long from last_checked_ok
 
437
                                      until this client is disabled
 
438
    extended_timeout:   extra long timeout when secret has been sent
 
439
    runtime_expansions: Allowed attributes for runtime expansion.
 
440
    expires:    datetime.datetime(); time (UTC) when a client will be
 
441
                disabled, or None
210
442
    """
 
443
    
 
444
    runtime_expansions = ("approval_delay", "approval_duration",
 
445
                          "created", "enabled", "expires",
 
446
                          "fingerprint", "host", "interval",
 
447
                          "last_approval_request", "last_checked_ok",
 
448
                          "last_enabled", "name", "timeout")
 
449
    client_defaults = { "timeout": "5m",
 
450
                        "extended_timeout": "15m",
 
451
                        "interval": "2m",
 
452
                        "checker": "fping -q -- %%(host)s",
 
453
                        "host": "",
 
454
                        "approval_delay": "0s",
 
455
                        "approval_duration": "1s",
 
456
                        "approved_by_default": "True",
 
457
                        "enabled": "True",
 
458
                        }
 
459
    
211
460
    def timeout_milliseconds(self):
212
461
        "Return the 'timeout' attribute in milliseconds"
213
 
        return ((self.timeout.days * 24 * 60 * 60 * 1000)
214
 
                + (self.timeout.seconds * 1000)
215
 
                + (self.timeout.microseconds // 1000))
 
462
        return timedelta_to_milliseconds(self.timeout)
 
463
    
 
464
    def extended_timeout_milliseconds(self):
 
465
        "Return the 'extended_timeout' attribute in milliseconds"
 
466
        return timedelta_to_milliseconds(self.extended_timeout)
216
467
    
217
468
    def interval_milliseconds(self):
218
469
        "Return the 'interval' attribute in milliseconds"
219
 
        return ((self.interval.days * 24 * 60 * 60 * 1000)
220
 
                + (self.interval.seconds * 1000)
221
 
                + (self.interval.microseconds // 1000))
222
 
    
223
 
    def __init__(self, name = None, disable_hook=None, config=None):
224
 
        """Note: the 'checker' key in 'config' sets the
225
 
        'checker_command' attribute and *not* the 'checker'
226
 
        attribute."""
 
470
        return timedelta_to_milliseconds(self.interval)
 
471
    
 
472
    def approval_delay_milliseconds(self):
 
473
        return timedelta_to_milliseconds(self.approval_delay)
 
474
    
 
475
    @staticmethod
 
476
    def config_parser(config):
 
477
        """Construct a new dict of client settings of this form:
 
478
        { client_name: {setting_name: value, ...}, ...}
 
479
        with exceptions for any special settings as defined above.
 
480
        NOTE: Must be a pure function. Must return the same result
 
481
        value given the same arguments.
 
482
        """
 
483
        settings = {}
 
484
        for client_name in config.sections():
 
485
            section = dict(config.items(client_name))
 
486
            client = settings[client_name] = {}
 
487
            
 
488
            client["host"] = section["host"]
 
489
            # Reformat values from string types to Python types
 
490
            client["approved_by_default"] = config.getboolean(
 
491
                client_name, "approved_by_default")
 
492
            client["enabled"] = config.getboolean(client_name,
 
493
                                                  "enabled")
 
494
            
 
495
            client["fingerprint"] = (section["fingerprint"].upper()
 
496
                                     .replace(" ", ""))
 
497
            if "secret" in section:
 
498
                client["secret"] = section["secret"].decode("base64")
 
499
            elif "secfile" in section:
 
500
                with open(os.path.expanduser(os.path.expandvars
 
501
                                             (section["secfile"])),
 
502
                          "rb") as secfile:
 
503
                    client["secret"] = secfile.read()
 
504
            else:
 
505
                raise TypeError("No secret or secfile for section {0}"
 
506
                                .format(section))
 
507
            client["timeout"] = string_to_delta(section["timeout"])
 
508
            client["extended_timeout"] = string_to_delta(
 
509
                section["extended_timeout"])
 
510
            client["interval"] = string_to_delta(section["interval"])
 
511
            client["approval_delay"] = string_to_delta(
 
512
                section["approval_delay"])
 
513
            client["approval_duration"] = string_to_delta(
 
514
                section["approval_duration"])
 
515
            client["checker_command"] = section["checker"]
 
516
            client["last_approval_request"] = None
 
517
            client["last_checked_ok"] = None
 
518
            client["last_checker_status"] = -2
 
519
        
 
520
        return settings
 
521
    
 
522
    def __init__(self, settings, name = None):
227
523
        self.name = name
228
 
        if config is None:
229
 
            config = {}
230
 
        logger.debug(u"Creating client %r", self.name)
 
524
        # adding all client settings
 
525
        for setting, value in settings.iteritems():
 
526
            setattr(self, setting, value)
 
527
        
 
528
        if self.enabled:
 
529
            if not hasattr(self, "last_enabled"):
 
530
                self.last_enabled = datetime.datetime.utcnow()
 
531
            if not hasattr(self, "expires"):
 
532
                self.expires = (datetime.datetime.utcnow()
 
533
                                + self.timeout)
 
534
        else:
 
535
            self.last_enabled = None
 
536
            self.expires = None
 
537
        
 
538
        logger.debug("Creating client %r", self.name)
231
539
        # Uppercase and remove spaces from fingerprint for later
232
540
        # comparison purposes with return value from the fingerprint()
233
541
        # function
234
 
        self.fingerprint = (config["fingerprint"].upper()
235
 
                            .replace(u" ", u""))
236
 
        logger.debug(u"  Fingerprint: %s", self.fingerprint)
237
 
        if "secret" in config:
238
 
            self.secret = config["secret"].decode(u"base64")
239
 
        elif "secfile" in config:
240
 
            with closing(open(os.path.expanduser
241
 
                              (os.path.expandvars
242
 
                               (config["secfile"])))) as secfile:
243
 
                self.secret = secfile.read()
244
 
        else:
245
 
            raise TypeError(u"No secret or secfile for client %s"
246
 
                            % self.name)
247
 
        self.host = config.get("host", "")
248
 
        self.created = datetime.datetime.utcnow()
249
 
        self.enabled = False
250
 
        self.last_enabled = None
251
 
        self.last_checked_ok = None
252
 
        self.timeout = string_to_delta(config["timeout"])
253
 
        self.interval = string_to_delta(config["interval"])
254
 
        self.disable_hook = disable_hook
 
542
        logger.debug("  Fingerprint: %s", self.fingerprint)
 
543
        self.created = settings.get("created",
 
544
                                    datetime.datetime.utcnow())
 
545
        
 
546
        # attributes specific for this server instance
255
547
        self.checker = None
256
548
        self.checker_initiator_tag = None
257
549
        self.disable_initiator_tag = None
258
550
        self.checker_callback_tag = None
259
 
        self.checker_command = config["checker"]
260
551
        self.current_checker_command = None
261
 
        self.last_connect = None
 
552
        self.approved = None
 
553
        self.approvals_pending = 0
 
554
        self.changedstate = (multiprocessing_manager
 
555
                             .Condition(multiprocessing_manager
 
556
                                        .Lock()))
 
557
        self.client_structure = [attr for attr in
 
558
                                 self.__dict__.iterkeys()
 
559
                                 if not attr.startswith("_")]
 
560
        self.client_structure.append("client_structure")
 
561
        
 
562
        for name, t in inspect.getmembers(type(self),
 
563
                                          lambda obj:
 
564
                                              isinstance(obj,
 
565
                                                         property)):
 
566
            if not name.startswith("_"):
 
567
                self.client_structure.append(name)
 
568
    
 
569
    # Send notice to process children that client state has changed
 
570
    def send_changedstate(self):
 
571
        with self.changedstate:
 
572
            self.changedstate.notify_all()
262
573
    
263
574
    def enable(self):
264
575
        """Start this client's checker and timeout hooks"""
 
576
        if getattr(self, "enabled", False):
 
577
            # Already enabled
 
578
            return
 
579
        self.expires = datetime.datetime.utcnow() + self.timeout
 
580
        self.enabled = True
265
581
        self.last_enabled = datetime.datetime.utcnow()
 
582
        self.init_checker()
 
583
        self.send_changedstate()
 
584
    
 
585
    def disable(self, quiet=True):
 
586
        """Disable this client."""
 
587
        if not getattr(self, "enabled", False):
 
588
            return False
 
589
        if not quiet:
 
590
            logger.info("Disabling client %s", self.name)
 
591
        if getattr(self, "disable_initiator_tag", None) is not None:
 
592
            gobject.source_remove(self.disable_initiator_tag)
 
593
            self.disable_initiator_tag = None
 
594
        self.expires = None
 
595
        if getattr(self, "checker_initiator_tag", None) is not None:
 
596
            gobject.source_remove(self.checker_initiator_tag)
 
597
            self.checker_initiator_tag = None
 
598
        self.stop_checker()
 
599
        self.enabled = False
 
600
        if not quiet:
 
601
            self.send_changedstate()
 
602
        # Do not run this again if called by a gobject.timeout_add
 
603
        return False
 
604
    
 
605
    def __del__(self):
 
606
        self.disable()
 
607
    
 
608
    def init_checker(self):
266
609
        # Schedule a new checker to be started an 'interval' from now,
267
610
        # and every interval from then on.
 
611
        if self.checker_initiator_tag is not None:
 
612
            gobject.source_remove(self.checker_initiator_tag)
268
613
        self.checker_initiator_tag = (gobject.timeout_add
269
614
                                      (self.interval_milliseconds(),
270
615
                                       self.start_checker))
271
 
        # Also start a new checker *right now*.
272
 
        self.start_checker()
273
616
        # Schedule a disable() when 'timeout' has passed
 
617
        if self.disable_initiator_tag is not None:
 
618
            gobject.source_remove(self.disable_initiator_tag)
274
619
        self.disable_initiator_tag = (gobject.timeout_add
275
620
                                   (self.timeout_milliseconds(),
276
621
                                    self.disable))
277
 
        self.enabled = True
278
 
    
279
 
    def disable(self):
280
 
        """Disable this client."""
281
 
        if not getattr(self, "enabled", False):
282
 
            return False
283
 
        logger.info(u"Disabling client %s", self.name)
284
 
        if getattr(self, "disable_initiator_tag", False):
285
 
            gobject.source_remove(self.disable_initiator_tag)
286
 
            self.disable_initiator_tag = None
287
 
        if getattr(self, "checker_initiator_tag", False):
288
 
            gobject.source_remove(self.checker_initiator_tag)
289
 
            self.checker_initiator_tag = None
290
 
        self.stop_checker()
291
 
        if self.disable_hook:
292
 
            self.disable_hook(self)
293
 
        self.enabled = False
294
 
        # Do not run this again if called by a gobject.timeout_add
295
 
        return False
296
 
    
297
 
    def __del__(self):
298
 
        self.disable_hook = None
299
 
        self.disable()
 
622
        # Also start a new checker *right now*.
 
623
        self.start_checker()
300
624
    
301
625
    def checker_callback(self, pid, condition, command):
302
626
        """The checker has completed, so take appropriate actions."""
303
627
        self.checker_callback_tag = None
304
628
        self.checker = None
305
629
        if os.WIFEXITED(condition):
306
 
            exitstatus = os.WEXITSTATUS(condition)
307
 
            if exitstatus == 0:
308
 
                logger.info(u"Checker for %(name)s succeeded",
 
630
            self.last_checker_status = os.WEXITSTATUS(condition)
 
631
            if self.last_checker_status == 0:
 
632
                logger.info("Checker for %(name)s succeeded",
309
633
                            vars(self))
310
634
                self.checked_ok()
311
635
            else:
312
 
                logger.info(u"Checker for %(name)s failed",
 
636
                logger.info("Checker for %(name)s failed",
313
637
                            vars(self))
314
638
        else:
315
 
            logger.warning(u"Checker for %(name)s crashed?",
 
639
            self.last_checker_status = -1
 
640
            logger.warning("Checker for %(name)s crashed?",
316
641
                           vars(self))
317
642
    
318
643
    def checked_ok(self):
319
 
        """Bump up the timeout for this client.
320
 
        This should only be called when the client has been seen,
321
 
        alive and well.
322
 
        """
 
644
        """Assert that the client has been seen, alive and well."""
323
645
        self.last_checked_ok = datetime.datetime.utcnow()
324
 
        gobject.source_remove(self.disable_initiator_tag)
325
 
        self.disable_initiator_tag = (gobject.timeout_add
326
 
                                      (self.timeout_milliseconds(),
327
 
                                       self.disable))
 
646
        self.last_checker_status = 0
 
647
        self.bump_timeout()
 
648
    
 
649
    def bump_timeout(self, timeout=None):
 
650
        """Bump up the timeout for this client."""
 
651
        if timeout is None:
 
652
            timeout = self.timeout
 
653
        if self.disable_initiator_tag is not None:
 
654
            gobject.source_remove(self.disable_initiator_tag)
 
655
            self.disable_initiator_tag = None
 
656
        if getattr(self, "enabled", False):
 
657
            self.disable_initiator_tag = (gobject.timeout_add
 
658
                                          (timedelta_to_milliseconds
 
659
                                           (timeout), self.disable))
 
660
            self.expires = datetime.datetime.utcnow() + timeout
 
661
    
 
662
    def need_approval(self):
 
663
        self.last_approval_request = datetime.datetime.utcnow()
328
664
    
329
665
    def start_checker(self):
330
666
        """Start a new checker subprocess if one is not running.
 
667
        
331
668
        If a checker already exists, leave it running and do
332
669
        nothing."""
333
670
        # The reason for not killing a running checker is that if we
334
 
        # did that, then if a checker (for some reason) started
335
 
        # running slowly and taking more than 'interval' time, the
336
 
        # client would inevitably timeout, since no checker would get
337
 
        # a chance to run to completion.  If we instead leave running
 
671
        # did that, and if a checker (for some reason) started running
 
672
        # slowly and taking more than 'interval' time, then the client
 
673
        # would inevitably timeout, since no checker would get a
 
674
        # chance to run to completion.  If we instead leave running
338
675
        # checkers alone, the checker would have to take more time
339
 
        # than 'timeout' for the client to be declared invalid, which
340
 
        # is as it should be.
 
676
        # than 'timeout' for the client to be disabled, which is as it
 
677
        # should be.
341
678
        
342
679
        # If a checker exists, make sure it is not a zombie
343
 
        if self.checker is not None:
 
680
        try:
344
681
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
682
        except (AttributeError, OSError) as error:
 
683
            if (isinstance(error, OSError)
 
684
                and error.errno != errno.ECHILD):
 
685
                raise error
 
686
        else:
345
687
            if pid:
346
688
                logger.warning("Checker was a zombie")
347
689
                gobject.source_remove(self.checker_callback_tag)
349
691
                                      self.current_checker_command)
350
692
        # Start a new checker if needed
351
693
        if self.checker is None:
 
694
            # Escape attributes for the shell
 
695
            escaped_attrs = dict(
 
696
                (attr, re.escape(unicode(getattr(self, attr))))
 
697
                for attr in
 
698
                self.runtime_expansions)
352
699
            try:
353
 
                # In case checker_command has exactly one % operator
354
 
                command = self.checker_command % self.host
355
 
            except TypeError:
356
 
                # Escape attributes for the shell
357
 
                escaped_attrs = dict((key, re.escape(str(val)))
358
 
                                     for key, val in
359
 
                                     vars(self).iteritems())
360
 
                try:
361
 
                    command = self.checker_command % escaped_attrs
362
 
                except TypeError, error:
363
 
                    logger.error(u'Could not format string "%s":'
364
 
                                 u' %s', self.checker_command, error)
365
 
                    return True # Try again later
 
700
                command = self.checker_command % escaped_attrs
 
701
            except TypeError as error:
 
702
                logger.error('Could not format string "%s"',
 
703
                             self.checker_command, exc_info=error)
 
704
                return True # Try again later
366
705
            self.current_checker_command = command
367
706
            try:
368
 
                logger.info(u"Starting checker %r for %s",
 
707
                logger.info("Starting checker %r for %s",
369
708
                            command, self.name)
370
709
                # We don't need to redirect stdout and stderr, since
371
710
                # in normal mode, that is already done by daemon(),
374
713
                self.checker = subprocess.Popen(command,
375
714
                                                close_fds=True,
376
715
                                                shell=True, cwd="/")
377
 
                self.checker_callback_tag = (gobject.child_watch_add
378
 
                                             (self.checker.pid,
379
 
                                              self.checker_callback,
380
 
                                              data=command))
381
 
                # The checker may have completed before the gobject
382
 
                # watch was added.  Check for this.
383
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
384
 
                if pid:
385
 
                    gobject.source_remove(self.checker_callback_tag)
386
 
                    self.checker_callback(pid, status, command)
387
 
            except OSError, error:
388
 
                logger.error(u"Failed to start subprocess: %s",
389
 
                             error)
 
716
            except OSError as error:
 
717
                logger.error("Failed to start subprocess",
 
718
                             exc_info=error)
 
719
            self.checker_callback_tag = (gobject.child_watch_add
 
720
                                         (self.checker.pid,
 
721
                                          self.checker_callback,
 
722
                                          data=command))
 
723
            # The checker may have completed before the gobject
 
724
            # watch was added.  Check for this.
 
725
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
726
            if pid:
 
727
                gobject.source_remove(self.checker_callback_tag)
 
728
                self.checker_callback(pid, status, command)
390
729
        # Re-run this periodically if run by gobject.timeout_add
391
730
        return True
392
731
    
397
736
            self.checker_callback_tag = None
398
737
        if getattr(self, "checker", None) is None:
399
738
            return
400
 
        logger.debug(u"Stopping checker for %(name)s", vars(self))
 
739
        logger.debug("Stopping checker for %(name)s", vars(self))
401
740
        try:
402
 
            os.kill(self.checker.pid, signal.SIGTERM)
403
 
            #os.sleep(0.5)
 
741
            self.checker.terminate()
 
742
            #time.sleep(0.5)
404
743
            #if self.checker.poll() is None:
405
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
406
 
        except OSError, error:
 
744
            #    self.checker.kill()
 
745
        except OSError as error:
407
746
            if error.errno != errno.ESRCH: # No such process
408
747
                raise
409
748
        self.checker = None
410
 
    
411
 
    def still_valid(self):
412
 
        """Has the timeout not yet passed for this client?"""
413
 
        if not getattr(self, "enabled", False):
414
 
            return False
415
 
        now = datetime.datetime.utcnow()
416
 
        if self.last_checked_ok is None:
417
 
            return now < (self.created + self.timeout)
418
 
        else:
419
 
            return now < (self.last_checked_ok + self.timeout)
420
 
 
421
 
 
422
 
class ClientDBus(Client, dbus.service.Object):
 
749
 
 
750
 
 
751
def dbus_service_property(dbus_interface, signature="v",
 
752
                          access="readwrite", byte_arrays=False):
 
753
    """Decorators for marking methods of a DBusObjectWithProperties to
 
754
    become properties on the D-Bus.
 
755
    
 
756
    The decorated method will be called with no arguments by "Get"
 
757
    and with one argument by "Set".
 
758
    
 
759
    The parameters, where they are supported, are the same as
 
760
    dbus.service.method, except there is only "signature", since the
 
761
    type from Get() and the type sent to Set() is the same.
 
762
    """
 
763
    # Encoding deeply encoded byte arrays is not supported yet by the
 
764
    # "Set" method, so we fail early here:
 
765
    if byte_arrays and signature != "ay":
 
766
        raise ValueError("Byte arrays not supported for non-'ay'"
 
767
                         " signature {0!r}".format(signature))
 
768
    def decorator(func):
 
769
        func._dbus_is_property = True
 
770
        func._dbus_interface = dbus_interface
 
771
        func._dbus_signature = signature
 
772
        func._dbus_access = access
 
773
        func._dbus_name = func.__name__
 
774
        if func._dbus_name.endswith("_dbus_property"):
 
775
            func._dbus_name = func._dbus_name[:-14]
 
776
        func._dbus_get_args_options = {'byte_arrays': byte_arrays }
 
777
        return func
 
778
    return decorator
 
779
 
 
780
 
 
781
def dbus_interface_annotations(dbus_interface):
 
782
    """Decorator for marking functions returning interface annotations
 
783
    
 
784
    Usage:
 
785
    
 
786
    @dbus_interface_annotations("org.example.Interface")
 
787
    def _foo(self):  # Function name does not matter
 
788
        return {"org.freedesktop.DBus.Deprecated": "true",
 
789
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
790
                    "false"}
 
791
    """
 
792
    def decorator(func):
 
793
        func._dbus_is_interface = True
 
794
        func._dbus_interface = dbus_interface
 
795
        func._dbus_name = dbus_interface
 
796
        return func
 
797
    return decorator
 
798
 
 
799
 
 
800
def dbus_annotations(annotations):
 
801
    """Decorator to annotate D-Bus methods, signals or properties
 
802
    Usage:
 
803
    
 
804
    @dbus_service_property("org.example.Interface", signature="b",
 
805
                           access="r")
 
806
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
 
807
                        "org.freedesktop.DBus.Property."
 
808
                        "EmitsChangedSignal": "false"})
 
809
    def Property_dbus_property(self):
 
810
        return dbus.Boolean(False)
 
811
    """
 
812
    def decorator(func):
 
813
        func._dbus_annotations = annotations
 
814
        return func
 
815
    return decorator
 
816
 
 
817
 
 
818
class DBusPropertyException(dbus.exceptions.DBusException):
 
819
    """A base class for D-Bus property-related exceptions
 
820
    """
 
821
    def __unicode__(self):
 
822
        return unicode(str(self))
 
823
 
 
824
 
 
825
class DBusPropertyAccessException(DBusPropertyException):
 
826
    """A property's access permissions disallows an operation.
 
827
    """
 
828
    pass
 
829
 
 
830
 
 
831
class DBusPropertyNotFound(DBusPropertyException):
 
832
    """An attempt was made to access a non-existing property.
 
833
    """
 
834
    pass
 
835
 
 
836
 
 
837
class DBusObjectWithProperties(dbus.service.Object):
 
838
    """A D-Bus object with properties.
 
839
    
 
840
    Classes inheriting from this can use the dbus_service_property
 
841
    decorator to expose methods as D-Bus properties.  It exposes the
 
842
    standard Get(), Set(), and GetAll() methods on the D-Bus.
 
843
    """
 
844
    
 
845
    @staticmethod
 
846
    def _is_dbus_thing(thing):
 
847
        """Returns a function testing if an attribute is a D-Bus thing
 
848
        
 
849
        If called like _is_dbus_thing("method") it returns a function
 
850
        suitable for use as predicate to inspect.getmembers().
 
851
        """
 
852
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
 
853
                                   False)
 
854
    
 
855
    def _get_all_dbus_things(self, thing):
 
856
        """Returns a generator of (name, attribute) pairs
 
857
        """
 
858
        return ((getattr(athing.__get__(self), "_dbus_name",
 
859
                         name),
 
860
                 athing.__get__(self))
 
861
                for cls in self.__class__.__mro__
 
862
                for name, athing in
 
863
                inspect.getmembers(cls,
 
864
                                   self._is_dbus_thing(thing)))
 
865
    
 
866
    def _get_dbus_property(self, interface_name, property_name):
 
867
        """Returns a bound method if one exists which is a D-Bus
 
868
        property with the specified name and interface.
 
869
        """
 
870
        for cls in  self.__class__.__mro__:
 
871
            for name, value in (inspect.getmembers
 
872
                                (cls,
 
873
                                 self._is_dbus_thing("property"))):
 
874
                if (value._dbus_name == property_name
 
875
                    and value._dbus_interface == interface_name):
 
876
                    return value.__get__(self)
 
877
        
 
878
        # No such property
 
879
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
 
880
                                   + interface_name + "."
 
881
                                   + property_name)
 
882
    
 
883
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
 
884
                         out_signature="v")
 
885
    def Get(self, interface_name, property_name):
 
886
        """Standard D-Bus property Get() method, see D-Bus standard.
 
887
        """
 
888
        prop = self._get_dbus_property(interface_name, property_name)
 
889
        if prop._dbus_access == "write":
 
890
            raise DBusPropertyAccessException(property_name)
 
891
        value = prop()
 
892
        if not hasattr(value, "variant_level"):
 
893
            return value
 
894
        return type(value)(value, variant_level=value.variant_level+1)
 
895
    
 
896
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
 
897
    def Set(self, interface_name, property_name, value):
 
898
        """Standard D-Bus property Set() method, see D-Bus standard.
 
899
        """
 
900
        prop = self._get_dbus_property(interface_name, property_name)
 
901
        if prop._dbus_access == "read":
 
902
            raise DBusPropertyAccessException(property_name)
 
903
        if prop._dbus_get_args_options["byte_arrays"]:
 
904
            # The byte_arrays option is not supported yet on
 
905
            # signatures other than "ay".
 
906
            if prop._dbus_signature != "ay":
 
907
                raise ValueError
 
908
            value = dbus.ByteArray(b''.join(chr(byte)
 
909
                                            for byte in value))
 
910
        prop(value)
 
911
    
 
912
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
 
913
                         out_signature="a{sv}")
 
914
    def GetAll(self, interface_name):
 
915
        """Standard D-Bus property GetAll() method, see D-Bus
 
916
        standard.
 
917
        
 
918
        Note: Will not include properties with access="write".
 
919
        """
 
920
        properties = {}
 
921
        for name, prop in self._get_all_dbus_things("property"):
 
922
            if (interface_name
 
923
                and interface_name != prop._dbus_interface):
 
924
                # Interface non-empty but did not match
 
925
                continue
 
926
            # Ignore write-only properties
 
927
            if prop._dbus_access == "write":
 
928
                continue
 
929
            value = prop()
 
930
            if not hasattr(value, "variant_level"):
 
931
                properties[name] = value
 
932
                continue
 
933
            properties[name] = type(value)(value, variant_level=
 
934
                                           value.variant_level+1)
 
935
        return dbus.Dictionary(properties, signature="sv")
 
936
    
 
937
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
 
938
                         out_signature="s",
 
939
                         path_keyword='object_path',
 
940
                         connection_keyword='connection')
 
941
    def Introspect(self, object_path, connection):
 
942
        """Overloading of standard D-Bus method.
 
943
        
 
944
        Inserts property tags and interface annotation tags.
 
945
        """
 
946
        xmlstring = dbus.service.Object.Introspect(self, object_path,
 
947
                                                   connection)
 
948
        try:
 
949
            document = xml.dom.minidom.parseString(xmlstring)
 
950
            def make_tag(document, name, prop):
 
951
                e = document.createElement("property")
 
952
                e.setAttribute("name", name)
 
953
                e.setAttribute("type", prop._dbus_signature)
 
954
                e.setAttribute("access", prop._dbus_access)
 
955
                return e
 
956
            for if_tag in document.getElementsByTagName("interface"):
 
957
                # Add property tags
 
958
                for tag in (make_tag(document, name, prop)
 
959
                            for name, prop
 
960
                            in self._get_all_dbus_things("property")
 
961
                            if prop._dbus_interface
 
962
                            == if_tag.getAttribute("name")):
 
963
                    if_tag.appendChild(tag)
 
964
                # Add annotation tags
 
965
                for typ in ("method", "signal", "property"):
 
966
                    for tag in if_tag.getElementsByTagName(typ):
 
967
                        annots = dict()
 
968
                        for name, prop in (self.
 
969
                                           _get_all_dbus_things(typ)):
 
970
                            if (name == tag.getAttribute("name")
 
971
                                and prop._dbus_interface
 
972
                                == if_tag.getAttribute("name")):
 
973
                                annots.update(getattr
 
974
                                              (prop,
 
975
                                               "_dbus_annotations",
 
976
                                               {}))
 
977
                        for name, value in annots.iteritems():
 
978
                            ann_tag = document.createElement(
 
979
                                "annotation")
 
980
                            ann_tag.setAttribute("name", name)
 
981
                            ann_tag.setAttribute("value", value)
 
982
                            tag.appendChild(ann_tag)
 
983
                # Add interface annotation tags
 
984
                for annotation, value in dict(
 
985
                    itertools.chain.from_iterable(
 
986
                        annotations().iteritems()
 
987
                        for name, annotations in
 
988
                        self._get_all_dbus_things("interface")
 
989
                        if name == if_tag.getAttribute("name")
 
990
                        )).iteritems():
 
991
                    ann_tag = document.createElement("annotation")
 
992
                    ann_tag.setAttribute("name", annotation)
 
993
                    ann_tag.setAttribute("value", value)
 
994
                    if_tag.appendChild(ann_tag)
 
995
                # Add the names to the return values for the
 
996
                # "org.freedesktop.DBus.Properties" methods
 
997
                if (if_tag.getAttribute("name")
 
998
                    == "org.freedesktop.DBus.Properties"):
 
999
                    for cn in if_tag.getElementsByTagName("method"):
 
1000
                        if cn.getAttribute("name") == "Get":
 
1001
                            for arg in cn.getElementsByTagName("arg"):
 
1002
                                if (arg.getAttribute("direction")
 
1003
                                    == "out"):
 
1004
                                    arg.setAttribute("name", "value")
 
1005
                        elif cn.getAttribute("name") == "GetAll":
 
1006
                            for arg in cn.getElementsByTagName("arg"):
 
1007
                                if (arg.getAttribute("direction")
 
1008
                                    == "out"):
 
1009
                                    arg.setAttribute("name", "props")
 
1010
            xmlstring = document.toxml("utf-8")
 
1011
            document.unlink()
 
1012
        except (AttributeError, xml.dom.DOMException,
 
1013
                xml.parsers.expat.ExpatError) as error:
 
1014
            logger.error("Failed to override Introspection method",
 
1015
                         exc_info=error)
 
1016
        return xmlstring
 
1017
 
 
1018
 
 
1019
def datetime_to_dbus(dt, variant_level=0):
 
1020
    """Convert a UTC datetime.datetime() to a D-Bus type."""
 
1021
    if dt is None:
 
1022
        return dbus.String("", variant_level = variant_level)
 
1023
    return dbus.String(dt.isoformat(),
 
1024
                       variant_level=variant_level)
 
1025
 
 
1026
 
 
1027
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1028
    """A class decorator; applied to a subclass of
 
1029
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1030
    interface names according to the "alt_interface_names" mapping.
 
1031
    Usage:
 
1032
    
 
1033
    @alternate_dbus_interfaces({"org.example.Interface":
 
1034
                                    "net.example.AlternateInterface"})
 
1035
    class SampleDBusObject(dbus.service.Object):
 
1036
        @dbus.service.method("org.example.Interface")
 
1037
        def SampleDBusMethod():
 
1038
            pass
 
1039
    
 
1040
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1041
    reachable via two interfaces: "org.example.Interface" and
 
1042
    "net.example.AlternateInterface", the latter of which will have
 
1043
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1044
    "true", unless "deprecate" is passed with a False value.
 
1045
    
 
1046
    This works for methods and signals, and also for D-Bus properties
 
1047
    (from DBusObjectWithProperties) and interfaces (from the
 
1048
    dbus_interface_annotations decorator).
 
1049
    """
 
1050
    def wrapper(cls):
 
1051
        for orig_interface_name, alt_interface_name in (
 
1052
            alt_interface_names.iteritems()):
 
1053
            attr = {}
 
1054
            interface_names = set()
 
1055
            # Go though all attributes of the class
 
1056
            for attrname, attribute in inspect.getmembers(cls):
 
1057
                # Ignore non-D-Bus attributes, and D-Bus attributes
 
1058
                # with the wrong interface name
 
1059
                if (not hasattr(attribute, "_dbus_interface")
 
1060
                    or not attribute._dbus_interface
 
1061
                    .startswith(orig_interface_name)):
 
1062
                    continue
 
1063
                # Create an alternate D-Bus interface name based on
 
1064
                # the current name
 
1065
                alt_interface = (attribute._dbus_interface
 
1066
                                 .replace(orig_interface_name,
 
1067
                                          alt_interface_name))
 
1068
                interface_names.add(alt_interface)
 
1069
                # Is this a D-Bus signal?
 
1070
                if getattr(attribute, "_dbus_is_signal", False):
 
1071
                    # Extract the original non-method function by
 
1072
                    # black magic
 
1073
                    nonmethod_func = (dict(
 
1074
                            zip(attribute.func_code.co_freevars,
 
1075
                                attribute.__closure__))["func"]
 
1076
                                      .cell_contents)
 
1077
                    # Create a new, but exactly alike, function
 
1078
                    # object, and decorate it to be a new D-Bus signal
 
1079
                    # with the alternate D-Bus interface name
 
1080
                    new_function = (dbus.service.signal
 
1081
                                    (alt_interface,
 
1082
                                     attribute._dbus_signature)
 
1083
                                    (types.FunctionType(
 
1084
                                nonmethod_func.func_code,
 
1085
                                nonmethod_func.func_globals,
 
1086
                                nonmethod_func.func_name,
 
1087
                                nonmethod_func.func_defaults,
 
1088
                                nonmethod_func.func_closure)))
 
1089
                    # Copy annotations, if any
 
1090
                    try:
 
1091
                        new_function._dbus_annotations = (
 
1092
                            dict(attribute._dbus_annotations))
 
1093
                    except AttributeError:
 
1094
                        pass
 
1095
                    # Define a creator of a function to call both the
 
1096
                    # original and alternate functions, so both the
 
1097
                    # original and alternate signals gets sent when
 
1098
                    # the function is called
 
1099
                    def fixscope(func1, func2):
 
1100
                        """This function is a scope container to pass
 
1101
                        func1 and func2 to the "call_both" function
 
1102
                        outside of its arguments"""
 
1103
                        def call_both(*args, **kwargs):
 
1104
                            """This function will emit two D-Bus
 
1105
                            signals by calling func1 and func2"""
 
1106
                            func1(*args, **kwargs)
 
1107
                            func2(*args, **kwargs)
 
1108
                        return call_both
 
1109
                    # Create the "call_both" function and add it to
 
1110
                    # the class
 
1111
                    attr[attrname] = fixscope(attribute, new_function)
 
1112
                # Is this a D-Bus method?
 
1113
                elif getattr(attribute, "_dbus_is_method", False):
 
1114
                    # Create a new, but exactly alike, function
 
1115
                    # object.  Decorate it to be a new D-Bus method
 
1116
                    # with the alternate D-Bus interface name.  Add it
 
1117
                    # to the class.
 
1118
                    attr[attrname] = (dbus.service.method
 
1119
                                      (alt_interface,
 
1120
                                       attribute._dbus_in_signature,
 
1121
                                       attribute._dbus_out_signature)
 
1122
                                      (types.FunctionType
 
1123
                                       (attribute.func_code,
 
1124
                                        attribute.func_globals,
 
1125
                                        attribute.func_name,
 
1126
                                        attribute.func_defaults,
 
1127
                                        attribute.func_closure)))
 
1128
                    # Copy annotations, if any
 
1129
                    try:
 
1130
                        attr[attrname]._dbus_annotations = (
 
1131
                            dict(attribute._dbus_annotations))
 
1132
                    except AttributeError:
 
1133
                        pass
 
1134
                # Is this a D-Bus property?
 
1135
                elif getattr(attribute, "_dbus_is_property", False):
 
1136
                    # Create a new, but exactly alike, function
 
1137
                    # object, and decorate it to be a new D-Bus
 
1138
                    # property with the alternate D-Bus interface
 
1139
                    # name.  Add it to the class.
 
1140
                    attr[attrname] = (dbus_service_property
 
1141
                                      (alt_interface,
 
1142
                                       attribute._dbus_signature,
 
1143
                                       attribute._dbus_access,
 
1144
                                       attribute
 
1145
                                       ._dbus_get_args_options
 
1146
                                       ["byte_arrays"])
 
1147
                                      (types.FunctionType
 
1148
                                       (attribute.func_code,
 
1149
                                        attribute.func_globals,
 
1150
                                        attribute.func_name,
 
1151
                                        attribute.func_defaults,
 
1152
                                        attribute.func_closure)))
 
1153
                    # Copy annotations, if any
 
1154
                    try:
 
1155
                        attr[attrname]._dbus_annotations = (
 
1156
                            dict(attribute._dbus_annotations))
 
1157
                    except AttributeError:
 
1158
                        pass
 
1159
                # Is this a D-Bus interface?
 
1160
                elif getattr(attribute, "_dbus_is_interface", False):
 
1161
                    # Create a new, but exactly alike, function
 
1162
                    # object.  Decorate it to be a new D-Bus interface
 
1163
                    # with the alternate D-Bus interface name.  Add it
 
1164
                    # to the class.
 
1165
                    attr[attrname] = (dbus_interface_annotations
 
1166
                                      (alt_interface)
 
1167
                                      (types.FunctionType
 
1168
                                       (attribute.func_code,
 
1169
                                        attribute.func_globals,
 
1170
                                        attribute.func_name,
 
1171
                                        attribute.func_defaults,
 
1172
                                        attribute.func_closure)))
 
1173
            if deprecate:
 
1174
                # Deprecate all alternate interfaces
 
1175
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1176
                for interface_name in interface_names:
 
1177
                    @dbus_interface_annotations(interface_name)
 
1178
                    def func(self):
 
1179
                        return { "org.freedesktop.DBus.Deprecated":
 
1180
                                     "true" }
 
1181
                    # Find an unused name
 
1182
                    for aname in (iname.format(i)
 
1183
                                  for i in itertools.count()):
 
1184
                        if aname not in attr:
 
1185
                            attr[aname] = func
 
1186
                            break
 
1187
            if interface_names:
 
1188
                # Replace the class with a new subclass of it with
 
1189
                # methods, signals, etc. as created above.
 
1190
                cls = type(b"{0}Alternate".format(cls.__name__),
 
1191
                           (cls,), attr)
 
1192
        return cls
 
1193
    return wrapper
 
1194
 
 
1195
 
 
1196
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1197
                                "se.bsnet.fukt.Mandos"})
 
1198
class ClientDBus(Client, DBusObjectWithProperties):
423
1199
    """A Client class using D-Bus
 
1200
    
424
1201
    Attributes:
425
 
    dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
 
1202
    dbus_object_path: dbus.ObjectPath
 
1203
    bus: dbus.SystemBus()
426
1204
    """
 
1205
    
 
1206
    runtime_expansions = (Client.runtime_expansions
 
1207
                          + ("dbus_object_path",))
 
1208
    
427
1209
    # dbus.service.Object doesn't use super(), so we can't either.
428
1210
    
429
 
    def __init__(self, *args, **kwargs):
 
1211
    def __init__(self, bus = None, *args, **kwargs):
 
1212
        self.bus = bus
430
1213
        Client.__init__(self, *args, **kwargs)
431
1214
        # Only now, when this client is initialized, can it show up on
432
1215
        # the D-Bus
 
1216
        client_object_name = unicode(self.name).translate(
 
1217
            {ord("."): ord("_"),
 
1218
             ord("-"): ord("_")})
433
1219
        self.dbus_object_path = (dbus.ObjectPath
434
 
                                 ("/clients/"
435
 
                                  + self.name.replace(".", "_")))
436
 
        dbus.service.Object.__init__(self, bus,
437
 
                                     self.dbus_object_path)
438
 
    def enable(self):
439
 
        oldstate = getattr(self, "enabled", False)
440
 
        r = Client.enable(self)
441
 
        if oldstate != self.enabled:
442
 
            # Emit D-Bus signals
443
 
            self.PropertyChanged(dbus.String(u"enabled"),
444
 
                                 dbus.Boolean(True, variant_level=1))
445
 
            self.PropertyChanged(dbus.String(u"last_enabled"),
446
 
                                 (_datetime_to_dbus(self.last_enabled,
447
 
                                                    variant_level=1)))
448
 
        return r
449
 
    
450
 
    def disable(self, signal = True):
451
 
        oldstate = getattr(self, "enabled", False)
452
 
        r = Client.disable(self)
453
 
        if signal and oldstate != self.enabled:
454
 
            # Emit D-Bus signal
455
 
            self.PropertyChanged(dbus.String(u"enabled"),
456
 
                                 dbus.Boolean(False, variant_level=1))
457
 
        return r
 
1220
                                 ("/clients/" + client_object_name))
 
1221
        DBusObjectWithProperties.__init__(self, self.bus,
 
1222
                                          self.dbus_object_path)
 
1223
    
 
1224
    def notifychangeproperty(transform_func,
 
1225
                             dbus_name, type_func=lambda x: x,
 
1226
                             variant_level=1):
 
1227
        """ Modify a variable so that it's a property which announces
 
1228
        its changes to DBus.
 
1229
        
 
1230
        transform_fun: Function that takes a value and a variant_level
 
1231
                       and transforms it to a D-Bus type.
 
1232
        dbus_name: D-Bus name of the variable
 
1233
        type_func: Function that transform the value before sending it
 
1234
                   to the D-Bus.  Default: no transform
 
1235
        variant_level: D-Bus variant level.  Default: 1
 
1236
        """
 
1237
        attrname = "_{0}".format(dbus_name)
 
1238
        def setter(self, value):
 
1239
            if hasattr(self, "dbus_object_path"):
 
1240
                if (not hasattr(self, attrname) or
 
1241
                    type_func(getattr(self, attrname, None))
 
1242
                    != type_func(value)):
 
1243
                    dbus_value = transform_func(type_func(value),
 
1244
                                                variant_level
 
1245
                                                =variant_level)
 
1246
                    self.PropertyChanged(dbus.String(dbus_name),
 
1247
                                         dbus_value)
 
1248
            setattr(self, attrname, value)
 
1249
        
 
1250
        return property(lambda self: getattr(self, attrname), setter)
 
1251
    
 
1252
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
 
1253
    approvals_pending = notifychangeproperty(dbus.Boolean,
 
1254
                                             "ApprovalPending",
 
1255
                                             type_func = bool)
 
1256
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
 
1257
    last_enabled = notifychangeproperty(datetime_to_dbus,
 
1258
                                        "LastEnabled")
 
1259
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
 
1260
                                   type_func = lambda checker:
 
1261
                                       checker is not None)
 
1262
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
 
1263
                                           "LastCheckedOK")
 
1264
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1265
                                               "LastCheckerStatus")
 
1266
    last_approval_request = notifychangeproperty(
 
1267
        datetime_to_dbus, "LastApprovalRequest")
 
1268
    approved_by_default = notifychangeproperty(dbus.Boolean,
 
1269
                                               "ApprovedByDefault")
 
1270
    approval_delay = notifychangeproperty(dbus.UInt64,
 
1271
                                          "ApprovalDelay",
 
1272
                                          type_func =
 
1273
                                          timedelta_to_milliseconds)
 
1274
    approval_duration = notifychangeproperty(
 
1275
        dbus.UInt64, "ApprovalDuration",
 
1276
        type_func = timedelta_to_milliseconds)
 
1277
    host = notifychangeproperty(dbus.String, "Host")
 
1278
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
1279
                                   type_func =
 
1280
                                   timedelta_to_milliseconds)
 
1281
    extended_timeout = notifychangeproperty(
 
1282
        dbus.UInt64, "ExtendedTimeout",
 
1283
        type_func = timedelta_to_milliseconds)
 
1284
    interval = notifychangeproperty(dbus.UInt64,
 
1285
                                    "Interval",
 
1286
                                    type_func =
 
1287
                                    timedelta_to_milliseconds)
 
1288
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1289
    
 
1290
    del notifychangeproperty
458
1291
    
459
1292
    def __del__(self, *args, **kwargs):
460
1293
        try:
461
1294
            self.remove_from_connection()
462
1295
        except LookupError:
463
1296
            pass
464
 
        if hasattr(dbus.service.Object, "__del__"):
465
 
            dbus.service.Object.__del__(self, *args, **kwargs)
 
1297
        if hasattr(DBusObjectWithProperties, "__del__"):
 
1298
            DBusObjectWithProperties.__del__(self, *args, **kwargs)
466
1299
        Client.__del__(self, *args, **kwargs)
467
1300
    
468
1301
    def checker_callback(self, pid, condition, command,
469
1302
                         *args, **kwargs):
470
1303
        self.checker_callback_tag = None
471
1304
        self.checker = None
472
 
        # Emit D-Bus signal
473
 
        self.PropertyChanged(dbus.String(u"checker_running"),
474
 
                             dbus.Boolean(False, variant_level=1))
475
1305
        if os.WIFEXITED(condition):
476
1306
            exitstatus = os.WEXITSTATUS(condition)
477
1307
            # Emit D-Bus signal
487
1317
        return Client.checker_callback(self, pid, condition, command,
488
1318
                                       *args, **kwargs)
489
1319
    
490
 
    def checked_ok(self, *args, **kwargs):
491
 
        r = Client.checked_ok(self, *args, **kwargs)
492
 
        # Emit D-Bus signal
493
 
        self.PropertyChanged(
494
 
            dbus.String(u"last_checked_ok"),
495
 
            (_datetime_to_dbus(self.last_checked_ok,
496
 
                               variant_level=1)))
497
 
        return r
498
 
    
499
1320
    def start_checker(self, *args, **kwargs):
500
1321
        old_checker = self.checker
501
1322
        if self.checker is not None:
508
1329
            and old_checker_pid != self.checker.pid):
509
1330
            # Emit D-Bus signal
510
1331
            self.CheckerStarted(self.current_checker_command)
511
 
            self.PropertyChanged(
512
 
                dbus.String("checker_running"),
513
 
                dbus.Boolean(True, variant_level=1))
514
 
        return r
515
 
    
516
 
    def stop_checker(self, *args, **kwargs):
517
 
        old_checker = getattr(self, "checker", None)
518
 
        r = Client.stop_checker(self, *args, **kwargs)
519
 
        if (old_checker is not None
520
 
            and getattr(self, "checker", None) is None):
521
 
            self.PropertyChanged(dbus.String(u"checker_running"),
522
 
                                 dbus.Boolean(False, variant_level=1))
523
 
        return r
524
 
    
525
 
    ## D-Bus methods & signals
526
 
    _interface = u"se.bsnet.fukt.Mandos.Client"
527
 
    
528
 
    # CheckedOK - method
529
 
    CheckedOK = dbus.service.method(_interface)(checked_ok)
530
 
    CheckedOK.__name__ = "CheckedOK"
 
1332
        return r
 
1333
    
 
1334
    def _reset_approved(self):
 
1335
        self.approved = None
 
1336
        return False
 
1337
    
 
1338
    def approve(self, value=True):
 
1339
        self.approved = value
 
1340
        gobject.timeout_add(timedelta_to_milliseconds
 
1341
                            (self.approval_duration),
 
1342
                            self._reset_approved)
 
1343
        self.send_changedstate()
 
1344
    
 
1345
    ## D-Bus methods, signals & properties
 
1346
    _interface = "se.recompile.Mandos.Client"
 
1347
    
 
1348
    ## Interfaces
 
1349
    
 
1350
    @dbus_interface_annotations(_interface)
 
1351
    def _foo(self):
 
1352
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1353
                     "false"}
 
1354
    
 
1355
    ## Signals
531
1356
    
532
1357
    # CheckerCompleted - signal
533
1358
    @dbus.service.signal(_interface, signature="nxs")
541
1366
        "D-Bus signal"
542
1367
        pass
543
1368
    
544
 
    # GetAllProperties - method
545
 
    @dbus.service.method(_interface, out_signature="a{sv}")
546
 
    def GetAllProperties(self):
547
 
        "D-Bus method"
548
 
        return dbus.Dictionary({
549
 
                dbus.String("name"):
550
 
                    dbus.String(self.name, variant_level=1),
551
 
                dbus.String("fingerprint"):
552
 
                    dbus.String(self.fingerprint, variant_level=1),
553
 
                dbus.String("host"):
554
 
                    dbus.String(self.host, variant_level=1),
555
 
                dbus.String("created"):
556
 
                    _datetime_to_dbus(self.created, variant_level=1),
557
 
                dbus.String("last_enabled"):
558
 
                    (_datetime_to_dbus(self.last_enabled,
559
 
                                       variant_level=1)
560
 
                     if self.last_enabled is not None
561
 
                     else dbus.Boolean(False, variant_level=1)),
562
 
                dbus.String("enabled"):
563
 
                    dbus.Boolean(self.enabled, variant_level=1),
564
 
                dbus.String("last_checked_ok"):
565
 
                    (_datetime_to_dbus(self.last_checked_ok,
566
 
                                       variant_level=1)
567
 
                     if self.last_checked_ok is not None
568
 
                     else dbus.Boolean (False, variant_level=1)),
569
 
                dbus.String("timeout"):
570
 
                    dbus.UInt64(self.timeout_milliseconds(),
571
 
                                variant_level=1),
572
 
                dbus.String("interval"):
573
 
                    dbus.UInt64(self.interval_milliseconds(),
574
 
                                variant_level=1),
575
 
                dbus.String("checker"):
576
 
                    dbus.String(self.checker_command,
577
 
                                variant_level=1),
578
 
                dbus.String("checker_running"):
579
 
                    dbus.Boolean(self.checker is not None,
580
 
                                 variant_level=1),
581
 
                dbus.String("object_path"):
582
 
                    dbus.ObjectPath(self.dbus_object_path,
583
 
                                    variant_level=1)
584
 
                }, signature="sv")
585
 
    
586
 
    # IsStillValid - method
587
 
    @dbus.service.method(_interface, out_signature="b")
588
 
    def IsStillValid(self):
589
 
        return self.still_valid()
590
 
    
591
1369
    # PropertyChanged - signal
592
1370
    @dbus.service.signal(_interface, signature="sv")
593
1371
    def PropertyChanged(self, property, value):
594
1372
        "D-Bus signal"
595
1373
        pass
596
1374
    
597
 
    # ReceivedSecret - signal
 
1375
    # GotSecret - signal
598
1376
    @dbus.service.signal(_interface)
599
 
    def ReceivedSecret(self):
600
 
        "D-Bus signal"
 
1377
    def GotSecret(self):
 
1378
        """D-Bus signal
 
1379
        Is sent after a successful transfer of secret from the Mandos
 
1380
        server to mandos-client
 
1381
        """
601
1382
        pass
602
1383
    
603
1384
    # Rejected - signal
604
 
    @dbus.service.signal(_interface)
605
 
    def Rejected(self):
 
1385
    @dbus.service.signal(_interface, signature="s")
 
1386
    def Rejected(self, reason):
606
1387
        "D-Bus signal"
607
1388
        pass
608
1389
    
609
 
    # SetChecker - method
610
 
    @dbus.service.method(_interface, in_signature="s")
611
 
    def SetChecker(self, checker):
612
 
        "D-Bus setter method"
613
 
        self.checker_command = checker
614
 
        # Emit D-Bus signal
615
 
        self.PropertyChanged(dbus.String(u"checker"),
616
 
                             dbus.String(self.checker_command,
617
 
                                         variant_level=1))
618
 
    
619
 
    # SetHost - method
620
 
    @dbus.service.method(_interface, in_signature="s")
621
 
    def SetHost(self, host):
622
 
        "D-Bus setter method"
623
 
        self.host = host
624
 
        # Emit D-Bus signal
625
 
        self.PropertyChanged(dbus.String(u"host"),
626
 
                             dbus.String(self.host, variant_level=1))
627
 
    
628
 
    # SetInterval - method
629
 
    @dbus.service.method(_interface, in_signature="t")
630
 
    def SetInterval(self, milliseconds):
631
 
        self.interval = datetime.timedelta(0, 0, 0, milliseconds)
632
 
        # Emit D-Bus signal
633
 
        self.PropertyChanged(dbus.String(u"interval"),
634
 
                             (dbus.UInt64(self.interval_milliseconds(),
635
 
                                          variant_level=1)))
636
 
    
637
 
    # SetSecret - method
638
 
    @dbus.service.method(_interface, in_signature="ay",
639
 
                         byte_arrays=True)
640
 
    def SetSecret(self, secret):
641
 
        "D-Bus setter method"
642
 
        self.secret = str(secret)
643
 
    
644
 
    # SetTimeout - method
645
 
    @dbus.service.method(_interface, in_signature="t")
646
 
    def SetTimeout(self, milliseconds):
647
 
        self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
648
 
        # Emit D-Bus signal
649
 
        self.PropertyChanged(dbus.String(u"timeout"),
650
 
                             (dbus.UInt64(self.timeout_milliseconds(),
651
 
                                          variant_level=1)))
 
1390
    # NeedApproval - signal
 
1391
    @dbus.service.signal(_interface, signature="tb")
 
1392
    def NeedApproval(self, timeout, default):
 
1393
        "D-Bus signal"
 
1394
        return self.need_approval()
 
1395
    
 
1396
    ## Methods
 
1397
    
 
1398
    # Approve - method
 
1399
    @dbus.service.method(_interface, in_signature="b")
 
1400
    def Approve(self, value):
 
1401
        self.approve(value)
 
1402
    
 
1403
    # CheckedOK - method
 
1404
    @dbus.service.method(_interface)
 
1405
    def CheckedOK(self):
 
1406
        self.checked_ok()
652
1407
    
653
1408
    # Enable - method
654
 
    Enable = dbus.service.method(_interface)(enable)
655
 
    Enable.__name__ = "Enable"
 
1409
    @dbus.service.method(_interface)
 
1410
    def Enable(self):
 
1411
        "D-Bus method"
 
1412
        self.enable()
656
1413
    
657
1414
    # StartChecker - method
658
1415
    @dbus.service.method(_interface)
667
1424
        self.disable()
668
1425
    
669
1426
    # StopChecker - method
670
 
    StopChecker = dbus.service.method(_interface)(stop_checker)
671
 
    StopChecker.__name__ = "StopChecker"
 
1427
    @dbus.service.method(_interface)
 
1428
    def StopChecker(self):
 
1429
        self.stop_checker()
 
1430
    
 
1431
    ## Properties
 
1432
    
 
1433
    # ApprovalPending - property
 
1434
    @dbus_service_property(_interface, signature="b", access="read")
 
1435
    def ApprovalPending_dbus_property(self):
 
1436
        return dbus.Boolean(bool(self.approvals_pending))
 
1437
    
 
1438
    # ApprovedByDefault - property
 
1439
    @dbus_service_property(_interface, signature="b",
 
1440
                           access="readwrite")
 
1441
    def ApprovedByDefault_dbus_property(self, value=None):
 
1442
        if value is None:       # get
 
1443
            return dbus.Boolean(self.approved_by_default)
 
1444
        self.approved_by_default = bool(value)
 
1445
    
 
1446
    # ApprovalDelay - property
 
1447
    @dbus_service_property(_interface, signature="t",
 
1448
                           access="readwrite")
 
1449
    def ApprovalDelay_dbus_property(self, value=None):
 
1450
        if value is None:       # get
 
1451
            return dbus.UInt64(self.approval_delay_milliseconds())
 
1452
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
 
1453
    
 
1454
    # ApprovalDuration - property
 
1455
    @dbus_service_property(_interface, signature="t",
 
1456
                           access="readwrite")
 
1457
    def ApprovalDuration_dbus_property(self, value=None):
 
1458
        if value is None:       # get
 
1459
            return dbus.UInt64(timedelta_to_milliseconds(
 
1460
                    self.approval_duration))
 
1461
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
 
1462
    
 
1463
    # Name - property
 
1464
    @dbus_service_property(_interface, signature="s", access="read")
 
1465
    def Name_dbus_property(self):
 
1466
        return dbus.String(self.name)
 
1467
    
 
1468
    # Fingerprint - property
 
1469
    @dbus_service_property(_interface, signature="s", access="read")
 
1470
    def Fingerprint_dbus_property(self):
 
1471
        return dbus.String(self.fingerprint)
 
1472
    
 
1473
    # Host - property
 
1474
    @dbus_service_property(_interface, signature="s",
 
1475
                           access="readwrite")
 
1476
    def Host_dbus_property(self, value=None):
 
1477
        if value is None:       # get
 
1478
            return dbus.String(self.host)
 
1479
        self.host = unicode(value)
 
1480
    
 
1481
    # Created - property
 
1482
    @dbus_service_property(_interface, signature="s", access="read")
 
1483
    def Created_dbus_property(self):
 
1484
        return datetime_to_dbus(self.created)
 
1485
    
 
1486
    # LastEnabled - property
 
1487
    @dbus_service_property(_interface, signature="s", access="read")
 
1488
    def LastEnabled_dbus_property(self):
 
1489
        return datetime_to_dbus(self.last_enabled)
 
1490
    
 
1491
    # Enabled - property
 
1492
    @dbus_service_property(_interface, signature="b",
 
1493
                           access="readwrite")
 
1494
    def Enabled_dbus_property(self, value=None):
 
1495
        if value is None:       # get
 
1496
            return dbus.Boolean(self.enabled)
 
1497
        if value:
 
1498
            self.enable()
 
1499
        else:
 
1500
            self.disable()
 
1501
    
 
1502
    # LastCheckedOK - property
 
1503
    @dbus_service_property(_interface, signature="s",
 
1504
                           access="readwrite")
 
1505
    def LastCheckedOK_dbus_property(self, value=None):
 
1506
        if value is not None:
 
1507
            self.checked_ok()
 
1508
            return
 
1509
        return datetime_to_dbus(self.last_checked_ok)
 
1510
    
 
1511
    # LastCheckerStatus - property
 
1512
    @dbus_service_property(_interface, signature="n",
 
1513
                           access="read")
 
1514
    def LastCheckerStatus_dbus_property(self):
 
1515
        return dbus.Int16(self.last_checker_status)
 
1516
    
 
1517
    # Expires - property
 
1518
    @dbus_service_property(_interface, signature="s", access="read")
 
1519
    def Expires_dbus_property(self):
 
1520
        return datetime_to_dbus(self.expires)
 
1521
    
 
1522
    # LastApprovalRequest - property
 
1523
    @dbus_service_property(_interface, signature="s", access="read")
 
1524
    def LastApprovalRequest_dbus_property(self):
 
1525
        return datetime_to_dbus(self.last_approval_request)
 
1526
    
 
1527
    # Timeout - property
 
1528
    @dbus_service_property(_interface, signature="t",
 
1529
                           access="readwrite")
 
1530
    def Timeout_dbus_property(self, value=None):
 
1531
        if value is None:       # get
 
1532
            return dbus.UInt64(self.timeout_milliseconds())
 
1533
        old_timeout = self.timeout
 
1534
        self.timeout = datetime.timedelta(0, 0, 0, value)
 
1535
        # Reschedule disabling
 
1536
        if self.enabled:
 
1537
            now = datetime.datetime.utcnow()
 
1538
            self.expires += self.timeout - old_timeout
 
1539
            if self.expires <= now:
 
1540
                # The timeout has passed
 
1541
                self.disable()
 
1542
            else:
 
1543
                if (getattr(self, "disable_initiator_tag", None)
 
1544
                    is None):
 
1545
                    return
 
1546
                gobject.source_remove(self.disable_initiator_tag)
 
1547
                self.disable_initiator_tag = (
 
1548
                    gobject.timeout_add(
 
1549
                        timedelta_to_milliseconds(self.expires - now),
 
1550
                        self.disable))
 
1551
    
 
1552
    # ExtendedTimeout - property
 
1553
    @dbus_service_property(_interface, signature="t",
 
1554
                           access="readwrite")
 
1555
    def ExtendedTimeout_dbus_property(self, value=None):
 
1556
        if value is None:       # get
 
1557
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1558
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
 
1559
    
 
1560
    # Interval - property
 
1561
    @dbus_service_property(_interface, signature="t",
 
1562
                           access="readwrite")
 
1563
    def Interval_dbus_property(self, value=None):
 
1564
        if value is None:       # get
 
1565
            return dbus.UInt64(self.interval_milliseconds())
 
1566
        self.interval = datetime.timedelta(0, 0, 0, value)
 
1567
        if getattr(self, "checker_initiator_tag", None) is None:
 
1568
            return
 
1569
        if self.enabled:
 
1570
            # Reschedule checker run
 
1571
            gobject.source_remove(self.checker_initiator_tag)
 
1572
            self.checker_initiator_tag = (gobject.timeout_add
 
1573
                                          (value, self.start_checker))
 
1574
            self.start_checker()    # Start one now, too
 
1575
    
 
1576
    # Checker - property
 
1577
    @dbus_service_property(_interface, signature="s",
 
1578
                           access="readwrite")
 
1579
    def Checker_dbus_property(self, value=None):
 
1580
        if value is None:       # get
 
1581
            return dbus.String(self.checker_command)
 
1582
        self.checker_command = unicode(value)
 
1583
    
 
1584
    # CheckerRunning - property
 
1585
    @dbus_service_property(_interface, signature="b",
 
1586
                           access="readwrite")
 
1587
    def CheckerRunning_dbus_property(self, value=None):
 
1588
        if value is None:       # get
 
1589
            return dbus.Boolean(self.checker is not None)
 
1590
        if value:
 
1591
            self.start_checker()
 
1592
        else:
 
1593
            self.stop_checker()
 
1594
    
 
1595
    # ObjectPath - property
 
1596
    @dbus_service_property(_interface, signature="o", access="read")
 
1597
    def ObjectPath_dbus_property(self):
 
1598
        return self.dbus_object_path # is already a dbus.ObjectPath
 
1599
    
 
1600
    # Secret = property
 
1601
    @dbus_service_property(_interface, signature="ay",
 
1602
                           access="write", byte_arrays=True)
 
1603
    def Secret_dbus_property(self, value):
 
1604
        self.secret = str(value)
672
1605
    
673
1606
    del _interface
674
1607
 
675
1608
 
676
 
class TCP_handler(SocketServer.BaseRequestHandler, object):
677
 
    """A TCP request handler class.
678
 
    Instantiated by IPv6_TCPServer for each request to handle it.
 
1609
class ProxyClient(object):
 
1610
    def __init__(self, child_pipe, fpr, address):
 
1611
        self._pipe = child_pipe
 
1612
        self._pipe.send(('init', fpr, address))
 
1613
        if not self._pipe.recv():
 
1614
            raise KeyError()
 
1615
    
 
1616
    def __getattribute__(self, name):
 
1617
        if name == '_pipe':
 
1618
            return super(ProxyClient, self).__getattribute__(name)
 
1619
        self._pipe.send(('getattr', name))
 
1620
        data = self._pipe.recv()
 
1621
        if data[0] == 'data':
 
1622
            return data[1]
 
1623
        if data[0] == 'function':
 
1624
            def func(*args, **kwargs):
 
1625
                self._pipe.send(('funcall', name, args, kwargs))
 
1626
                return self._pipe.recv()[1]
 
1627
            return func
 
1628
    
 
1629
    def __setattr__(self, name, value):
 
1630
        if name == '_pipe':
 
1631
            return super(ProxyClient, self).__setattr__(name, value)
 
1632
        self._pipe.send(('setattr', name, value))
 
1633
 
 
1634
 
 
1635
class ClientHandler(socketserver.BaseRequestHandler, object):
 
1636
    """A class to handle client connections.
 
1637
    
 
1638
    Instantiated once for each connection to handle it.
679
1639
    Note: This will run in its own forked process."""
680
1640
    
681
1641
    def handle(self):
682
 
        logger.info(u"TCP connection from: %s",
683
 
                    unicode(self.client_address))
684
 
        logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
685
 
        # Open IPC pipe to parent process
686
 
        with closing(os.fdopen(self.server.pipe[1], "w", 1)) as ipc:
 
1642
        with contextlib.closing(self.server.child_pipe) as child_pipe:
 
1643
            logger.info("TCP connection from: %s",
 
1644
                        unicode(self.client_address))
 
1645
            logger.debug("Pipe FD: %d",
 
1646
                         self.server.child_pipe.fileno())
 
1647
            
687
1648
            session = (gnutls.connection
688
1649
                       .ClientSession(self.request,
689
1650
                                      gnutls.connection
690
1651
                                      .X509Credentials()))
691
1652
            
692
 
            line = self.request.makefile().readline()
693
 
            logger.debug(u"Protocol version: %r", line)
694
 
            try:
695
 
                if int(line.strip().split()[0]) > 1:
696
 
                    raise RuntimeError
697
 
            except (ValueError, IndexError, RuntimeError), error:
698
 
                logger.error(u"Unknown protocol version: %s", error)
699
 
                return
700
 
            
701
1653
            # Note: gnutls.connection.X509Credentials is really a
702
1654
            # generic GnuTLS certificate credentials object so long as
703
1655
            # no X.509 keys are added to it.  Therefore, we can use it
704
1656
            # here despite using OpenPGP certificates.
705
1657
            
706
1658
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
707
 
            #                     "+AES-256-CBC", "+SHA1",
708
 
            #                     "+COMP-NULL", "+CTYPE-OPENPGP",
709
 
            #                     "+DHE-DSS"))
 
1659
            #                      "+AES-256-CBC", "+SHA1",
 
1660
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
 
1661
            #                      "+DHE-DSS"))
710
1662
            # Use a fallback default, since this MUST be set.
711
 
            priority = self.server.settings.get("priority", "NORMAL")
 
1663
            priority = self.server.gnutls_priority
 
1664
            if priority is None:
 
1665
                priority = "NORMAL"
712
1666
            (gnutls.library.functions
713
1667
             .gnutls_priority_set_direct(session._c_object,
714
1668
                                         priority, None))
715
1669
            
 
1670
            # Start communication using the Mandos protocol
 
1671
            # Get protocol number
 
1672
            line = self.request.makefile().readline()
 
1673
            logger.debug("Protocol version: %r", line)
 
1674
            try:
 
1675
                if int(line.strip().split()[0]) > 1:
 
1676
                    raise RuntimeError
 
1677
            except (ValueError, IndexError, RuntimeError) as error:
 
1678
                logger.error("Unknown protocol version: %s", error)
 
1679
                return
 
1680
            
 
1681
            # Start GnuTLS connection
716
1682
            try:
717
1683
                session.handshake()
718
 
            except gnutls.errors.GNUTLSError, error:
719
 
                logger.warning(u"Handshake failed: %s", error)
 
1684
            except gnutls.errors.GNUTLSError as error:
 
1685
                logger.warning("Handshake failed: %s", error)
720
1686
                # Do not run session.bye() here: the session is not
721
1687
                # established.  Just abandon the request.
722
1688
                return
723
 
            logger.debug(u"Handshake succeeded")
 
1689
            logger.debug("Handshake succeeded")
 
1690
            
 
1691
            approval_required = False
724
1692
            try:
725
 
                fpr = self.fingerprint(self.peer_certificate(session))
726
 
            except (TypeError, gnutls.errors.GNUTLSError), error:
727
 
                logger.warning(u"Bad certificate: %s", error)
728
 
                session.bye()
729
 
                return
730
 
            logger.debug(u"Fingerprint: %s", fpr)
 
1693
                try:
 
1694
                    fpr = self.fingerprint(self.peer_certificate
 
1695
                                           (session))
 
1696
                except (TypeError,
 
1697
                        gnutls.errors.GNUTLSError) as error:
 
1698
                    logger.warning("Bad certificate: %s", error)
 
1699
                    return
 
1700
                logger.debug("Fingerprint: %s", fpr)
 
1701
                
 
1702
                try:
 
1703
                    client = ProxyClient(child_pipe, fpr,
 
1704
                                         self.client_address)
 
1705
                except KeyError:
 
1706
                    return
 
1707
                
 
1708
                if client.approval_delay:
 
1709
                    delay = client.approval_delay
 
1710
                    client.approvals_pending += 1
 
1711
                    approval_required = True
 
1712
                
 
1713
                while True:
 
1714
                    if not client.enabled:
 
1715
                        logger.info("Client %s is disabled",
 
1716
                                       client.name)
 
1717
                        if self.server.use_dbus:
 
1718
                            # Emit D-Bus signal
 
1719
                            client.Rejected("Disabled")
 
1720
                        return
 
1721
                    
 
1722
                    if client.approved or not client.approval_delay:
 
1723
                        #We are approved or approval is disabled
 
1724
                        break
 
1725
                    elif client.approved is None:
 
1726
                        logger.info("Client %s needs approval",
 
1727
                                    client.name)
 
1728
                        if self.server.use_dbus:
 
1729
                            # Emit D-Bus signal
 
1730
                            client.NeedApproval(
 
1731
                                client.approval_delay_milliseconds(),
 
1732
                                client.approved_by_default)
 
1733
                    else:
 
1734
                        logger.warning("Client %s was not approved",
 
1735
                                       client.name)
 
1736
                        if self.server.use_dbus:
 
1737
                            # Emit D-Bus signal
 
1738
                            client.Rejected("Denied")
 
1739
                        return
 
1740
                    
 
1741
                    #wait until timeout or approved
 
1742
                    time = datetime.datetime.now()
 
1743
                    client.changedstate.acquire()
 
1744
                    client.changedstate.wait(
 
1745
                        float(timedelta_to_milliseconds(delay)
 
1746
                              / 1000))
 
1747
                    client.changedstate.release()
 
1748
                    time2 = datetime.datetime.now()
 
1749
                    if (time2 - time) >= delay:
 
1750
                        if not client.approved_by_default:
 
1751
                            logger.warning("Client %s timed out while"
 
1752
                                           " waiting for approval",
 
1753
                                           client.name)
 
1754
                            if self.server.use_dbus:
 
1755
                                # Emit D-Bus signal
 
1756
                                client.Rejected("Approval timed out")
 
1757
                            return
 
1758
                        else:
 
1759
                            break
 
1760
                    else:
 
1761
                        delay -= time2 - time
 
1762
                
 
1763
                sent_size = 0
 
1764
                while sent_size < len(client.secret):
 
1765
                    try:
 
1766
                        sent = session.send(client.secret[sent_size:])
 
1767
                    except gnutls.errors.GNUTLSError as error:
 
1768
                        logger.warning("gnutls send failed",
 
1769
                                       exc_info=error)
 
1770
                        return
 
1771
                    logger.debug("Sent: %d, remaining: %d",
 
1772
                                 sent, len(client.secret)
 
1773
                                 - (sent_size + sent))
 
1774
                    sent_size += sent
 
1775
                
 
1776
                logger.info("Sending secret to %s", client.name)
 
1777
                # bump the timeout using extended_timeout
 
1778
                client.bump_timeout(client.extended_timeout)
 
1779
                if self.server.use_dbus:
 
1780
                    # Emit D-Bus signal
 
1781
                    client.GotSecret()
731
1782
            
732
 
            for c in self.server.clients:
733
 
                if c.fingerprint == fpr:
734
 
                    client = c
735
 
                    break
736
 
            else:
737
 
                ipc.write("NOTFOUND %s\n" % fpr)
738
 
                session.bye()
739
 
                return
740
 
            # Have to check if client.still_valid(), since it is
741
 
            # possible that the client timed out while establishing
742
 
            # the GnuTLS session.
743
 
            if not client.still_valid():
744
 
                ipc.write("INVALID %s\n" % client.name)
745
 
                session.bye()
746
 
                return
747
 
            ipc.write("SENDING %s\n" % client.name)
748
 
            sent_size = 0
749
 
            while sent_size < len(client.secret):
750
 
                sent = session.send(client.secret[sent_size:])
751
 
                logger.debug(u"Sent: %d, remaining: %d",
752
 
                             sent, len(client.secret)
753
 
                             - (sent_size + sent))
754
 
                sent_size += sent
755
 
            session.bye()
 
1783
            finally:
 
1784
                if approval_required:
 
1785
                    client.approvals_pending -= 1
 
1786
                try:
 
1787
                    session.bye()
 
1788
                except gnutls.errors.GNUTLSError as error:
 
1789
                    logger.warning("GnuTLS bye failed",
 
1790
                                   exc_info=error)
756
1791
    
757
1792
    @staticmethod
758
1793
    def peer_certificate(session):
814
1849
        # Convert the buffer to a Python bytestring
815
1850
        fpr = ctypes.string_at(buf, buf_len.value)
816
1851
        # Convert the bytestring to hexadecimal notation
817
 
        hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
 
1852
        hex_fpr = binascii.hexlify(fpr).upper()
818
1853
        return hex_fpr
819
1854
 
820
1855
 
821
 
class ForkingMixInWithPipe(SocketServer.ForkingMixIn, object):
822
 
    """Like SocketServer.ForkingMixIn, but also pass a pipe.
823
 
    Assumes a gobject.MainLoop event loop.
824
 
    """
 
1856
class MultiprocessingMixIn(object):
 
1857
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
1858
    def sub_process_main(self, request, address):
 
1859
        try:
 
1860
            self.finish_request(request, address)
 
1861
        except Exception:
 
1862
            self.handle_error(request, address)
 
1863
        self.close_request(request)
 
1864
    
 
1865
    def process_request(self, request, address):
 
1866
        """Start a new process to process the request."""
 
1867
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1868
                                       args = (request, address))
 
1869
        proc.start()
 
1870
        return proc
 
1871
 
 
1872
 
 
1873
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
 
1874
    """ adds a pipe to the MixIn """
825
1875
    def process_request(self, request, client_address):
826
 
        """This overrides and wraps the original process_request().
827
 
        This function creates a new pipe in self.pipe 
 
1876
        """Overrides and wraps the original process_request().
 
1877
        
 
1878
        This function creates a new pipe in self.pipe
828
1879
        """
829
 
        self.pipe = os.pipe()
830
 
        super(ForkingMixInWithPipe,
831
 
              self).process_request(request, client_address)
832
 
        os.close(self.pipe[1])  # close write end
833
 
        # Call "handle_ipc" for both data and EOF events
834
 
        gobject.io_add_watch(self.pipe[0],
835
 
                             gobject.IO_IN | gobject.IO_HUP,
836
 
                             self.handle_ipc)
837
 
    def handle_ipc(source, condition):
 
1880
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
 
1881
        
 
1882
        proc = MultiprocessingMixIn.process_request(self, request,
 
1883
                                                    client_address)
 
1884
        self.child_pipe.close()
 
1885
        self.add_pipe(parent_pipe, proc)
 
1886
    
 
1887
    def add_pipe(self, parent_pipe, proc):
838
1888
        """Dummy function; override as necessary"""
839
 
        os.close(source)
840
 
        return False
841
 
 
842
 
 
843
 
class IPv6_TCPServer(ForkingMixInWithPipe,
844
 
                     SocketServer.TCPServer, object):
 
1889
        raise NotImplementedError
 
1890
 
 
1891
 
 
1892
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
 
1893
                     socketserver.TCPServer, object):
845
1894
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
 
1895
    
846
1896
    Attributes:
847
 
        settings:       Server settings
848
 
        clients:        Set() of Client objects
849
1897
        enabled:        Boolean; whether this server is activated yet
 
1898
        interface:      None or a network interface name (string)
 
1899
        use_ipv6:       Boolean; to use IPv6 or not
850
1900
    """
851
 
    address_family = socket.AF_INET6
852
 
    def __init__(self, *args, **kwargs):
853
 
        if "settings" in kwargs:
854
 
            self.settings = kwargs["settings"]
855
 
            del kwargs["settings"]
856
 
        if "clients" in kwargs:
857
 
            self.clients = kwargs["clients"]
858
 
            del kwargs["clients"]
859
 
        if "use_ipv6" in kwargs:
860
 
            if not kwargs["use_ipv6"]:
861
 
                self.address_family = socket.AF_INET
862
 
            del kwargs["use_ipv6"]
863
 
        self.enabled = False
864
 
        super(IPv6_TCPServer, self).__init__(*args, **kwargs)
 
1901
    def __init__(self, server_address, RequestHandlerClass,
 
1902
                 interface=None, use_ipv6=True, socketfd=None):
 
1903
        """If socketfd is set, use that file descriptor instead of
 
1904
        creating a new one with socket.socket().
 
1905
        """
 
1906
        self.interface = interface
 
1907
        if use_ipv6:
 
1908
            self.address_family = socket.AF_INET6
 
1909
        if socketfd is not None:
 
1910
            # Save the file descriptor
 
1911
            self.socketfd = socketfd
 
1912
            # Save the original socket.socket() function
 
1913
            self.socket_socket = socket.socket
 
1914
            # To implement --socket, we monkey patch socket.socket.
 
1915
            # 
 
1916
            # (When socketserver.TCPServer is a new-style class, we
 
1917
            # could make self.socket into a property instead of monkey
 
1918
            # patching socket.socket.)
 
1919
            # 
 
1920
            # Create a one-time-only replacement for socket.socket()
 
1921
            @functools.wraps(socket.socket)
 
1922
            def socket_wrapper(*args, **kwargs):
 
1923
                # Restore original function so subsequent calls are
 
1924
                # not affected.
 
1925
                socket.socket = self.socket_socket
 
1926
                del self.socket_socket
 
1927
                # This time only, return a new socket object from the
 
1928
                # saved file descriptor.
 
1929
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
1930
            # Replace socket.socket() function with wrapper
 
1931
            socket.socket = socket_wrapper
 
1932
        # The socketserver.TCPServer.__init__ will call
 
1933
        # socket.socket(), which might be our replacement,
 
1934
        # socket_wrapper(), if socketfd was set.
 
1935
        socketserver.TCPServer.__init__(self, server_address,
 
1936
                                        RequestHandlerClass)
 
1937
    
865
1938
    def server_bind(self):
866
1939
        """This overrides the normal server_bind() function
867
1940
        to bind to an interface if one was specified, and also NOT to
868
1941
        bind to an address or port if they were not specified."""
869
 
        if self.settings["interface"]:
870
 
            # 25 is from /usr/include/asm-i486/socket.h
871
 
            SO_BINDTODEVICE = getattr(socket, "SO_BINDTODEVICE", 25)
872
 
            try:
873
 
                self.socket.setsockopt(socket.SOL_SOCKET,
874
 
                                       SO_BINDTODEVICE,
875
 
                                       self.settings["interface"])
876
 
            except socket.error, error:
877
 
                if error[0] == errno.EPERM:
878
 
                    logger.error(u"No permission to"
879
 
                                 u" bind to interface %s",
880
 
                                 self.settings["interface"])
881
 
                else:
882
 
                    raise
 
1942
        if self.interface is not None:
 
1943
            if SO_BINDTODEVICE is None:
 
1944
                logger.error("SO_BINDTODEVICE does not exist;"
 
1945
                             " cannot bind to interface %s",
 
1946
                             self.interface)
 
1947
            else:
 
1948
                try:
 
1949
                    self.socket.setsockopt(socket.SOL_SOCKET,
 
1950
                                           SO_BINDTODEVICE,
 
1951
                                           str(self.interface + '\0'))
 
1952
                except socket.error as error:
 
1953
                    if error.errno == errno.EPERM:
 
1954
                        logger.error("No permission to bind to"
 
1955
                                     " interface %s", self.interface)
 
1956
                    elif error.errno == errno.ENOPROTOOPT:
 
1957
                        logger.error("SO_BINDTODEVICE not available;"
 
1958
                                     " cannot bind to interface %s",
 
1959
                                     self.interface)
 
1960
                    elif error.errno == errno.ENODEV:
 
1961
                        logger.error("Interface %s does not exist,"
 
1962
                                     " cannot bind", self.interface)
 
1963
                    else:
 
1964
                        raise
883
1965
        # Only bind(2) the socket if we really need to.
884
1966
        if self.server_address[0] or self.server_address[1]:
885
1967
            if not self.server_address[0]:
892
1974
            elif not self.server_address[1]:
893
1975
                self.server_address = (self.server_address[0],
894
1976
                                       0)
895
 
#                 if self.settings["interface"]:
 
1977
#                 if self.interface:
896
1978
#                     self.server_address = (self.server_address[0],
897
1979
#                                            0, # port
898
1980
#                                            0, # flowinfo
899
1981
#                                            if_nametoindex
900
 
#                                            (self.settings
901
 
#                                             ["interface"]))
902
 
            return super(IPv6_TCPServer, self).server_bind()
 
1982
#                                            (self.interface))
 
1983
            return socketserver.TCPServer.server_bind(self)
 
1984
 
 
1985
 
 
1986
class MandosServer(IPv6_TCPServer):
 
1987
    """Mandos server.
 
1988
    
 
1989
    Attributes:
 
1990
        clients:        set of Client objects
 
1991
        gnutls_priority GnuTLS priority string
 
1992
        use_dbus:       Boolean; to emit D-Bus signals or not
 
1993
    
 
1994
    Assumes a gobject.MainLoop event loop.
 
1995
    """
 
1996
    def __init__(self, server_address, RequestHandlerClass,
 
1997
                 interface=None, use_ipv6=True, clients=None,
 
1998
                 gnutls_priority=None, use_dbus=True, socketfd=None):
 
1999
        self.enabled = False
 
2000
        self.clients = clients
 
2001
        if self.clients is None:
 
2002
            self.clients = {}
 
2003
        self.use_dbus = use_dbus
 
2004
        self.gnutls_priority = gnutls_priority
 
2005
        IPv6_TCPServer.__init__(self, server_address,
 
2006
                                RequestHandlerClass,
 
2007
                                interface = interface,
 
2008
                                use_ipv6 = use_ipv6,
 
2009
                                socketfd = socketfd)
903
2010
    def server_activate(self):
904
2011
        if self.enabled:
905
 
            return super(IPv6_TCPServer, self).server_activate()
 
2012
            return socketserver.TCPServer.server_activate(self)
 
2013
    
906
2014
    def enable(self):
907
2015
        self.enabled = True
908
 
    def handle_ipc(self, source, condition, file_objects={}):
909
 
        condition_names = {
910
 
            gobject.IO_IN: "IN", # There is data to read.
911
 
            gobject.IO_OUT: "OUT", # Data can be written (without
912
 
                                   # blocking).
913
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
914
 
            gobject.IO_ERR: "ERR", # Error condition.
915
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
916
 
                                   # broken, usually for pipes and
917
 
                                   # sockets).
918
 
            }
919
 
        conditions_string = ' | '.join(name
920
 
                                       for cond, name in
921
 
                                       condition_names.iteritems()
922
 
                                       if cond & condition)
923
 
        logger.debug("Handling IPC: FD = %d, condition = %s", source,
924
 
                     conditions_string)
925
 
        
926
 
        # Turn the pipe file descriptor into a Python file object
927
 
        if source not in file_objects:
928
 
            file_objects[source] = os.fdopen(source, "r", 1)
929
 
        
930
 
        # Read a line from the file object
931
 
        cmdline = file_objects[source].readline()
932
 
        if not cmdline:             # Empty line means end of file
933
 
            # close the IPC pipe
934
 
            file_objects[source].close()
935
 
            del file_objects[source]
936
 
            
937
 
            # Stop calling this function
938
 
            return False
939
 
        
940
 
        logger.debug("IPC command: %r", cmdline)
941
 
        
942
 
        # Parse and act on command
943
 
        cmd, args = cmdline.rstrip("\r\n").split(None, 1)
944
 
        
945
 
        if cmd == "NOTFOUND":
946
 
            logger.warning(u"Client not found for fingerprint: %s",
947
 
                           args)
948
 
            if self.settings["use_dbus"]:
949
 
                # Emit D-Bus signal
950
 
                mandos_dbus_service.ClientNotFound(args)
951
 
        elif cmd == "INVALID":
952
 
            for client in self.clients:
953
 
                if client.name == args:
954
 
                    logger.warning(u"Client %s is invalid", args)
955
 
                    if self.settings["use_dbus"]:
956
 
                        # Emit D-Bus signal
957
 
                        client.Rejected()
958
 
                    break
959
 
            else:
960
 
                logger.error(u"Unknown client %s is invalid", args)
961
 
        elif cmd == "SENDING":
962
 
            for client in self.clients:
963
 
                if client.name == args:
964
 
                    logger.info(u"Sending secret to %s", client.name)
965
 
                    client.checked_ok()
966
 
                    if self.settings["use_dbus"]:
967
 
                        # Emit D-Bus signal
968
 
                        client.ReceivedSecret()
969
 
                    break
970
 
            else:
971
 
                logger.error(u"Sending secret to unknown client %s",
972
 
                             args)
973
 
        else:
974
 
            logger.error("Unknown IPC command: %r", cmdline)
975
 
        
976
 
        # Keep calling this function
 
2016
    
 
2017
    def add_pipe(self, parent_pipe, proc):
 
2018
        # Call "handle_ipc" for both data and EOF events
 
2019
        gobject.io_add_watch(parent_pipe.fileno(),
 
2020
                             gobject.IO_IN | gobject.IO_HUP,
 
2021
                             functools.partial(self.handle_ipc,
 
2022
                                               parent_pipe =
 
2023
                                               parent_pipe,
 
2024
                                               proc = proc))
 
2025
    
 
2026
    def handle_ipc(self, source, condition, parent_pipe=None,
 
2027
                   proc = None, client_object=None):
 
2028
        # error, or the other end of multiprocessing.Pipe has closed
 
2029
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2030
            # Wait for other process to exit
 
2031
            proc.join()
 
2032
            return False
 
2033
        
 
2034
        # Read a request from the child
 
2035
        request = parent_pipe.recv()
 
2036
        command = request[0]
 
2037
        
 
2038
        if command == 'init':
 
2039
            fpr = request[1]
 
2040
            address = request[2]
 
2041
            
 
2042
            for c in self.clients.itervalues():
 
2043
                if c.fingerprint == fpr:
 
2044
                    client = c
 
2045
                    break
 
2046
            else:
 
2047
                logger.info("Client not found for fingerprint: %s, ad"
 
2048
                            "dress: %s", fpr, address)
 
2049
                if self.use_dbus:
 
2050
                    # Emit D-Bus signal
 
2051
                    mandos_dbus_service.ClientNotFound(fpr,
 
2052
                                                       address[0])
 
2053
                parent_pipe.send(False)
 
2054
                return False
 
2055
            
 
2056
            gobject.io_add_watch(parent_pipe.fileno(),
 
2057
                                 gobject.IO_IN | gobject.IO_HUP,
 
2058
                                 functools.partial(self.handle_ipc,
 
2059
                                                   parent_pipe =
 
2060
                                                   parent_pipe,
 
2061
                                                   proc = proc,
 
2062
                                                   client_object =
 
2063
                                                   client))
 
2064
            parent_pipe.send(True)
 
2065
            # remove the old hook in favor of the new above hook on
 
2066
            # same fileno
 
2067
            return False
 
2068
        if command == 'funcall':
 
2069
            funcname = request[1]
 
2070
            args = request[2]
 
2071
            kwargs = request[3]
 
2072
            
 
2073
            parent_pipe.send(('data', getattr(client_object,
 
2074
                                              funcname)(*args,
 
2075
                                                         **kwargs)))
 
2076
        
 
2077
        if command == 'getattr':
 
2078
            attrname = request[1]
 
2079
            if callable(client_object.__getattribute__(attrname)):
 
2080
                parent_pipe.send(('function',))
 
2081
            else:
 
2082
                parent_pipe.send(('data', client_object
 
2083
                                  .__getattribute__(attrname)))
 
2084
        
 
2085
        if command == 'setattr':
 
2086
            attrname = request[1]
 
2087
            value = request[2]
 
2088
            setattr(client_object, attrname, value)
 
2089
        
977
2090
        return True
978
2091
 
979
2092
 
988
2101
    datetime.timedelta(0, 3600)
989
2102
    >>> string_to_delta('24h')
990
2103
    datetime.timedelta(1)
991
 
    >>> string_to_delta(u'1w')
 
2104
    >>> string_to_delta('1w')
992
2105
    datetime.timedelta(7)
993
2106
    >>> string_to_delta('5m 30s')
994
2107
    datetime.timedelta(0, 330)
998
2111
        try:
999
2112
            suffix = unicode(s[-1])
1000
2113
            value = int(s[:-1])
1001
 
            if suffix == u"d":
 
2114
            if suffix == "d":
1002
2115
                delta = datetime.timedelta(value)
1003
 
            elif suffix == u"s":
 
2116
            elif suffix == "s":
1004
2117
                delta = datetime.timedelta(0, value)
1005
 
            elif suffix == u"m":
 
2118
            elif suffix == "m":
1006
2119
                delta = datetime.timedelta(0, 0, 0, 0, value)
1007
 
            elif suffix == u"h":
 
2120
            elif suffix == "h":
1008
2121
                delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1009
 
            elif suffix == u"w":
 
2122
            elif suffix == "w":
1010
2123
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1011
2124
            else:
1012
 
                raise ValueError
1013
 
        except (ValueError, IndexError):
1014
 
            raise ValueError
 
2125
                raise ValueError("Unknown suffix {0!r}"
 
2126
                                 .format(suffix))
 
2127
        except (ValueError, IndexError) as e:
 
2128
            raise ValueError(*(e.args))
1015
2129
        timevalue += delta
1016
2130
    return timevalue
1017
2131
 
1018
2132
 
1019
 
def server_state_changed(state):
1020
 
    """Derived from the Avahi example code"""
1021
 
    if state == avahi.SERVER_COLLISION:
1022
 
        logger.error(u"Zeroconf server name collision")
1023
 
        service.remove()
1024
 
    elif state == avahi.SERVER_RUNNING:
1025
 
        service.add()
1026
 
 
1027
 
 
1028
 
def entry_group_state_changed(state, error):
1029
 
    """Derived from the Avahi example code"""
1030
 
    logger.debug(u"Avahi state change: %i", state)
1031
 
    
1032
 
    if state == avahi.ENTRY_GROUP_ESTABLISHED:
1033
 
        logger.debug(u"Zeroconf service established.")
1034
 
    elif state == avahi.ENTRY_GROUP_COLLISION:
1035
 
        logger.warning(u"Zeroconf service name collision.")
1036
 
        service.rename()
1037
 
    elif state == avahi.ENTRY_GROUP_FAILURE:
1038
 
        logger.critical(u"Avahi: Error in group state changed %s",
1039
 
                        unicode(error))
1040
 
        raise AvahiGroupError(u"State changed: %s" % unicode(error))
1041
 
 
1042
 
def if_nametoindex(interface):
1043
 
    """Call the C function if_nametoindex(), or equivalent"""
1044
 
    global if_nametoindex
1045
 
    try:
1046
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1047
 
                          (ctypes.util.find_library("c"))
1048
 
                          .if_nametoindex)
1049
 
    except (OSError, AttributeError):
1050
 
        if "struct" not in sys.modules:
1051
 
            import struct
1052
 
        if "fcntl" not in sys.modules:
1053
 
            import fcntl
1054
 
        def if_nametoindex(interface):
1055
 
            "Get an interface index the hard way, i.e. using fcntl()"
1056
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1057
 
            with closing(socket.socket()) as s:
1058
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1059
 
                                    struct.pack("16s16x", interface))
1060
 
            interface_index = struct.unpack("I", ifreq[16:20])[0]
1061
 
            return interface_index
1062
 
    return if_nametoindex(interface)
1063
 
 
1064
 
 
1065
2133
def daemon(nochdir = False, noclose = False):
1066
2134
    """See daemon(3).  Standard BSD Unix function.
 
2135
    
1067
2136
    This should really exist as os.daemon, but it doesn't (yet)."""
1068
2137
    if os.fork():
1069
2138
        sys.exit()
1074
2143
        sys.exit()
1075
2144
    if not noclose:
1076
2145
        # Close all standard open file descriptors
1077
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2146
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1078
2147
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1079
2148
            raise OSError(errno.ENODEV,
1080
 
                          "/dev/null not a character device")
 
2149
                          "{0} not a character device"
 
2150
                          .format(os.devnull))
1081
2151
        os.dup2(null, sys.stdin.fileno())
1082
2152
        os.dup2(null, sys.stdout.fileno())
1083
2153
        os.dup2(null, sys.stderr.fileno())
1087
2157
 
1088
2158
def main():
1089
2159
    
1090
 
    ######################################################################
 
2160
    ##################################################################
1091
2161
    # Parsing of options, both command line and config file
1092
2162
    
1093
 
    parser = optparse.OptionParser(version = "%%prog %s" % version)
1094
 
    parser.add_option("-i", "--interface", type="string",
1095
 
                      metavar="IF", help="Bind to interface IF")
1096
 
    parser.add_option("-a", "--address", type="string",
1097
 
                      help="Address to listen for requests on")
1098
 
    parser.add_option("-p", "--port", type="int",
1099
 
                      help="Port number to receive requests on")
1100
 
    parser.add_option("--check", action="store_true",
1101
 
                      help="Run self-test")
1102
 
    parser.add_option("--debug", action="store_true",
1103
 
                      help="Debug mode; run in foreground and log to"
1104
 
                      " terminal")
1105
 
    parser.add_option("--priority", type="string", help="GnuTLS"
1106
 
                      " priority string (see GnuTLS documentation)")
1107
 
    parser.add_option("--servicename", type="string", metavar="NAME",
1108
 
                      help="Zeroconf service name")
1109
 
    parser.add_option("--configdir", type="string",
1110
 
                      default="/etc/mandos", metavar="DIR",
1111
 
                      help="Directory to search for configuration"
1112
 
                      " files")
1113
 
    parser.add_option("--no-dbus", action="store_false",
1114
 
                      dest="use_dbus",
1115
 
                      help="Do not provide D-Bus system bus"
1116
 
                      " interface")
1117
 
    parser.add_option("--no-ipv6", action="store_false",
1118
 
                      dest="use_ipv6", help="Do not use IPv6")
1119
 
    options = parser.parse_args()[0]
 
2163
    parser = argparse.ArgumentParser()
 
2164
    parser.add_argument("-v", "--version", action="version",
 
2165
                        version = "%(prog)s {0}".format(version),
 
2166
                        help="show version number and exit")
 
2167
    parser.add_argument("-i", "--interface", metavar="IF",
 
2168
                        help="Bind to interface IF")
 
2169
    parser.add_argument("-a", "--address",
 
2170
                        help="Address to listen for requests on")
 
2171
    parser.add_argument("-p", "--port", type=int,
 
2172
                        help="Port number to receive requests on")
 
2173
    parser.add_argument("--check", action="store_true",
 
2174
                        help="Run self-test")
 
2175
    parser.add_argument("--debug", action="store_true",
 
2176
                        help="Debug mode; run in foreground and log"
 
2177
                        " to terminal")
 
2178
    parser.add_argument("--debuglevel", metavar="LEVEL",
 
2179
                        help="Debug level for stdout output")
 
2180
    parser.add_argument("--priority", help="GnuTLS"
 
2181
                        " priority string (see GnuTLS documentation)")
 
2182
    parser.add_argument("--servicename",
 
2183
                        metavar="NAME", help="Zeroconf service name")
 
2184
    parser.add_argument("--configdir",
 
2185
                        default="/etc/mandos", metavar="DIR",
 
2186
                        help="Directory to search for configuration"
 
2187
                        " files")
 
2188
    parser.add_argument("--no-dbus", action="store_false",
 
2189
                        dest="use_dbus", help="Do not provide D-Bus"
 
2190
                        " system bus interface")
 
2191
    parser.add_argument("--no-ipv6", action="store_false",
 
2192
                        dest="use_ipv6", help="Do not use IPv6")
 
2193
    parser.add_argument("--no-restore", action="store_false",
 
2194
                        dest="restore", help="Do not restore stored"
 
2195
                        " state")
 
2196
    parser.add_argument("--socket", type=int,
 
2197
                        help="Specify a file descriptor to a network"
 
2198
                        " socket to use instead of creating one")
 
2199
    parser.add_argument("--statedir", metavar="DIR",
 
2200
                        help="Directory to save/restore state in")
 
2201
    parser.add_argument("--foreground", action="store_true",
 
2202
                        help="Run in foreground")
 
2203
    
 
2204
    options = parser.parse_args()
1120
2205
    
1121
2206
    if options.check:
1122
2207
        import doctest
1133
2218
                        "servicename": "Mandos",
1134
2219
                        "use_dbus": "True",
1135
2220
                        "use_ipv6": "True",
 
2221
                        "debuglevel": "",
 
2222
                        "restore": "True",
 
2223
                        "socket": "",
 
2224
                        "statedir": "/var/lib/mandos",
 
2225
                        "foreground": "False",
1136
2226
                        }
1137
2227
    
1138
2228
    # Parse config file for server-global settings
1139
 
    server_config = ConfigParser.SafeConfigParser(server_defaults)
 
2229
    server_config = configparser.SafeConfigParser(server_defaults)
1140
2230
    del server_defaults
1141
 
    server_config.read(os.path.join(options.configdir, "mandos.conf"))
 
2231
    server_config.read(os.path.join(options.configdir,
 
2232
                                    "mandos.conf"))
1142
2233
    # Convert the SafeConfigParser object to a dict
1143
2234
    server_settings = server_config.defaults()
1144
2235
    # Use the appropriate methods on the non-string config options
1145
 
    server_settings["debug"] = server_config.getboolean("DEFAULT",
1146
 
                                                        "debug")
1147
 
    server_settings["use_dbus"] = server_config.getboolean("DEFAULT",
1148
 
                                                           "use_dbus")
1149
 
    server_settings["use_ipv6"] = server_config.getboolean("DEFAULT",
1150
 
                                                           "use_ipv6")
 
2236
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
 
2237
        server_settings[option] = server_config.getboolean("DEFAULT",
 
2238
                                                           option)
1151
2239
    if server_settings["port"]:
1152
2240
        server_settings["port"] = server_config.getint("DEFAULT",
1153
2241
                                                       "port")
 
2242
    if server_settings["socket"]:
 
2243
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2244
                                                         "socket")
 
2245
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2246
        # over with an opened os.devnull.  But we don't want this to
 
2247
        # happen with a supplied network socket.
 
2248
        if 0 <= server_settings["socket"] <= 2:
 
2249
            server_settings["socket"] = os.dup(server_settings
 
2250
                                               ["socket"])
1154
2251
    del server_config
1155
2252
    
1156
2253
    # Override the settings from the config file with command line
1157
2254
    # options, if set.
1158
2255
    for option in ("interface", "address", "port", "debug",
1159
2256
                   "priority", "servicename", "configdir",
1160
 
                   "use_dbus", "use_ipv6"):
 
2257
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2258
                   "statedir", "socket", "foreground"):
1161
2259
        value = getattr(options, option)
1162
2260
        if value is not None:
1163
2261
            server_settings[option] = value
1164
2262
    del options
 
2263
    # Force all strings to be unicode
 
2264
    for option in server_settings.keys():
 
2265
        if type(server_settings[option]) is str:
 
2266
            server_settings[option] = unicode(server_settings[option])
 
2267
    # Debug implies foreground
 
2268
    if server_settings["debug"]:
 
2269
        server_settings["foreground"] = True
1165
2270
    # Now we have our good server settings in "server_settings"
1166
2271
    
1167
2272
    ##################################################################
1168
2273
    
1169
2274
    # For convenience
1170
2275
    debug = server_settings["debug"]
 
2276
    debuglevel = server_settings["debuglevel"]
1171
2277
    use_dbus = server_settings["use_dbus"]
1172
2278
    use_ipv6 = server_settings["use_ipv6"]
 
2279
    stored_state_path = os.path.join(server_settings["statedir"],
 
2280
                                     stored_state_file)
 
2281
    foreground = server_settings["foreground"]
1173
2282
    
1174
 
    if not debug:
1175
 
        syslogger.setLevel(logging.WARNING)
1176
 
        console.setLevel(logging.WARNING)
 
2283
    if debug:
 
2284
        initlogger(debug, logging.DEBUG)
 
2285
    else:
 
2286
        if not debuglevel:
 
2287
            initlogger(debug)
 
2288
        else:
 
2289
            level = getattr(logging, debuglevel.upper())
 
2290
            initlogger(debug, level)
1177
2291
    
1178
2292
    if server_settings["servicename"] != "Mandos":
1179
2293
        syslogger.setFormatter(logging.Formatter
1180
 
                               ('Mandos (%s) [%%(process)d]:'
1181
 
                                ' %%(levelname)s: %%(message)s'
1182
 
                                % server_settings["servicename"]))
 
2294
                               ('Mandos ({0}) [%(process)d]:'
 
2295
                                ' %(levelname)s: %(message)s'
 
2296
                                .format(server_settings
 
2297
                                        ["servicename"])))
1183
2298
    
1184
2299
    # Parse config file with clients
1185
 
    client_defaults = { "timeout": "1h",
1186
 
                        "interval": "5m",
1187
 
                        "checker": "fping -q -- %%(host)s",
1188
 
                        "host": "",
1189
 
                        }
1190
 
    client_config = ConfigParser.SafeConfigParser(client_defaults)
 
2300
    client_config = configparser.SafeConfigParser(Client
 
2301
                                                  .client_defaults)
1191
2302
    client_config.read(os.path.join(server_settings["configdir"],
1192
2303
                                    "clients.conf"))
1193
 
 
 
2304
    
1194
2305
    global mandos_dbus_service
1195
2306
    mandos_dbus_service = None
1196
2307
    
1197
 
    clients = Set()
1198
 
    tcp_server = IPv6_TCPServer((server_settings["address"],
1199
 
                                 server_settings["port"]),
1200
 
                                TCP_handler,
1201
 
                                settings=server_settings,
1202
 
                                clients=clients, use_ipv6=use_ipv6)
1203
 
    pidfilename = "/var/run/mandos.pid"
1204
 
    try:
1205
 
        pidfile = open(pidfilename, "w")
1206
 
    except IOError:
1207
 
        logger.error("Could not open file %r", pidfilename)
 
2308
    tcp_server = MandosServer((server_settings["address"],
 
2309
                               server_settings["port"]),
 
2310
                              ClientHandler,
 
2311
                              interface=(server_settings["interface"]
 
2312
                                         or None),
 
2313
                              use_ipv6=use_ipv6,
 
2314
                              gnutls_priority=
 
2315
                              server_settings["priority"],
 
2316
                              use_dbus=use_dbus,
 
2317
                              socketfd=(server_settings["socket"]
 
2318
                                        or None))
 
2319
    if not foreground:
 
2320
        pidfilename = "/var/run/mandos.pid"
 
2321
        pidfile = None
 
2322
        try:
 
2323
            pidfile = open(pidfilename, "w")
 
2324
        except IOError as e:
 
2325
            logger.error("Could not open file %r", pidfilename,
 
2326
                         exc_info=e)
1208
2327
    
1209
 
    try:
1210
 
        uid = pwd.getpwnam("_mandos").pw_uid
1211
 
        gid = pwd.getpwnam("_mandos").pw_gid
1212
 
    except KeyError:
 
2328
    for name in ("_mandos", "mandos", "nobody"):
1213
2329
        try:
1214
 
            uid = pwd.getpwnam("mandos").pw_uid
1215
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2330
            uid = pwd.getpwnam(name).pw_uid
 
2331
            gid = pwd.getpwnam(name).pw_gid
 
2332
            break
1216
2333
        except KeyError:
1217
 
            try:
1218
 
                uid = pwd.getpwnam("nobody").pw_uid
1219
 
                gid = pwd.getpwnam("nogroup").pw_gid
1220
 
            except KeyError:
1221
 
                uid = 65534
1222
 
                gid = 65534
 
2334
            continue
 
2335
    else:
 
2336
        uid = 65534
 
2337
        gid = 65534
1223
2338
    try:
1224
2339
        os.setgid(gid)
1225
2340
        os.setuid(uid)
1226
 
    except OSError, error:
1227
 
        if error[0] != errno.EPERM:
 
2341
    except OSError as error:
 
2342
        if error.errno != errno.EPERM:
1228
2343
            raise error
1229
2344
    
1230
 
    # Enable all possible GnuTLS debugging
1231
2345
    if debug:
 
2346
        # Enable all possible GnuTLS debugging
 
2347
        
1232
2348
        # "Use a log level over 10 to enable all debugging options."
1233
2349
        # - GnuTLS manual
1234
2350
        gnutls.library.functions.gnutls_global_set_log_level(11)
1239
2355
        
1240
2356
        (gnutls.library.functions
1241
2357
         .gnutls_global_set_log_function(debug_gnutls))
1242
 
    
1243
 
    global service
1244
 
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1245
 
    service = AvahiService(name = server_settings["servicename"],
1246
 
                           servicetype = "_mandos._tcp",
1247
 
                           protocol = protocol)
1248
 
    if server_settings["interface"]:
1249
 
        service.interface = (if_nametoindex
1250
 
                             (server_settings["interface"]))
 
2358
        
 
2359
        # Redirect stdin so all checkers get /dev/null
 
2360
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
2361
        os.dup2(null, sys.stdin.fileno())
 
2362
        if null > 2:
 
2363
            os.close(null)
 
2364
    
 
2365
    # Need to fork before connecting to D-Bus
 
2366
    if not foreground:
 
2367
        # Close all input and output, do double fork, etc.
 
2368
        daemon()
 
2369
    
 
2370
    # multiprocessing will use threads, so before we use gobject we
 
2371
    # need to inform gobject that threads will be used.
 
2372
    gobject.threads_init()
1251
2373
    
1252
2374
    global main_loop
1253
 
    global bus
1254
 
    global server
1255
2375
    # From the Avahi example code
1256
 
    DBusGMainLoop(set_as_default=True )
 
2376
    DBusGMainLoop(set_as_default=True)
1257
2377
    main_loop = gobject.MainLoop()
1258
2378
    bus = dbus.SystemBus()
1259
 
    server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
1260
 
                                           avahi.DBUS_PATH_SERVER),
1261
 
                            avahi.DBUS_INTERFACE_SERVER)
1262
2379
    # End of Avahi example code
1263
2380
    if use_dbus:
1264
 
        bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
 
2381
        try:
 
2382
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
2383
                                            bus, do_not_queue=True)
 
2384
            old_bus_name = (dbus.service.BusName
 
2385
                            ("se.bsnet.fukt.Mandos", bus,
 
2386
                             do_not_queue=True))
 
2387
        except dbus.exceptions.NameExistsException as e:
 
2388
            logger.error("Disabling D-Bus:", exc_info=e)
 
2389
            use_dbus = False
 
2390
            server_settings["use_dbus"] = False
 
2391
            tcp_server.use_dbus = False
 
2392
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
 
2393
    service = AvahiServiceToSyslog(name =
 
2394
                                   server_settings["servicename"],
 
2395
                                   servicetype = "_mandos._tcp",
 
2396
                                   protocol = protocol, bus = bus)
 
2397
    if server_settings["interface"]:
 
2398
        service.interface = (if_nametoindex
 
2399
                             (str(server_settings["interface"])))
 
2400
    
 
2401
    global multiprocessing_manager
 
2402
    multiprocessing_manager = multiprocessing.Manager()
1265
2403
    
1266
2404
    client_class = Client
1267
2405
    if use_dbus:
1268
 
        client_class = ClientDBus
1269
 
    clients.update(Set(
1270
 
            client_class(name = section,
1271
 
                         config= dict(client_config.items(section)))
1272
 
            for section in client_config.sections()))
1273
 
    if not clients:
1274
 
        logger.warning(u"No clients defined")
1275
 
    
1276
 
    if debug:
1277
 
        # Redirect stdin so all checkers get /dev/null
1278
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1279
 
        os.dup2(null, sys.stdin.fileno())
1280
 
        if null > 2:
1281
 
            os.close(null)
1282
 
    else:
1283
 
        # No console logging
1284
 
        logger.removeHandler(console)
1285
 
        # Close all input and output, do double fork, etc.
1286
 
        daemon()
1287
 
    
1288
 
    try:
1289
 
        with closing(pidfile):
1290
 
            pid = os.getpid()
1291
 
            pidfile.write(str(pid) + "\n")
 
2406
        client_class = functools.partial(ClientDBus, bus = bus)
 
2407
    
 
2408
    client_settings = Client.config_parser(client_config)
 
2409
    old_client_settings = {}
 
2410
    clients_data = {}
 
2411
    
 
2412
    # Get client data and settings from last running state.
 
2413
    if server_settings["restore"]:
 
2414
        try:
 
2415
            with open(stored_state_path, "rb") as stored_state:
 
2416
                clients_data, old_client_settings = (pickle.load
 
2417
                                                     (stored_state))
 
2418
            os.remove(stored_state_path)
 
2419
        except IOError as e:
 
2420
            if e.errno == errno.ENOENT:
 
2421
                logger.warning("Could not load persistent state: {0}"
 
2422
                                .format(os.strerror(e.errno)))
 
2423
            else:
 
2424
                logger.critical("Could not load persistent state:",
 
2425
                                exc_info=e)
 
2426
                raise
 
2427
        except EOFError as e:
 
2428
            logger.warning("Could not load persistent state: "
 
2429
                           "EOFError:", exc_info=e)
 
2430
    
 
2431
    with PGPEngine() as pgp:
 
2432
        for client_name, client in clients_data.iteritems():
 
2433
            # Decide which value to use after restoring saved state.
 
2434
            # We have three different values: Old config file,
 
2435
            # new config file, and saved state.
 
2436
            # New config value takes precedence if it differs from old
 
2437
            # config value, otherwise use saved state.
 
2438
            for name, value in client_settings[client_name].items():
 
2439
                try:
 
2440
                    # For each value in new config, check if it
 
2441
                    # differs from the old config value (Except for
 
2442
                    # the "secret" attribute)
 
2443
                    if (name != "secret" and
 
2444
                        value != old_client_settings[client_name]
 
2445
                        [name]):
 
2446
                        client[name] = value
 
2447
                except KeyError:
 
2448
                    pass
 
2449
            
 
2450
            # Clients who has passed its expire date can still be
 
2451
            # enabled if its last checker was successful.  Clients
 
2452
            # whose checker succeeded before we stored its state is
 
2453
            # assumed to have successfully run all checkers during
 
2454
            # downtime.
 
2455
            if client["enabled"]:
 
2456
                if datetime.datetime.utcnow() >= client["expires"]:
 
2457
                    if not client["last_checked_ok"]:
 
2458
                        logger.warning(
 
2459
                            "disabling client {0} - Client never "
 
2460
                            "performed a successful checker"
 
2461
                            .format(client_name))
 
2462
                        client["enabled"] = False
 
2463
                    elif client["last_checker_status"] != 0:
 
2464
                        logger.warning(
 
2465
                            "disabling client {0} - Client "
 
2466
                            "last checker failed with error code {1}"
 
2467
                            .format(client_name,
 
2468
                                    client["last_checker_status"]))
 
2469
                        client["enabled"] = False
 
2470
                    else:
 
2471
                        client["expires"] = (datetime.datetime
 
2472
                                             .utcnow()
 
2473
                                             + client["timeout"])
 
2474
                        logger.debug("Last checker succeeded,"
 
2475
                                     " keeping {0} enabled"
 
2476
                                     .format(client_name))
 
2477
            try:
 
2478
                client["secret"] = (
 
2479
                    pgp.decrypt(client["encrypted_secret"],
 
2480
                                client_settings[client_name]
 
2481
                                ["secret"]))
 
2482
            except PGPError:
 
2483
                # If decryption fails, we use secret from new settings
 
2484
                logger.debug("Failed to decrypt {0} old secret"
 
2485
                             .format(client_name))
 
2486
                client["secret"] = (
 
2487
                    client_settings[client_name]["secret"])
 
2488
    
 
2489
    # Add/remove clients based on new changes made to config
 
2490
    for client_name in (set(old_client_settings)
 
2491
                        - set(client_settings)):
 
2492
        del clients_data[client_name]
 
2493
    for client_name in (set(client_settings)
 
2494
                        - set(old_client_settings)):
 
2495
        clients_data[client_name] = client_settings[client_name]
 
2496
    
 
2497
    # Create all client objects
 
2498
    for client_name, client in clients_data.iteritems():
 
2499
        tcp_server.clients[client_name] = client_class(
 
2500
            name = client_name, settings = client)
 
2501
    
 
2502
    if not tcp_server.clients:
 
2503
        logger.warning("No clients defined")
 
2504
    
 
2505
    if not foreground:
 
2506
        if pidfile is not None:
 
2507
            try:
 
2508
                with pidfile:
 
2509
                    pid = os.getpid()
 
2510
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2511
            except IOError:
 
2512
                logger.error("Could not write to file %r with PID %d",
 
2513
                             pidfilename, pid)
1292
2514
        del pidfile
1293
 
    except IOError:
1294
 
        logger.error(u"Could not write to file %r with PID %d",
1295
 
                     pidfilename, pid)
1296
 
    except NameError:
1297
 
        # "pidfile" was never created
1298
 
        pass
1299
 
    del pidfilename
1300
 
    
1301
 
    def cleanup():
1302
 
        "Cleanup function; run on exit"
1303
 
        global group
1304
 
        # From the Avahi example code
1305
 
        if not group is None:
1306
 
            group.Free()
1307
 
            group = None
1308
 
        # End of Avahi example code
1309
 
        
1310
 
        while clients:
1311
 
            client = clients.pop()
1312
 
            client.disable_hook = None
1313
 
            client.disable()
1314
 
    
1315
 
    atexit.register(cleanup)
1316
 
    
1317
 
    if not debug:
1318
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
 
2515
        del pidfilename
 
2516
    
1319
2517
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1320
2518
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1321
2519
    
1322
2520
    if use_dbus:
1323
 
        class MandosDBusService(dbus.service.Object):
 
2521
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2522
                                        "se.bsnet.fukt.Mandos"})
 
2523
        class MandosDBusService(DBusObjectWithProperties):
1324
2524
            """A D-Bus proxy object"""
1325
2525
            def __init__(self):
1326
2526
                dbus.service.Object.__init__(self, bus, "/")
1327
 
            _interface = u"se.bsnet.fukt.Mandos"
1328
 
            
1329
 
            @dbus.service.signal(_interface, signature="oa{sv}")
1330
 
            def ClientAdded(self, objpath, properties):
 
2527
            _interface = "se.recompile.Mandos"
 
2528
            
 
2529
            @dbus_interface_annotations(_interface)
 
2530
            def _foo(self):
 
2531
                return { "org.freedesktop.DBus.Property"
 
2532
                         ".EmitsChangedSignal":
 
2533
                             "false"}
 
2534
            
 
2535
            @dbus.service.signal(_interface, signature="o")
 
2536
            def ClientAdded(self, objpath):
1331
2537
                "D-Bus signal"
1332
2538
                pass
1333
2539
            
1334
 
            @dbus.service.signal(_interface, signature="s")
1335
 
            def ClientNotFound(self, fingerprint):
 
2540
            @dbus.service.signal(_interface, signature="ss")
 
2541
            def ClientNotFound(self, fingerprint, address):
1336
2542
                "D-Bus signal"
1337
2543
                pass
1338
2544
            
1344
2550
            @dbus.service.method(_interface, out_signature="ao")
1345
2551
            def GetAllClients(self):
1346
2552
                "D-Bus method"
1347
 
                return dbus.Array(c.dbus_object_path for c in clients)
 
2553
                return dbus.Array(c.dbus_object_path
 
2554
                                  for c in
 
2555
                                  tcp_server.clients.itervalues())
1348
2556
            
1349
 
            @dbus.service.method(_interface, out_signature="a{oa{sv}}")
 
2557
            @dbus.service.method(_interface,
 
2558
                                 out_signature="a{oa{sv}}")
1350
2559
            def GetAllClientsWithProperties(self):
1351
2560
                "D-Bus method"
1352
2561
                return dbus.Dictionary(
1353
 
                    ((c.dbus_object_path, c.GetAllProperties())
1354
 
                     for c in clients),
 
2562
                    ((c.dbus_object_path, c.GetAll(""))
 
2563
                     for c in tcp_server.clients.itervalues()),
1355
2564
                    signature="oa{sv}")
1356
2565
            
1357
2566
            @dbus.service.method(_interface, in_signature="o")
1358
2567
            def RemoveClient(self, object_path):
1359
2568
                "D-Bus method"
1360
 
                for c in clients:
 
2569
                for c in tcp_server.clients.itervalues():
1361
2570
                    if c.dbus_object_path == object_path:
1362
 
                        clients.remove(c)
 
2571
                        del tcp_server.clients[c.name]
1363
2572
                        c.remove_from_connection()
1364
2573
                        # Don't signal anything except ClientRemoved
1365
 
                        c.disable(signal=False)
 
2574
                        c.disable(quiet=True)
1366
2575
                        # Emit D-Bus signal
1367
2576
                        self.ClientRemoved(object_path, c.name)
1368
2577
                        return
1369
 
                raise KeyError
 
2578
                raise KeyError(object_path)
1370
2579
            
1371
2580
            del _interface
1372
2581
        
1373
2582
        mandos_dbus_service = MandosDBusService()
1374
2583
    
1375
 
    for client in clients:
 
2584
    def cleanup():
 
2585
        "Cleanup function; run on exit"
 
2586
        service.cleanup()
 
2587
        
 
2588
        multiprocessing.active_children()
 
2589
        if not (tcp_server.clients or client_settings):
 
2590
            return
 
2591
        
 
2592
        # Store client before exiting. Secrets are encrypted with key
 
2593
        # based on what config file has. If config file is
 
2594
        # removed/edited, old secret will thus be unrecovable.
 
2595
        clients = {}
 
2596
        with PGPEngine() as pgp:
 
2597
            for client in tcp_server.clients.itervalues():
 
2598
                key = client_settings[client.name]["secret"]
 
2599
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2600
                                                      key)
 
2601
                client_dict = {}
 
2602
                
 
2603
                # A list of attributes that can not be pickled
 
2604
                # + secret.
 
2605
                exclude = set(("bus", "changedstate", "secret",
 
2606
                               "checker"))
 
2607
                for name, typ in (inspect.getmembers
 
2608
                                  (dbus.service.Object)):
 
2609
                    exclude.add(name)
 
2610
                
 
2611
                client_dict["encrypted_secret"] = (client
 
2612
                                                   .encrypted_secret)
 
2613
                for attr in client.client_structure:
 
2614
                    if attr not in exclude:
 
2615
                        client_dict[attr] = getattr(client, attr)
 
2616
                
 
2617
                clients[client.name] = client_dict
 
2618
                del client_settings[client.name]["secret"]
 
2619
        
 
2620
        try:
 
2621
            with (tempfile.NamedTemporaryFile
 
2622
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2623
                   dir=os.path.dirname(stored_state_path),
 
2624
                   delete=False)) as stored_state:
 
2625
                pickle.dump((clients, client_settings), stored_state)
 
2626
                tempname=stored_state.name
 
2627
            os.rename(tempname, stored_state_path)
 
2628
        except (IOError, OSError) as e:
 
2629
            if not debug:
 
2630
                try:
 
2631
                    os.remove(tempname)
 
2632
                except NameError:
 
2633
                    pass
 
2634
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2635
                logger.warning("Could not save persistent state: {0}"
 
2636
                               .format(os.strerror(e.errno)))
 
2637
            else:
 
2638
                logger.warning("Could not save persistent state:",
 
2639
                               exc_info=e)
 
2640
                raise e
 
2641
        
 
2642
        # Delete all clients, and settings from config
 
2643
        while tcp_server.clients:
 
2644
            name, client = tcp_server.clients.popitem()
 
2645
            if use_dbus:
 
2646
                client.remove_from_connection()
 
2647
            # Don't signal anything except ClientRemoved
 
2648
            client.disable(quiet=True)
 
2649
            if use_dbus:
 
2650
                # Emit D-Bus signal
 
2651
                mandos_dbus_service.ClientRemoved(client
 
2652
                                                  .dbus_object_path,
 
2653
                                                  client.name)
 
2654
        client_settings.clear()
 
2655
    
 
2656
    atexit.register(cleanup)
 
2657
    
 
2658
    for client in tcp_server.clients.itervalues():
1376
2659
        if use_dbus:
1377
2660
            # Emit D-Bus signal
1378
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path,
1379
 
                                            client.GetAllProperties())
1380
 
        client.enable()
 
2661
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
 
2662
        # Need to initiate checking of clients
 
2663
        if client.enabled:
 
2664
            client.init_checker()
1381
2665
    
1382
2666
    tcp_server.enable()
1383
2667
    tcp_server.server_activate()
1385
2669
    # Find out what port we got
1386
2670
    service.port = tcp_server.socket.getsockname()[1]
1387
2671
    if use_ipv6:
1388
 
        logger.info(u"Now listening on address %r, port %d,"
1389
 
                    " flowinfo %d, scope_id %d"
1390
 
                    % tcp_server.socket.getsockname())
 
2672
        logger.info("Now listening on address %r, port %d,"
 
2673
                    " flowinfo %d, scope_id %d",
 
2674
                    *tcp_server.socket.getsockname())
1391
2675
    else:                       # IPv4
1392
 
        logger.info(u"Now listening on address %r, port %d"
1393
 
                    % tcp_server.socket.getsockname())
 
2676
        logger.info("Now listening on address %r, port %d",
 
2677
                    *tcp_server.socket.getsockname())
1394
2678
    
1395
2679
    #service.interface = tcp_server.socket.getsockname()[3]
1396
2680
    
1397
2681
    try:
1398
2682
        # From the Avahi example code
1399
 
        server.connect_to_signal("StateChanged", server_state_changed)
1400
2683
        try:
1401
 
            server_state_changed(server.GetState())
1402
 
        except dbus.exceptions.DBusException, error:
1403
 
            logger.critical(u"DBusException: %s", error)
 
2684
            service.activate()
 
2685
        except dbus.exceptions.DBusException as error:
 
2686
            logger.critical("D-Bus Exception", exc_info=error)
 
2687
            cleanup()
1404
2688
            sys.exit(1)
1405
2689
        # End of Avahi example code
1406
2690
        
1409
2693
                             (tcp_server.handle_request
1410
2694
                              (*args[2:], **kwargs) or True))
1411
2695
        
1412
 
        logger.debug(u"Starting main loop")
 
2696
        logger.debug("Starting main loop")
1413
2697
        main_loop.run()
1414
 
    except AvahiError, error:
1415
 
        logger.critical(u"AvahiError: %s", error)
 
2698
    except AvahiError as error:
 
2699
        logger.critical("Avahi Error", exc_info=error)
 
2700
        cleanup()
1416
2701
        sys.exit(1)
1417
2702
    except KeyboardInterrupt:
1418
2703
        if debug:
1419
 
            print >> sys.stderr
 
2704
            print("", file=sys.stderr)
1420
2705
        logger.debug("Server received KeyboardInterrupt")
1421
2706
    logger.debug("Server exiting")
 
2707
    # Must run before the D-Bus bus name gets deregistered
 
2708
    cleanup()
1422
2709
 
1423
2710
if __name__ == '__main__':
1424
2711
    main()