/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-05-24 18:10:10 UTC
  • Revision ID: teddy@recompile.se-20120524181010-cg4zcc6e5igbanbc
* Makefile (DOCBOOKTOMAN): Only run man --warnings if both "man" and
                           the en_US.utf8 locale exists.
* debian/control (Build-Depends): Removed "man, locales-all".
  (Standards-Version): Updated to "3.9.3".
* debian/copyright (Format): Updated to
  "http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/".
* mandos (PGPEngine.__exit__, datetime_to_dbus): White space fixes.
  (alternate_dbus_interfaces): Doc string fix.

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2011 Teddy Hogeborn
15
 
# Copyright © 2008-2011 Björn Påhlsson
 
14
# Copyright © 2008-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
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
 
37
from future_builtins import *
 
38
 
37
39
import SocketServer as socketserver
38
40
import socket
39
41
import argparse
62
64
import functools
63
65
import cPickle as pickle
64
66
import multiprocessing
 
67
import types
 
68
import binascii
 
69
import tempfile
 
70
import itertools
65
71
 
66
72
import dbus
67
73
import dbus.service
72
78
import ctypes.util
73
79
import xml.dom.minidom
74
80
import inspect
 
81
import GnuPGInterface
75
82
 
76
83
try:
77
84
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
81
88
    except ImportError:
82
89
        SO_BINDTODEVICE = None
83
90
 
84
 
 
85
 
version = "1.3.0"
86
 
 
87
 
#logger = logging.getLogger('mandos')
88
 
logger = logging.Logger('mandos')
 
91
version = "1.5.4"
 
92
stored_state_file = "clients.pickle"
 
93
 
 
94
logger = logging.getLogger()
89
95
syslogger = (logging.handlers.SysLogHandler
90
96
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
91
97
              address = str("/dev/log")))
92
 
syslogger.setFormatter(logging.Formatter
93
 
                       ('Mandos [%(process)d]: %(levelname)s:'
94
 
                        ' %(message)s'))
95
 
logger.addHandler(syslogger)
96
 
 
97
 
console = logging.StreamHandler()
98
 
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
99
 
                                       ' %(levelname)s:'
100
 
                                       ' %(message)s'))
101
 
logger.addHandler(console)
 
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
 
102
213
 
103
214
class AvahiError(Exception):
104
215
    def __init__(self, value, *args, **kwargs):
134
245
    server: D-Bus Server
135
246
    bus: dbus.SystemBus()
136
247
    """
 
248
    
137
249
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
138
250
                 servicetype = None, port = None, TXT = None,
139
251
                 domain = "", host = "", max_renames = 32768,
152
264
        self.server = None
153
265
        self.bus = bus
154
266
        self.entry_group_state_changed_match = None
 
267
    
155
268
    def rename(self):
156
269
        """Derived from the Avahi example code"""
157
270
        if self.rename_count >= self.max_renames:
159
272
                            " after %i retries, exiting.",
160
273
                            self.rename_count)
161
274
            raise AvahiServiceError("Too many renames")
162
 
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
 
275
        self.name = unicode(self.server
 
276
                            .GetAlternativeServiceName(self.name))
163
277
        logger.info("Changing Zeroconf service name to %r ...",
164
278
                    self.name)
165
 
        syslogger.setFormatter(logging.Formatter
166
 
                               ('Mandos (%s) [%%(process)d]:'
167
 
                                ' %%(levelname)s: %%(message)s'
168
 
                                % self.name))
169
279
        self.remove()
170
280
        try:
171
281
            self.add()
172
282
        except dbus.exceptions.DBusException as error:
173
 
            logger.critical("DBusException: %s", error)
 
283
            logger.critical("D-Bus Exception", exc_info=error)
174
284
            self.cleanup()
175
285
            os._exit(1)
176
286
        self.rename_count += 1
 
287
    
177
288
    def remove(self):
178
289
        """Derived from the Avahi example code"""
179
290
        if self.entry_group_state_changed_match is not None:
181
292
            self.entry_group_state_changed_match = None
182
293
        if self.group is not None:
183
294
            self.group.Reset()
 
295
    
184
296
    def add(self):
185
297
        """Derived from the Avahi example code"""
186
298
        self.remove()
191
303
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
192
304
        self.entry_group_state_changed_match = (
193
305
            self.group.connect_to_signal(
194
 
                'StateChanged', self .entry_group_state_changed))
 
306
                'StateChanged', self.entry_group_state_changed))
195
307
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
196
308
                     self.name, self.type)
197
309
        self.group.AddService(
203
315
            dbus.UInt16(self.port),
204
316
            avahi.string_array_to_txt_array(self.TXT))
205
317
        self.group.Commit()
 
318
    
206
319
    def entry_group_state_changed(self, state, error):
207
320
        """Derived from the Avahi example code"""
208
321
        logger.debug("Avahi entry group state change: %i", state)
215
328
        elif state == avahi.ENTRY_GROUP_FAILURE:
216
329
            logger.critical("Avahi: Error in group state changed %s",
217
330
                            unicode(error))
218
 
            raise AvahiGroupError("State changed: %s"
219
 
                                  % unicode(error))
 
331
            raise AvahiGroupError("State changed: {0!s}"
 
332
                                  .format(error))
 
333
    
220
334
    def cleanup(self):
221
335
        """Derived from the Avahi example code"""
222
336
        if self.group is not None:
223
337
            try:
224
338
                self.group.Free()
225
339
            except (dbus.exceptions.UnknownMethodException,
226
 
                    dbus.exceptions.DBusException) as e:
 
340
                    dbus.exceptions.DBusException):
227
341
                pass
228
342
            self.group = None
229
343
        self.remove()
 
344
    
230
345
    def server_state_changed(self, state, error=None):
231
346
        """Derived from the Avahi example code"""
232
347
        logger.debug("Avahi server state change: %i", state)
251
366
                logger.debug("Unknown state: %r", state)
252
367
            else:
253
368
                logger.debug("Unknown state: %r: %r", state, error)
 
369
    
254
370
    def activate(self):
255
371
        """Derived from the Avahi example code"""
256
372
        if self.server is None:
264
380
        self.server_state_changed(self.server.GetState())
265
381
 
266
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
 
267
401
class Client(object):
268
402
    """A representation of a client host served by this server.
269
403
    
270
404
    Attributes:
271
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
405
    approved:   bool(); 'None' if not yet approved/disapproved
272
406
    approval_delay: datetime.timedelta(); Time to wait for approval
273
407
    approval_duration: datetime.timedelta(); Duration of one approval
274
408
    checker:    subprocess.Popen(); a running checker process used
281
415
                     instance %(name)s can be used in the command.
282
416
    checker_initiator_tag: a gobject event source tag, or None
283
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
284
420
    current_checker_command: string; current running checker_command
285
 
    disable_hook:  If set, called by disable() as disable_hook(self)
286
421
    disable_initiator_tag: a gobject event source tag, or None
287
422
    enabled:    bool()
288
423
    fingerprint: string (40 or 32 hexadecimal digits); used to
291
426
    interval:   datetime.timedelta(); How often to start a new checker
292
427
    last_approval_request: datetime.datetime(); (UTC) or None
293
428
    last_checked_ok: datetime.datetime(); (UTC) or None
294
 
    last_enabled: datetime.datetime(); (UTC)
 
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
295
433
    name:       string; from the config file, used in log messages and
296
434
                        D-Bus identifiers
297
435
    secret:     bytestring; sent verbatim (over TLS) to client
298
436
    timeout:    datetime.timedelta(); How long from last_checked_ok
299
437
                                      until this client is disabled
 
438
    extended_timeout:   extra long timeout when secret has been sent
300
439
    runtime_expansions: Allowed attributes for runtime expansion.
 
440
    expires:    datetime.datetime(); time (UTC) when a client will be
 
441
                disabled, or None
301
442
    """
302
443
    
303
444
    runtime_expansions = ("approval_delay", "approval_duration",
304
 
                          "created", "enabled", "fingerprint",
305
 
                          "host", "interval", "last_checked_ok",
 
445
                          "created", "enabled", "expires",
 
446
                          "fingerprint", "host", "interval",
 
447
                          "last_approval_request", "last_checked_ok",
306
448
                          "last_enabled", "name", "timeout")
307
 
    
308
 
    @staticmethod
309
 
    def _timedelta_to_milliseconds(td):
310
 
        "Convert a datetime.timedelta() to milliseconds"
311
 
        return ((td.days * 24 * 60 * 60 * 1000)
312
 
                + (td.seconds * 1000)
313
 
                + (td.microseconds // 1000))
 
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
                        }
314
459
    
315
460
    def timeout_milliseconds(self):
316
461
        "Return the 'timeout' attribute in milliseconds"
317
 
        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)
318
467
    
319
468
    def interval_milliseconds(self):
320
469
        "Return the 'interval' attribute in milliseconds"
321
 
        return self._timedelta_to_milliseconds(self.interval)
322
 
 
 
470
        return timedelta_to_milliseconds(self.interval)
 
471
    
323
472
    def approval_delay_milliseconds(self):
324
 
        return self._timedelta_to_milliseconds(self.approval_delay)
325
 
    
326
 
    def __init__(self, name = None, disable_hook=None, config=None):
327
 
        """Note: the 'checker' key in 'config' sets the
328
 
        'checker_command' attribute and *not* the 'checker'
