/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-26 22:56:38 UTC
  • mfrom: (589.1.1 socket-option)
  • Revision ID: teddy@recompile.se-20120526225638-4hvqyrvmj0036lfn
Merge "--socket" option for server.

This is suggested by the GNU Coding Standards' Table of Long Options,
and will probably also allow socket activation (e.g. by systemd(8)).

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.1"
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
 
267
 
def _timedelta_to_milliseconds(td):
 
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):
268
395
    "Convert a datetime.timedelta() to milliseconds"
269
396
    return ((td.days * 24 * 60 * 60 * 1000)
270
397
            + (td.seconds * 1000)
271
398
            + (td.microseconds // 1000))
272
 
        
 
399
 
 
400
 
273
401
class Client(object):
274
402
    """A representation of a client host served by this server.
275
403
    
276
404
    Attributes:
277
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
405
    approved:   bool(); 'None' if not yet approved/disapproved
278
406
    approval_delay: datetime.timedelta(); Time to wait for approval
279
407
    approval_duration: datetime.timedelta(); Duration of one approval
280
408
    checker:    subprocess.Popen(); a running checker process used
287
415
                     instance %(name)s can be used in the command.
288
416
    checker_initiator_tag: a gobject event source tag, or None
289
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
290
420
    current_checker_command: string; current running checker_command
291
 
    disable_hook:  If set, called by disable() as disable_hook(self)
292
421
    disable_initiator_tag: a gobject event source tag, or None
293
422
    enabled:    bool()
294
423
    fingerprint: string (40 or 32 hexadecimal digits); used to
297
426
    interval:   datetime.timedelta(); How often to start a new checker
298
427
    last_approval_request: datetime.datetime(); (UTC) or None
299
428
    last_checked_ok: datetime.datetime(); (UTC) or None
300
 
    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
301
433
    name:       string; from the config file, used in log messages and
302
434
                        D-Bus identifiers
303
435
    secret:     bytestring; sent verbatim (over TLS) to client
304
436
    timeout:    datetime.timedelta(); How long from last_checked_ok
305
437
                                      until this client is disabled
306
 
    extended_timeout:   extra long timeout when password has been sent
 
438
    extended_timeout:   extra long timeout when secret has been sent
307
439
    runtime_expansions: Allowed attributes for runtime expansion.
308
440
    expires:    datetime.datetime(); time (UTC) when a client will be
309
441
                disabled, or None
310
442
    """
311
443
    
312
444
    runtime_expansions = ("approval_delay", "approval_duration",
313
 
                          "created", "enabled", "fingerprint",
314
 
                          "host", "interval", "last_checked_ok",
 
445
                          "created", "enabled", "expires",
 
446
                          "fingerprint", "host", "interval",
 
447
                          "last_approval_request", "last_checked_ok",
315
448
                          "last_enabled", "name", "timeout")
316
 
        
 
449
    client_defaults = { "timeout": "5m",
 
450
                        "extended_timeout": "15m",
 
451
                        "interval": "2m",
 
452
                        "checker": "fping -q -- %%(host)s",
 
453
                        "host": "",
 
454
                        "approval_delay": "0s",
 
455
                        "approval_duration": "1s",
 
456
                        "approved_by_default": "True",
 
457
                        "enabled": "True",
 
458
                        }
 
459
    
317
460
    def timeout_milliseconds(self):
318
461
        "Return the 'timeout' attribute in milliseconds"
319
 
        return _timedelta_to_milliseconds(self.timeout)
320
 
 
 
462
        return timedelta_to_milliseconds(self.timeout)
 
463
    
321
464
    def extended_timeout_milliseconds(self):
322
465
        "Return the 'extended_timeout' attribute in milliseconds"
323
 
        return _timedelta_to_milliseconds(self.extended_timeout)    
 
466
        return timedelta_to_milliseconds(self.extended_timeout)
324
467
    
325
468
    def interval_milliseconds(self):
326
469
        "Return the 'interval' attribute in milliseconds"
327
 
        return _timedelta_to_milliseconds(self.interval)
328
 
 
 
470
        return timedelta_to_milliseconds(self.interval)
 
471
    
329
472
    def approval_delay_milliseconds(self):
330
 
        return _timedelta_to_milliseconds(self.approval_delay)
331
 
    
332
 
    def __init__(self, name = None, disable_hook=None, config=None):
333
 
        """Note: the 'checker' key in 'config' sets the
334
 
        'checker_command' attribute and *not* the 'checker'
335
 
        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):
336
523
        self.name = name
337
 
        if config is None:
338
 
            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
        
339
538
        logger.debug("Creating client %r", self.name)
340
539
        # Uppercase and remove spaces from fingerprint for later
341
540
        # comparison purposes with return value from the fingerprint()
342
541
        # function
343
 
        self.fingerprint = (config["fingerprint"].upper()
344
 
                            .replace(" ", ""))
345
542
        logger.debug("  Fingerprint: %s", self.fingerprint)
346
 
        if "secret" in config:
347
 
            self.secret = config["secret"].decode("base64")
348
 
        elif "secfile" in config:
349
 
            with open(os.path.expanduser(os.path.expandvars
350
 
                                         (config["secfile"])),
351
 
                      "rb") as secfile:
352
 
                self.secret = secfile.read()
353
 
        else:
354
 
            raise TypeError("No secret or secfile for client %s"
355
 
                            % self.name)
356
 
        self.host = config.get("host", "")
357
 
        self.created = datetime.datetime.utcnow()
358
 
        self.enabled = False
359
 
        self.last_approval_request = None
360
 
        self.last_enabled = None
361
 
        self.last_checked_ok = None
362
 
        self.timeout = string_to_delta(config["timeout"])
363
 
        self.extended_timeout = string_to_delta(config["extended_timeout"])
364
 
        self.interval = string_to_delta(config["interval"])
365
 
        self.disable_hook = disable_hook
 
543
        self.created = settings.get("created",
 
544
                                    datetime.datetime.utcnow())
 
545
        
 
546
        # attributes specific for this server instance
366
547
        self.checker = None
367
548
        self.checker_initiator_tag = None
368
549
        self.disable_initiator_tag = None
369
 
        self.expires = None
370
550
        self.checker_callback_tag = None
371
 
        self.checker_command = config["checker"]
372
551
        self.current_checker_command = None
373
 
        self.last_connect = None
374
 
        self._approved = None
375
 
        self.approved_by_default = config.get("approved_by_default",
376
 
                                              True)
 
552
        self.approved = None
377
553
        self.approvals_pending = 0
378
 
        self.approval_delay = string_to_delta(
379
 
            config["approval_delay"])
380
 
        self.approval_duration = string_to_delta(
381
 
            config["approval_duration"])
382
 
        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)
383
568
    
 
569
    # Send notice to process children that client state has changed
384
570
    def send_changedstate(self):
385
 
        self.changedstate.acquire()
386
 
        self.changedstate.notify_all()
387
 
        self.changedstate.release()
388
 
        
 
571
        with self.changedstate:
 
572
            self.changedstate.notify_all()
 
573
    
389
574
    def enable(self):
390
575
        """Start this client's checker and timeout hooks"""
391
576
        if getattr(self, "enabled", False):
392
577
            # Already enabled
393
578
            return
 
579
        self.expires = datetime.datetime.utcnow() + self.timeout
 
580
        self.enabled = True
 
581
        self.last_enabled = datetime.datetime.utcnow()
 
582
        self.init_checker()
394
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):
395
609
        # Schedule a new checker to be started an 'interval' from now,
396
610
        # and every interval from then on.
 
611
        if self.checker_initiator_tag is not None:
 
612
            gobject.source_remove(self.checker_initiator_tag)
397
613
        self.checker_initiator_tag = (gobject.timeout_add
398
614
                                      (self.interval_milliseconds(),
399
615
                                       self.start_checker))
400
616
        # Schedule a disable() when 'timeout' has passed
401
 
        self.expires = datetime.datetime.utcnow() + self.timeout
 
617
        if self.disable_initiator_tag is not None:
 
618
            gobject.source_remove(self.disable_initiator_tag)
402
619
        self.disable_initiator_tag = (gobject.timeout_add
403
620
                                   (self.timeout_milliseconds(),
404
621
                                    self.disable))
405
 
        self.enabled = True
406
 
        self.last_enabled = datetime.datetime.utcnow()
407
622
        # Also start a new checker *right now*.
408
623
        self.start_checker()
409
624
    
410
 
    def disable(self, quiet=True):
411
 
        """Disable this client."""
412
 
        if not getattr(self, "enabled", False):
413
 
            return False
414
 
        if not quiet:
415
 
            self.send_changedstate()
416
 
        if not quiet:
417
 
            logger.info("Disabling client %s", self.name)
418
 
        if getattr(self, "disable_initiator_tag", False):
419
 
            gobject.source_remove(self.disable_initiator_tag)
420
 
            self.disable_initiator_tag = None
421
 
        self.expires = None
422
 
        if getattr(self, "checker_initiator_tag", False):
423
 
            gobject.source_remove(self.checker_initiator_tag)
424
 
            self.checker_initiator_tag = None
425
 
        self.stop_checker()
426
 
        if self.disable_hook:
427
 
            self.disable_hook(self)
428
 
        self.enabled = False
429
 
        # Do not run this again if called by a gobject.timeout_add
430
 
        return False
431
 
    
432
 
    def __del__(self):
433
 
        self.disable_hook = None
434
 
        self.disable()
435
 
    
436
625
    def checker_callback(self, pid, condition, command):
437
626
        """The checker has completed, so take appropriate actions."""
438
627
        self.checker_callback_tag = None
439
628
        self.checker = None
440
629
        if os.WIFEXITED(condition):
441
 
            exitstatus = os.WEXITSTATUS(condition)
442
 
            if exitstatus == 0:
 
630
            self.last_checker_status = os.WEXITSTATUS(condition)
 
631
            if self.last_checker_status == 0:
443
632
                logger.info("Checker for %(name)s succeeded",
444
633
                            vars(self))
445
634
                self.checked_ok()
447
636
                logger.info("Checker for %(name)s failed",
448
637
                            vars(self))
449
638
        else:
 
639
            self.last_checker_status = -1
450
640
            logger.warning("Checker for %(name)s crashed?",
451
641
                           vars(self))
452
642
    
453
 
    def checked_ok(self, timeout=None):
454
 
        """Bump up the timeout for this client.
455
 
        
456
 
        This should only be called when the client has been seen,
457
 
        alive and well.
458
 
        """
 
643
    def checked_ok(self):
 
644
        """Assert that the client has been seen, alive and well."""
 
645
        self.last_checked_ok = datetime.datetime.utcnow()
 
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."""
459
651
        if timeout is None:
460
652
            timeout = self.timeout
461
 
        self.last_checked_ok = datetime.datetime.utcnow()
462
 
        gobject.source_remove(self.disable_initiator_tag)
463
 
        self.expires = datetime.datetime.utcnow() + timeout
464
 
        self.disable_initiator_tag = (gobject.timeout_add
465
 
                                      (_timedelta_to_milliseconds(timeout),
466
 
                                       self.disable))
 
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
467
661
    
468
662
    def need_approval(self):
469
663
        self.last_approval_request = datetime.datetime.utcnow()
474
668
        If a checker already exists, leave it running and do
475
669
        nothing."""
476
670
        # The reason for not killing a running checker is that if we
477
 
        # did that, then if a checker (for some reason) started
478
 
        # running slowly and taking more than 'interval' time, the
479
 
        # client would inevitably timeout, since no checker would get
480
 
        # 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
481
675
        # checkers alone, the checker would have to take more time
482
676
        # than 'timeout' for the client to be disabled, which is as it
483
677
        # should be.
497
691
                                      self.current_checker_command)
