/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: 2015-08-02 16:45:29 UTC
  • mto: (237.7.594 trunk)
  • mto: This revision was merged to the branch mainline in revision 325.
  • Revision ID: teddy@recompile.se-20150802164529-pemtk1agiqluoiua
Deprecate some D-Bus methods in favor of D-Bus properties.

The following D-Bus methods on the interface
"se.recompile.Mandos.Client" are redundant, and are therefore
deprecated:  "Disable", "Enable", "StartChecker", and "StopChecker".
Instead, the D-Bus properties "Enabled" and "CheckerRunning" should be
set, as was always also possible.

* DBUS-API (se.recompile.Mandos.Client.Disable): Remove; deprecated.
  (se.recompile.Mandos.Client.Enable): - '' -
  (se.recompile.Mandos.Client.StartChecker): - '' -
  (se.recompile.Mandos.Client.StopChecker): - '' -
* mandos (ClientDBus.Enable): Annotate as deprecated.
  (ClientDBus.StartChecker): - '' -
  (ClientDBus.Disable): - '' -
  (ClientDBus.StopChecker): - '' -
* mandos-monitor (MandosClientWidget.keypress): Set properties instead
                                                of calling deprecated
                                                methods.

Show diffs side-by-side

added added

removed removed

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