329
 
        attribute."""
 
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):
330
523
        self.name = name
331
 
        if config is None:
332
 
            config = {}
 
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
        
333
538
        logger.debug("Creating client %r", self.name)
334
539
        # Uppercase and remove spaces from fingerprint for later
335
540
        # comparison purposes with return value from the fingerprint()
336
541
        # function
337
 
        self.fingerprint = (config["fingerprint"].upper()
338
 
                            .replace(" ", ""))
339
542
        logger.debug("  Fingerprint: %s", self.fingerprint)
340
 
        if "secret" in config:
341
 
            self.secret = config["secret"].decode("base64")
342
 
        elif "secfile" in config:
343
 
            with open(os.path.expanduser(os.path.expandvars
344
 
                                         (config["secfile"])),
345
 
                      "rb") as secfile:
346
 
                self.secret = secfile.read()
347
 
        else:
348
 
            raise TypeError("No secret or secfile for client %s"
349
 
                            % self.name)
350
 
        self.host = config.get("host", "")
351
 
        self.created = datetime.datetime.utcnow()
352
 
        self.enabled = False
353
 
        self.last_approval_request = None
354
 
        self.last_enabled = None
355
 
        self.last_checked_ok = None
356
 
        self.timeout = string_to_delta(config["timeout"])
357
 
        self.interval = string_to_delta(config["interval"])
358
 
        self.disable_hook = disable_hook
 
543
        self.created = settings.get("created",
 
544
                                    datetime.datetime.utcnow())
 
545
        
 
546
        # attributes specific for this server instance
359
547
        self.checker = None
360
548
        self.checker_initiator_tag = None
361
549
        self.disable_initiator_tag = None
362
550
        self.checker_callback_tag = None
363
 
        self.checker_command = config["checker"]
364
551
        self.current_checker_command = None
365
 
        self.last_connect = None
366
 
        self._approved = None
367
 
        self.approved_by_default = config.get("approved_by_default",
368
 
                                              True)
 
552
        self.approved = None
369
553
        self.approvals_pending = 0
370
 
        self.approval_delay = string_to_delta(
371
 
            config["approval_delay"])
372
 
        self.approval_duration = string_to_delta(
373
 
            config["approval_duration"])
374
 
        self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
 
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)
375
568
    
 
569
    # Send notice to process children that client state has changed
376
570
    def send_changedstate(self):
377
 
        self.changedstate.acquire()
378
 
        self.changedstate.notify_all()
379
 
        self.changedstate.release()
380
 
        
 
571
        with self.changedstate:
 
572
            self.changedstate.notify_all()
 
573
    
381
574
    def enable(self):
382
575
        """Start this client's checker and timeout hooks"""
383
576
        if getattr(self, "enabled", False):
384
577
            # Already enabled
385
578
            return
386
 
        self.send_changedstate()
 
579
        self.expires = datetime.datetime.utcnow() + self.timeout
 
580
        self.enabled = True
387
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):
388
609
        # Schedule a new checker to be started an 'interval' from now,
389
610
        # and every interval from then on.
 
611
        if self.checker_initiator_tag is not None:
 
612
            gobject.source_remove(self.checker_initiator_tag)
390
613
        self.checker_initiator_tag = (gobject.timeout_add
391
614
                                      (self.interval_milliseconds(),
392
615
                                       self.start_checker))
393
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)
394
619
        self.disable_initiator_tag = (gobject.timeout_add
395
620
                                   (self.timeout_milliseconds(),
396
621
                                    self.disable))
397
 
        self.enabled = True
398
622
        # Also start a new checker *right now*.
399
623
        self.start_checker()
400
624
    
401
 
    def disable(self, quiet=True):
402
 
        """Disable this client."""
403
 
        if not getattr(self, "enabled", False):
404
 
            return False
405
 
        if not quiet:
406
 
            self.send_changedstate()
407
 
        if not quiet:
408
 
            logger.info("Disabling client %s", self.name)
409
 
        if getattr(self, "disable_initiator_tag", False):
410
 
            gobject.source_remove(self.disable_initiator_tag)
411
 
            self.disable_initiator_tag = None
412
 
        if getattr(self, "checker_initiator_tag", False):
413
 
            gobject.source_remove(self.checker_initiator_tag)
414
 
            self.checker_initiator_tag = None
415
 
        self.stop_checker()
416
 
        if self.disable_hook:
417
 
            self.disable_hook(self)
418
 
        self.enabled = False
419
 
        # Do not run this again if called by a gobject.timeout_add
420
 
        return False
421
 
    
422
 
    def __del__(self):
423
 
        self.disable_hook = None
424
 
        self.disable()
425
 
    
426
625
    def checker_callback(self, pid, condition, command):
427
626
        """The checker has completed, so take appropriate actions."""
428
627
        self.checker_callback_tag = None
429
628
        self.checker = None
430
629
        if os.WIFEXITED(condition):
431
 
            exitstatus = os.WEXITSTATUS(condition)
432
 
            if exitstatus == 0:
 
630
            self.last_checker_status = os.WEXITSTATUS(condition)
 
631
            if self.last_checker_status == 0:
433
632
                logger.info("Checker for %(name)s succeeded",
434
633
                            vars(self))
435
634
                self.checked_ok()
437
636
                logger.info("Checker for %(name)s failed",
438
637
                            vars(self))
439
638
        else:
 
639
            self.last_checker_status = -1
440
640
            logger.warning("Checker for %(name)s crashed?",
441
641
                           vars(self))
442
642
    
443
643
    def checked_ok(self):
444
 
        """Bump up the timeout for this client.
445
 
        
446
 
        This should only be called when the client has been seen,
447
 
        alive and well.
448
 
        """
 
644
        """Assert that the client has been seen, alive and well."""
449
645
        self.last_checked_ok = datetime.datetime.utcnow()
450
 
        gobject.source_remove(self.disable_initiator_tag)
451
 
        self.disable_initiator_tag = (gobject.timeout_add
452
 
                                      (self.timeout_milliseconds(),
453
 
                                       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
454
661
    
455
662
    def need_approval(self):
456
663
        self.last_approval_request = datetime.datetime.utcnow()
461
668
        If a checker already exists, leave it running and do
462
669
        nothing."""
463
670
        # The reason for not killing a running checker is that if we
464
 
        # did that, then if a checker (for some reason) started
465
 
        # running slowly and taking more than 'interval' time, the
466
 
        # client would inevitably timeout, since no checker would get
467
 
        # 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
468
675
        # checkers alone, the checker would have to take more time
469
676
        # than 'timeout' for the client to be disabled, which is as it
470
677
        # should be.
484
691
                                      self.current_checker_command)
485
692
        # Start a new checker if needed
486
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)
487
699
            try:
488
 
                # In case checker_command has exactly one % operator
489
 
                command = self.checker_command % self.host
490
 
            except TypeError:
491
 
                # Escape attributes for the shell
492
 
                escaped_attrs = dict(
493
 
                    (attr,
494
 
                     re.escape(unicode(str(getattr(self, attr, "")),
495
 
                                       errors=
496
 
                                       'replace')))
497
 
                    for attr in
498
 
                    self.runtime_expansions)
499
 
 
500
 
                try:
501
 
                    command = self.checker_command % escaped_attrs
502
 
                except TypeError as error:
503
 
                    logger.error('Could not format string "%s":'
504
 
                                 ' %s', self.checker_command, error)
505
 
                    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
506
705
            self.current_checker_command = command
507
706
            try:
508
707
                logger.info("Starting checker %r for %s",
514
713
                self.checker = subprocess.Popen(command,
515
714
                                                close_fds=True,
516
715
                                                shell=True, cwd="/")
517
 
                self.checker_callback_tag = (gobject.child_watch_add
518
 
                                             (self.checker.pid,
519
 
                                              self.checker_callback,
520
 
                                              data=command))
521
 
                # The checker may have completed before the gobject
522
 
                # watch was added.  Check for this.
523
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
524
 
                if pid:
525
 
                    gobject.source_remove(self.checker_callback_tag)
526
 
                    self.checker_callback(pid, status, command)
527
716
            except OSError as error:
528
 
                logger.error("Failed to start subprocess: %s",
529
 
                             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)
530
729
        # Re-run this periodically if run by gobject.timeout_add
531
730
        return True
532
731
    
539
738
            return
540
739
        logger.debug("Stopping checker for %(name)s", vars(self))
541
740
        try:
542
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
741
            self.checker.terminate()
543
742
            #time.sleep(0.5)
544
743
            #if self.checker.poll() is None:
545
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
744
            #    self.checker.kill()
546
745
        except OSError as error:
547
746
            if error.errno != errno.ESRCH: # No such process
548
747
                raise
549
748
        self.checker = None
550
749
 
 
750
 
551
751
def dbus_service_property(dbus_interface, signature="v",
552
752
                          access="readwrite", byte_arrays=False):
553
753
    """Decorators for marking methods of a DBusObjectWithProperties to
564
764
    # "Set" method, so we fail early here:
565
765
    if byte_arrays and signature != "ay":
566
766
        raise ValueError("Byte arrays not supported for non-'ay'"
567
 
                         " signature %r" % signature)
 
767
                         " signature {0!r}".format(signature))
568
768
    def decorator(func):
569
769
        func._dbus_is_property = True
570
770
        func._dbus_interface = dbus_interface
578
778
    return decorator
579
779
 
580
780
 
 
781
def dbus_interface_annotations(dbus_interface):
 
782
    """Decorator for marking functions returning interface annotations
 
783
    
 
784
    Usage:
 
785
    
 
786
    @dbus_interface_annotations("org.example.Interface")
 
787
    def _foo(self):  # Function name does not matter
 
788
        return {"org.freedesktop.DBus.Deprecated": "true",
 
789
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
790
                    "false"}
 
791
    """
 
792
    def decorator(func):
 
793
        func._dbus_is_interface = True
 
794
        func._dbus_interface = dbus_interface
 
795
        func._dbus_name = dbus_interface
 
796
        return func
 
797
    return decorator
 
798
 
 
799
 
 
800
def dbus_annotations(annotations):
 
801
    """Decorator to annotate D-Bus methods, signals or properties
 
802
    Usage:
 
803
    
 
804
    @dbus_service_property("org.example.Interface", signature="b",
 
805
                           access="r")
 
806
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
 
807
                        "org.freedesktop.DBus.Property."
 
808
                        "EmitsChangedSignal": "false"})
 
809
    def Property_dbus_property(self):
 
810
        return dbus.Boolean(False)
 
811
    """
 
812
    def decorator(func):
 
813
        func._dbus_annotations = annotations
 
814
        return func
 
815
    return decorator
 
816
 
 
817
 
581
818
class DBusPropertyException(dbus.exceptions.DBusException):
582
819
    """A base class for D-Bus property-related exceptions
583
820
    """
599
836
 
600
837
class DBusObjectWithProperties(dbus.service.Object):
601
838
    """A D-Bus object with properties.
602
 
 
 
839
    
603
840
    Classes inheriting from this can use the dbus_service_property
604
841
    decorator to expose methods as D-Bus properties.  It exposes the
605
842
    standard Get(), Set(), and GetAll() methods on the D-Bus.
606
843
    """
607
844
    
608
845
    @staticmethod
609
 
    def _is_dbus_property(obj):
610
 
        return getattr(obj, "_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)
611
854
    
612
 
    def _get_all_dbus_properties(self):
 
855
    def _get_all_dbus_things(self, thing):
613
856
        """Returns a generator of (name, attribute) pairs
614
857
        """
615
 
        return ((prop._dbus_name, prop)
616
 
                for name, prop in
617
 
                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)))
618
865
    
619
866
    def _get_dbus_property(self, interface_name, property_name):
620
867
        """Returns a bound method if one exists which is a D-Bus
621
868
        property with the specified name and interface.
622
869
        """
623
 
        for name in (property_name,
624
 
                     property_name + "_dbus_property"):
625
 
            prop = getattr(self, name, None)
626
 
            if (prop is None
627
 
                or not self._is_dbus_property(prop)
628
 
                or prop._dbus_name != property_name
629
 
                or (interface_name and prop._dbus_interface
630
 
                    and interface_name != prop._dbus_interface)):
631
 
                continue
632
 
            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
        
633
878
        # No such property
634
879
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
635
880
                                   + interface_name + "."
660
905
            # signatures other than "ay".
661
906
            if prop._dbus_signature != "ay":
662
907
                raise ValueError
663
 
            value = dbus.ByteArray(''.join(unichr(byte)
664
 
                                           for byte in value))
 
908
            value = dbus.ByteArray(b''.join(chr(byte)
 
909
                                            for byte in value))
665
910
        prop(value)
666
911
    
667
912
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
669
914
    def GetAll(self, interface_name):
670
915
        """Standard D-Bus property GetAll() method, see D-Bus
671
916
        standard.
672
 
 
 
917
        
673
918
        Note: Will not include properties with access="write".
674
919
        """
675
 
        all = {}
676
 
        for name, prop in self._get_all_dbus_properties():
 
920
        properties = {}
 
921
        for name, prop in self._get_all_dbus_things("property"):
677
922
            if (interface_name
678
923
                and interface_name != prop._dbus_interface):
679
924
                # Interface non-empty but did not match
683
928
                continue
684
929
            value = prop()
685
930
            if not hasattr(value, "variant_level"):
686
 
                all[name] = value
 
931
                properties[name] = value
687
932
                continue
688
 
            all[name] = type(value)(value, variant_level=
689
 
                                    value.variant_level+1)
690
 
        return dbus.Dictionary(all, signature="sv")
 
933
            properties[name] = type(value)(value, variant_level=
 
934
                                           value.variant_level+1)
 
935
        return dbus.Dictionary(properties, signature="sv")
691
936
    
692
937
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
693
938
                         out_signature="s",
694
939
                         path_keyword='object_path',
695
940
                         connection_keyword='connection')
696
941
    def Introspect(self, object_path, connection):
697
 
        """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.
698
945
        """
699
946
        xmlstring = dbus.service.Object.Introspect(self, object_path,
700
947
                                                   connection)
707
954
                e.setAttribute("access", prop._dbus_access)
708
955
                return e
709
956
            for if_tag in document.getElementsByTagName("interface"):
 
957
                # Add property tags
710
958
                for tag in (make_tag(document, name, prop)
711
959
                            for name, prop
712
 
                            in self._get_all_dbus_properties()
 
960
                            in self._get_all_dbus_things("property")
713
961
                            if prop._dbus_interface
714
962
                            == if_tag.getAttribute("name")):
715
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)
716
995
                # Add the names to the return values for the
717
996
                # "org.freedesktop.DBus.Properties" methods
718
997
                if (if_tag.getAttribute("name")
733
1012
        except (AttributeError, xml.dom.DOMException,
734
1013
                xml.parsers.expat.ExpatError) as error:
735
1014
            logger.error("Failed to override Introspection method",
736
 
                         error)
 
1015
                         exc_info=error)
737
1016
        return xmlstring
738
1017
 
739
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"})
740
1198
class ClientDBus(Client, DBusObjectWithProperties):
741
1199
    """A Client class using D-Bus
742
1200
    
751
1209
    # dbus.service.Object doesn't use super(), so we can't either.
752
1210
    
753
1211
    def __init__(self, bus = None, *args, **kwargs):
754
 
        self._approvals_pending = 0
755
1212
        self.bus = bus
756
1213
        Client.__init__(self, *args, **kwargs)
757
1214
        # Only now, when this client is initialized, can it show up on
763
1220
                                 ("/clients/" + client_object_name))
764
1221
        DBusObjectWithProperties.__init__(self, self.bus,
765
1222
                                          self.dbus_object_path)
766
 
        
767
 
    def _get_approvals_pending(self):
768
 
        return self._approvals_pending
769
 
    def _set_approvals_pending(self, value):
770
 
        old_value = self._approvals_pending
771
 
        self._approvals_pending = value
772
 
        bval = bool(value)
773
 
        if (hasattr(self, "dbus_object_path")
774
 
            and bval is not bool(old_value)):
775
 
            dbus_bool = dbus.Boolean(bval, variant_level=1)
776
 
            self.PropertyChanged(dbus.String("ApprovalPending"),
777
 
                                 dbus_bool)
778
 
 
779
 
    approvals_pending = property(_get_approvals_pending,
780
 
                                 _set_approvals_pending)
781
 
    del _get_approvals_pending, _set_approvals_pending
782
 
    
783
 
    @staticmethod
784
 
    def _datetime_to_dbus(dt, variant_level=0):
785
 
        """Convert a UTC datetime.datetime() to a D-Bus type."""
786
 
        return dbus.String(dt.isoformat(),
787
 
                           variant_level=variant_level)
788
 
    
789
 
    def enable(self):
790
 
        oldstate = getattr(self, "enabled", False)
791
 
        r = Client.enable(self)
792
 
        if oldstate != self.enabled:
793
 
            # Emit D-Bus signals
794
 
            self.PropertyChanged(dbus.String("Enabled"),
795
 
                                 dbus.Boolean(True, variant_level=1))
796
 
            self.PropertyChanged(
797
 
                dbus.String("LastEnabled"),
798
 
                self._datetime_to_dbus(self.last_enabled,
799
 
                                       variant_level=1))
800
 
        return r
801
 
    
802
 
    def disable(self, quiet = False):
803
 
        oldstate = getattr(self, "enabled", False)
804
 
        r = Client.disable(self, quiet=quiet)
805
 
        if not quiet and oldstate != self.enabled:
806
 
            # Emit D-Bus signal
807
 
            self.PropertyChanged(dbus.String("Enabled"),
808
 
                                 dbus.Boolean(False, variant_level=1))
809
 
        return r
 
1223
    
 
1224
    def notifychangeproperty(transform_func,
 
1225
                             dbus_name, type_func=lambda x: x,
 
1226
                             variant_level=1):
 
1227
        """ Modify a variable so that it's a property which announces
 
1228
        its changes to DBus.
 
1229
        
 
1230
        transform_fun: Function that takes a value and a variant_level
 
1231
                       and transforms it to a D-Bus type.
 
1232
        dbus_name: D-Bus name of the variable
 
1233
        type_func: Function that transform the value before sending it
 
1234
                   to the D-Bus.  Default: no transform
 
1235
        variant_level: D-Bus variant level.  Default: 1
 