498
692
        # Start a new checker if needed
499
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)
500
699
            try:
501
 
                # In case checker_command has exactly one % operator
502
 
                command = self.checker_command % self.host
503
 
            except TypeError:
504
 
                # Escape attributes for the shell
505
 
                escaped_attrs = dict(
506
 
                    (attr,
507
 
                     re.escape(unicode(str(getattr(self, attr, "")),
508
 
                                       errors=
509
 
                                       'replace')))
510
 
                    for attr in
511
 
                    self.runtime_expansions)
512
 
 
513
 
                try:
514
 
                    command = self.checker_command % escaped_attrs
515
 
                except TypeError as error:
516
 
                    logger.error('Could not format string "%s":'
517
 
                                 ' %s', self.checker_command, error)
518
 
                    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
519
705
            self.current_checker_command = command
520
706
            try:
521
707
                logger.info("Starting checker %r for %s",
527
713
                self.checker = subprocess.Popen(command,
528
714
                                                close_fds=True,
529
715
                                                shell=True, cwd="/")
530
 
                self.checker_callback_tag = (gobject.child_watch_add
531
 
                                             (self.checker.pid,
532
 
                                              self.checker_callback,
533
 
                                              data=command))
534
 
                # The checker may have completed before the gobject
535
 
                # watch was added.  Check for this.
536
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
537
 
                if pid:
538
 
                    gobject.source_remove(self.checker_callback_tag)
539
 
                    self.checker_callback(pid, status, command)
540
716
            except OSError as error:
541
 
                logger.error("Failed to start subprocess: %s",
542
 
                             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)
543
729
        # Re-run this periodically if run by gobject.timeout_add
544
730
        return True
545
731
    
552
738
            return
553
739
        logger.debug("Stopping checker for %(name)s", vars(self))
554
740
        try:
555
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
741
            self.checker.terminate()
556
742
            #time.sleep(0.5)
557
743
            #if self.checker.poll() is None:
558
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
744
            #    self.checker.kill()
559
745
        except OSError as error:
560
746
            if error.errno != errno.ESRCH: # No such process
561
747
                raise
562
748
        self.checker = None
563
749
 
 
750
 
564
751
def dbus_service_property(dbus_interface, signature="v",
565
752
                          access="readwrite", byte_arrays=False):
566
753
    """Decorators for marking methods of a DBusObjectWithProperties to
577
764
    # "Set" method, so we fail early here:
578
765
    if byte_arrays and signature != "ay":
579
766
        raise ValueError("Byte arrays not supported for non-'ay'"
580
 
                         " signature %r" % signature)
 
767
                         " signature {0!r}".format(signature))
581
768
    def decorator(func):
582
769
        func._dbus_is_property = True
583
770
        func._dbus_interface = dbus_interface
591
778
    return decorator
592
779
 
593
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
 
594
818
class DBusPropertyException(dbus.exceptions.DBusException):
595
819
    """A base class for D-Bus property-related exceptions
596
820
    """
612
836
 
613
837
class DBusObjectWithProperties(dbus.service.Object):
614
838
    """A D-Bus object with properties.
615
 
 
 
839
    
616
840
    Classes inheriting from this can use the dbus_service_property
617
841
    decorator to expose methods as D-Bus properties.  It exposes the
618
842
    standard Get(), Set(), and GetAll() methods on the D-Bus.
619
843
    """
620
844
    
621
845
    @staticmethod
622
 
    def _is_dbus_property(obj):
623
 
        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)
624
854
    
625
 
    def _get_all_dbus_properties(self):
 
855
    def _get_all_dbus_things(self, thing):
626
856
        """Returns a generator of (name, attribute) pairs
627
857
        """
628
 
        return ((prop._dbus_name, prop)
629
 
                for name, prop in
630
 
                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)))
631
865
    
632
866
    def _get_dbus_property(self, interface_name, property_name):
633
867
        """Returns a bound method if one exists which is a D-Bus
634
868
        property with the specified name and interface.
635
869
        """
636
 
        for name in (property_name,
637
 
                     property_name + "_dbus_property"):
638
 
            prop = getattr(self, name, None)
639
 
            if (prop is None
640
 
                or not self._is_dbus_property(prop)
641
 
                or prop._dbus_name != property_name
642
 
                or (interface_name and prop._dbus_interface
643
 
                    and interface_name != prop._dbus_interface)):
644
 
                continue
645
 
            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
        
646
878
        # No such property
647
879
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
648
880
                                   + interface_name + "."
673
905
            # signatures other than "ay".
674
906
            if prop._dbus_signature != "ay":
675
907
                raise ValueError
676
 
            value = dbus.ByteArray(''.join(unichr(byte)
677
 
                                           for byte in value))
 
908
            value = dbus.ByteArray(b''.join(chr(byte)
 
909
                                            for byte in value))
678
910
        prop(value)
679
911
    
680
912
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
682
914
    def GetAll(self, interface_name):
683
915
        """Standard D-Bus property GetAll() method, see D-Bus
684
916
        standard.
685
 
 
 
917
        
686
918
        Note: Will not include properties with access="write".
687
919
        """
688
 
        all = {}
689
 
        for name, prop in self._get_all_dbus_properties():
 
920
        properties = {}
 
921
        for name, prop in self._get_all_dbus_things("property"):
690
922
            if (interface_name
691
923
                and interface_name != prop._dbus_interface):
692
924
                # Interface non-empty but did not match
696
928
                continue
697
929
            value = prop()
698
930
            if not hasattr(value, "variant_level"):
699
 
                all[name] = value
 
931
                properties[name] = value
700
932
                continue
701
 
            all[name] = type(value)(value, variant_level=
702
 
                                    value.variant_level+1)
703
 
        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")
704
936
    
705
937
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
706
938
                         out_signature="s",
707
939
                         path_keyword='object_path',
708
940
                         connection_keyword='connection')
709
941
    def Introspect(self, object_path, connection):
710
 
        """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.
711
945
        """
712
946
        xmlstring = dbus.service.Object.Introspect(self, object_path,
713
947
                                                   connection)
720
954
                e.setAttribute("access", prop._dbus_access)
721
955
                return e
722
956
            for if_tag in document.getElementsByTagName("interface"):
 
957
                # Add property tags
723
958
                for tag in (make_tag(document, name, prop)
724
959
                            for name, prop
725
 
                            in self._get_all_dbus_properties()
 
960
                            in self._get_all_dbus_things("property")
726
961
                            if prop._dbus_interface
727
962
                            == if_tag.getAttribute("name")):
728
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)
729
995
                # Add the names to the return values for the
730
996
                # "org.freedesktop.DBus.Properties" methods
731
997
                if (if_tag.getAttribute("name")
746
1012
        except (AttributeError, xml.dom.DOMException,
747
1013
                xml.parsers.expat.ExpatError) as error:
748
1014
            logger.error("Failed to override Introspection method",
749
 
                         error)
 
1015
                         exc_info=error)
750
1016
        return xmlstring
751
1017
 
752
1018
 
753
 
def datetime_to_dbus (dt, variant_level=0):
 
1019
def datetime_to_dbus(dt, variant_level=0):
754
1020
    """Convert a UTC datetime.datetime() to a D-Bus type."""
755
1021
    if dt is None:
756
1022
        return dbus.String("", variant_level = variant_level)
757
1023
    return dbus.String(dt.isoformat(),
758
1024
                       variant_level=variant_level)
759
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"})
760
1198
class ClientDBus(Client, DBusObjectWithProperties):
761
1199
    """A Client class using D-Bus
762
1200
    
771
1209
    # dbus.service.Object doesn't use super(), so we can't either.
772
1210
    
773
1211
    def __init__(self, bus = None, *args, **kwargs):
774
 
        self._approvals_pending = 0
775
1212
        self.bus = bus
776
1213
        Client.__init__(self, *args, **kwargs)
777
1214
        # Only now, when this client is initialized, can it show up on
783
1220
                                 ("/clients/" + client_object_name))
784
1221
        DBusObjectWithProperties.__init__(self, self.bus,
785
1222
                                          self.dbus_object_path)
786
 
        
 
1223
    
787
1224
    def notifychangeproperty(transform_func,
788
1225
                             dbus_name, type_func=lambda x: x,
789
1226
                             variant_level=1):
790
 
        """ Modify a variable so that its a property that announce its
791
 
        changes to DBus.
792
 
        transform_fun: Function that takes a value and transform it to
793
 
                       DBus type.
794
 
        dbus_name: DBus name of the variable
 
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
795
1233
        type_func: Function that transform the value before sending it
796
 
                   to DBus
797
 
        variant_level: DBus variant level. default: 1
 
1234
                   to the D-Bus.  Default: no transform
 
1235
        variant_level: D-Bus variant level.  Default: 1
798
1236
        """
799
 
        real_value = [None,]
 
1237
        attrname = "_{0}".format(dbus_name)
800
1238
        def setter(self, value):
801
 
            old_value = real_value[0]
802
 
            real_value[0] = value
803
1239
            if hasattr(self, "dbus_object_path"):
804
 
                if type_func(old_value) != type_func(real_value[0]):
805
 
                    dbus_value = transform_func(type_func(real_value[0]),
806
 
                                                variant_level)
 
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)
807
1246
                    self.PropertyChanged(dbus.String(dbus_name),
808
1247
                                         dbus_value)
809
 
 
810
 
        return property(lambda self: real_value[0], setter)
811
 
 
812
 
 
 
1248
            setattr(self, attrname, value)
 
1249
        
 
1250
        return property(lambda self: getattr(self, attrname), setter)
 
1251
    
813
1252
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
814
1253
    approvals_pending = notifychangeproperty(dbus.Boolean,
815
1254
                                             "ApprovalPending",
818
1257
    last_enabled = notifychangeproperty(datetime_to_dbus,
819
1258
                                        "LastEnabled")
820
1259
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
821
 
                                   type_func = lambda checker: checker is not None)
 
1260
                                   type_func = lambda checker:
 
1261
                                       checker is not None)
822
1262
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
823
1263
                                           "LastCheckedOK")
824
 
    last_approval_request = notifychangeproperty(datetime_to_dbus,
825
 
                                                 "LastApprovalRequest")
 
1264
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1265
                                               "LastCheckerStatus")
 
1266
    last_approval_request = notifychangeproperty(
 
1267
        datetime_to_dbus, "LastApprovalRequest")
826
1268
    approved_by_default = notifychangeproperty(dbus.Boolean,
827
1269
                                               "ApprovedByDefault")
828
 
    approval_delay = notifychangeproperty(dbus.UInt16, "ApprovalDelay",
829
 
                                          type_func = _timedelta_to_milliseconds)
830
 
    approval_duration = notifychangeproperty(dbus.UInt16, "ApprovalDuration",
831
 
                                             type_func = _timedelta_to_milliseconds)
 
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)
832
1277
    host = notifychangeproperty(dbus.String, "Host")
833
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
834
 
                                   type_func = _timedelta_to_milliseconds)
835
 
    extended_timeout = notifychangeproperty(dbus.UInt16, "ExtendedTimeout",
836
 
                                            type_func = _timedelta_to_milliseconds)
837
 
    interval = notifychangeproperty(dbus.UInt16, "Interval",
838
 
                                    type_func = _timedelta_to_milliseconds)
 
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)
839
1288
    checker_command = notifychangeproperty(dbus.String, "Checker")
840
1289
    
841
1290
    del notifychangeproperty
867
1316
        
868
1317
        return Client.checker_callback(self, pid, condition, command,
869
1318
                                       *args, **kwargs)
870
 
 
 
1319
    
871
1320
    def start_checker(self, *args, **kwargs):
872
1321
        old_checker = self.checker
873
1322
        if self.checker is not None:
883
1332
        return r
884
1333
    
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(_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
    
1001
1456
                           access="readwrite")
1002
1457
    def ApprovalDuration_dbus_property(self, value=None):
1003
1458
        if value is None:       # get
1004
 
            return dbus.UInt64(_timedelta_to_milliseconds(
 
1459
            return dbus.UInt64(timedelta_to_milliseconds(
1005
1460
                    self.approval_duration))
1006
1461
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1007
1462
    
1021
1476
    def Host_dbus_property(self, value=None):
1022
1477
        if value is None:       # get
1023
1478
            return dbus.String(self.host)
1024
 
        self.host = value
 
1479
        self.host = unicode(value)
1025
1480
    
1026
1481
    # Created - property
1027
1482
    @dbus_service_property(_interface, signature="s", access="read")
1028
1483
    def Created_dbus_property(self):
1029
 
        return dbus.String(datetime_to_dbus(self.created))
 
1484
        return datetime_to_dbus(self.created)
1030
1485
    
1031
1486
    # LastEnabled - property
1032
1487
    @dbus_service_property(_interface, signature="s", access="read")
1053
1508
            return
1054
1509
        return datetime_to_dbus(self.last_checked_ok)
1055
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
    
1056
1517
    # Expires - property
1057
1518
    @dbus_service_property(_interface, signature="s", access="read")
1058
1519
    def Expires_dbus_property(self):
1069
1530
    def Timeout_dbus_property(self, value=None):
1070
1531
        if value is None:       # get
1071
1532
            return dbus.UInt64(self.timeout_milliseconds())
 
1533
        old_timeout = self.timeout
1072
1534
        self.timeout = datetime.timedelta(0, 0, 0, value)
1073
 
        if getattr(self, "disable_initiator_tag", None) is None:
1074
 
            return
1075
 
        # Reschedule timeout
1076
 
        gobject.source_remove(self.disable_initiator_tag)
1077
 
        self.disable_initiator_tag = None
1078
 
        self.expires = None
1079
 
        time_to_die = (self.
1080
 
                       _timedelta_to_milliseconds((self
1081
 
                                                   .last_checked_ok
1082
 
                                                   + self.timeout)
1083
 
                                                  - datetime.datetime
1084
 
                                                  .utcnow()))
1085
 
        if time_to_die <= 0:
1086
 
            # The timeout has passed
1087
 
            self.disable()
1088
 
        else:
1089
 
            self.expires = (datetime.datetime.utcnow()
1090
 
                            + datetime.timedelta(milliseconds = time_to_die))
1091
 
            self.disable_initiator_tag = (gobject.timeout_add
1092
 
                                          (time_to_die, self.disable))
1093
 
 
 
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
    
1094
1552
    # ExtendedTimeout - property
1095
1553
    @dbus_service_property(_interface, signature="t",
1096
1554
                           access="readwrite")
1098
1556
        if value is None:       # get
1099
1557
            return dbus.UInt64(self.extended_timeout_milliseconds())
1100
1558
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1101
 
 
 
1559
    
1102
1560
    # Interval - property
1103
1561
    @dbus_service_property(_interface, signature="t",
1104
1562
                           access="readwrite")
1108
1566
        self.interval = datetime.timedelta(0, 0, 0, value)
1109
1567
        if getattr(self, "checker_initiator_tag", None) is None:
1110
1568
            return
1111
 
        # Reschedule checker run
1112
 
        gobject.source_remove(self.checker_initiator_tag)
1113
 
        self.checker_initiator_tag = (gobject.timeout_add
1114
 
                                      (value, self.start_checker))
1115
 
        self.start_checker()    # Start one now, too
1116
 
 
 
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
    
1117
1576
    # Checker - property
1118
1577
    @dbus_service_property(_interface, signature="s",
1119
1578
                           access="readwrite")
1120
1579
    def Checker_dbus_property(self, value=None):
1121
1580
        if value is None:       # get
1122
1581
            return dbus.String(self.checker_command)
1123
 
        self.checker_command = value
 
1582
        self.checker_command = unicode(value)
1124
1583
    
1125
1584
    # CheckerRunning - property
1126
1585
    @dbus_service_property(_interface, signature="b",
1153
1612
        self._pipe.send(('init', fpr, address))
1154
1613
        if not self._pipe.recv():
1155
1614
            raise KeyError()
1156
 
 
 
1615
    
1157
1616
    def __getattribute__(self, name):
1158
 
        if(name == '_pipe'):
 
1617
        if name == '_pipe':
1159
1618
            return super(ProxyClient, self).__getattribute__(name)
1160
1619
        self._pipe.send(('getattr', name))
1161
1620
        data = self._pipe.recv()
1166
1625
                self._pipe.send(('funcall', name, args, kwargs))
1167
1626
                return self._pipe.recv()[1]
1168
1627
            return func
1169
 
 
 
1628
    
1170
1629
    def __setattr__(self, name, value):
1171
 
        if(name == '_pipe'):
 
1630
        if name == '_pipe':
1172
1631
            return super(ProxyClient, self).__setattr__(name, value)
1173
1632
        self._pipe.send(('setattr', name, value))
1174
1633
 
1185
1644
                        unicode(self.client_address))
1186
1645
            logger.debug("Pipe FD: %d",
1187
1646
                         self.server.child_pipe.fileno())
1188
 
 
 
1647
            
1189
1648
            session = (gnutls.connection
1190
1649
                       .ClientSession(self.request,
1191
1650
                                      gnutls.connection
1192
1651
                                      .X509Credentials()))
1193
 
 
 
1652
            
1194
1653
            # Note: gnutls.connection.X509Credentials is really a
1195
1654
            # generic GnuTLS certificate credentials object so long as
1196
1655
            # no X.509 keys are added to it.  Therefore, we can use it
1197
1656
            # here despite using OpenPGP certificates.
1198
 
 
 
1657
            
1199
1658
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1200
1659
            #                      "+AES-256-CBC", "+SHA1",
1201
1660
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1207
1666
            (gnutls.library.functions
1208
1667
             .gnutls_priority_set_direct(session._c_object,
1209
1668
                                         priority, None))
1210
 
 
 
1669
            
1211
1670
            # Start communication using the Mandos protocol
1212
1671
            # Get protocol number
1213
1672
            line = self.request.makefile().readline()
1218
1677
            except (ValueError, IndexError, RuntimeError) as error:
1219
1678
                logger.error("Unknown protocol version: %s", error)
1220
1679
                return
1221
 
 
 
1680
            
1222
1681
            # Start GnuTLS connection
1223
1682
            try:
1224
1683
                session.handshake()
1228
1687
                # established.  Just abandon the request.
1229
1688
                return
1230
1689
            logger.debug("Handshake succeeded")
1231
 
 
 
1690
            
1232
1691
            approval_required = False
1233
1692
            try:
1234
1693
                try:
1239
1698
                    logger.warning("Bad certificate: %s", error)
1240
1699
                    return
1241
1700
                logger.debug("Fingerprint: %s", fpr)
1242
 
 
 
1701
                
1243
1702
                try:
1244
1703
                    client = ProxyClient(child_pipe, fpr,
1245
1704
                                         self.client_address)
1257
1716
                                       client.name)
1258
1717
                        if self.server.use_dbus:
1259
1718
                            # Emit D-Bus signal
1260
 
                            client.Rejected("Disabled")                    
 
1719
                            client.Rejected("Disabled")
1261
1720
                        return
1262
1721
                    
1263
 
                    if client._approved or not client.approval_delay:
 
1722
                    if client.approved or not client.approval_delay:
1264
1723
                        #We are approved or approval is disabled
1265
1724
                        break
1266
 
                    elif client._approved is None:
 
1725
                    elif client.approved is None:
1267
1726
                        logger.info("Client %s needs approval",
1268
1727
                                    client.name)
1269
1728
                        if self.server.use_dbus:
1280
1739
                        return
1281
1740
                    
1282
1741
                    #wait until timeout or approved
1283
 
                    #x = float(client._timedelta_to_milliseconds(delay))
1284
1742
                    time = datetime.datetime.now()
1285
1743
                    client.changedstate.acquire()
1286
 
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
 
1744
                    client.changedstate.wait(
 
1745
                        float(timedelta_to_milliseconds(delay)
 
1746
                              / 1000))
1287
1747
                    client.changedstate.release()
1288
1748
                    time2 = datetime.datetime.now()
1289
1749
                    if (time2 - time) >= delay:
1305
1765
                    try:
1306
1766
                        sent = session.send(client.secret[sent_size:])
1307
1767
                    except gnutls.errors.GNUTLSError as error:
1308
 
                        logger.warning("gnutls send failed")
 
1768
                        logger.warning("gnutls send failed",
 
1769
                                       exc_info=error)
1309
1770
                        return
1310
1771
                    logger.debug("Sent: %d, remaining: %d",
1311
1772
                                 sent, len(client.secret)
1312
1773
                                 - (sent_size + sent))
1313
1774
                    sent_size += sent
1314
 
 
 
1775
                
1315
1776
                logger.info("Sending secret to %s", client.name)
1316
 
                # bump the timeout as if seen
1317
 
                client.checked_ok(client.extended_timeout)
 
1777
                # bump the timeout using extended_timeout
 
1778
                client.bump_timeout(client.extended_timeout)
1318
1779
                if self.server.use_dbus:
1319
1780
                    # Emit D-Bus signal
1320
1781
                    client.GotSecret()
1325
1786
                try:
1326
1787
                    session.bye()
1327
1788
                except gnutls.errors.GNUTLSError as error:
1328
 
                    logger.warning("GnuTLS bye failed")
 
1789
                    logger.warning("GnuTLS bye failed",
 
1790
                                   exc_info=error)
1329
1791
    
1330
1792
    @staticmethod
1331
1793
    def peer_certificate(session):
1387
1849
        # Convert the buffer to a Python bytestring
1388
1850
        fpr = ctypes.string_at(buf, buf_len.value)
1389
1851
        # Convert the bytestring to hexadecimal notation
1390
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
1852
        hex_fpr = binascii.hexlify(fpr).upper()
1391
1853
        return hex_fpr
1392
1854
 
1393
1855
 
1396
1858
    def sub_process_main(self, request, address):
1397
1859
        try:
1398
1860
            self.finish_request(request, address)
1399
 
        except:
 
1861
        except Exception:
1400
1862
            self.handle_error(request, address)
1401
1863
        self.close_request(request)
1402
 
            
 
1864
    
1403
1865
    def process_request(self, request, address):
1404
1866
        """Start a new process to process the request."""
1405
 
        multiprocessing.Process(target = self.sub_process_main,
1406
 
                                args = (request, address)).start()
 
1867
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1868
                                       args = (request, address))
 
1869
        proc.start()
 
1870
        return proc
 
1871
 
1407
1872
 
1408
1873
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1409
1874
    """ adds a pipe to the MixIn """
1413
1878
        This function creates a new pipe in self.pipe
1414
1879
        """
1415
1880
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1416
 
 
1417
 
        super(MultiprocessingMixInWithPipe,
1418
 
              self).process_request(request, client_address)
 
1881
        
 
1882
        proc = MultiprocessingMixIn.process_request(self, request,
 
1883
                                                    client_address)
1419
1884
        self.child_pipe.close()
1420
 
        self.add_pipe(parent_pipe)
1421
 
 
1422
 
    def add_pipe(self, parent_pipe):
 
1885
        self.add_pipe(parent_pipe, proc)
 
1886
    
 
1887
    def add_pipe(self, parent_pipe, proc):
1423
1888
        """Dummy function; override as necessary"""
1424
1889
        raise NotImplementedError
1425
1890
 
 
1891
 
1426
1892
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1427
1893
                     socketserver.TCPServer, object):
1428
1894
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
1433
1899
        use_ipv6:       Boolean; to use IPv6 or not
1434
1900
    """
1435
1901
    def __init__(self, server_address, RequestHandlerClass,
1436
 
                 interface=None, use_ipv6=True):
 
1902
                 interface=None, use_ipv6=True, socketfd=None):
 
1903
        """If socketfd is set, use that file descriptor instead of
 
1904
        creating a new one with socket.socket().
 
1905
        """
1437
1906
        self.interface = interface
1438
1907
        if use_ipv6:
1439
1908
            self.address_family = socket.AF_INET6
 
1909
        if socketfd is not None:
 
1910
            # Save the file descriptor
 
1911
            self.socketfd = socketfd
 
1912
            # Save the original socket.socket() function
 
1913
            self.socket_socket = socket.socket
 
1914
            # To implement --socket, we monkey patch socket.socket.
 
1915
            # 
 
1916
            # (When socketserver.TCPServer is a new-style class, we
 
1917
            # could make self.socket into a property instead of monkey
 
1918
            # patching socket.socket.)
 
1919
            # 
 
1920
            # Create a one-time-only replacement for socket.socket()
 
1921
            @functools.wraps(socket.socket)
 
1922
            def socket_wrapper(*args, **kwargs):
 
1923
                # Restore original function so subsequent calls are
 
1924
                # not affected.
 
1925
                socket.socket = self.socket_socket
 
1926
                del self.socket_socket
 
1927
                # This time only, return a new socket object from the
 
1928
                # saved file descriptor.
 
1929
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
1930
            # Replace socket.socket() function with wrapper
 
1931
            socket.socket = socket_wrapper
 
1932
        # The socketserver.TCPServer.__init__ will call
 
1933
        # socket.socket(), which might be our replacement,
 
1934
        # socket_wrapper(), if socketfd was set.
1440
1935
        socketserver.TCPServer.__init__(self, server_address,
1441
1936
                                        RequestHandlerClass)
 
1937
    
1442
1938
    def server_bind(self):
1443
1939
        """This overrides the normal server_bind() function
1444
1940
        to bind to an interface if one was specified, and also NOT to
1455
1951
                                           str(self.interface
1456
1952
                                               + '\0'))
1457
1953
                except socket.error as error:
1458
 
                    if error[0] == errno.EPERM:
 
1954
                    if error.errno == errno.EPERM:
1459
1955
                        logger.error("No permission to"
1460
1956
                                     " bind to interface %s",
1461
1957
                                     self.interface)
1462
 
                    elif error[0] == errno.ENOPROTOOPT:
 
1958
                    elif error.errno == errno.ENOPROTOOPT:
1463
1959
                        logger.error("SO_BINDTODEVICE not available;"
1464
1960
                                     " cannot bind to interface %s",
1465
1961
                                     self.interface)
 
1962
                    elif error.errno == errno.ENODEV:
 
1963
                        logger.error("Interface %s does not"
 
1964
                                     " exist, cannot bind",
 
1965
                                     self.interface)
1466
1966
                    else:
1467
1967
                        raise
1468
1968
        # Only bind(2) the socket if we really need to.
1498
1998
    """
1499
1999
    def __init__(self, server_address, RequestHandlerClass,
1500
2000
                 interface=None, use_ipv6=True, clients=None,
1501
 
                 gnutls_priority=None, use_dbus=True):
 
2001
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1502
2002
        self.enabled = False
1503
2003
        self.clients = clients
1504
2004
        if self.clients is None:
1505
 
            self.clients = set()
 
2005
            self.clients = {}
1506
2006
        self.use_dbus = use_dbus
1507
2007
        self.gnutls_priority = gnutls_priority
1508
2008
        IPv6_TCPServer.__init__(self, server_address,
1509
2009
                                RequestHandlerClass,
1510
2010
                                interface = interface,
1511
 
                                use_ipv6 = use_ipv6)
 
2011
                                use_ipv6 = use_ipv6,
 
2012
                                socketfd = socketfd)
1512
2013
    def server_activate(self):
1513
2014
        if self.enabled:
1514
2015
            return socketserver.TCPServer.server_activate(self)
 
2016
    
1515
2017
    def enable(self):
1516
2018
        self.enabled = True
1517
 
    def add_pipe(self, parent_pipe):
 
2019
    
 
2020
    def add_pipe(self, parent_pipe, proc):
1518
2021
        # Call "handle_ipc" for both data and EOF events
1519
2022
        gobject.io_add_watch(parent_pipe.fileno(),
1520
2023
                             gobject.IO_IN | gobject.IO_HUP,
1521
2024
                             functools.partial(self.handle_ipc,
1522
 
                                               parent_pipe = parent_pipe))
1523
 
        
 
2025
                                               parent_pipe =
 
2026
                                               parent_pipe,
 
2027
                                               proc = proc))
 
2028
    
1524
2029
    def handle_ipc(self, source, condition, parent_pipe=None,
1525
 
                   client_object=None):
1526
 
        condition_names = {
1527
 
            gobject.IO_IN: "IN",   # There is data to read.
1528
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1529
 
                                    # blocking).
1530
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1531
 
            gobject.IO_ERR: "ERR", # Error condition.
1532
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1533
 
                                    # broken, usually for pipes and
1534
 
                                    # sockets).
1535
 
            }
1536
 
        conditions_string = ' | '.join(name
1537
 
                                       for cond, name in
1538
 
                                       condition_names.iteritems()
1539
 
                                       if cond & condition)
1540
 
        # error or the other end of multiprocessing.Pipe has closed
1541
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2030
                   proc = None, client_object=None):
 
2031
        # error, or the other end of multiprocessing.Pipe has closed
 
2032
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2033
            # Wait for other process to exit
 
2034
            proc.join()
1542
2035
            return False
1543
2036
        
1544
2037
        # Read a request from the child
1549
2042
            fpr = request[1]
1550
2043
            address = request[2]
1551
2044
            
1552
 
            for c in self.clients:
 
2045
            for c in self.clients.itervalues():
1553
2046
                if c.fingerprint == fpr:
1554
2047
                    client = c
1555
2048
                    break
1558
2051
                            "dress: %s", fpr, address)
1559
2052
                if self.use_dbus:
1560
2053
                    # Emit D-Bus signal
1561
 
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
 
2054
                    mandos_dbus_service.ClientNotFound(fpr,
 
2055
                                                       address[0])
1562
2056
                parent_pipe.send(False)
1563
2057
                return False
1564
2058
            
1565
2059
            gobject.io_add_watch(parent_pipe.fileno(),
1566
2060
                                 gobject.IO_IN | gobject.IO_HUP,
1567
2061
                                 functools.partial(self.handle_ipc,
1568
 
                                                   parent_pipe = parent_pipe,
1569
 
                                                   client_object = client))
 
2062
                                                   parent_pipe =
 
2063
                                                   parent_pipe,
 
2064
                                                   proc = proc,
 
2065
                                                   client_object =
 
2066
                                                   client))
1570
2067
            parent_pipe.send(True)
1571
 
            # remove the old hook in favor of the new above hook on same fileno
 
2068
            # remove the old hook in favor of the new above hook on
 
2069
            # same fileno
1572
2070
            return False
1573
2071
        if command == 'funcall':
1574
2072
            funcname = request[1]
1575
2073
            args = request[2]
1576
2074
            kwargs = request[3]
1577
2075
            
1578
 
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1579
 
 
 
2076
            parent_pipe.send(('data', getattr(client_object,
 
2077
                                              funcname)(*args,
 
2078
                                                         **kwargs)))
 
2079
        
1580
2080
        if command == 'getattr':
1581
2081
            attrname = request[1]
1582
2082
            if callable(client_object.__getattribute__(attrname)):
1583
2083
                parent_pipe.send(('function',))
1584
2084
            else:
1585
 
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
 
2085
                parent_pipe.send(('data', client_object
 
2086
                                  .__getattribute__(attrname)))
1586
2087
        
1587
2088
        if command == 'setattr':
1588
2089
            attrname = request[1]
1589
2090
            value = request[2]
1590
2091
            setattr(client_object, attrname, value)
1591
 
 
 
2092
        
1592
2093
        return True
1593
2094
 
1594
2095
 
1624
2125
            elif suffix == "w":
1625
2126
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1626
2127
            else:
1627
 
                raise ValueError("Unknown suffix %r" % suffix)
 
2128
                raise ValueError("Unknown suffix {0!r}"
 
2129
                                 .format(suffix))
1628
2130
        except (ValueError, IndexError) as e:
1629
2131
            raise ValueError(*(e.args))
1630
2132
        timevalue += delta
1631
2133
    return timevalue
1632
2134
 
1633
2135
 
1634
 
def if_nametoindex(interface):
1635
 
    """Call the C function if_nametoindex(), or equivalent
1636
 
    
1637
 
    Note: This function cannot accept a unicode string."""
1638
 
    global if_nametoindex
1639
 
    try:
1640
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1641
 
                          (ctypes.util.find_library("c"))
1642
 
                          .if_nametoindex)
1643
 
    except (OSError, AttributeError):
1644
 
        logger.warning("Doing if_nametoindex the hard way")
1645
 
        def if_nametoindex(interface):
1646
 
            "Get an interface index the hard way, i.e. using fcntl()"
1647
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1648
 
            with contextlib.closing(socket.socket()) as s:
1649
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1650
 
                                    struct.pack(str("16s16x"),
1651
 
                                                interface))
1652
 
            interface_index = struct.unpack(str("I"),
1653
 
                                            ifreq[16:20])[0]
1654
 
            return interface_index
1655
 
    return if_nametoindex(interface)
1656
 
 
1657
 
 
1658
2136
def daemon(nochdir = False, noclose = False):
1659
2137
    """See daemon(3).  Standard BSD Unix function.
1660
2138
    
1668
2146
        sys.exit()
1669
2147
    if not noclose:
1670
2148
        # Close all standard open file descriptors
1671
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2149
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1672
2150
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1673
2151
            raise OSError(errno.ENODEV,
1674
 
                          "%s not a character device"
1675
 
                          % os.path.devnull)
 
2152
                          "{0} not a character device"
 
2153
                          .format(os.devnull))
1676
2154
        os.dup2(null, sys.stdin.fileno())
1677
2155
        os.dup2(null, sys.stdout.fileno())
1678
2156
        os.dup2(null, sys.stderr.fileno())
1687
2165
    
1688
2166
    parser = argparse.ArgumentParser()
1689
2167
    parser.add_argument("-v", "--version", action="version",
1690
 
                        version = "%%(prog)s %s" % version,
 
2168
                        version = "%(prog)s {0}".format(version),
1691
2169
                        help="show version number and exit")
1692
2170
    parser.add_argument("-i", "--interface", metavar="IF",
1693
2171
                        help="Bind to interface IF")
1715
2193
                        " system bus interface")
1716
2194
    parser.add_argument("--no-ipv6", action="store_false",
1717
2195
                        dest="use_ipv6", help="Do not use IPv6")
 
2196
    parser.add_argument("--no-restore", action="store_false",
 
2197
                        dest="restore", help="Do not restore stored"
 
2198
                        " state")
 
2199
    parser.add_argument("--socket", type=int,
 
2200
                        help="Specify a file descriptor to a network"
 
2201
                        " socket to use instead of creating one")
 
2202
    parser.add_argument("--statedir", metavar="DIR",
 
2203
                        help="Directory to save/restore state in")
 
2204
    
1718
2205
    options = parser.parse_args()
1719
2206
    
1720
2207
    if options.check:
1733
2220
                        "use_dbus": "True",
1734
2221
                        "use_ipv6": "True",
1735
2222
                        "debuglevel": "",
 
2223
                        "restore": "True",
 
2224
                        "socket": "",
 
2225
                        "statedir": "/var/lib/mandos"
1736
2226
                        }
1737
2227
    
1738
2228
    # Parse config file for server-global settings
1749
2239
    if server_settings["port"]:
1750
2240
        server_settings["port"] = server_config.getint("DEFAULT",
1751
2241
                                                       "port")
 
2242
    if server_settings["socket"]:
 
2243
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2244
                                                         "socket")
 
2245
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2246
        # over with an opened os.devnull.  But we don't want this to
 
2247
        # happen with a supplied network socket.
 
2248
        if 0 <= server_settings["socket"] <= 2:
 
2249
            server_settings["socket"] = os.dup(server_settings
 
2250
                                               ["socket"])
1752
2251
    del server_config
1753
2252
    
1754
2253
    # Override the settings from the config file with command line
1755
2254
    # options, if set.
1756
2255
    for option in ("interface", "address", "port", "debug",
1757
2256
                   "priority", "servicename", "configdir",
1758
 
                   "use_dbus", "use_ipv6", "debuglevel"):
 
2257
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2258
                   "statedir", "socket"):
1759
2259
        value = getattr(options, option)
1760
2260
        if value is not None:
1761
2261
            server_settings[option] = value
1773
2273
    debuglevel = server_settings["debuglevel"]
1774
2274
    use_dbus = server_settings["use_dbus"]
1775
2275
    use_ipv6 = server_settings["use_ipv6"]
1776
 
 
 
2276
    stored_state_path = os.path.join(server_settings["statedir"],
 
2277
                                     stored_state_file)
 
2278
    
 
2279
    if debug:
 
2280
        initlogger(debug, logging.DEBUG)
 
2281
    else:
 
2282
        if not debuglevel:
 
2283
            initlogger(debug)
 
2284
        else:
 
2285
            level = getattr(logging, debuglevel.upper())
 
2286
            initlogger(debug, level)
 
2287
    
1777
2288
    if server_settings["servicename"] != "Mandos":
1778
2289
        syslogger.setFormatter(logging.Formatter
1779
 
                               ('Mandos (%s) [%%(process)d]:'
1780
 
                                ' %%(levelname)s: %%(message)s'
1781
 
                                % server_settings["servicename"]))
 
2290
                               ('Mandos ({0}) [%(process)d]:'
 
2291
                                ' %(levelname)s: %(message)s'
 
2292
                                .format(server_settings
 
2293
                                        ["servicename"])))
1782
2294
    
1783
2295
    # Parse config file with clients
1784
 
    client_defaults = { "timeout": "5m",
1785
 
                        "extended_timeout": "15m",
1786
 
                        "interval": "2m",
1787
 
                        "checker": "fping -q -- %%(host)s",
1788
 
                        "host": "",
1789
 
                        "approval_delay": "0s",
1790
 
                        "approval_duration": "1s",
1791
 
                        }
1792
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2296
    client_config = configparser.SafeConfigParser(Client
 
2297
                                                  .client_defaults)
1793
2298
    client_config.read(os.path.join(server_settings["configdir"],
1794
2299
                                    "clients.conf"))
1795
2300
    
1804
2309
                              use_ipv6=use_ipv6,
1805
2310
                              gnutls_priority=
1806
2311
                              server_settings["priority"],
1807
 
                              use_dbus=use_dbus)
 
2312
                              use_dbus=use_dbus,
 
2313
                              socketfd=(server_settings["socket"]
 
2314
                                        or None))
1808
2315
    if not debug:
1809
2316
        pidfilename = "/var/run/mandos.pid"
1810
2317
        try:
1811
2318
            pidfile = open(pidfilename, "w")
1812
 
        except IOError:
1813
 
            logger.error("Could not open file %r", pidfilename)
 
2319
        except IOError as e:
 
2320
            logger.error("Could not open file %r", pidfilename,
 
2321
                         exc_info=e)
1814
2322
    
1815
 
    try:
1816
 
        uid = pwd.getpwnam("_mandos").pw_uid
1817
 
        gid = pwd.getpwnam("_mandos").pw_gid
1818
 
    except KeyError:
 
2323
    for name in ("_mandos", "mandos", "nobody"):
1819
2324
        try:
1820
 
            uid = pwd.getpwnam("mandos").pw_uid
1821
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2325
            uid = pwd.getpwnam(name).pw_uid
 
2326
            gid = pwd.getpwnam(name).pw_gid
 
2327
            break
1822
2328
        except KeyError:
1823
 
            try:
1824
 
                uid = pwd.getpwnam("nobody").pw_uid
1825
 
                gid = pwd.getpwnam("nobody").pw_gid
1826
 
            except KeyError:
1827
 
                uid = 65534
1828
 
                gid = 65534
 
2329
            continue
 
2330
    else:
 
2331
        uid = 65534
 
2332
        gid = 65534
1829
2333
    try:
1830
2334
        os.setgid(gid)
1831
2335
        os.setuid(uid)
1832
2336
    except OSError as error:
1833
 
        if error[0] != errno.EPERM:
 
2337
        if error.errno != errno.EPERM:
1834
2338
            raise error
1835
2339
    
1836
 
    if not debug and not debuglevel:
1837
 
        syslogger.setLevel(logging.WARNING)
1838
 
        console.setLevel(logging.WARNING)
1839
 
    if debuglevel:
1840
 
        level = getattr(logging, debuglevel.upper())
1841
 
        syslogger.setLevel(level)
1842
 
        console.setLevel(level)
1843
 
 
1844
2340
    if debug:
1845
2341
        # Enable all possible GnuTLS debugging
1846
2342
        
1856
2352
         .gnutls_global_set_log_function(debug_gnutls))
1857
2353
        
1858
2354
        # Redirect stdin so all checkers get /dev/null
1859
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2355
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1860
2356
        os.dup2(null, sys.stdin.fileno())
1861
2357
        if null > 2:
1862
2358
            os.close(null)
1863
 
    else:
1864
 
        # No console logging
1865
 
        logger.removeHandler(console)
1866
2359
    
1867
2360
    # Need to fork before connecting to D-Bus
1868
2361
    if not debug:
1869
2362
        # Close all input and output, do double fork, etc.
1870
2363
        daemon()
1871
2364
    
 
2365
    # multiprocessing will use threads, so before we use gobject we
 
2366
    # need to inform gobject that threads will be used.
 
2367
    gobject.threads_init()
 
2368
    
1872
2369
    global main_loop
1873
2370
    # From the Avahi example code
1874
 
    DBusGMainLoop(set_as_default=True )
 
2371
    DBusGMainLoop(set_as_default=True)
1875
2372
    main_loop = gobject.MainLoop()
1876
2373
    bus = dbus.SystemBus()
1877
2374
    # End of Avahi example code
1878
2375
    if use_dbus:
1879
2376
        try:
1880
 
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
 
2377
            bus_name = dbus.service.BusName("se.recompile.Mandos",
1881
2378
                                            bus, do_not_queue=True)
 
2379
            old_bus_name = (dbus.service.BusName
 
2380
                            ("se.bsnet.fukt.Mandos", bus,
 
2381
                             do_not_queue=True))
1882
2382
        except dbus.exceptions.NameExistsException as e:
1883
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2383
            logger.error("Disabling D-Bus:", exc_info=e)
1884
2384
            use_dbus = False
1885
2385
            server_settings["use_dbus"] = False
1886
2386
            tcp_server.use_dbus = False
1887
2387
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1888
 
    service = AvahiService(name = server_settings["servicename"],
1889
 
                           servicetype = "_mandos._tcp",
1890
 
                           protocol = protocol, bus = bus)
 
2388
    service = AvahiServiceToSyslog(name =
 
2389
                                   server_settings["servicename"],
 
2390
                                   servicetype = "_mandos._tcp",
 
2391
                                   protocol = protocol, bus = bus)
1891
2392
    if server_settings["interface"]:
1892
2393
        service.interface = (if_nametoindex
1893
2394
                             (str(server_settings["interface"])))
1898
2399
    client_class = Client
1899
2400
    if use_dbus:
1900
2401
        client_class = functools.partial(ClientDBus, bus = bus)
1901
 
    def client_config_items(config, section):
1902
 
        special_settings = {
1903
 
            "approved_by_default":
1904
 
                lambda: config.getboolean(section,
1905
 
                                          "approved_by_default"),
1906
 
            }
1907
 
        for name, value in config.items(section):
 
2402
    
 
2403
    client_settings = Client.config_parser(client_config)
 
2404
    old_client_settings = {}
 
2405
    clients_data = {}
 
2406
    
 
2407
    # Get client data and settings from last running state.
 
2408
    if server_settings["restore"]:
 
2409
        try:
 
2410
            with open(stored_state_path, "rb") as stored_state:
 
2411
                clients_data, old_client_settings = (pickle.load
 
2412
                                                     (stored_state))
 
2413
            os.remove(stored_state_path)
 
2414
        except IOError as e:
 
2415
            if e.errno == errno.ENOENT:
 
2416
                logger.warning("Could not load persistent state: {0}"
 
2417
                                .format(os.strerror(e.errno)))
 
2418
            else:
 
2419
                logger.critical("Could not load persistent state:",
 
2420
                                exc_info=e)
 
2421
                raise
 
2422
        except EOFError as e:
 
2423
            logger.warning("Could not load persistent state: "
 
2424
                           "EOFError:", exc_info=e)
 
2425
    
 
2426
    with PGPEngine() as pgp:
 
2427
        for client_name, client in clients_data.iteritems():
 
2428
            # Decide which value to use after restoring saved state.
 
2429
            # We have three different values: Old config file,
 
2430
            # new config file, and saved state.
 
2431
            # New config value takes precedence if it differs from old
 
2432
            # config value, otherwise use saved state.
 
2433
            for name, value in client_settings[client_name].items():
 
2434
                try:
 
2435
                    # For each value in new config, check if it
 
2436
                    # differs from the old config value (Except for
 
2437
                    # the "secret" attribute)
 
2438
                    if (name != "secret" and
 
2439
                        value != old_client_settings[client_name]
 
2440
                        [name]):
 
2441
                        client[name] = value
 
2442
                except KeyError:
 
2443
                    pass
 
2444
            
 
2445
            # Clients who has passed its expire date can still be
 
2446
            # enabled if its last checker was successful.  Clients
 
2447
            # whose checker succeeded before we stored its state is
 
2448
            # assumed to have successfully run all checkers during
 
2449
            # downtime.
 
2450
            if client["enabled"]:
 
2451
                if datetime.datetime.utcnow() >= client["expires"]:
 
2452
                    if not client["last_checked_ok"]:
 
2453
                        logger.warning(
 
2454
                            "disabling client {0} - Client never "
 
2455
                            "performed a successful checker"
 
2456
                            .format(client_name))
 
2457
                        client["enabled"] = False
 
2458
                    elif client["last_checker_status"] != 0:
 
2459
                        logger.warning(
 
2460
                            "disabling client {0} - Client "
 
2461
                            "last checker failed with error code {1}"
 
2462
                            .format(client_name,
 
2463
                                    client["last_checker_status"]))
 
2464
                        client["enabled"] = False
 
2465
                    else:
 
2466
                        client["expires"] = (datetime.datetime
 
2467
                                             .utcnow()
 
2468
                                             + client["timeout"])
 
2469
                        logger.debug("Last checker succeeded,"
 
2470
                                     " keeping {0} enabled"
 
2471
                                     .format(client_name))
1908
2472
            try:
1909
 
                yield (name, special_settings[name]())
1910
 
            except KeyError:
1911
 
                yield (name, value)
1912
 
    
1913
 
    tcp_server.clients.update(set(
1914
 
            client_class(name = section,
1915
 
                         config= dict(client_config_items(
1916
 
                        client_config, section)))
1917
 
            for section in client_config.sections()))
 
2473
                client["secret"] = (
 
2474
                    pgp.decrypt(client["encrypted_secret"],
 
2475
                                client_settings[client_name]
 
2476
                                ["secret"]))
 
2477
            except PGPError:
 
2478
                # If decryption fails, we use secret from new settings
 
2479
                logger.debug("Failed to decrypt {0} old secret"
 
2480
                             .format(client_name))
 
2481
                client["secret"] = (
 
2482
                    client_settings[client_name]["secret"])
 
2483
    
 
2484
    # Add/remove clients based on new changes made to config
 
2485
    for client_name in (set(old_client_settings)
 
2486
                        - set(client_settings)):
 
2487
        del clients_data[client_name]
 
2488
    for client_name in (set(client_settings)
 
2489
                        - set(old_client_settings)):
 
2490
        clients_data[client_name] = client_settings[client_name]
 
2491
    
 
2492
    # Create all client objects
 
2493
    for client_name, client in clients_data.iteritems():
 
2494
        tcp_server.clients[client_name] = client_class(
 
2495
            name = client_name, settings = client)
 
2496
    
1918
2497
    if not tcp_server.clients:
1919
2498
        logger.warning("No clients defined")
1920
 
        
 
2499
    
1921
2500
    if not debug:
1922
2501
        try:
1923
2502
            with pidfile:
1931
2510
            # "pidfile" was never created
1932
2511
            pass
1933
2512
        del pidfilename
1934
 
        
1935
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
1936
 
 
 
2513
    
1937
2514
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1938
2515
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1939
2516
    
1940
2517
    if use_dbus:
1941
 
        class MandosDBusService(dbus.service.Object):
 
2518
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2519
                                        "se.bsnet.fukt.Mandos"})
 
2520
        class MandosDBusService(DBusObjectWithProperties):
1942
2521
            """A D-Bus proxy object"""
1943
2522
            def __init__(self):
1944
2523
                dbus.service.Object.__init__(self, bus, "/")
1945
 
            _interface = "se.bsnet.fukt.Mandos"
 
2524
            _interface = "se.recompile.Mandos"
 
2525
            
 
2526
            @dbus_interface_annotations(_interface)
 
2527
            def _foo(self):
 
2528
                return { "org.freedesktop.DBus.Property"
 
2529
                         ".EmitsChangedSignal":
 
2530
                             "false"}
1946
2531
            
1947
2532
            @dbus.service.signal(_interface, signature="o")
1948
2533
            def ClientAdded(self, objpath):
1963
2548
            def GetAllClients(self):
1964
2549
                "D-Bus method"
1965
2550
                return dbus.Array(c.dbus_object_path
1966
 
                                  for c in tcp_server.clients)
 
2551
                                  for c in
 
2552
                                  tcp_server.clients.itervalues())
1967
2553
            
1968
2554
            @dbus.service.method(_interface,
1969
2555
                                 out_signature="a{oa{sv}}")
1971
2557
                "D-Bus method"
1972
2558
                return dbus.Dictionary(
1973
2559
                    ((c.dbus_object_path, c.GetAll(""))
1974
 
                     for c in tcp_server.clients),
 
2560
                     for c in tcp_server.clients.itervalues()),
1975
2561
                    signature="oa{sv}")
1976
2562
            
1977
2563
            @dbus.service.method(_interface, in_signature="o")
1978
2564
            def RemoveClient(self, object_path):
1979
2565
                "D-Bus method"
1980
 
                for c in tcp_server.clients:
 
2566
                for c in tcp_server.clients.itervalues():
1981
2567
                    if c.dbus_object_path == object_path:
1982
 
                        tcp_server.clients.remove(c)
 
2568
                        del tcp_server.clients[c.name]
1983
2569
                        c.remove_from_connection()
1984
2570
                        # Don't signal anything except ClientRemoved
1985
2571
                        c.disable(quiet=True)
1996
2582
        "Cleanup function; run on exit"
1997
2583
        service.cleanup()
1998
2584
        
 
2585
        multiprocessing.active_children()
 
2586
        if not (tcp_server.clients or client_settings):
 
2587
            return
 
2588
        
 
2589
        # Store client before exiting. Secrets are encrypted with key
 
2590
        # based on what config file has. If config file is
 
2591
        # removed/edited, old secret will thus be unrecovable.
 
2592
        clients = {}
 
2593
        with PGPEngine() as pgp:
 
2594
            for client in tcp_server.clients.itervalues():
 
2595
                key = client_settings[client.name]["secret"]
 
2596
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2597
                                                      key)
 
2598
                client_dict = {}
 
2599
                
 
2600
                # A list of attributes that can not be pickled
 
2601
                # + secret.
 
2602
                exclude = set(("bus", "changedstate", "secret",
 
2603
                               "checker"))
 
2604
                for name, typ in (inspect.getmembers
 
2605
                                  (dbus.service.Object)):
 
2606
                    exclude.add(name)
 
2607
                
 
2608
                client_dict["encrypted_secret"] = (client
 
2609
                                                   .encrypted_secret)
 
2610
                for attr in client.client_structure:
 
2611
                    if attr not in exclude:
 
2612
                        client_dict[attr] = getattr(client, attr)
 
2613
                
 
2614
                clients[client.name] = client_dict
 
2615
                del client_settings[client.name]["secret"]
 
2616
        
 
2617
        try:
 
2618
            with (tempfile.NamedTemporaryFile
 
2619
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2620
                   dir=os.path.dirname(stored_state_path),
 
2621
                   delete=False)) as stored_state:
 
2622
                pickle.dump((clients, client_settings), stored_state)
 
2623
                tempname=stored_state.name
 
2624
            os.rename(tempname, stored_state_path)
 
2625
        except (IOError, OSError) as e:
 
2626
            if not debug:
 
2627
                try:
 
2628
                    os.remove(tempname)
 
2629
                except NameError:
 
2630
                    pass
 
2631
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2632
                logger.warning("Could not save persistent state: {0}"
 
2633
                               .format(os.strerror(e.errno)))
 
2634
            else:
 
2635
                logger.warning("Could not save persistent state:",
 
2636
                               exc_info=e)
 
2637
                raise e
 
2638
        
 
2639
        # Delete all clients, and settings from config
1999
2640
        while tcp_server.clients:
2000
 
            client = tcp_server.clients.pop()
 
2641
            name, client = tcp_server.clients.popitem()
2001
2642
            if use_dbus:
2002
2643
                client.remove_from_connection()
2003
 
            client.disable_hook = None
2004
2644
            # Don't signal anything except ClientRemoved
2005
2645
            client.disable(quiet=True)
2006
2646
            if use_dbus:
2007
2647
                # Emit D-Bus signal
2008
 
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
 
2648
                mandos_dbus_service.ClientRemoved(client
 
2649
                                                  .dbus_object_path,
2009
2650
                                                  client.name)
 
2651
        client_settings.clear()
2010
2652
    
2011
2653
    atexit.register(cleanup)
2012
2654
    
2013
 
    for client in tcp_server.clients:
 
2655
    for client in tcp_server.clients.itervalues():
2014
2656
        if use_dbus:
2015
2657
            # Emit D-Bus signal
2016
2658
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2017
 
        client.enable()
 
2659
        # Need to initiate checking of clients
 
2660
        if client.enabled:
 
2661
            client.init_checker()
2018
2662
    
2019
2663
    tcp_server.enable()
2020
2664
    tcp_server.server_activate()
2023
2667
    service.port = tcp_server.socket.getsockname()[1]
2024
2668
    if use_ipv6:
2025
2669
        logger.info("Now listening on address %r, port %d,"
2026
 
                    " flowinfo %d, scope_id %d"
2027
 
                    % tcp_server.socket.getsockname())
 
2670
                    " flowinfo %d, scope_id %d",
 
2671
                    *tcp_server.socket.getsockname())
2028
2672
    else:                       # IPv4
2029
 
        logger.info("Now listening on address %r, port %d"
2030
 
                    % tcp_server.socket.getsockname())
 
2673
        logger.info("Now listening on address %r, port %d",
 
2674
                    *tcp_server.socket.getsockname())
2031
2675
    
2032
2676
    #service.interface = tcp_server.socket.getsockname()[3]
2033
2677
    
2036
2680
        try:
2037
2681
            service.activate()
2038
2682
        except dbus.exceptions.DBusException as error:
2039
 
            logger.critical("DBusException: %s", error)
 
2683
            logger.critical("D-Bus Exception", exc_info=error)
2040
2684
            cleanup()
2041
2685
            sys.exit(1)
2042
2686
        # End of Avahi example code
2049
2693
        logger.debug("Starting main loop")
2050
2694
        main_loop.run()
2051
2695
    except AvahiError as error:
2052
 
        logger.critical("AvahiError: %s", error)
 
2696
        logger.critical("Avahi Error", exc_info=error)
2053
2697
        cleanup()
2054
2698
        sys.exit(1)
2055
2699
    except KeyboardInterrupt: