/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2012-06-09 23:41:07 UTC
  • mto: This revision was merged to the branch mainline in revision 596.
  • Revision ID: teddy@recompile.se-20120609234107-vm6zilzz0y6aihsm
* plugins.d/mandos-client.c (raise_privileges,
  raise_privileges_permanently, lower_privileges): Return error_t and
                                                   save old errno
                                                   before calling any
                                                   other function.

Show diffs side-by-side

added added

removed removed

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