1236
        """
 
1237
        attrname = "_{0}".format(dbus_name)
 
1238
        def setter(self, value):
 
1239
            if hasattr(self, "dbus_object_path"):
 
1240
                if (not hasattr(self, attrname) or
 
1241
                    type_func(getattr(self, attrname, None))
 
1242
                    != type_func(value)):
 
1243
                    dbus_value = transform_func(type_func(value),
 
1244
                                                variant_level
 
1245
                                                =variant_level)
 
1246
                    self.PropertyChanged(dbus.String(dbus_name),
 
1247
                                         dbus_value)
 
1248
            setattr(self, attrname, value)
 
1249
        
 
1250
        return property(lambda self: getattr(self, attrname), setter)
 
1251
    
 
1252
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
 
1253
    approvals_pending = notifychangeproperty(dbus.Boolean,
 
1254
                                             "ApprovalPending",
 
1255
                                             type_func = bool)
 
1256
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
 
1257
    last_enabled = notifychangeproperty(datetime_to_dbus,
 
1258
                                        "LastEnabled")
 
1259
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
 
1260
                                   type_func = lambda checker:
 
1261
                                       checker is not None)
 
1262
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
 
1263
                                           "LastCheckedOK")
 
1264
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1265
                                               "LastCheckerStatus")
 
1266
    last_approval_request = notifychangeproperty(
 
1267
        datetime_to_dbus, "LastApprovalRequest")
 
1268
    approved_by_default = notifychangeproperty(dbus.Boolean,
 
1269
                                               "ApprovedByDefault")
 
1270
    approval_delay = notifychangeproperty(dbus.UInt64,
 
1271
                                          "ApprovalDelay",
 
1272
                                          type_func =
 
1273
                                          timedelta_to_milliseconds)
 
1274
    approval_duration = notifychangeproperty(
 
1275
        dbus.UInt64, "ApprovalDuration",
 
1276
        type_func = timedelta_to_milliseconds)
 
1277
    host = notifychangeproperty(dbus.String, "Host")
 
1278
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
1279
                                   type_func =
 
1280
                                   timedelta_to_milliseconds)
 
1281
    extended_timeout = notifychangeproperty(
 
1282
        dbus.UInt64, "ExtendedTimeout",
 
1283
        type_func = timedelta_to_milliseconds)
 
1284
    interval = notifychangeproperty(dbus.UInt64,
 
1285
                                    "Interval",
 
1286
                                    type_func =
 
1287
                                    timedelta_to_milliseconds)
 
1288
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1289
    
 
1290
    del notifychangeproperty
810
1291
    
811
1292
    def __del__(self, *args, **kwargs):
812
1293
        try:
821
1302
                         *args, **kwargs):
822
1303
        self.checker_callback_tag = None
823
1304
        self.checker = None
824
 
        # Emit D-Bus signal
825
 
        self.PropertyChanged(dbus.String("CheckerRunning"),
826
 
                             dbus.Boolean(False, variant_level=1))
827
1305
        if os.WIFEXITED(condition):
828
1306
            exitstatus = os.WEXITSTATUS(condition)
829
1307
            # Emit D-Bus signal
839
1317
        return Client.checker_callback(self, pid, condition, command,
840
1318
                                       *args, **kwargs)
841
1319
    
842
 
    def checked_ok(self, *args, **kwargs):
843
 
        Client.checked_ok(self, *args, **kwargs)
844
 
        # Emit D-Bus signal
845
 
        self.PropertyChanged(
846
 
            dbus.String("LastCheckedOK"),
847
 
            (self._datetime_to_dbus(self.last_checked_ok,
848
 
                                    variant_level=1)))
849
 
    
850
 
    def need_approval(self, *args, **kwargs):
851
 
        r = Client.need_approval(self, *args, **kwargs)
852
 
        # Emit D-Bus signal
853
 
        self.PropertyChanged(
854
 
            dbus.String("LastApprovalRequest"),
855
 
            (self._datetime_to_dbus(self.last_approval_request,
856
 
                                    variant_level=1)))
857
 
        return r
858
 
    
859
1320
    def start_checker(self, *args, **kwargs):
860
1321
        old_checker = self.checker
861
1322
        if self.checker is not None:
868
1329
            and old_checker_pid != self.checker.pid):
869
1330
            # Emit D-Bus signal
870
1331
            self.CheckerStarted(self.current_checker_command)
871
 
            self.PropertyChanged(
872
 
                dbus.String("CheckerRunning"),
873
 
                dbus.Boolean(True, variant_level=1))
874
1332
        return r
875
1333
    
876
 
    def stop_checker(self, *args, **kwargs):
877
 
        old_checker = getattr(self, "checker", None)
878
 
        r = Client.stop_checker(self, *args, **kwargs)
879
 
        if (old_checker is not None
880
 
            and getattr(self, "checker", None) is None):
881
 
            self.PropertyChanged(dbus.String("CheckerRunning"),
882
 
                                 dbus.Boolean(False, variant_level=1))
883
 
        return r
884
 
 
885
1334
    def _reset_approved(self):
886
 
        self._approved = None
 
1335
        self.approved = None
887
1336
        return False
888
1337
    
889
1338
    def approve(self, value=True):
890
 
        self.send_changedstate()
891
 
        self._approved = value
892
 
        gobject.timeout_add(self._timedelta_to_milliseconds
 
1339
        self.approved = value
 
1340
        gobject.timeout_add(timedelta_to_milliseconds
893
1341
                            (self.approval_duration),
894
1342
                            self._reset_approved)
895
 
    
 
1343
        self.send_changedstate()
896
1344
    
897
1345
    ## D-Bus methods, signals & properties
898
 
    _interface = "se.bsnet.fukt.Mandos.Client"
 
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"}
899
1354
    
900
1355
    ## Signals
901
1356
    
987
1442
        if value is None:       # get
988
1443
            return dbus.Boolean(self.approved_by_default)
989
1444
        self.approved_by_default = bool(value)
990
 
        # Emit D-Bus signal
991
 
        self.PropertyChanged(dbus.String("ApprovedByDefault"),
992
 
                             dbus.Boolean(value, variant_level=1))
993
1445
    
994
1446
    # ApprovalDelay - property
995
1447
    @dbus_service_property(_interface, signature="t",
998
1450
        if value is None:       # get
999
1451
            return dbus.UInt64(self.approval_delay_milliseconds())
1000
1452
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1001
 
        # Emit D-Bus signal
1002
 
        self.PropertyChanged(dbus.String("ApprovalDelay"),
1003
 
                             dbus.UInt64(value, variant_level=1))
1004
1453
    
1005
1454
    # ApprovalDuration - property
1006
1455
    @dbus_service_property(_interface, signature="t",
1007
1456
                           access="readwrite")
1008
1457
    def ApprovalDuration_dbus_property(self, value=None):
1009
1458
        if value is None:       # get
1010
 
            return dbus.UInt64(self._timedelta_to_milliseconds(
 
1459
            return dbus.UInt64(timedelta_to_milliseconds(
1011
1460
                    self.approval_duration))
1012
1461
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1013
 
        # Emit D-Bus signal
1014
 
        self.PropertyChanged(dbus.String("ApprovalDuration"),
1015
 
                             dbus.UInt64(value, variant_level=1))
1016
1462
    
1017
1463
    # Name - property
1018
1464
    @dbus_service_property(_interface, signature="s", access="read")
1030
1476
    def Host_dbus_property(self, value=None):
1031
1477
        if value is None:       # get
1032
1478
            return dbus.String(self.host)
1033
 
        self.host = value
1034
 
        # Emit D-Bus signal
1035
 
        self.PropertyChanged(dbus.String("Host"),
1036
 
                             dbus.String(value, variant_level=1))
 
1479
        self.host = unicode(value)
1037
1480
    
1038
1481
    # Created - property
1039
1482
    @dbus_service_property(_interface, signature="s", access="read")
1040
1483
    def Created_dbus_property(self):
1041
 
        return dbus.String(self._datetime_to_dbus(self.created))
 
1484
        return datetime_to_dbus(self.created)
1042
1485
    
1043
1486
    # LastEnabled - property
1044
1487
    @dbus_service_property(_interface, signature="s", access="read")
1045
1488
    def LastEnabled_dbus_property(self):
1046
 
        if self.last_enabled is None:
1047
 
            return dbus.String("")
1048
 
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
 
1489
        return datetime_to_dbus(self.last_enabled)
1049
1490
    
1050
1491
    # Enabled - property
1051
1492
    @dbus_service_property(_interface, signature="b",
1065
1506
        if value is not None:
1066
1507
            self.checked_ok()
1067
1508
            return
1068
 
        if self.last_checked_ok is None:
1069
 
            return dbus.String("")
1070
 
        return dbus.String(self._datetime_to_dbus(self
1071
 
                                                  .last_checked_ok))
 
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)
1072
1521
    
1073
1522
    # LastApprovalRequest - property
1074
1523
    @dbus_service_property(_interface, signature="s", access="read")
1075
1524
    def LastApprovalRequest_dbus_property(self):
1076
 
        if self.last_approval_request is None:
1077
 
            return dbus.String("")
1078
 
        return dbus.String(self.
1079
 
                           _datetime_to_dbus(self
1080
 
                                             .last_approval_request))
 
1525
        return datetime_to_dbus(self.last_approval_request)
1081
1526
    
1082
1527
    # Timeout - property
1083
1528
    @dbus_service_property(_interface, signature="t",
1085
1530
    def Timeout_dbus_property(self, value=None):
1086
1531
        if value is None:       # get
1087
1532
            return dbus.UInt64(self.timeout_milliseconds())
 
1533
        old_timeout = self.timeout
1088
1534
        self.timeout = datetime.timedelta(0, 0, 0, value)
1089
 
        # Emit D-Bus signal
1090
 
        self.PropertyChanged(dbus.String("Timeout"),
1091
 
                             dbus.UInt64(value, variant_level=1))
1092
 
        if getattr(self, "disable_initiator_tag", None) is None:
1093
 
            return
1094
 
        # Reschedule timeout
1095
 
        gobject.source_remove(self.disable_initiator_tag)
1096
 
        self.disable_initiator_tag = None
1097
 
        time_to_die = (self.
1098
 
                       _timedelta_to_milliseconds((self
1099
 
                                                   .last_checked_ok
1100
 
                                                   + self.timeout)
1101
 
                                                  - datetime.datetime
1102
 
                                                  .utcnow()))
1103
 
        if time_to_die <= 0:
1104
 
            # The timeout has passed
1105
 
            self.disable()
1106
 
        else:
1107
 
            self.disable_initiator_tag = (gobject.timeout_add
1108
 
                                          (time_to_die, self.disable))
 
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)
1109
1559
    
1110
1560
    # Interval - property
1111
1561
    @dbus_service_property(_interface, signature="t",
1114
1564
        if value is None:       # get
1115
1565
            return dbus.UInt64(self.interval_milliseconds())
1116
1566
        self.interval = datetime.timedelta(0, 0, 0, value)
1117
 
        # Emit D-Bus signal
1118
 
        self.PropertyChanged(dbus.String("Interval"),
1119
 
                             dbus.UInt64(value, variant_level=1))
1120
1567
        if getattr(self, "checker_initiator_tag", None) is None:
1121
1568
            return
1122
 
        # Reschedule checker run
1123
 
        gobject.source_remove(self.checker_initiator_tag)
1124
 
        self.checker_initiator_tag = (gobject.timeout_add
1125
 
                                      (value, self.start_checker))
1126
 
        self.start_checker()    # Start one now, too
1127
 
 
 
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
    
1128
1576
    # Checker - property
1129
1577
    @dbus_service_property(_interface, signature="s",
1130
1578
                           access="readwrite")
1131
1579
    def Checker_dbus_property(self, value=None):
1132
1580
        if value is None:       # get
1133
1581
            return dbus.String(self.checker_command)
1134
 
        self.checker_command = value
1135
 
        # Emit D-Bus signal
1136
 
        self.PropertyChanged(dbus.String("Checker"),
1137
 
                             dbus.String(self.checker_command,
1138
 
                                         variant_level=1))
 
1582
        self.checker_command = unicode(value)
1139
1583
    
1140
1584
    # CheckerRunning - property
1141
1585
    @dbus_service_property(_interface, signature="b",
1168
1612
        self._pipe.send(('init', fpr, address))
1169
1613
        if not self._pipe.recv():
1170
1614
            raise KeyError()
1171
 
 
 
1615
    
1172
1616
    def __getattribute__(self, name):
1173
 
        if(name == '_pipe'):
 
1617
        if name == '_pipe':
1174
1618
            return super(ProxyClient, self).__getattribute__(name)
1175
1619
        self._pipe.send(('getattr', name))
1176
1620
        data = self._pipe.recv()
1181
1625
                self._pipe.send(('funcall', name, args, kwargs))
1182
1626
                return self._pipe.recv()[1]
1183
1627
            return func
1184
 
 
 
1628
    
1185
1629
    def __setattr__(self, name, value):
1186
 
        if(name == '_pipe'):
 
1630
        if name == '_pipe':
1187
1631
            return super(ProxyClient, self).__setattr__(name, value)
1188
1632
        self._pipe.send(('setattr', name, value))
1189
1633
 
1200
1644
                        unicode(self.client_address))
1201
1645
            logger.debug("Pipe FD: %d",
1202
1646
                         self.server.child_pipe.fileno())
1203
 
 
 
1647
            
1204
1648
            session = (gnutls.connection
1205
1649
                       .ClientSession(self.request,
1206
1650
                                      gnutls.connection
1207
1651
                                      .X509Credentials()))
1208
 
 
 
1652
            
1209
1653
            # Note: gnutls.connection.X509Credentials is really a
1210
1654
            # generic GnuTLS certificate credentials object so long as
1211
1655
            # no X.509 keys are added to it.  Therefore, we can use it
1212
1656
            # here despite using OpenPGP certificates.
1213
 
 
 
1657
            
1214
1658
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1215
1659
            #                      "+AES-256-CBC", "+SHA1",
1216
1660
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1222
1666
            (gnutls.library.functions
1223
1667
             .gnutls_priority_set_direct(session._c_object,
1224
1668
                                         priority, None))
1225
 
 
 
1669
            
1226
1670
            # Start communication using the Mandos protocol
1227
1671
            # Get protocol number
1228
1672
            line = self.request.makefile().readline()
1233
1677
            except (ValueError, IndexError, RuntimeError) as error:
1234
1678
                logger.error("Unknown protocol version: %s", error)
1235
1679
                return
1236
 
 
 
1680
            
1237
1681
            # Start GnuTLS connection
1238
1682
            try:
1239
1683
                session.handshake()
1243
1687
                # established.  Just abandon the request.
1244
1688
                return
1245
1689
            logger.debug("Handshake succeeded")
1246
 
 
 
1690
            
1247
1691
            approval_required = False
1248
1692
            try:
1249
1693
                try:
1254
1698
                    logger.warning("Bad certificate: %s", error)
1255
1699
                    return
1256
1700
                logger.debug("Fingerprint: %s", fpr)
1257
 
 
 
1701
                
1258
1702
                try:
1259
1703
                    client = ProxyClient(child_pipe, fpr,
1260
1704
                                         self.client_address)
1272
1716
                                       client.name)
1273
1717
                        if self.server.use_dbus:
1274
1718
                            # Emit D-Bus signal
1275
 
                            client.Rejected("Disabled")                    
 
1719
                            client.Rejected("Disabled")
1276
1720
                        return
1277
1721
                    
1278
 
                    if client._approved or not client.approval_delay:
 
1722
                    if client.approved or not client.approval_delay:
1279
1723
                        #We are approved or approval is disabled
1280
1724
                        break
1281
 
                    elif client._approved is None:
 
1725
                    elif client.approved is None:
1282
1726
                        logger.info("Client %s needs approval",
1283
1727
                                    client.name)
1284
1728
                        if self.server.use_dbus:
1295
1739
                        return
1296
1740
                    
1297
1741
                    #wait until timeout or approved
1298
 
                    #x = float(client._timedelta_to_milliseconds(delay))
1299
1742
                    time = datetime.datetime.now()
1300
1743
                    client.changedstate.acquire()
1301
 
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
 
1744
                    client.changedstate.wait(
 
1745
                        float(timedelta_to_milliseconds(delay)
 
1746
                              / 1000))
1302
1747
                    client.changedstate.release()
1303
1748
                    time2 = datetime.datetime.now()
1304
1749
                    if (time2 - time) >= delay:
1320
1765
                    try:
1321
1766
                        sent = session.send(client.secret[sent_size:])
1322
1767
                    except gnutls.errors.GNUTLSError as error:
1323
 
                        logger.warning("gnutls send failed")
 
1768
                        logger.warning("gnutls send failed",
 
1769
                                       exc_info=error)
1324
1770
                        return
1325
1771
                    logger.debug("Sent: %d, remaining: %d",
1326
1772
                                 sent, len(client.secret)
1327
1773
                                 - (sent_size + sent))
1328
1774
                    sent_size += sent
1329
 
 
 
1775
                
1330
1776
                logger.info("Sending secret to %s", client.name)
1331
 
                # bump the timeout as if seen
1332
 
                client.checked_ok()
 
1777
                # bump the timeout using extended_timeout
 
1778
                client.bump_timeout(client.extended_timeout)
1333
1779
                if self.server.use_dbus:
1334
1780
                    # Emit D-Bus signal
1335
1781
                    client.GotSecret()
1340
1786
                try:
1341
1787
                    session.bye()
1342
1788
                except gnutls.errors.GNUTLSError as error:
1343
 
                    logger.warning("GnuTLS bye failed")
 
1789
                    logger.warning("GnuTLS bye failed",
 
1790
                                   exc_info=error)
1344
1791
    
1345
1792
    @staticmethod
1346
1793
    def peer_certificate(session):
1402
1849
        # Convert the buffer to a Python bytestring
1403
1850
        fpr = ctypes.string_at(buf, buf_len.value)
1404
1851
        # Convert the bytestring to hexadecimal notation
1405
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
1852
        hex_fpr = binascii.hexlify(fpr).upper()
1406
1853
        return hex_fpr
1407
1854
 
1408
1855
 
1411
1858
    def sub_process_main(self, request, address):
1412
1859
        try:
1413
1860
            self.finish_request(request, address)
1414
 
        except:
 
1861
        except Exception:
1415
1862
            self.handle_error(request, address)
1416
1863
        self.close_request(request)
1417
 
            
 
1864
    
1418
1865
    def process_request(self, request, address):
1419
1866
        """Start a new process to process the request."""
1420
 
        multiprocessing.Process(target = self.sub_process_main,
1421
 
                                args = (request, address)).start()
 
1867
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1868
                                       args = (request, address))
 
1869
        proc.start()
 
1870
        return proc
 
1871
 
1422
1872
 
1423
1873
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1424
1874
    """ adds a pipe to the MixIn """
1428
1878
        This function creates a new pipe in self.pipe
1429
1879
        """
1430
1880
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1431
 
 
1432
 
        super(MultiprocessingMixInWithPipe,
1433
 
              self).process_request(request, client_address)
 
1881
        
 
1882
        proc = MultiprocessingMixIn.process_request(self, request,
 
1883
                                                    client_address)
1434
1884
        self.child_pipe.close()
1435
 
        self.add_pipe(parent_pipe)
1436
 
 
1437
 
    def add_pipe(self, parent_pipe):
 
1885
        self.add_pipe(parent_pipe, proc)
 
1886
    
 
1887
    def add_pipe(self, parent_pipe, proc):
1438
1888
        """Dummy function; override as necessary"""
1439
1889
        raise NotImplementedError
1440
1890
 
 
1891
 
1441
1892
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1442
1893
                     socketserver.TCPServer, object):
1443
1894
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
1470
1921
                                           str(self.interface
1471
1922
                                               + '\0'))
1472
1923
                except socket.error as error:
1473
 
                    if error[0] == errno.EPERM:
 
1924
                    if error.errno == errno.EPERM:
1474
1925
                        logger.error("No permission to"
1475
1926
                                     " bind to interface %s",
1476
1927
                                     self.interface)
1477
 
                    elif error[0] == errno.ENOPROTOOPT:
 
1928
                    elif error.errno == errno.ENOPROTOOPT:
1478
1929
                        logger.error("SO_BINDTODEVICE not available;"
1479
1930
                                     " cannot bind to interface %s",
1480
1931
                                     self.interface)
 
1932
                    elif error.errno == errno.ENODEV:
 
1933
                        logger.error("Interface %s does not"
 
1934
                                     " exist, cannot bind",
 
1935
                                     self.interface)
1481
1936
                    else:
1482
1937
                        raise
1483
1938
        # Only bind(2) the socket if we really need to.
1517
1972
        self.enabled = False
1518
1973
        self.clients = clients
1519
1974
        if self.clients is None:
1520
 
            self.clients = set()
 
1975
            self.clients = {}
1521
1976
        self.use_dbus = use_dbus
1522
1977
        self.gnutls_priority = gnutls_priority
1523
1978
        IPv6_TCPServer.__init__(self, server_address,
1527
1982
    def server_activate(self):
1528
1983
        if self.enabled:
1529
1984
            return socketserver.TCPServer.server_activate(self)
 
1985
    
1530
1986
    def enable(self):
1531
1987
        self.enabled = True
1532
 
    def add_pipe(self, parent_pipe):
 
1988
    
 
1989
    def add_pipe(self, parent_pipe, proc):
1533
1990
        # Call "handle_ipc" for both data and EOF events
1534
1991
        gobject.io_add_watch(parent_pipe.fileno(),
1535
1992
                             gobject.IO_IN | gobject.IO_HUP,
1536
1993
                             functools.partial(self.handle_ipc,
1537
 
                                               parent_pipe = parent_pipe))
1538
 
        
 
1994
                                               parent_pipe =
 
1995
                                               parent_pipe,
 
1996
                                               proc = proc))
 
1997
    
1539
1998
    def handle_ipc(self, source, condition, parent_pipe=None,
1540
 
                   client_object=None):
1541
 
        condition_names = {
1542
 
            gobject.IO_IN: "IN",   # There is data to read.
1543
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1544
 
                                    # blocking).
1545
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1546
 
            gobject.IO_ERR: "ERR", # Error condition.
1547
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1548
 
                                    # broken, usually for pipes and
1549
 
                                    # sockets).
1550
 
            }
1551
 
        conditions_string = ' | '.join(name
1552
 
                                       for cond, name in
1553
 
                                       condition_names.iteritems()
1554
 
                                       if cond & condition)
1555
 
        # error or the other end of multiprocessing.Pipe has closed
1556
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
1999
                   proc = None, client_object=None):
 
2000
        # error, or the other end of multiprocessing.Pipe has closed
 
2001
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2002
            # Wait for other process to exit
 
2003
            proc.join()
1557
2004
            return False
1558
2005
        
1559
2006
        # Read a request from the child
1564
2011
            fpr = request[1]
1565
2012
            address = request[2]
1566
2013
            
1567
 
            for c in self.clients:
 
2014
            for c in self.clients.itervalues():
1568
2015
                if c.fingerprint == fpr:
1569
2016
                    client = c
1570
2017
                    break
1573
2020
                            "dress: %s", fpr, address)
1574
2021
                if self.use_dbus:
1575
2022
                    # Emit D-Bus signal
1576
 
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
 
2023
                    mandos_dbus_service.ClientNotFound(fpr,
 
2024
                                                       address[0])
1577
2025
                parent_pipe.send(False)
1578
2026
                return False
1579
2027
            
1580
2028
            gobject.io_add_watch(parent_pipe.fileno(),
1581
2029
                                 gobject.IO_IN | gobject.IO_HUP,
1582
2030
                                 functools.partial(self.handle_ipc,
1583
 
                                                   parent_pipe = parent_pipe,
1584
 
                                                   client_object = client))
 
2031
                                                   parent_pipe =
 
2032
                                                   parent_pipe,
 
2033
                                                   proc = proc,
 
2034
                                                   client_object =
 
2035
                                                   client))
1585
2036
            parent_pipe.send(True)
1586
 
            # remove the old hook in favor of the new above hook on same fileno
 
2037
            # remove the old hook in favor of the new above hook on
 
2038
            # same fileno
1587
2039
            return False
1588
2040
        if command == 'funcall':
1589
2041
            funcname = request[1]
1590
2042
            args = request[2]
1591
2043
            kwargs = request[3]
1592
2044
            
1593
 
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1594
 
 
 
2045
            parent_pipe.send(('data', getattr(client_object,
 
2046
                                              funcname)(*args,
 
2047
                                                         **kwargs)))
 
2048
        
1595
2049
        if command == 'getattr':
1596
2050
            attrname = request[1]
1597
2051
            if callable(client_object.__getattribute__(attrname)):
1598
2052
                parent_pipe.send(('function',))
1599
2053
            else:
1600
 
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
 
2054
                parent_pipe.send(('data', client_object
 
2055
                                  .__getattribute__(attrname)))
1601
2056
        
1602
2057
        if command == 'setattr':
1603
2058
            attrname = request[1]
1604
2059
            value = request[2]
1605
2060
            setattr(client_object, attrname, value)
1606
 
 
 
2061
        
1607
2062
        return True
1608
2063
 
1609
2064
 
1639
2094
            elif suffix == "w":
1640
2095
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1641
2096
            else:
1642
 
                raise ValueError("Unknown suffix %r" % suffix)
 
2097
                raise ValueError("Unknown suffix {0!r}"
 
2098
                                 .format(suffix))
1643
2099
        except (ValueError, IndexError) as e:
1644
2100
            raise ValueError(*(e.args))
1645
2101
        timevalue += delta
1646
2102
    return timevalue
1647
2103
 
1648
2104
 
1649
 
def if_nametoindex(interface):
1650
 
    """Call the C function if_nametoindex(), or equivalent
1651
 
    
1652
 
    Note: This function cannot accept a unicode string."""
1653
 
    global if_nametoindex
1654
 
    try:
1655
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1656
 
                          (ctypes.util.find_library("c"))
1657
 
                          .if_nametoindex)
1658
 
    except (OSError, AttributeError):
1659
 
        logger.warning("Doing if_nametoindex the hard way")
1660
 
        def if_nametoindex(interface):
1661
 
            "Get an interface index the hard way, i.e. using fcntl()"
1662
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1663
 
            with contextlib.closing(socket.socket()) as s:
1664
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1665
 
                                    struct.pack(str("16s16x"),
1666
 
                                                interface))
1667
 
            interface_index = struct.unpack(str("I"),
1668
 
                                            ifreq[16:20])[0]
1669
 
            return interface_index
1670
 
    return if_nametoindex(interface)
1671
 
 
1672
 
 
1673
2105
def daemon(nochdir = False, noclose = False):
1674
2106
    """See daemon(3).  Standard BSD Unix function.
1675
2107
    
1683
2115
        sys.exit()
1684
2116
    if not noclose:
1685
2117
        # Close all standard open file descriptors
1686
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2118
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1687
2119
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1688
2120
            raise OSError(errno.ENODEV,
1689
 
                          "%s not a character device"
1690
 
                          % os.path.devnull)
 
2121
                          "{0} not a character device"
 
2122
                          .format(os.devnull))
1691
2123
        os.dup2(null, sys.stdin.fileno())
1692
2124
        os.dup2(null, sys.stdout.fileno())
1693
2125
        os.dup2(null, sys.stderr.fileno())
1702
2134
    
1703
2135
    parser = argparse.ArgumentParser()
1704
2136
    parser.add_argument("-v", "--version", action="version",
1705
 
                        version = "%%(prog)s %s" % version,
 
2137
                        version = "%(prog)s {0}".format(version),
1706
2138
                        help="show version number and exit")
1707
2139
    parser.add_argument("-i", "--interface", metavar="IF",
1708
2140
                        help="Bind to interface IF")
1730
2162
                        " system bus interface")
1731
2163
    parser.add_argument("--no-ipv6", action="store_false",
1732
2164
                        dest="use_ipv6", help="Do not use IPv6")
 
2165
    parser.add_argument("--no-restore", action="store_false",
 
2166
                        dest="restore", help="Do not restore stored"
 
2167
                        " state")
 
2168
    parser.add_argument("--statedir", metavar="DIR",
 
2169
                        help="Directory to save/restore state in")
 
2170
    
1733
2171
    options = parser.parse_args()
1734
2172
    
1735
2173
    if options.check:
1748
2186
                        "use_dbus": "True",
1749
2187
                        "use_ipv6": "True",
1750
2188
                        "debuglevel": "",
 
2189
                        "restore": "True",
 
2190
                        "statedir": "/var/lib/mandos"
1751
2191
                        }
1752
2192
    
1753
2193
    # Parse config file for server-global settings
1770
2210
    # options, if set.
1771
2211
    for option in ("interface", "address", "port", "debug",
1772
2212
                   "priority", "servicename", "configdir",
1773
 
                   "use_dbus", "use_ipv6", "debuglevel"):
 
2213
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2214
                   "statedir"):
1774
2215
        value = getattr(options, option)
1775
2216
        if value is not None:
1776
2217
            server_settings[option] = value
1788
2229
    debuglevel = server_settings["debuglevel"]
1789
2230
    use_dbus = server_settings["use_dbus"]
1790
2231
    use_ipv6 = server_settings["use_ipv6"]
1791
 
 
 
2232
    stored_state_path = os.path.join(server_settings["statedir"],
 
2233
                                     stored_state_file)
 
2234
    
 
2235
    if debug:
 
2236
        initlogger(debug, logging.DEBUG)
 
2237
    else:
 
2238
        if not debuglevel:
 
2239
            initlogger(debug)
 
2240
        else:
 
2241
            level = getattr(logging, debuglevel.upper())
 
2242
            initlogger(debug, level)
 
2243
    
1792
2244
    if server_settings["servicename"] != "Mandos":
1793
2245
        syslogger.setFormatter(logging.Formatter
1794
 
                               ('Mandos (%s) [%%(process)d]:'
1795
 
                                ' %%(levelname)s: %%(message)s'
1796
 
                                % server_settings["servicename"]))
 
2246
                               ('Mandos ({0}) [%(process)d]:'
 
2247
                                ' %(levelname)s: %(message)s'
 
2248
                                .format(server_settings
 
2249
                                        ["servicename"])))
1797
2250
    
1798
2251
    # Parse config file with clients
1799
 
    client_defaults = { "timeout": "1h",
1800
 
                        "interval": "5m",
1801
 
                        "checker": "fping -q -- %%(host)s",
1802
 
                        "host": "",
1803
 
                        "approval_delay": "0s",
1804
 
                        "approval_duration": "1s",
1805
 
                        }
1806
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2252
    client_config = configparser.SafeConfigParser(Client
 
2253
                                                  .client_defaults)
1807
2254
    client_config.read(os.path.join(server_settings["configdir"],
1808
2255
                                    "clients.conf"))
1809
2256
    
1823
2270
        pidfilename = "/var/run/mandos.pid"
1824
2271
        try:
1825
2272
            pidfile = open(pidfilename, "w")
1826
 
        except IOError:
1827
 
            logger.error("Could not open file %r", pidfilename)
 
2273
        except IOError as e:
 
2274
            logger.error("Could not open file %r", pidfilename,
 
2275
                         exc_info=e)
1828
2276
    
1829
 
    try:
1830
 
        uid = pwd.getpwnam("_mandos").pw_uid
1831
 
        gid = pwd.getpwnam("_mandos").pw_gid
1832
 
    except KeyError:
 
2277
    for name in ("_mandos", "mandos", "nobody"):
1833
2278
        try:
1834
 
            uid = pwd.getpwnam("mandos").pw_uid
1835
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2279
            uid = pwd.getpwnam(name).pw_uid
 
2280
            gid = pwd.getpwnam(name).pw_gid
 
2281
            break
1836
2282
        except KeyError:
1837
 
            try:
1838
 
                uid = pwd.getpwnam("nobody").pw_uid
1839
 
                gid = pwd.getpwnam("nobody").pw_gid
1840
 
            except KeyError:
1841
 
                uid = 65534
1842
 
                gid = 65534
 
2283
            continue
 
2284
    else:
 
2285
        uid = 65534
 
2286
        gid = 65534
1843
2287
    try:
1844
2288
        os.setgid(gid)
1845
2289
        os.setuid(uid)
1846
2290
    except OSError as error:
1847
 
        if error[0] != errno.EPERM:
 
2291
        if error.errno != errno.EPERM:
1848
2292
            raise error
1849
2293
    
1850
 
    if not debug and not debuglevel:
1851
 
        syslogger.setLevel(logging.WARNING)
1852
 
        console.setLevel(logging.WARNING)
1853
 
    if debuglevel:
1854
 
        level = getattr(logging, debuglevel.upper())
1855
 
        syslogger.setLevel(level)
1856
 
        console.setLevel(level)
1857
 
 
1858
2294
    if debug:
1859
2295
        # Enable all possible GnuTLS debugging
1860
2296
        
1870
2306
         .gnutls_global_set_log_function(debug_gnutls))
1871
2307
        
1872
2308
        # Redirect stdin so all checkers get /dev/null
1873
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2309
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1874
2310
        os.dup2(null, sys.stdin.fileno())
1875
2311
        if null > 2:
1876
2312
            os.close(null)
1877
 
    else:
1878
 
        # No console logging
1879
 
        logger.removeHandler(console)
1880
2313
    
1881
2314
    # Need to fork before connecting to D-Bus
1882
2315
    if not debug:
1883
2316
        # Close all input and output, do double fork, etc.
1884
2317
        daemon()
1885
2318
    
 
2319
    gobject.threads_init()
 
2320
    
1886
2321
    global main_loop
1887
2322
    # From the Avahi example code
1888
 
    DBusGMainLoop(set_as_default=True )
 
2323
    DBusGMainLoop(set_as_default=True)
1889
2324
    main_loop = gobject.MainLoop()
1890
2325
    bus = dbus.SystemBus()
1891
2326
    # End of Avahi example code
1892
2327
    if use_dbus:
1893
2328
        try:
1894
 
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
 
2329
            bus_name = dbus.service.BusName("se.recompile.Mandos",
1895
2330
                                            bus, do_not_queue=True)
 
2331
            old_bus_name = (dbus.service.BusName
 
2332
                            ("se.bsnet.fukt.Mandos", bus,
 
2333
                             do_not_queue=True))
1896
2334
        except dbus.exceptions.NameExistsException as e:
1897
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2335
            logger.error("Disabling D-Bus:", exc_info=e)
1898
2336
            use_dbus = False
1899
2337
            server_settings["use_dbus"] = False
1900
2338
            tcp_server.use_dbus = False
1901
2339
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1902
 
    service = AvahiService(name = server_settings["servicename"],
1903
 
                           servicetype = "_mandos._tcp",
1904
 
                           protocol = protocol, bus = bus)
 
2340
    service = AvahiServiceToSyslog(name =
 
2341
                                   server_settings["servicename"],
 
2342
                                   servicetype = "_mandos._tcp",
 
2343
                                   protocol = protocol, bus = bus)
1905
2344
    if server_settings["interface"]:
1906
2345
        service.interface = (if_nametoindex
1907
2346
                             (str(server_settings["interface"])))
1912
2351
    client_class = Client
1913
2352
    if use_dbus:
1914
2353
        client_class = functools.partial(ClientDBus, bus = bus)
1915
 
    def client_config_items(config, section):
1916
 
        special_settings = {
1917
 
            "approved_by_default":
1918
 
                lambda: config.getboolean(section,
1919
 
                                          "approved_by_default"),
1920
 
            }
1921
 
        for name, value in config.items(section):
 
2354
    
 
2355
    client_settings = Client.config_parser(client_config)
 
2356
    old_client_settings = {}
 
2357
    clients_data = {}
 
2358
    
 
2359
    # Get client data and settings from last running state.
 
2360
    if server_settings["restore"]:
 
2361
        try:
 
2362
            with open(stored_state_path, "rb") as stored_state:
 
2363
                clients_data, old_client_settings = (pickle.load
 
2364
                                                     (stored_state))
 
2365
            os.remove(stored_state_path)
 
2366
        except IOError as e:
 
2367
            if e.errno == errno.ENOENT:
 
2368
                logger.warning("Could not load persistent state: {0}"
 
2369
                                .format(os.strerror(e.errno)))
 
2370
            else:
 
2371
                logger.critical("Could not load persistent state:",
 
2372
                                exc_info=e)
 
2373
                raise
 
2374
        except EOFError as e:
 
2375
            logger.warning("Could not load persistent state: "
 
2376
                           "EOFError:", exc_info=e)
 
2377
    
 
2378
    with PGPEngine() as pgp:
 
2379
        for client_name, client in clients_data.iteritems():
 
2380
            # Decide which value to use after restoring saved state.
 
2381
            # We have three different values: Old config file,
 
2382
            # new config file, and saved state.
 
2383
            # New config value takes precedence if it differs from old
 
2384
            # config value, otherwise use saved state.
 
2385
            for name, value in client_settings[client_name].items():
 
2386
                try:
 
2387
                    # For each value in new config, check if it
 
2388
                    # differs from the old config value (Except for
 
2389
                    # the "secret" attribute)
 
2390
                    if (name != "secret" and
 
2391
                        value != old_client_settings[client_name]
 
2392
                        [name]):
 
2393
                        client[name] = value
 
2394
                except KeyError:
 
2395
                    pass
 
2396
            
 
2397
            # Clients who has passed its expire date can still be
 
2398
            # enabled if its last checker was successful.  Clients
 
2399
            # whose checker succeeded before we stored its state is
 
2400
            # assumed to have successfully run all checkers during
 
2401
            # downtime.
 
2402
            if client["enabled"]:
 
2403
                if datetime.datetime.utcnow() >= client["expires"]:
 
2404
                    if not client["last_checked_ok"]:
 
2405
                        logger.warning(
 
2406
                            "disabling client {0} - Client never "
 
2407
                            "performed a successful checker"
 
2408
                            .format(client_name))
 
2409
                        client["enabled"] = False
 
2410
                    elif client["last_checker_status"] != 0:
 
2411
                        logger.warning(
 
2412
                            "disabling client {0} - Client "
 
2413
                            "last checker failed with error code {1}"
 
2414
                            .format(client_name,
 
2415
                                    client["last_checker_status"]))
 
2416
                        client["enabled"] = False
 
2417
                    else:
 
2418
                        client["expires"] = (datetime.datetime
 
2419
                                             .utcnow()
 
2420
                                             + client["timeout"])
 
2421
                        logger.debug("Last checker succeeded,"
 
2422
                                     " keeping {0} enabled"
 
2423
                                     .format(client_name))
1922
2424
            try:
1923
 
                yield (name, special_settings[name]())
1924
 
            except KeyError:
1925
 
                yield (name, value)
1926
 
    
1927
 
    tcp_server.clients.update(set(
1928
 
            client_class(name = section,
1929
 
                         config= dict(client_config_items(
1930
 
                        client_config, section)))
1931
 
            for section in client_config.sections()))
 
2425
                client["secret"] = (
 
2426
                    pgp.decrypt(client["encrypted_secret"],
 
2427
                                client_settings[client_name]
 
2428
                                ["secret"]))
 
2429
            except PGPError:
 
2430
                # If decryption fails, we use secret from new settings
 
2431
                logger.debug("Failed to decrypt {0} old secret"
 
2432
                             .format(client_name))
 
2433
                client["secret"] = (
 
2434
                    client_settings[client_name]["secret"])
 
2435
    
 
2436
    # Add/remove clients based on new changes made to config
 
2437
    for client_name in (set(old_client_settings)
 
2438
                        - set(client_settings)):
 
2439
        del clients_data[client_name]
 
2440
    for client_name in (set(client_settings)
 
2441
                        - set(old_client_settings)):
 
2442
        clients_data[client_name] = client_settings[client_name]
 
2443
    
 
2444
    # Create all client objects
 
2445
    for client_name, client in clients_data.iteritems():
 
2446
        tcp_server.clients[client_name] = client_class(
 
2447
            name = client_name, settings = client)
 
2448
    
1932
2449
    if not tcp_server.clients:
1933
2450
        logger.warning("No clients defined")
1934
 
        
 
2451
    
1935
2452
    if not debug:
1936
2453
        try:
1937
2454
            with pidfile:
1945
2462
            # "pidfile" was never created
1946
2463
            pass
1947
2464
        del pidfilename
1948
 
        
1949
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
1950
 
 
 
2465
    
1951
2466
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1952
2467
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1953
2468
    
1954
2469
    if use_dbus:
1955
 
        class MandosDBusService(dbus.service.Object):
 
2470
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2471
                                        "se.bsnet.fukt.Mandos"})
 
2472
        class MandosDBusService(DBusObjectWithProperties):
1956
2473
            """A D-Bus proxy object"""
1957
2474
            def __init__(self):
1958
2475
                dbus.service.Object.__init__(self, bus, "/")
1959
 
            _interface = "se.bsnet.fukt.Mandos"
 
2476
            _interface = "se.recompile.Mandos"
 
2477
            
 
2478
            @dbus_interface_annotations(_interface)
 
2479
            def _foo(self):
 
2480
                return { "org.freedesktop.DBus.Property"
 
2481
                         ".EmitsChangedSignal":
 
2482
                             "false"}
1960
2483
            
1961
2484
            @dbus.service.signal(_interface, signature="o")
1962
2485
            def ClientAdded(self, objpath):
1977
2500
            def GetAllClients(self):
1978
2501
                "D-Bus method"
1979
2502
                return dbus.Array(c.dbus_object_path
1980
 
                                  for c in tcp_server.clients)
 
2503
                                  for c in
 
2504
                                  tcp_server.clients.itervalues())
1981
2505
            
1982
2506
            @dbus.service.method(_interface,
1983
2507
                                 out_signature="a{oa{sv}}")
1985
2509
                "D-Bus method"
1986
2510
                return dbus.Dictionary(
1987
2511
                    ((c.dbus_object_path, c.GetAll(""))
1988
 
                     for c in tcp_server.clients),
 
2512
                     for c in tcp_server.clients.itervalues()),
1989
2513
                    signature="oa{sv}")
1990
2514
            
1991
2515
            @dbus.service.method(_interface, in_signature="o")
1992
2516
            def RemoveClient(self, object_path):
1993
2517
                "D-Bus method"
1994
 
                for c in tcp_server.clients:
 
2518
                for c in tcp_server.clients.itervalues():
1995
2519
                    if c.dbus_object_path == object_path:
1996
 
                        tcp_server.clients.remove(c)
 
2520
                        del tcp_server.clients[c.name]
1997
2521
                        c.remove_from_connection()
1998
2522
                        # Don't signal anything except ClientRemoved
1999
2523
                        c.disable(quiet=True)
2010
2534
        "Cleanup function; run on exit"
2011
2535
        service.cleanup()
2012
2536
        
 
2537
        multiprocessing.active_children()
 
2538
        if not (tcp_server.clients or client_settings):
 
2539
            return
 
2540
        
 
2541
        # Store client before exiting. Secrets are encrypted with key
 
2542
        # based on what config file has. If config file is
 
2543
        # removed/edited, old secret will thus be unrecovable.
 
2544
        clients = {}
 
2545
        with PGPEngine() as pgp:
 
2546
            for client in tcp_server.clients.itervalues():
 
2547
                key = client_settings[client.name]["secret"]
 
2548
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2549
                                                      key)
 
2550
                client_dict = {}
 
2551
                
 
2552
                # A list of attributes that can not be pickled
 
2553
                # + secret.
 
2554
                exclude = set(("bus", "changedstate", "secret",
 
2555
                               "checker"))
 
2556
                for name, typ in (inspect.getmembers
 
2557
                                  (dbus.service.Object)):
 
2558
                    exclude.add(name)
 
2559
                
 
2560
                client_dict["encrypted_secret"] = (client
 
2561
                                                   .encrypted_secret)
 
2562
                for attr in client.client_structure:
 
2563
                    if attr not in exclude:
 
2564
                        client_dict[attr] = getattr(client, attr)
 
2565
                
 
2566
                clients[client.name] = client_dict
 
2567
                del client_settings[client.name]["secret"]
 
2568
        
 
2569
        try:
 
2570
            with (tempfile.NamedTemporaryFile
 
2571
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2572
                   dir=os.path.dirname(stored_state_path),
 
2573
                   delete=False)) as stored_state:
 
2574
                pickle.dump((clients, client_settings), stored_state)
 
2575
                tempname=stored_state.name
 
2576
            os.rename(tempname, stored_state_path)
 
2577
        except (IOError, OSError) as e:
 
2578
            if not debug:
 
2579
                try:
 
2580
                    os.remove(tempname)
 
2581
                except NameError:
 
2582
                    pass
 
2583
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2584
                logger.warning("Could not save persistent state: {0}"
 
2585
                               .format(os.strerror(e.errno)))
 
2586
            else:
 
2587
                logger.warning("Could not save persistent state:",
 
2588
                               exc_info=e)
 
2589
                raise e
 
2590
        
 
2591
        # Delete all clients, and settings from config
2013
2592
        while tcp_server.clients:
2014
 
            client = tcp_server.clients.pop()
 
2593
            name, client = tcp_server.clients.popitem()
2015
2594
            if use_dbus:
2016
2595
                client.remove_from_connection()
2017
 
            client.disable_hook = None
2018
2596
            # Don't signal anything except ClientRemoved
2019
2597
            client.disable(quiet=True)
2020
2598
            if use_dbus:
2021
2599
                # Emit D-Bus signal
2022
 
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
 
2600
                mandos_dbus_service.ClientRemoved(client
 
2601
                                                  .dbus_object_path,
2023
2602
                                                  client.name)
 
2603
        client_settings.clear()
2024
2604
    
2025
2605
    atexit.register(cleanup)
2026
2606
    
2027
 
    for client in tcp_server.clients:
 
2607
    for client in tcp_server.clients.itervalues():
2028
2608
        if use_dbus:
2029
2609
            # Emit D-Bus signal
2030
2610
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2031
 
        client.enable()
 
2611
        # Need to initiate checking of clients
 
2612
        if client.enabled:
 
2613
            client.init_checker()
2032
2614
    
2033
2615
    tcp_server.enable()
2034
2616
    tcp_server.server_activate()
2037
2619
    service.port = tcp_server.socket.getsockname()[1]
2038
2620
    if use_ipv6:
2039
2621
        logger.info("Now listening on address %r, port %d,"
2040
 
                    " flowinfo %d, scope_id %d"
2041
 
                    % tcp_server.socket.getsockname())
 
2622
                    " flowinfo %d, scope_id %d",
 
2623
                    *tcp_server.socket.getsockname())
2042
2624
    else:                       # IPv4
2043
 
        logger.info("Now listening on address %r, port %d"
2044
 
                    % tcp_server.socket.getsockname())
 
2625
        logger.info("Now listening on address %r, port %d",
 
2626
                    *tcp_server.socket.getsockname())
2045
2627
    
2046
2628
    #service.interface = tcp_server.socket.getsockname()[3]
2047
2629
    
2050
2632
        try:
2051
2633
            service.activate()
2052
2634
        except dbus.exceptions.DBusException as error:
2053
 
            logger.critical("DBusException: %s", error)
 
2635
            logger.critical("D-Bus Exception", exc_info=error)
2054
2636
            cleanup()
2055
2637
            sys.exit(1)
2056
2638
        # End of Avahi example code
2063
2645
        logger.debug("Starting main loop")
2064
2646
        main_loop.run()
2065
2647
    except AvahiError as error:
2066
 
        logger.critical("AvahiError: %s", error)
 
2648
        logger.critical("Avahi Error", exc_info=error)
2067
2649
        cleanup()
2068
2650
        sys.exit(1)
2069
2651
    except KeyboardInterrupt: