/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2011 Teddy Hogeborn
15
 
# Copyright © 2008-2011 Björn Påhlsson
 
14
# Copyright © 2008-2012 Teddy Hogeborn
 
15
# Copyright © 2008-2012 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
28
28
# along with this program.  If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
31
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
31
# Contact the authors at <mandos@recompile.se>.
32
32
33
33
 
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
 
37
from future_builtins import *
 
38
 
37
39
import SocketServer as socketserver
38
40
import socket
39
41
import argparse
62
64
import functools
63
65
import cPickle as pickle
64
66
import multiprocessing
 
67
import types
 
68
import binascii
 
69
import tempfile
 
70
import itertools
65
71
 
66
72
import dbus
67
73
import dbus.service
72
78
import ctypes.util
73
79
import xml.dom.minidom
74
80
import inspect
 
81
import GnuPGInterface
75
82
 
76
83
try:
77
84
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
81
88
    except ImportError:
82
89
        SO_BINDTODEVICE = None
83
90
 
84
 
 
85
 
version = "1.3.0"
86
 
 
87
 
#logger = logging.getLogger('mandos')
88
 
logger = logging.Logger('mandos')
 
91
version = "1.6.0"
 
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
 
        if self.group is not None:
180
 
            try:
181
 
                self.group.Free()
182
 
            except (dbus.exceptions.UnknownMethodException,
183
 
                    dbus.exceptions.DBusException) as e:
184
 
                pass
185
 
            self.group = None
186
290
        if self.entry_group_state_changed_match is not None:
187
291
            self.entry_group_state_changed_match.remove()
188
292
            self.entry_group_state_changed_match = None
 
293
        if self.group is not None:
 
294
            self.group.Reset()
 
295
    
189
296
    def add(self):
190
297
        """Derived from the Avahi example code"""
191
298
        self.remove()
192
 
        self.group = dbus.Interface(
193
 
            self.bus.get_object(avahi.DBUS_NAME,
194
 
                                self.server.EntryGroupNew(),
195
 
                                follow_name_owner_changes=True),
196
 
            avahi.DBUS_INTERFACE_ENTRY_GROUP)
 
299
        if self.group is None:
 
300
            self.group = dbus.Interface(
 
301
                self.bus.get_object(avahi.DBUS_NAME,
 
302
                                    self.server.EntryGroupNew()),
 
303
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
197
304
        self.entry_group_state_changed_match = (
198
305
            self.group.connect_to_signal(
199
 
                'StateChanged', self .entry_group_state_changed))
 
306
                'StateChanged', self.entry_group_state_changed))
200
307
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
201
308
                     self.name, self.type)
202
309
        self.group.AddService(
208
315
            dbus.UInt16(self.port),
209
316
            avahi.string_array_to_txt_array(self.TXT))
210
317
        self.group.Commit()
 
318
    
211
319
    def entry_group_state_changed(self, state, error):
212
320
        """Derived from the Avahi example code"""
213
321
        logger.debug("Avahi entry group state change: %i", state)
220
328
        elif state == avahi.ENTRY_GROUP_FAILURE:
221
329
            logger.critical("Avahi: Error in group state changed %s",
222
330
                            unicode(error))
223
 
            raise AvahiGroupError("State changed: %s"
224
 
                                  % unicode(error))
 
331
            raise AvahiGroupError("State changed: {0!s}"
 
332
                                  .format(error))
 
333
    
225
334
    def cleanup(self):
226
335
        """Derived from the Avahi example code"""
 
336
        if self.group is not None:
 
337
            try:
 
338
                self.group.Free()
 
339
            except (dbus.exceptions.UnknownMethodException,
 
340
                    dbus.exceptions.DBusException):
 
341
                pass
 
342
            self.group = None
227
343
        self.remove()
 
344
    
228
345
    def server_state_changed(self, state, error=None):
229
346
        """Derived from the Avahi example code"""
230
347
        logger.debug("Avahi server state change: %i", state)
236
353
                       avahi.SERVER_FAILURE:
237
354
                           "Zeroconf server failure" }
238
355
        if state in bad_states:
239
 
            if bad_states[state]:
240
 
                logger.error(bad_states[state])
241
 
            self.remove()
 
356
            if bad_states[state] is not None:
 
357
                if error is None:
 
358
                    logger.error(bad_states[state])
 
359
                else:
 
360
                    logger.error(bad_states[state] + ": %r", error)
 
361
            self.cleanup()
242
362
        elif state == avahi.SERVER_RUNNING:
243
363
            self.add()
244
364
        else:
245
 
            logger.debug("Unknown state: %r", state)
 
365
            if error is None:
 
366
                logger.debug("Unknown state: %r", state)
 
367
            else:
 
368
                logger.debug("Unknown state: %r: %r", state, error)
 
369
    
246
370
    def activate(self):
247
371
        """Derived from the Avahi example code"""
248
372
        if self.server is None:
256
380
        self.server_state_changed(self.server.GetState())
257
381
 
258
382
 
 
383
class AvahiServiceToSyslog(AvahiService):
 
384
    def rename(self):
 
385
        """Add the new name to the syslog messages"""
 
386
        ret = AvahiService.rename(self)
 
387
        syslogger.setFormatter(logging.Formatter
 
388
                               ('Mandos ({0}) [%(process)d]:'
 
389
                                ' %(levelname)s: %(message)s'
 
390
                                .format(self.name)))
 
391
        return ret
 
392
 
 
393
 
 
394
def timedelta_to_milliseconds(td):
 
395
    "Convert a datetime.timedelta() to milliseconds"
 
396
    return ((td.days * 24 * 60 * 60 * 1000)
 
397
            + (td.seconds * 1000)
 
398
            + (td.microseconds // 1000))
 
399
 
 
400
 
259
401
class Client(object):
260
402
    """A representation of a client host served by this server.
261
403
    
262
404
    Attributes:
263
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
405
    approved:   bool(); 'None' if not yet approved/disapproved
264
406
    approval_delay: datetime.timedelta(); Time to wait for approval
265
407
    approval_duration: datetime.timedelta(); Duration of one approval
266
408
    checker:    subprocess.Popen(); a running checker process used
273
415
                     instance %(name)s can be used in the command.
274
416
    checker_initiator_tag: a gobject event source tag, or None
275
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
276
420
    current_checker_command: string; current running checker_command
277
 
    disable_hook:  If set, called by disable() as disable_hook(self)
278
421
    disable_initiator_tag: a gobject event source tag, or None
279
422
    enabled:    bool()
280
423
    fingerprint: string (40 or 32 hexadecimal digits); used to
283
426
    interval:   datetime.timedelta(); How often to start a new checker
284
427
    last_approval_request: datetime.datetime(); (UTC) or None
285
428
    last_checked_ok: datetime.datetime(); (UTC) or None
286
 
    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
287
433
    name:       string; from the config file, used in log messages and
288
434
                        D-Bus identifiers
289
435
    secret:     bytestring; sent verbatim (over TLS) to client
290
436
    timeout:    datetime.timedelta(); How long from last_checked_ok
291
437
                                      until this client is disabled
 
438
    extended_timeout:   extra long timeout when secret has been sent
292
439
    runtime_expansions: Allowed attributes for runtime expansion.
 
440
    expires:    datetime.datetime(); time (UTC) when a client will be
 
441
                disabled, or None
293
442
    """
294
443
    
295
444
    runtime_expansions = ("approval_delay", "approval_duration",
296
 
                          "created", "enabled", "fingerprint",
297
 
                          "host", "interval", "last_checked_ok",
 
445
                          "created", "enabled", "expires",
 
446
                          "fingerprint", "host", "interval",
 
447
                          "last_approval_request", "last_checked_ok",
298
448
                          "last_enabled", "name", "timeout")
299
 
    
300
 
    @staticmethod
301
 
    def _timedelta_to_milliseconds(td):
302
 
        "Convert a datetime.timedelta() to milliseconds"
303
 
        return ((td.days * 24 * 60 * 60 * 1000)
304
 
                + (td.seconds * 1000)
305
 
                + (td.microseconds // 1000))
 
449
    client_defaults = { "timeout": "5m",
 
450
                        "extended_timeout": "15m",
 
451
                        "interval": "2m",
 
452
                        "checker": "fping -q -- %%(host)s",
 
453
                        "host": "",
 
454
                        "approval_delay": "0s",
 
455
                        "approval_duration": "1s",
 
456
                        "approved_by_default": "True",
 
457
                        "enabled": "True",
 
458
                        }
306
459
    
307
460
    def timeout_milliseconds(self):
308
461
        "Return the 'timeout' attribute in milliseconds"
309
 
        return self._timedelta_to_milliseconds(self.timeout)
 
462
        return timedelta_to_milliseconds(self.timeout)
 
463
    
 
464
    def extended_timeout_milliseconds(self):
 
465
        "Return the 'extended_timeout' attribute in milliseconds"
 
466
        return timedelta_to_milliseconds(self.extended_timeout)
310
467
    
311
468
    def interval_milliseconds(self):
312
469
        "Return the 'interval' attribute in milliseconds"
313
 
        return self._timedelta_to_milliseconds(self.interval)
314
 
 
 
470
        return timedelta_to_milliseconds(self.interval)
 
471
    
315
472
    def approval_delay_milliseconds(self):
316
 
        return self._timedelta_to_milliseconds(self.approval_delay)
317
 
    
318
 
    def __init__(self, name = None, disable_hook=None, config=None):
319
 
        """Note: the 'checker' key in 'config' sets the
320
 
        'checker_command' attribute and *not* the 'checker'
321
 
        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):
322
523
        self.name = name
323
 
        if config is None:
324
 
            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
        
325
538
        logger.debug("Creating client %r", self.name)
326
539
        # Uppercase and remove spaces from fingerprint for later
327
540
        # comparison purposes with return value from the fingerprint()
328
541
        # function
329
 
        self.fingerprint = (config["fingerprint"].upper()
330
 
                            .replace(" ", ""))
331
542
        logger.debug("  Fingerprint: %s", self.fingerprint)
332
 
        if "secret" in config:
333
 
            self.secret = config["secret"].decode("base64")
334
 
        elif "secfile" in config:
335
 
            with open(os.path.expanduser(os.path.expandvars
336
 
                                         (config["secfile"])),
337
 
                      "rb") as secfile:
338
 
                self.secret = secfile.read()
339
 
        else:
340
 
            raise TypeError("No secret or secfile for client %s"
341
 
                            % self.name)
342
 
        self.host = config.get("host", "")
343
 
        self.created = datetime.datetime.utcnow()
344
 
        self.enabled = False
345
 
        self.last_approval_request = None
346
 
        self.last_enabled = None
347
 
        self.last_checked_ok = None
348
 
        self.timeout = string_to_delta(config["timeout"])
349
 
        self.interval = string_to_delta(config["interval"])
350
 
        self.disable_hook = disable_hook
 
543
        self.created = settings.get("created",
 
544
                                    datetime.datetime.utcnow())
 
545
        
 
546
        # attributes specific for this server instance
351
547
        self.checker = None
352
548
        self.checker_initiator_tag = None
353
549
        self.disable_initiator_tag = None
354
550
        self.checker_callback_tag = None
355
 
        self.checker_command = config["checker"]
356
551
        self.current_checker_command = None
357
 
        self.last_connect = None
358
 
        self._approved = None
359
 
        self.approved_by_default = config.get("approved_by_default",
360
 
                                              True)
 
552
        self.approved = None
361
553
        self.approvals_pending = 0
362
 
        self.approval_delay = string_to_delta(
363
 
            config["approval_delay"])
364
 
        self.approval_duration = string_to_delta(
365
 
            config["approval_duration"])
366
 
        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)
367
568
    
 
569
    # Send notice to process children that client state has changed
368
570
    def send_changedstate(self):
369
 
        self.changedstate.acquire()
370
 
        self.changedstate.notify_all()
371
 
        self.changedstate.release()
372
 
        
 
571
        with self.changedstate:
 
572
            self.changedstate.notify_all()
 
573
    
373
574
    def enable(self):
374
575
        """Start this client's checker and timeout hooks"""
375
576
        if getattr(self, "enabled", False):
376
577
            # Already enabled
377
578
            return
378
 
        self.send_changedstate()
 
579
        self.expires = datetime.datetime.utcnow() + self.timeout
 
580
        self.enabled = True
379
581
        self.last_enabled = datetime.datetime.utcnow()
 
582
        self.init_checker()
 
583
        self.send_changedstate()
 
584
    
 
585
    def disable(self, quiet=True):
 
586
        """Disable this client."""
 
587
        if not getattr(self, "enabled", False):
 
588
            return False
 
589
        if not quiet:
 
590
            logger.info("Disabling client %s", self.name)
 
591
        if getattr(self, "disable_initiator_tag", None) is not None:
 
592
            gobject.source_remove(self.disable_initiator_tag)
 
593
            self.disable_initiator_tag = None
 
594
        self.expires = None
 
595
        if getattr(self, "checker_initiator_tag", None) is not None:
 
596
            gobject.source_remove(self.checker_initiator_tag)
 
597
            self.checker_initiator_tag = None
 
598
        self.stop_checker()
 
599
        self.enabled = False
 
600
        if not quiet:
 
601
            self.send_changedstate()
 
602
        # Do not run this again if called by a gobject.timeout_add
 
603
        return False
 
604
    
 
605
    def __del__(self):
 
606
        self.disable()
 
607
    
 
608
    def init_checker(self):
380
609
        # Schedule a new checker to be started an 'interval' from now,
381
610
        # and every interval from then on.
 
611
        if self.checker_initiator_tag is not None:
 
612
            gobject.source_remove(self.checker_initiator_tag)
382
613
        self.checker_initiator_tag = (gobject.timeout_add
383
614
                                      (self.interval_milliseconds(),
384
615
                                       self.start_checker))
385
616
        # Schedule a disable() when 'timeout' has passed
 
617
        if self.disable_initiator_tag is not None:
 
618
            gobject.source_remove(self.disable_initiator_tag)
386
619
        self.disable_initiator_tag = (gobject.timeout_add
387
620
                                   (self.timeout_milliseconds(),
388
621
                                    self.disable))
389
 
        self.enabled = True
390
622
        # Also start a new checker *right now*.
391
623
        self.start_checker()
392
624
    
393
 
    def disable(self, quiet=True):
394
 
        """Disable this client."""
395
 
        if not getattr(self, "enabled", False):
396
 
            return False
397
 
        if not quiet:
398
 
            self.send_changedstate()
399
 
        if not quiet:
400
 
            logger.info("Disabling client %s", self.name)
401
 
        if getattr(self, "disable_initiator_tag", False):
402
 
            gobject.source_remove(self.disable_initiator_tag)
403
 
            self.disable_initiator_tag = None
404
 
        if getattr(self, "checker_initiator_tag", False):
405
 
            gobject.source_remove(self.checker_initiator_tag)
406
 
            self.checker_initiator_tag = None
407
 
        self.stop_checker()
408
 
        if self.disable_hook:
409
 
            self.disable_hook(self)
410
 
        self.enabled = False
411
 
        # Do not run this again if called by a gobject.timeout_add
412
 
        return False
413
 
    
414
 
    def __del__(self):
415
 
        self.disable_hook = None
416
 
        self.disable()
417
 
    
418
625
    def checker_callback(self, pid, condition, command):
419
626
        """The checker has completed, so take appropriate actions."""
420
627
        self.checker_callback_tag = None
421
628
        self.checker = None
422
629
        if os.WIFEXITED(condition):
423
 
            exitstatus = os.WEXITSTATUS(condition)
424
 
            if exitstatus == 0:
 
630
            self.last_checker_status = os.WEXITSTATUS(condition)
 
631
            if self.last_checker_status == 0:
425
632
                logger.info("Checker for %(name)s succeeded",
426
633
                            vars(self))
427
634
                self.checked_ok()
429
636
                logger.info("Checker for %(name)s failed",
430
637
                            vars(self))
431
638
        else:
 
639
            self.last_checker_status = -1
432
640
            logger.warning("Checker for %(name)s crashed?",
433
641
                           vars(self))
434
642
    
435
643
    def checked_ok(self):
436
 
        """Bump up the timeout for this client.
437
 
        
438
 
        This should only be called when the client has been seen,
439
 
        alive and well.
440
 
        """
 
644
        """Assert that the client has been seen, alive and well."""
441
645
        self.last_checked_ok = datetime.datetime.utcnow()
442
 
        gobject.source_remove(self.disable_initiator_tag)
443
 
        self.disable_initiator_tag = (gobject.timeout_add
444
 
                                      (self.timeout_milliseconds(),
445
 
                                       self.disable))
 
646
        self.last_checker_status = 0
 
647
        self.bump_timeout()
 
648
    
 
649
    def bump_timeout(self, timeout=None):
 
650
        """Bump up the timeout for this client."""
 
651
        if timeout is None:
 
652
            timeout = self.timeout
 
653
        if self.disable_initiator_tag is not None:
 
654
            gobject.source_remove(self.disable_initiator_tag)
 
655
            self.disable_initiator_tag = None
 
656
        if getattr(self, "enabled", False):
 
657
            self.disable_initiator_tag = (gobject.timeout_add
 
658
                                          (timedelta_to_milliseconds
 
659
                                           (timeout), self.disable))
 
660
            self.expires = datetime.datetime.utcnow() + timeout
446
661
    
447
662
    def need_approval(self):
448
663
        self.last_approval_request = datetime.datetime.utcnow()
453
668
        If a checker already exists, leave it running and do
454
669
        nothing."""
455
670
        # The reason for not killing a running checker is that if we
456
 
        # did that, then if a checker (for some reason) started
457
 
        # running slowly and taking more than 'interval' time, the
458
 
        # client would inevitably timeout, since no checker would get
459
 
        # 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
460
675
        # checkers alone, the checker would have to take more time
461
676
        # than 'timeout' for the client to be disabled, which is as it
462
677
        # should be.
476
691
                                      self.current_checker_command)
477
692
        # Start a new checker if needed
478
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)
479
699
            try:
480
 
                # In case checker_command has exactly one % operator
481
 
                command = self.checker_command % self.host
482
 
            except TypeError:
483
 
                # Escape attributes for the shell
484
 
                escaped_attrs = dict(
485
 
                    (attr,
486
 
                     re.escape(unicode(str(getattr(self, attr, "")),
487
 
                                       errors=
488
 
                                       'replace')))
489
 
                    for attr in
490
 
                    self.runtime_expansions)
491
 
 
492
 
                try:
493
 
                    command = self.checker_command % escaped_attrs
494
 
                except TypeError as error:
495
 
                    logger.error('Could not format string "%s":'
496
 
                                 ' %s', self.checker_command, error)
497
 
                    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
498
705
            self.current_checker_command = command
499
706
            try:
500
707
                logger.info("Starting checker %r for %s",
506
713
                self.checker = subprocess.Popen(command,
507
714
                                                close_fds=True,
508
715
                                                shell=True, cwd="/")
509
 
                self.checker_callback_tag = (gobject.child_watch_add
510
 
                                             (self.checker.pid,
511
 
                                              self.checker_callback,
512
 
                                              data=command))
513
 
                # The checker may have completed before the gobject
514
 
                # watch was added.  Check for this.
515
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
516
 
                if pid:
517
 
                    gobject.source_remove(self.checker_callback_tag)
518
 
                    self.checker_callback(pid, status, command)
519
716
            except OSError as error:
520
 
                logger.error("Failed to start subprocess: %s",
521
 
                             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)
522
729
        # Re-run this periodically if run by gobject.timeout_add
523
730
        return True
524
731
    
531
738
            return
532
739
        logger.debug("Stopping checker for %(name)s", vars(self))
533
740
        try:
534
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
741
            self.checker.terminate()
535
742
            #time.sleep(0.5)
536
743
            #if self.checker.poll() is None:
537
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
744
            #    self.checker.kill()
538
745
        except OSError as error:
539
746
            if error.errno != errno.ESRCH: # No such process
540
747
                raise
541
748
        self.checker = None
542
749
 
 
750
 
543
751
def dbus_service_property(dbus_interface, signature="v",
544
752
                          access="readwrite", byte_arrays=False):
545
753
    """Decorators for marking methods of a DBusObjectWithProperties to
556
764
    # "Set" method, so we fail early here:
557
765
    if byte_arrays and signature != "ay":
558
766
        raise ValueError("Byte arrays not supported for non-'ay'"
559
 
                         " signature %r" % signature)
 
767
                         " signature {0!r}".format(signature))
560
768
    def decorator(func):
561
769
        func._dbus_is_property = True
562
770
        func._dbus_interface = dbus_interface
570
778
    return decorator
571
779
 
572
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
 
573
818
class DBusPropertyException(dbus.exceptions.DBusException):
574
819
    """A base class for D-Bus property-related exceptions
575
820
    """
591
836
 
592
837
class DBusObjectWithProperties(dbus.service.Object):
593
838
    """A D-Bus object with properties.
594
 
 
 
839
    
595
840
    Classes inheriting from this can use the dbus_service_property
596
841
    decorator to expose methods as D-Bus properties.  It exposes the
597
842
    standard Get(), Set(), and GetAll() methods on the D-Bus.
598
843
    """
599
844
    
600
845
    @staticmethod
601
 
    def _is_dbus_property(obj):
602
 
        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)
603
854
    
604
 
    def _get_all_dbus_properties(self):
 
855
    def _get_all_dbus_things(self, thing):
605
856
        """Returns a generator of (name, attribute) pairs
606
857
        """
607
 
        return ((prop._dbus_name, prop)
608
 
                for name, prop in
609
 
                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)))
610
865
    
611
866
    def _get_dbus_property(self, interface_name, property_name):
612
867
        """Returns a bound method if one exists which is a D-Bus
613
868
        property with the specified name and interface.
614
869
        """
615
 
        for name in (property_name,
616
 
                     property_name + "_dbus_property"):
617
 
            prop = getattr(self, name, None)
618
 
            if (prop is None
619
 
                or not self._is_dbus_property(prop)
620
 
                or prop._dbus_name != property_name
621
 
                or (interface_name and prop._dbus_interface
622
 
                    and interface_name != prop._dbus_interface)):
623
 
                continue
624
 
            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
        
625
878
        # No such property
626
879
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
627
880
                                   + interface_name + "."
652
905
            # signatures other than "ay".
653
906
            if prop._dbus_signature != "ay":
654
907
                raise ValueError
655
 
            value = dbus.ByteArray(''.join(unichr(byte)
656
 
                                           for byte in value))
 
908
            value = dbus.ByteArray(b''.join(chr(byte)
 
909
                                            for byte in value))
657
910
        prop(value)
658
911
    
659
912
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
661
914
    def GetAll(self, interface_name):
662
915
        """Standard D-Bus property GetAll() method, see D-Bus
663
916
        standard.
664
 
 
 
917
        
665
918
        Note: Will not include properties with access="write".
666
919
        """
667
 
        all = {}
668
 
        for name, prop in self._get_all_dbus_properties():
 
920
        properties = {}
 
921
        for name, prop in self._get_all_dbus_things("property"):
669
922
            if (interface_name
670
923
                and interface_name != prop._dbus_interface):
671
924
                # Interface non-empty but did not match
675
928
                continue
676
929
            value = prop()
677
930
            if not hasattr(value, "variant_level"):
678
 
                all[name] = value
 
931
                properties[name] = value
679
932
                continue
680
 
            all[name] = type(value)(value, variant_level=
681
 
                                    value.variant_level+1)
682
 
        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")
683
936
    
684
937
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
685
938
                         out_signature="s",
686
939
                         path_keyword='object_path',
687
940
                         connection_keyword='connection')
688
941
    def Introspect(self, object_path, connection):
689
 
        """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.
690
945
        """
691
946
        xmlstring = dbus.service.Object.Introspect(self, object_path,
692
947
                                                   connection)
699
954
                e.setAttribute("access", prop._dbus_access)
700
955
                return e
701
956
            for if_tag in document.getElementsByTagName("interface"):
 
957
                # Add property tags
702
958
                for tag in (make_tag(document, name, prop)
703
959
                            for name, prop
704
 
                            in self._get_all_dbus_properties()
 
960
                            in self._get_all_dbus_things("property")
705
961
                            if prop._dbus_interface
706
962
                            == if_tag.getAttribute("name")):
707
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)
708
995
                # Add the names to the return values for the
709
996
                # "org.freedesktop.DBus.Properties" methods
710
997
                if (if_tag.getAttribute("name")
725
1012
        except (AttributeError, xml.dom.DOMException,
726
1013
                xml.parsers.expat.ExpatError) as error:
727
1014
            logger.error("Failed to override Introspection method",
728
 
                         error)
 
1015
                         exc_info=error)
729
1016
        return xmlstring
730
1017
 
731
1018
 
 
1019
def datetime_to_dbus(dt, variant_level=0):
 
1020
    """Convert a UTC datetime.datetime() to a D-Bus type."""
 
1021
    if dt is None:
 
1022
        return dbus.String("", variant_level = variant_level)
 
1023
    return dbus.String(dt.isoformat(),
 
1024
                       variant_level=variant_level)
 
1025
 
 
1026
 
 
1027
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1028
    """A class decorator; applied to a subclass of
 
1029
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1030
    interface names according to the "alt_interface_names" mapping.
 
1031
    Usage:
 
1032
    
 
1033
    @alternate_dbus_interfaces({"org.example.Interface":
 
1034
                                    "net.example.AlternateInterface"})
 
1035
    class SampleDBusObject(dbus.service.Object):
 
1036
        @dbus.service.method("org.example.Interface")
 
1037
        def SampleDBusMethod():
 
1038
            pass
 
1039
    
 
1040
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1041
    reachable via two interfaces: "org.example.Interface" and
 
1042
    "net.example.AlternateInterface", the latter of which will have
 
1043
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1044
    "true", unless "deprecate" is passed with a False value.
 
1045
    
 
1046
    This works for methods and signals, and also for D-Bus properties
 
1047
    (from DBusObjectWithProperties) and interfaces (from the
 
1048
    dbus_interface_annotations decorator).
 
1049
    """
 
1050
    def wrapper(cls):
 
1051
        for orig_interface_name, alt_interface_name in (
 
1052
            alt_interface_names.iteritems()):
 
1053
            attr = {}
 
1054
            interface_names = set()
 
1055
            # Go though all attributes of the class
 
1056
            for attrname, attribute in inspect.getmembers(cls):
 
1057
                # Ignore non-D-Bus attributes, and D-Bus attributes
 
1058
                # with the wrong interface name
 
1059
                if (not hasattr(attribute, "_dbus_interface")
 
1060
                    or not attribute._dbus_interface
 
1061
                    .startswith(orig_interface_name)):
 
1062
                    continue
 
1063
                # Create an alternate D-Bus interface name based on
 
1064
                # the current name
 
1065
                alt_interface = (attribute._dbus_interface
 
1066
                                 .replace(orig_interface_name,
 
1067
                                          alt_interface_name))
 
1068
                interface_names.add(alt_interface)
 
1069
                # Is this a D-Bus signal?
 
1070
                if getattr(attribute, "_dbus_is_signal", False):
 
1071
                    # Extract the original non-method function by
 
1072
                    # black magic
 
1073
                    nonmethod_func = (dict(
 
1074
                            zip(attribute.func_code.co_freevars,
 
1075
                                attribute.__closure__))["func"]
 
1076
                                      .cell_contents)
 
1077
                    # Create a new, but exactly alike, function
 
1078
                    # object, and decorate it to be a new D-Bus signal
 
1079
                    # with the alternate D-Bus interface name
 
1080
                    new_function = (dbus.service.signal
 
1081
                                    (alt_interface,
 
1082
                                     attribute._dbus_signature)
 
1083
                                    (types.FunctionType(
 
1084
                                nonmethod_func.func_code,
 
1085
                                nonmethod_func.func_globals,
 
1086
                                nonmethod_func.func_name,
 
1087
                                nonmethod_func.func_defaults,
 
1088
                                nonmethod_func.func_closure)))
 
1089
                    # Copy annotations, if any
 
1090
                    try:
 
1091
                        new_function._dbus_annotations = (
 
1092
                            dict(attribute._dbus_annotations))
 
1093
                    except AttributeError:
 
1094
                        pass
 
1095
                    # Define a creator of a function to call both the
 
1096
                    # original and alternate functions, so both the
 
1097
                    # original and alternate signals gets sent when
 
1098
                    # the function is called
 
1099
                    def fixscope(func1, func2):
 
1100
                        """This function is a scope container to pass
 
1101
                        func1 and func2 to the "call_both" function
 
1102
                        outside of its arguments"""
 
1103
                        def call_both(*args, **kwargs):
 
1104
                            """This function will emit two D-Bus
 
1105
                            signals by calling func1 and func2"""
 
1106
                            func1(*args, **kwargs)
 
1107
                            func2(*args, **kwargs)
 
1108
                        return call_both
 
1109
                    # Create the "call_both" function and add it to
 
1110
                    # the class
 
1111
                    attr[attrname] = fixscope(attribute, new_function)
 
1112
                # Is this a D-Bus method?
 
1113
                elif getattr(attribute, "_dbus_is_method", False):
 
1114
                    # Create a new, but exactly alike, function
 
1115
                    # object.  Decorate it to be a new D-Bus method
 
1116
                    # with the alternate D-Bus interface name.  Add it
 
1117
                    # to the class.
 
1118
                    attr[attrname] = (dbus.service.method
 
1119
                                      (alt_interface,
 
1120
                                       attribute._dbus_in_signature,
 
1121
                                       attribute._dbus_out_signature)
 
1122
                                      (types.FunctionType
 
1123
                                       (attribute.func_code,
 
1124
                                        attribute.func_globals,
 
1125
                                        attribute.func_name,
 
1126
                                        attribute.func_defaults,
 
1127
                                        attribute.func_closure)))
 
1128
                    # Copy annotations, if any
 
1129
                    try:
 
1130
                        attr[attrname]._dbus_annotations = (
 
1131
                            dict(attribute._dbus_annotations))
 
1132
                    except AttributeError:
 
1133
                        pass
 
1134
                # Is this a D-Bus property?
 
1135
                elif getattr(attribute, "_dbus_is_property", False):
 
1136
                    # Create a new, but exactly alike, function
 
1137
                    # object, and decorate it to be a new D-Bus
 
1138
                    # property with the alternate D-Bus interface
 
1139
                    # name.  Add it to the class.
 
1140
                    attr[attrname] = (dbus_service_property
 
1141
                                      (alt_interface,
 
1142
                                       attribute._dbus_signature,
 
1143
                                       attribute._dbus_access,
 
1144
                                       attribute
 
1145
                                       ._dbus_get_args_options
 
1146
                                       ["byte_arrays"])
 
1147
                                      (types.FunctionType
 
1148
                                       (attribute.func_code,
 
1149
                                        attribute.func_globals,
 
1150
                                        attribute.func_name,
 
1151
                                        attribute.func_defaults,
 
1152
                                        attribute.func_closure)))
 
1153
                    # Copy annotations, if any
 
1154
                    try:
 
1155
                        attr[attrname]._dbus_annotations = (
 
1156
                            dict(attribute._dbus_annotations))
 
1157
                    except AttributeError:
 
1158
                        pass
 
1159
                # Is this a D-Bus interface?
 
1160
                elif getattr(attribute, "_dbus_is_interface", False):
 
1161
                    # Create a new, but exactly alike, function
 
1162
                    # object.  Decorate it to be a new D-Bus interface
 
1163
                    # with the alternate D-Bus interface name.  Add it
 
1164
                    # to the class.
 
1165
                    attr[attrname] = (dbus_interface_annotations
 
1166
                                      (alt_interface)
 
1167
                                      (types.FunctionType
 
1168
                                       (attribute.func_code,
 
1169
                                        attribute.func_globals,
 
1170
                                        attribute.func_name,
 
1171
                                        attribute.func_defaults,
 
1172
                                        attribute.func_closure)))
 
1173
            if deprecate:
 
1174
                # Deprecate all alternate interfaces
 
1175
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1176
                for interface_name in interface_names:
 
1177
                    @dbus_interface_annotations(interface_name)
 
1178
                    def func(self):
 
1179
                        return { "org.freedesktop.DBus.Deprecated":
 
1180
                                     "true" }
 
1181
                    # Find an unused name
 
1182
                    for aname in (iname.format(i)
 
1183
                                  for i in itertools.count()):
 
1184
                        if aname not in attr:
 
1185
                            attr[aname] = func
 
1186
                            break
 
1187
            if interface_names:
 
1188
                # Replace the class with a new subclass of it with
 
1189
                # methods, signals, etc. as created above.
 
1190
                cls = type(b"{0}Alternate".format(cls.__name__),
 
1191
                           (cls,), attr)
 
1192
        return cls
 
1193
    return wrapper
 
1194
 
 
1195
 
 
1196
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1197
                                "se.bsnet.fukt.Mandos"})
732
1198
class ClientDBus(Client, DBusObjectWithProperties):
733
1199
    """A Client class using D-Bus
734
1200
    
743
1209
    # dbus.service.Object doesn't use super(), so we can't either.
744
1210
    
745
1211
    def __init__(self, bus = None, *args, **kwargs):
746
 
        self._approvals_pending = 0
747
1212
        self.bus = bus
748
1213
        Client.__init__(self, *args, **kwargs)
749
1214
        # Only now, when this client is initialized, can it show up on
755
1220
                                 ("/clients/" + client_object_name))
756
1221
        DBusObjectWithProperties.__init__(self, self.bus,
757
1222
                                          self.dbus_object_path)
758
 
        
759
 
    def _get_approvals_pending(self):
760
 
        return self._approvals_pending
761
 
    def _set_approvals_pending(self, value):
762
 
        old_value = self._approvals_pending
763
 
        self._approvals_pending = value
764
 
        bval = bool(value)
765
 
        if (hasattr(self, "dbus_object_path")
766
 
            and bval is not bool(old_value)):
767
 
            dbus_bool = dbus.Boolean(bval, variant_level=1)
768
 
            self.PropertyChanged(dbus.String("ApprovalPending"),
769
 
                                 dbus_bool)
770
 
 
771
 
    approvals_pending = property(_get_approvals_pending,
772
 
                                 _set_approvals_pending)
773
 
    del _get_approvals_pending, _set_approvals_pending
774
 
    
775
 
    @staticmethod
776
 
    def _datetime_to_dbus(dt, variant_level=0):
777
 
        """Convert a UTC datetime.datetime() to a D-Bus type."""
778
 
        return dbus.String(dt.isoformat(),
779
 
                           variant_level=variant_level)
780
 
    
781
 
    def enable(self):
782
 
        oldstate = getattr(self, "enabled", False)
783
 
        r = Client.enable(self)
784
 
        if oldstate != self.enabled:
785
 
            # Emit D-Bus signals
786
 
            self.PropertyChanged(dbus.String("Enabled"),
787
 
                                 dbus.Boolean(True, variant_level=1))
788
 
            self.PropertyChanged(
789
 
                dbus.String("LastEnabled"),
790
 
                self._datetime_to_dbus(self.last_enabled,
791
 
                                       variant_level=1))
792
 
        return r
793
 
    
794
 
    def disable(self, quiet = False):
795
 
        oldstate = getattr(self, "enabled", False)
796
 
        r = Client.disable(self, quiet=quiet)
797
 
        if not quiet and oldstate != self.enabled:
798
 
            # Emit D-Bus signal
799
 
            self.PropertyChanged(dbus.String("Enabled"),
800
 
                                 dbus.Boolean(False, variant_level=1))
801
 
        return r
 
1223
    
 
1224
    def notifychangeproperty(transform_func,
 
1225
                             dbus_name, type_func=lambda x: x,
 
1226
                             variant_level=1):
 
1227
        """ Modify a variable so that it's a property which announces
 
1228
        its changes to DBus.
 
1229
        
 
1230
        transform_fun: Function that takes a value and a variant_level
 
1231
                       and transforms it to a D-Bus type.
 
1232
        dbus_name: D-Bus name of the variable
 
1233
        type_func: Function that transform the value before sending it
 
1234
                   to the D-Bus.  Default: no transform
 
1235
        variant_level: D-Bus variant level.  Default: 1
 
1236
        """
 
1237
        attrname = "_{0}".format(dbus_name)
 
1238
        def setter(self, value):
 
1239
            if hasattr(self, "dbus_object_path"):
 
1240
                if (not hasattr(self, attrname) or
 
1241
                    type_func(getattr(self, attrname, None))
 
1242
                    != type_func(value)):
 
1243
                    dbus_value = transform_func(type_func(value),
 
1244
                                                variant_level
 
1245
                                                =variant_level)
 
1246
                    self.PropertyChanged(dbus.String(dbus_name),
 
1247
                                         dbus_value)
 
1248
            setattr(self, attrname, value)
 
1249
        
 
1250
        return property(lambda self: getattr(self, attrname), setter)
 
1251
    
 
1252
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
 
1253
    approvals_pending = notifychangeproperty(dbus.Boolean,
 
1254
                                             "ApprovalPending",
 
1255
                                             type_func = bool)
 
1256
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
 
1257
    last_enabled = notifychangeproperty(datetime_to_dbus,
 
1258
                                        "LastEnabled")
 
1259
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
 
1260
                                   type_func = lambda checker:
 
1261
                                       checker is not None)
 
1262
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
 
1263
                                           "LastCheckedOK")
 
1264
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1265
                                               "LastCheckerStatus")
 
1266
    last_approval_request = notifychangeproperty(
 
1267
        datetime_to_dbus, "LastApprovalRequest")
 
1268
    approved_by_default = notifychangeproperty(dbus.Boolean,
 
1269
                                               "ApprovedByDefault")
 
1270
    approval_delay = notifychangeproperty(dbus.UInt64,
 
1271
                                          "ApprovalDelay",
 
1272
                                          type_func =
 
1273
                                          timedelta_to_milliseconds)
 
1274
    approval_duration = notifychangeproperty(
 
1275
        dbus.UInt64, "ApprovalDuration",
 
1276
        type_func = timedelta_to_milliseconds)
 
1277
    host = notifychangeproperty(dbus.String, "Host")
 
1278
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
1279
                                   type_func =
 
1280
                                   timedelta_to_milliseconds)
 
1281
    extended_timeout = notifychangeproperty(
 
1282
        dbus.UInt64, "ExtendedTimeout",
 
1283
        type_func = timedelta_to_milliseconds)
 
1284
    interval = notifychangeproperty(dbus.UInt64,
 
1285
                                    "Interval",
 
1286
                                    type_func =
 
1287
                                    timedelta_to_milliseconds)
 
1288
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1289
    
 
1290
    del notifychangeproperty
802
1291
    
803
1292
    def __del__(self, *args, **kwargs):
804
1293
        try:
813
1302
                         *args, **kwargs):
814
1303
        self.checker_callback_tag = None
815
1304
        self.checker = None
816
 
        # Emit D-Bus signal
817
 
        self.PropertyChanged(dbus.String("CheckerRunning"),
818
 
                             dbus.Boolean(False, variant_level=1))
819
1305
        if os.WIFEXITED(condition):
820
1306
            exitstatus = os.WEXITSTATUS(condition)
821
1307
            # Emit D-Bus signal
831
1317
        return Client.checker_callback(self, pid, condition, command,
832
1318
                                       *args, **kwargs)
833
1319
    
834
 
    def checked_ok(self, *args, **kwargs):
835
 
        Client.checked_ok(self, *args, **kwargs)
836
 
        # Emit D-Bus signal
837
 
        self.PropertyChanged(
838
 
            dbus.String("LastCheckedOK"),
839
 
            (self._datetime_to_dbus(self.last_checked_ok,
840
 
                                    variant_level=1)))
841
 
    
842
 
    def need_approval(self, *args, **kwargs):
843
 
        r = Client.need_approval(self, *args, **kwargs)
844
 
        # Emit D-Bus signal
845
 
        self.PropertyChanged(
846
 
            dbus.String("LastApprovalRequest"),
847
 
            (self._datetime_to_dbus(self.last_approval_request,
848
 
                                    variant_level=1)))
849
 
        return r
850
 
    
851
1320
    def start_checker(self, *args, **kwargs):
852
1321
        old_checker = self.checker
853
1322
        if self.checker is not None:
860
1329
            and old_checker_pid != self.checker.pid):
861
1330
            # Emit D-Bus signal
862
1331
            self.CheckerStarted(self.current_checker_command)
863
 
            self.PropertyChanged(
864
 
                dbus.String("CheckerRunning"),
865
 
                dbus.Boolean(True, variant_level=1))
866
1332
        return r
867
1333
    
868
 
    def stop_checker(self, *args, **kwargs):
869
 
        old_checker = getattr(self, "checker", None)
870
 
        r = Client.stop_checker(self, *args, **kwargs)
871
 
        if (old_checker is not None
872
 
            and getattr(self, "checker", None) is None):
873
 
            self.PropertyChanged(dbus.String("CheckerRunning"),
874
 
                                 dbus.Boolean(False, variant_level=1))
875
 
        return r
876
 
 
877
1334
    def _reset_approved(self):
878
 
        self._approved = None
 
1335
        self.approved = None
879
1336
        return False
880
1337
    
881
1338
    def approve(self, value=True):
882
 
        self.send_changedstate()
883
 
        self._approved = value
884
 
        gobject.timeout_add(self._timedelta_to_milliseconds
 
1339
        self.approved = value
 
1340
        gobject.timeout_add(timedelta_to_milliseconds
885
1341
                            (self.approval_duration),
886
1342
                            self._reset_approved)
887
 
    
 
1343
        self.send_changedstate()
888
1344
    
889
1345
    ## D-Bus methods, signals & properties
890
 
    _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"}
891
1354
    
892
1355
    ## Signals
893
1356
    
979
1442
        if value is None:       # get
980
1443
            return dbus.Boolean(self.approved_by_default)
981
1444
        self.approved_by_default = bool(value)
982
 
        # Emit D-Bus signal
983
 
        self.PropertyChanged(dbus.String("ApprovedByDefault"),
984
 
                             dbus.Boolean(value, variant_level=1))
985
1445
    
986
1446
    # ApprovalDelay - property
987
1447
    @dbus_service_property(_interface, signature="t",
990
1450
        if value is None:       # get
991
1451
            return dbus.UInt64(self.approval_delay_milliseconds())
992
1452
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
993
 
        # Emit D-Bus signal
994
 
        self.PropertyChanged(dbus.String("ApprovalDelay"),
995
 
                             dbus.UInt64(value, variant_level=1))
996
1453
    
997
1454
    # ApprovalDuration - property
998
1455
    @dbus_service_property(_interface, signature="t",
999
1456
                           access="readwrite")
1000
1457
    def ApprovalDuration_dbus_property(self, value=None):
1001
1458
        if value is None:       # get
1002
 
            return dbus.UInt64(self._timedelta_to_milliseconds(
 
1459
            return dbus.UInt64(timedelta_to_milliseconds(
1003
1460
                    self.approval_duration))
1004
1461
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1005
 
        # Emit D-Bus signal
1006
 
        self.PropertyChanged(dbus.String("ApprovalDuration"),
1007
 
                             dbus.UInt64(value, variant_level=1))
1008
1462
    
1009
1463
    # Name - property
1010
1464
    @dbus_service_property(_interface, signature="s", access="read")
1022
1476
    def Host_dbus_property(self, value=None):
1023
1477
        if value is None:       # get
1024
1478
            return dbus.String(self.host)
1025
 
        self.host = value
1026
 
        # Emit D-Bus signal
1027
 
        self.PropertyChanged(dbus.String("Host"),
1028
 
                             dbus.String(value, variant_level=1))
 
1479
        self.host = unicode(value)
1029
1480
    
1030
1481
    # Created - property
1031
1482
    @dbus_service_property(_interface, signature="s", access="read")
1032
1483
    def Created_dbus_property(self):
1033
 
        return dbus.String(self._datetime_to_dbus(self.created))
 
1484
        return datetime_to_dbus(self.created)
1034
1485
    
1035
1486
    # LastEnabled - property
1036
1487
    @dbus_service_property(_interface, signature="s", access="read")
1037
1488
    def LastEnabled_dbus_property(self):
1038
 
        if self.last_enabled is None:
1039
 
            return dbus.String("")
1040
 
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
 
1489
        return datetime_to_dbus(self.last_enabled)
1041
1490
    
1042
1491
    # Enabled - property
1043
1492
    @dbus_service_property(_interface, signature="b",
1057
1506
        if value is not None:
1058
1507
            self.checked_ok()
1059
1508
            return
1060
 
        if self.last_checked_ok is None:
1061
 
            return dbus.String("")
1062
 
        return dbus.String(self._datetime_to_dbus(self
1063
 
                                                  .last_checked_ok))
 
1509
        return datetime_to_dbus(self.last_checked_ok)
 
1510
    
 
1511
    # LastCheckerStatus - property
 
1512
    @dbus_service_property(_interface, signature="n",
 
1513
                           access="read")
 
1514
    def LastCheckerStatus_dbus_property(self):
 
1515
        return dbus.Int16(self.last_checker_status)
 
1516
    
 
1517
    # Expires - property
 
1518
    @dbus_service_property(_interface, signature="s", access="read")
 
1519
    def Expires_dbus_property(self):
 
1520
        return datetime_to_dbus(self.expires)
1064
1521
    
1065
1522
    # LastApprovalRequest - property
1066
1523
    @dbus_service_property(_interface, signature="s", access="read")
1067
1524
    def LastApprovalRequest_dbus_property(self):
1068
 
        if self.last_approval_request is None:
1069
 
            return dbus.String("")
1070
 
        return dbus.String(self.
1071
 
                           _datetime_to_dbus(self
1072
 
                                             .last_approval_request))
 
1525
        return datetime_to_dbus(self.last_approval_request)
1073
1526
    
1074
1527
    # Timeout - property
1075
1528
    @dbus_service_property(_interface, signature="t",
1077
1530
    def Timeout_dbus_property(self, value=None):
1078
1531
        if value is None:       # get
1079
1532
            return dbus.UInt64(self.timeout_milliseconds())
 
1533
        old_timeout = self.timeout
1080
1534
        self.timeout = datetime.timedelta(0, 0, 0, value)
1081
 
        # Emit D-Bus signal
1082
 
        self.PropertyChanged(dbus.String("Timeout"),
1083
 
                             dbus.UInt64(value, variant_level=1))
1084
 
        if getattr(self, "disable_initiator_tag", None) is None:
1085
 
            return
1086
 
        # Reschedule timeout
1087
 
        gobject.source_remove(self.disable_initiator_tag)
1088
 
        self.disable_initiator_tag = None
1089
 
        time_to_die = (self.
1090
 
                       _timedelta_to_milliseconds((self
1091
 
                                                   .last_checked_ok
1092
 
                                                   + self.timeout)
1093
 
                                                  - datetime.datetime
1094
 
                                                  .utcnow()))
1095
 
        if time_to_die <= 0:
1096
 
            # The timeout has passed
1097
 
            self.disable()
1098
 
        else:
1099
 
            self.disable_initiator_tag = (gobject.timeout_add
1100
 
                                          (time_to_die, self.disable))
 
1535
        # Reschedule disabling
 
1536
        if self.enabled:
 
1537
            now = datetime.datetime.utcnow()
 
1538
            self.expires += self.timeout - old_timeout
 
1539
            if self.expires <= now:
 
1540
                # The timeout has passed
 
1541
                self.disable()
 
1542
            else:
 
1543
                if (getattr(self, "disable_initiator_tag", None)
 
1544
                    is None):
 
1545
                    return
 
1546
                gobject.source_remove(self.disable_initiator_tag)
 
1547
                self.disable_initiator_tag = (
 
1548
                    gobject.timeout_add(
 
1549
                        timedelta_to_milliseconds(self.expires - now),
 
1550
                        self.disable))
 
1551
    
 
1552
    # ExtendedTimeout - property
 
1553
    @dbus_service_property(_interface, signature="t",
 
1554
                           access="readwrite")
 
1555
    def ExtendedTimeout_dbus_property(self, value=None):
 
1556
        if value is None:       # get
 
1557
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1558
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1101
1559
    
1102
1560
    # Interval - property
1103
1561
    @dbus_service_property(_interface, signature="t",
1106
1564
        if value is None:       # get
1107
1565
            return dbus.UInt64(self.interval_milliseconds())
1108
1566
        self.interval = datetime.timedelta(0, 0, 0, value)
1109
 
        # Emit D-Bus signal
1110
 
        self.PropertyChanged(dbus.String("Interval"),
1111
 
                             dbus.UInt64(value, variant_level=1))
1112
1567
        if getattr(self, "checker_initiator_tag", None) is None:
1113
1568
            return
1114
 
        # Reschedule checker run
1115
 
        gobject.source_remove(self.checker_initiator_tag)
1116
 
        self.checker_initiator_tag = (gobject.timeout_add
1117
 
                                      (value, self.start_checker))
1118
 
        self.start_checker()    # Start one now, too
1119
 
 
 
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
    
1120
1576
    # Checker - property
1121
1577
    @dbus_service_property(_interface, signature="s",
1122
1578
                           access="readwrite")
1123
1579
    def Checker_dbus_property(self, value=None):
1124
1580
        if value is None:       # get
1125
1581
            return dbus.String(self.checker_command)
1126
 
        self.checker_command = value
1127
 
        # Emit D-Bus signal
1128
 
        self.PropertyChanged(dbus.String("Checker"),
1129
 
                             dbus.String(self.checker_command,
1130
 
                                         variant_level=1))
 
1582
        self.checker_command = unicode(value)
1131
1583
    
1132
1584
    # CheckerRunning - property
1133
1585
    @dbus_service_property(_interface, signature="b",
1160
1612
        self._pipe.send(('init', fpr, address))
1161
1613
        if not self._pipe.recv():
1162
1614
            raise KeyError()
1163
 
 
 
1615
    
1164
1616
    def __getattribute__(self, name):
1165
 
        if(name == '_pipe'):
 
1617
        if name == '_pipe':
1166
1618
            return super(ProxyClient, self).__getattribute__(name)
1167
1619
        self._pipe.send(('getattr', name))
1168
1620
        data = self._pipe.recv()
1173
1625
                self._pipe.send(('funcall', name, args, kwargs))
1174
1626
                return self._pipe.recv()[1]
1175
1627
            return func
1176
 
 
 
1628
    
1177
1629
    def __setattr__(self, name, value):
1178
 
        if(name == '_pipe'):
 
1630
        if name == '_pipe':
1179
1631
            return super(ProxyClient, self).__setattr__(name, value)
1180
1632
        self._pipe.send(('setattr', name, value))
1181
1633
 
1192
1644
                        unicode(self.client_address))
1193
1645
            logger.debug("Pipe FD: %d",
1194
1646
                         self.server.child_pipe.fileno())
1195
 
 
 
1647
            
1196
1648
            session = (gnutls.connection
1197
1649
                       .ClientSession(self.request,
1198
1650
                                      gnutls.connection
1199
1651
                                      .X509Credentials()))
1200
 
 
 
1652
            
1201
1653
            # Note: gnutls.connection.X509Credentials is really a
1202
1654
            # generic GnuTLS certificate credentials object so long as
1203
1655
            # no X.509 keys are added to it.  Therefore, we can use it
1204
1656
            # here despite using OpenPGP certificates.
1205
 
 
 
1657
            
1206
1658
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1207
1659
            #                      "+AES-256-CBC", "+SHA1",
1208
1660
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1214
1666
            (gnutls.library.functions
1215
1667
             .gnutls_priority_set_direct(session._c_object,
1216
1668
                                         priority, None))
1217
 
 
 
1669
            
1218
1670
            # Start communication using the Mandos protocol
1219
1671
            # Get protocol number
1220
1672
            line = self.request.makefile().readline()
1225
1677
            except (ValueError, IndexError, RuntimeError) as error:
1226
1678
                logger.error("Unknown protocol version: %s", error)
1227
1679
                return
1228
 
 
 
1680
            
1229
1681
            # Start GnuTLS connection
1230
1682
            try:
1231
1683
                session.handshake()
1235
1687
                # established.  Just abandon the request.
1236
1688
                return
1237
1689
            logger.debug("Handshake succeeded")
1238
 
 
 
1690
            
1239
1691
            approval_required = False
1240
1692
            try:
1241
1693
                try:
1246
1698
                    logger.warning("Bad certificate: %s", error)
1247
1699
                    return
1248
1700
                logger.debug("Fingerprint: %s", fpr)
1249
 
 
 
1701
                
1250
1702
                try:
1251
1703
                    client = ProxyClient(child_pipe, fpr,
1252
1704
                                         self.client_address)
1260
1712
                
1261
1713
                while True:
1262
1714
                    if not client.enabled:
1263
 
                        logger.warning("Client %s is disabled",
 
1715
                        logger.info("Client %s is disabled",
1264
1716
                                       client.name)
1265
1717
                        if self.server.use_dbus:
1266
1718
                            # Emit D-Bus signal
1267
 
                            client.Rejected("Disabled")                    
 
1719
                            client.Rejected("Disabled")
1268
1720
                        return
1269
1721
                    
1270
 
                    if client._approved or not client.approval_delay:
 
1722
                    if client.approved or not client.approval_delay:
1271
1723
                        #We are approved or approval is disabled
1272
1724
                        break
1273
 
                    elif client._approved is None:
 
1725
                    elif client.approved is None:
1274
1726
                        logger.info("Client %s needs approval",
1275
1727
                                    client.name)
1276
1728
                        if self.server.use_dbus:
1287
1739
                        return
1288
1740
                    
1289
1741
                    #wait until timeout or approved
1290
 
                    #x = float(client._timedelta_to_milliseconds(delay))
1291
1742
                    time = datetime.datetime.now()
1292
1743
                    client.changedstate.acquire()
1293
 
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
 
1744
                    client.changedstate.wait(
 
1745
                        float(timedelta_to_milliseconds(delay)
 
1746
                              / 1000))
1294
1747
                    client.changedstate.release()
1295
1748
                    time2 = datetime.datetime.now()
1296
1749
                    if (time2 - time) >= delay:
1312
1765
                    try:
1313
1766
                        sent = session.send(client.secret[sent_size:])
1314
1767
                    except gnutls.errors.GNUTLSError as error:
1315
 
                        logger.warning("gnutls send failed")
 
1768
                        logger.warning("gnutls send failed",
 
1769
                                       exc_info=error)
1316
1770
                        return
1317
1771
                    logger.debug("Sent: %d, remaining: %d",
1318
1772
                                 sent, len(client.secret)
1319
1773
                                 - (sent_size + sent))
1320
1774
                    sent_size += sent
1321
 
 
 
1775
                
1322
1776
                logger.info("Sending secret to %s", client.name)
1323
 
                # bump the timeout as if seen
1324
 
                client.checked_ok()
 
1777
                # bump the timeout using extended_timeout
 
1778
                client.bump_timeout(client.extended_timeout)
1325
1779
                if self.server.use_dbus:
1326
1780
                    # Emit D-Bus signal
1327
1781
                    client.GotSecret()
1332
1786
                try:
1333
1787
                    session.bye()
1334
1788
                except gnutls.errors.GNUTLSError as error:
1335
 
                    logger.warning("GnuTLS bye failed")
 
1789
                    logger.warning("GnuTLS bye failed",
 
1790
                                   exc_info=error)
1336
1791
    
1337
1792
    @staticmethod
1338
1793
    def peer_certificate(session):
1394
1849
        # Convert the buffer to a Python bytestring
1395
1850
        fpr = ctypes.string_at(buf, buf_len.value)
1396
1851
        # Convert the bytestring to hexadecimal notation
1397
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
1852
        hex_fpr = binascii.hexlify(fpr).upper()
1398
1853
        return hex_fpr
1399
1854
 
1400
1855
 
1403
1858
    def sub_process_main(self, request, address):
1404
1859
        try:
1405
1860
            self.finish_request(request, address)
1406
 
        except:
 
1861
        except Exception:
1407
1862
            self.handle_error(request, address)
1408
1863
        self.close_request(request)
1409
 
            
 
1864
    
1410
1865
    def process_request(self, request, address):
1411
1866
        """Start a new process to process the request."""
1412
 
        multiprocessing.Process(target = self.sub_process_main,
1413
 
                                args = (request, address)).start()
 
1867
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1868
                                       args = (request, address))
 
1869
        proc.start()
 
1870
        return proc
 
1871
 
1414
1872
 
1415
1873
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1416
1874
    """ adds a pipe to the MixIn """
1420
1878
        This function creates a new pipe in self.pipe
1421
1879
        """
1422
1880
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1423
 
 
1424
 
        super(MultiprocessingMixInWithPipe,
1425
 
              self).process_request(request, client_address)
 
1881
        
 
1882
        proc = MultiprocessingMixIn.process_request(self, request,
 
1883
                                                    client_address)
1426
1884
        self.child_pipe.close()
1427
 
        self.add_pipe(parent_pipe)
1428
 
 
1429
 
    def add_pipe(self, parent_pipe):
 
1885
        self.add_pipe(parent_pipe, proc)
 
1886
    
 
1887
    def add_pipe(self, parent_pipe, proc):
1430
1888
        """Dummy function; override as necessary"""
1431
1889
        raise NotImplementedError
1432
1890
 
 
1891
 
1433
1892
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1434
1893
                     socketserver.TCPServer, object):
1435
1894
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
1440
1899
        use_ipv6:       Boolean; to use IPv6 or not
1441
1900
    """
1442
1901
    def __init__(self, server_address, RequestHandlerClass,
1443
 
                 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
        """
1444
1906
        self.interface = interface
1445
1907
        if use_ipv6:
1446
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.
1447
1935
        socketserver.TCPServer.__init__(self, server_address,
1448
1936
                                        RequestHandlerClass)
 
1937
    
1449
1938
    def server_bind(self):
1450
1939
        """This overrides the normal server_bind() function
1451
1940
        to bind to an interface if one was specified, and also NOT to
1459
1948
                try:
1460
1949
                    self.socket.setsockopt(socket.SOL_SOCKET,
1461
1950
                                           SO_BINDTODEVICE,
1462
 
                                           str(self.interface
1463
 
                                               + '\0'))
 
1951
                                           str(self.interface + '\0'))
1464
1952
                except socket.error as error:
1465
 
                    if error[0] == errno.EPERM:
1466
 
                        logger.error("No permission to"
1467
 
                                     " bind to interface %s",
1468
 
                                     self.interface)
1469
 
                    elif error[0] == errno.ENOPROTOOPT:
 
1953
                    if error.errno == errno.EPERM:
 
1954
                        logger.error("No permission to bind to"
 
1955
                                     " interface %s", self.interface)
 
1956
                    elif error.errno == errno.ENOPROTOOPT:
1470
1957
                        logger.error("SO_BINDTODEVICE not available;"
1471
1958
                                     " cannot bind to interface %s",
1472
1959
                                     self.interface)
 
1960
                    elif error.errno == errno.ENODEV:
 
1961
                        logger.error("Interface %s does not exist,"
 
1962
                                     " cannot bind", self.interface)
1473
1963
                    else:
1474
1964
                        raise
1475
1965
        # Only bind(2) the socket if we really need to.
1505
1995
    """
1506
1996
    def __init__(self, server_address, RequestHandlerClass,
1507
1997
                 interface=None, use_ipv6=True, clients=None,
1508
 
                 gnutls_priority=None, use_dbus=True):
 
1998
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1509
1999
        self.enabled = False
1510
2000
        self.clients = clients
1511
2001
        if self.clients is None:
1512
 
            self.clients = set()
 
2002
            self.clients = {}
1513
2003
        self.use_dbus = use_dbus
1514
2004
        self.gnutls_priority = gnutls_priority
1515
2005
        IPv6_TCPServer.__init__(self, server_address,
1516
2006
                                RequestHandlerClass,
1517
2007
                                interface = interface,
1518
 
                                use_ipv6 = use_ipv6)
 
2008
                                use_ipv6 = use_ipv6,
 
2009
                                socketfd = socketfd)
1519
2010
    def server_activate(self):
1520
2011
        if self.enabled:
1521
2012
            return socketserver.TCPServer.server_activate(self)
 
2013
    
1522
2014
    def enable(self):
1523
2015
        self.enabled = True
1524
 
    def add_pipe(self, parent_pipe):
 
2016
    
 
2017
    def add_pipe(self, parent_pipe, proc):
1525
2018
        # Call "handle_ipc" for both data and EOF events
1526
2019
        gobject.io_add_watch(parent_pipe.fileno(),
1527
2020
                             gobject.IO_IN | gobject.IO_HUP,
1528
2021
                             functools.partial(self.handle_ipc,
1529
 
                                               parent_pipe = parent_pipe))
1530
 
        
 
2022
                                               parent_pipe =
 
2023
                                               parent_pipe,
 
2024
                                               proc = proc))
 
2025
    
1531
2026
    def handle_ipc(self, source, condition, parent_pipe=None,
1532
 
                   client_object=None):
1533
 
        condition_names = {
1534
 
            gobject.IO_IN: "IN",   # There is data to read.
1535
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1536
 
                                    # blocking).
1537
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1538
 
            gobject.IO_ERR: "ERR", # Error condition.
1539
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1540
 
                                    # broken, usually for pipes and
1541
 
                                    # sockets).
1542
 
            }
1543
 
        conditions_string = ' | '.join(name
1544
 
                                       for cond, name in
1545
 
                                       condition_names.iteritems()
1546
 
                                       if cond & condition)
1547
 
        # error or the other end of multiprocessing.Pipe has closed
1548
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2027
                   proc = None, client_object=None):
 
2028
        # error, or the other end of multiprocessing.Pipe has closed
 
2029
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2030
            # Wait for other process to exit
 
2031
            proc.join()
1549
2032
            return False
1550
2033
        
1551
2034
        # Read a request from the child
1556
2039
            fpr = request[1]
1557
2040
            address = request[2]
1558
2041
            
1559
 
            for c in self.clients:
 
2042
            for c in self.clients.itervalues():
1560
2043
                if c.fingerprint == fpr:
1561
2044
                    client = c
1562
2045
                    break
1563
2046
            else:
1564
 
                logger.warning("Client not found for fingerprint: %s, ad"
1565
 
                               "dress: %s", fpr, address)
 
2047
                logger.info("Client not found for fingerprint: %s, ad"
 
2048
                            "dress: %s", fpr, address)
1566
2049
                if self.use_dbus:
1567
2050
                    # Emit D-Bus signal
1568
 
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
 
2051
                    mandos_dbus_service.ClientNotFound(fpr,
 
2052
                                                       address[0])
1569
2053
                parent_pipe.send(False)
1570
2054
                return False
1571
2055
            
1572
2056
            gobject.io_add_watch(parent_pipe.fileno(),
1573
2057
                                 gobject.IO_IN | gobject.IO_HUP,
1574
2058
                                 functools.partial(self.handle_ipc,
1575
 
                                                   parent_pipe = parent_pipe,
1576
 
                                                   client_object = client))
 
2059
                                                   parent_pipe =
 
2060
                                                   parent_pipe,
 
2061
                                                   proc = proc,
 
2062
                                                   client_object =
 
2063
                                                   client))
1577
2064
            parent_pipe.send(True)
1578
 
            # remove the old hook in favor of the new above hook on same fileno
 
2065
            # remove the old hook in favor of the new above hook on
 
2066
            # same fileno
1579
2067
            return False
1580
2068
        if command == 'funcall':
1581
2069
            funcname = request[1]
1582
2070
            args = request[2]
1583
2071
            kwargs = request[3]
1584
2072
            
1585
 
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1586
 
 
 
2073
            parent_pipe.send(('data', getattr(client_object,
 
2074
                                              funcname)(*args,
 
2075
                                                         **kwargs)))
 
2076
        
1587
2077
        if command == 'getattr':
1588
2078
            attrname = request[1]
1589
2079
            if callable(client_object.__getattribute__(attrname)):
1590
2080
                parent_pipe.send(('function',))
1591
2081
            else:
1592
 
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
 
2082
                parent_pipe.send(('data', client_object
 
2083
                                  .__getattribute__(attrname)))
1593
2084
        
1594
2085
        if command == 'setattr':
1595
2086
            attrname = request[1]
1596
2087
            value = request[2]
1597
2088
            setattr(client_object, attrname, value)
1598
 
 
 
2089
        
1599
2090
        return True
1600
2091
 
1601
2092
 
1631
2122
            elif suffix == "w":
1632
2123
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1633
2124
            else:
1634
 
                raise ValueError("Unknown suffix %r" % suffix)
 
2125
                raise ValueError("Unknown suffix {0!r}"
 
2126
                                 .format(suffix))
1635
2127
        except (ValueError, IndexError) as e:
1636
2128
            raise ValueError(*(e.args))
1637
2129
        timevalue += delta
1638
2130
    return timevalue
1639
2131
 
1640
2132
 
1641
 
def if_nametoindex(interface):
1642
 
    """Call the C function if_nametoindex(), or equivalent
1643
 
    
1644
 
    Note: This function cannot accept a unicode string."""
1645
 
    global if_nametoindex
1646
 
    try:
1647
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1648
 
                          (ctypes.util.find_library("c"))
1649
 
                          .if_nametoindex)
1650
 
    except (OSError, AttributeError):
1651
 
        logger.warning("Doing if_nametoindex the hard way")
1652
 
        def if_nametoindex(interface):
1653
 
            "Get an interface index the hard way, i.e. using fcntl()"
1654
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1655
 
            with contextlib.closing(socket.socket()) as s:
1656
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1657
 
                                    struct.pack(str("16s16x"),
1658
 
                                                interface))
1659
 
            interface_index = struct.unpack(str("I"),
1660
 
                                            ifreq[16:20])[0]
1661
 
            return interface_index
1662
 
    return if_nametoindex(interface)
1663
 
 
1664
 
 
1665
2133
def daemon(nochdir = False, noclose = False):
1666
2134
    """See daemon(3).  Standard BSD Unix function.
1667
2135
    
1675
2143
        sys.exit()
1676
2144
    if not noclose:
1677
2145
        # Close all standard open file descriptors
1678
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2146
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1679
2147
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1680
2148
            raise OSError(errno.ENODEV,
1681
 
                          "%s not a character device"
1682
 
                          % os.path.devnull)
 
2149
                          "{0} not a character device"
 
2150
                          .format(os.devnull))
1683
2151
        os.dup2(null, sys.stdin.fileno())
1684
2152
        os.dup2(null, sys.stdout.fileno())
1685
2153
        os.dup2(null, sys.stderr.fileno())
1694
2162
    
1695
2163
    parser = argparse.ArgumentParser()
1696
2164
    parser.add_argument("-v", "--version", action="version",
1697
 
                        version = "%%(prog)s %s" % version,
 
2165
                        version = "%(prog)s {0}".format(version),
1698
2166
                        help="show version number and exit")
1699
2167
    parser.add_argument("-i", "--interface", metavar="IF",
1700
2168
                        help="Bind to interface IF")
1722
2190
                        " system bus interface")
1723
2191
    parser.add_argument("--no-ipv6", action="store_false",
1724
2192
                        dest="use_ipv6", help="Do not use IPv6")
 
2193
    parser.add_argument("--no-restore", action="store_false",
 
2194
                        dest="restore", help="Do not restore stored"
 
2195
                        " state")
 
2196
    parser.add_argument("--socket", type=int,
 
2197
                        help="Specify a file descriptor to a network"
 
2198
                        " socket to use instead of creating one")
 
2199
    parser.add_argument("--statedir", metavar="DIR",
 
2200
                        help="Directory to save/restore state in")
 
2201
    parser.add_argument("--foreground", action="store_true",
 
2202
                        help="Run in foreground")
 
2203
    
1725
2204
    options = parser.parse_args()
1726
2205
    
1727
2206
    if options.check:
1740
2219
                        "use_dbus": "True",
1741
2220
                        "use_ipv6": "True",
1742
2221
                        "debuglevel": "",
 
2222
                        "restore": "True",
 
2223
                        "socket": "",
 
2224
                        "statedir": "/var/lib/mandos",
 
2225
                        "foreground": "False",
1743
2226
                        }
1744
2227
    
1745
2228
    # Parse config file for server-global settings
1750
2233
    # Convert the SafeConfigParser object to a dict
1751
2234
    server_settings = server_config.defaults()
1752
2235
    # Use the appropriate methods on the non-string config options
1753
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2236
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1754
2237
        server_settings[option] = server_config.getboolean("DEFAULT",
1755
2238
                                                           option)
1756
2239
    if server_settings["port"]:
1757
2240
        server_settings["port"] = server_config.getint("DEFAULT",
1758
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"])
1759
2251
    del server_config
1760
2252
    
1761
2253
    # Override the settings from the config file with command line
1762
2254
    # options, if set.
1763
2255
    for option in ("interface", "address", "port", "debug",
1764
2256
                   "priority", "servicename", "configdir",
1765
 
                   "use_dbus", "use_ipv6", "debuglevel"):
 
2257
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2258
                   "statedir", "socket", "foreground"):
1766
2259
        value = getattr(options, option)
1767
2260
        if value is not None:
1768
2261
            server_settings[option] = value
1771
2264
    for option in server_settings.keys():
1772
2265
        if type(server_settings[option]) is str:
1773
2266
            server_settings[option] = unicode(server_settings[option])
 
2267
    # Debug implies foreground
 
2268
    if server_settings["debug"]:
 
2269
        server_settings["foreground"] = True
1774
2270
    # Now we have our good server settings in "server_settings"
1775
2271
    
1776
2272
    ##################################################################
1780
2276
    debuglevel = server_settings["debuglevel"]
1781
2277
    use_dbus = server_settings["use_dbus"]
1782
2278
    use_ipv6 = server_settings["use_ipv6"]
1783
 
 
 
2279
    stored_state_path = os.path.join(server_settings["statedir"],
 
2280
                                     stored_state_file)
 
2281
    foreground = server_settings["foreground"]
 
2282
    
 
2283
    if debug:
 
2284
        initlogger(debug, logging.DEBUG)
 
2285
    else:
 
2286
        if not debuglevel:
 
2287
            initlogger(debug)
 
2288
        else:
 
2289
            level = getattr(logging, debuglevel.upper())
 
2290
            initlogger(debug, level)
 
2291
    
1784
2292
    if server_settings["servicename"] != "Mandos":
1785
2293
        syslogger.setFormatter(logging.Formatter
1786
 
                               ('Mandos (%s) [%%(process)d]:'
1787
 
                                ' %%(levelname)s: %%(message)s'
1788
 
                                % server_settings["servicename"]))
 
2294
                               ('Mandos ({0}) [%(process)d]:'
 
2295
                                ' %(levelname)s: %(message)s'
 
2296
                                .format(server_settings
 
2297
                                        ["servicename"])))
1789
2298
    
1790
2299
    # Parse config file with clients
1791
 
    client_defaults = { "timeout": "1h",
1792
 
                        "interval": "5m",
1793
 
                        "checker": "fping -q -- %%(host)s",
1794
 
                        "host": "",
1795
 
                        "approval_delay": "0s",
1796
 
                        "approval_duration": "1s",
1797
 
                        }
1798
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2300
    client_config = configparser.SafeConfigParser(Client
 
2301
                                                  .client_defaults)
1799
2302
    client_config.read(os.path.join(server_settings["configdir"],
1800
2303
                                    "clients.conf"))
1801
2304
    
1810
2313
                              use_ipv6=use_ipv6,
1811
2314
                              gnutls_priority=
1812
2315
                              server_settings["priority"],
1813
 
                              use_dbus=use_dbus)
1814
 
    if not debug:
 
2316
                              use_dbus=use_dbus,
 
2317
                              socketfd=(server_settings["socket"]
 
2318
                                        or None))
 
2319
    if not foreground:
1815
2320
        pidfilename = "/var/run/mandos.pid"
 
2321
        pidfile = None
1816
2322
        try:
1817
2323
            pidfile = open(pidfilename, "w")
1818
 
        except IOError:
1819
 
            logger.error("Could not open file %r", pidfilename)
 
2324
        except IOError as e:
 
2325
            logger.error("Could not open file %r", pidfilename,
 
2326
                         exc_info=e)
1820
2327
    
1821
 
    try:
1822
 
        uid = pwd.getpwnam("_mandos").pw_uid
1823
 
        gid = pwd.getpwnam("_mandos").pw_gid
1824
 
    except KeyError:
 
2328
    for name in ("_mandos", "mandos", "nobody"):
1825
2329
        try:
1826
 
            uid = pwd.getpwnam("mandos").pw_uid
1827
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2330
            uid = pwd.getpwnam(name).pw_uid
 
2331
            gid = pwd.getpwnam(name).pw_gid
 
2332
            break
1828
2333
        except KeyError:
1829
 
            try:
1830
 
                uid = pwd.getpwnam("nobody").pw_uid
1831
 
                gid = pwd.getpwnam("nobody").pw_gid
1832
 
            except KeyError:
1833
 
                uid = 65534
1834
 
                gid = 65534
 
2334
            continue
 
2335
    else:
 
2336
        uid = 65534
 
2337
        gid = 65534
1835
2338
    try:
1836
2339
        os.setgid(gid)
1837
2340
        os.setuid(uid)
1838
2341
    except OSError as error:
1839
 
        if error[0] != errno.EPERM:
 
2342
        if error.errno != errno.EPERM:
1840
2343
            raise error
1841
2344
    
1842
 
    if not debug and not debuglevel:
1843
 
        syslogger.setLevel(logging.WARNING)
1844
 
        console.setLevel(logging.WARNING)
1845
 
    if debuglevel:
1846
 
        level = getattr(logging, debuglevel.upper())
1847
 
        syslogger.setLevel(level)
1848
 
        console.setLevel(level)
1849
 
 
1850
2345
    if debug:
1851
2346
        # Enable all possible GnuTLS debugging
1852
2347
        
1862
2357
         .gnutls_global_set_log_function(debug_gnutls))
1863
2358
        
1864
2359
        # Redirect stdin so all checkers get /dev/null
1865
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2360
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1866
2361
        os.dup2(null, sys.stdin.fileno())
1867
2362
        if null > 2:
1868
2363
            os.close(null)
1869
 
    else:
1870
 
        # No console logging
1871
 
        logger.removeHandler(console)
1872
2364
    
1873
2365
    # Need to fork before connecting to D-Bus
1874
 
    if not debug:
 
2366
    if not foreground:
1875
2367
        # Close all input and output, do double fork, etc.
1876
2368
        daemon()
1877
2369
    
 
2370
    # multiprocessing will use threads, so before we use gobject we
 
2371
    # need to inform gobject that threads will be used.
 
2372
    gobject.threads_init()
 
2373
    
1878
2374
    global main_loop
1879
2375
    # From the Avahi example code
1880
 
    DBusGMainLoop(set_as_default=True )
 
2376
    DBusGMainLoop(set_as_default=True)
1881
2377
    main_loop = gobject.MainLoop()
1882
2378
    bus = dbus.SystemBus()
1883
2379
    # End of Avahi example code
1884
2380
    if use_dbus:
1885
2381
        try:
1886
 
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
 
2382
            bus_name = dbus.service.BusName("se.recompile.Mandos",
1887
2383
                                            bus, do_not_queue=True)
 
2384
            old_bus_name = (dbus.service.BusName
 
2385
                            ("se.bsnet.fukt.Mandos", bus,
 
2386
                             do_not_queue=True))
1888
2387
        except dbus.exceptions.NameExistsException as e:
1889
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2388
            logger.error("Disabling D-Bus:", exc_info=e)
1890
2389
            use_dbus = False
1891
2390
            server_settings["use_dbus"] = False
1892
2391
            tcp_server.use_dbus = False
1893
2392
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1894
 
    service = AvahiService(name = server_settings["servicename"],
1895
 
                           servicetype = "_mandos._tcp",
1896
 
                           protocol = protocol, bus = bus)
 
2393
    service = AvahiServiceToSyslog(name =
 
2394
                                   server_settings["servicename"],
 
2395
                                   servicetype = "_mandos._tcp",
 
2396
                                   protocol = protocol, bus = bus)
1897
2397
    if server_settings["interface"]:
1898
2398
        service.interface = (if_nametoindex
1899
2399
                             (str(server_settings["interface"])))
1904
2404
    client_class = Client
1905
2405
    if use_dbus:
1906
2406
        client_class = functools.partial(ClientDBus, bus = bus)
1907
 
    def client_config_items(config, section):
1908
 
        special_settings = {
1909
 
            "approved_by_default":
1910
 
                lambda: config.getboolean(section,
1911
 
                                          "approved_by_default"),
1912
 
            }
1913
 
        for name, value in config.items(section):
 
2407
    
 
2408
    client_settings = Client.config_parser(client_config)
 
2409
    old_client_settings = {}
 
2410
    clients_data = {}
 
2411
    
 
2412
    # Get client data and settings from last running state.
 
2413
    if server_settings["restore"]:
 
2414
        try:
 
2415
            with open(stored_state_path, "rb") as stored_state:
 
2416
                clients_data, old_client_settings = (pickle.load
 
2417
                                                     (stored_state))
 
2418
            os.remove(stored_state_path)
 
2419
        except IOError as e:
 
2420
            if e.errno == errno.ENOENT:
 
2421
                logger.warning("Could not load persistent state: {0}"
 
2422
                                .format(os.strerror(e.errno)))
 
2423
            else:
 
2424
                logger.critical("Could not load persistent state:",
 
2425
                                exc_info=e)
 
2426
                raise
 
2427
        except EOFError as e:
 
2428
            logger.warning("Could not load persistent state: "
 
2429
                           "EOFError:", exc_info=e)
 
2430
    
 
2431
    with PGPEngine() as pgp:
 
2432
        for client_name, client in clients_data.iteritems():
 
2433
            # Decide which value to use after restoring saved state.
 
2434
            # We have three different values: Old config file,
 
2435
            # new config file, and saved state.
 
2436
            # New config value takes precedence if it differs from old
 
2437
            # config value, otherwise use saved state.
 
2438
            for name, value in client_settings[client_name].items():
 
2439
                try:
 
2440
                    # For each value in new config, check if it
 
2441
                    # differs from the old config value (Except for
 
2442
                    # the "secret" attribute)
 
2443
                    if (name != "secret" and
 
2444
                        value != old_client_settings[client_name]
 
2445
                        [name]):
 
2446
                        client[name] = value
 
2447
                except KeyError:
 
2448
                    pass
 
2449
            
 
2450
            # Clients who has passed its expire date can still be
 
2451
            # enabled if its last checker was successful.  Clients
 
2452
            # whose checker succeeded before we stored its state is
 
2453
            # assumed to have successfully run all checkers during
 
2454
            # downtime.
 
2455
            if client["enabled"]:
 
2456
                if datetime.datetime.utcnow() >= client["expires"]:
 
2457
                    if not client["last_checked_ok"]:
 
2458
                        logger.warning(
 
2459
                            "disabling client {0} - Client never "
 
2460
                            "performed a successful checker"
 
2461
                            .format(client_name))
 
2462
                        client["enabled"] = False
 
2463
                    elif client["last_checker_status"] != 0:
 
2464
                        logger.warning(
 
2465
                            "disabling client {0} - Client "
 
2466
                            "last checker failed with error code {1}"
 
2467
                            .format(client_name,
 
2468
                                    client["last_checker_status"]))
 
2469
                        client["enabled"] = False
 
2470
                    else:
 
2471
                        client["expires"] = (datetime.datetime
 
2472
                                             .utcnow()
 
2473
                                             + client["timeout"])
 
2474
                        logger.debug("Last checker succeeded,"
 
2475
                                     " keeping {0} enabled"
 
2476
                                     .format(client_name))
1914
2477
            try:
1915
 
                yield (name, special_settings[name]())
1916
 
            except KeyError:
1917
 
                yield (name, value)
1918
 
    
1919
 
    tcp_server.clients.update(set(
1920
 
            client_class(name = section,
1921
 
                         config= dict(client_config_items(
1922
 
                        client_config, section)))
1923
 
            for section in client_config.sections()))
 
2478
                client["secret"] = (
 
2479
                    pgp.decrypt(client["encrypted_secret"],
 
2480
                                client_settings[client_name]
 
2481
                                ["secret"]))
 
2482
            except PGPError:
 
2483
                # If decryption fails, we use secret from new settings
 
2484
                logger.debug("Failed to decrypt {0} old secret"
 
2485
                             .format(client_name))
 
2486
                client["secret"] = (
 
2487
                    client_settings[client_name]["secret"])
 
2488
    
 
2489
    # Add/remove clients based on new changes made to config
 
2490
    for client_name in (set(old_client_settings)
 
2491
                        - set(client_settings)):
 
2492
        del clients_data[client_name]
 
2493
    for client_name in (set(client_settings)
 
2494
                        - set(old_client_settings)):
 
2495
        clients_data[client_name] = client_settings[client_name]
 
2496
    
 
2497
    # Create all client objects
 
2498
    for client_name, client in clients_data.iteritems():
 
2499
        tcp_server.clients[client_name] = client_class(
 
2500
            name = client_name, settings = client)
 
2501
    
1924
2502
    if not tcp_server.clients:
1925
2503
        logger.warning("No clients defined")
1926
 
        
1927
 
    if not debug:
1928
 
        try:
1929
 
            with pidfile:
1930
 
                pid = os.getpid()
1931
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
1932
 
            del pidfile
1933
 
        except IOError:
1934
 
            logger.error("Could not write to file %r with PID %d",
1935
 
                         pidfilename, pid)
1936
 
        except NameError:
1937
 
            # "pidfile" was never created
1938
 
            pass
 
2504
    
 
2505
    if not foreground:
 
2506
        if pidfile is not None:
 
2507
            try:
 
2508
                with pidfile:
 
2509
                    pid = os.getpid()
 
2510
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2511
            except IOError:
 
2512
                logger.error("Could not write to file %r with PID %d",
 
2513
                             pidfilename, pid)
 
2514
        del pidfile
1939
2515
        del pidfilename
1940
 
        
1941
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
1942
 
 
 
2516
    
1943
2517
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1944
2518
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1945
2519
    
1946
2520
    if use_dbus:
1947
 
        class MandosDBusService(dbus.service.Object):
 
2521
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2522
                                        "se.bsnet.fukt.Mandos"})
 
2523
        class MandosDBusService(DBusObjectWithProperties):
1948
2524
            """A D-Bus proxy object"""
1949
2525
            def __init__(self):
1950
2526
                dbus.service.Object.__init__(self, bus, "/")
1951
 
            _interface = "se.bsnet.fukt.Mandos"
 
2527
            _interface = "se.recompile.Mandos"
 
2528
            
 
2529
            @dbus_interface_annotations(_interface)
 
2530
            def _foo(self):
 
2531
                return { "org.freedesktop.DBus.Property"
 
2532
                         ".EmitsChangedSignal":
 
2533
                             "false"}
1952
2534
            
1953
2535
            @dbus.service.signal(_interface, signature="o")
1954
2536
            def ClientAdded(self, objpath):
1969
2551
            def GetAllClients(self):
1970
2552
                "D-Bus method"
1971
2553
                return dbus.Array(c.dbus_object_path
1972
 
                                  for c in tcp_server.clients)
 
2554
                                  for c in
 
2555
                                  tcp_server.clients.itervalues())
1973
2556
            
1974
2557
            @dbus.service.method(_interface,
1975
2558
                                 out_signature="a{oa{sv}}")
1977
2560
                "D-Bus method"
1978
2561
                return dbus.Dictionary(
1979
2562
                    ((c.dbus_object_path, c.GetAll(""))
1980
 
                     for c in tcp_server.clients),
 
2563
                     for c in tcp_server.clients.itervalues()),
1981
2564
                    signature="oa{sv}")
1982
2565
            
1983
2566
            @dbus.service.method(_interface, in_signature="o")
1984
2567
            def RemoveClient(self, object_path):
1985
2568
                "D-Bus method"
1986
 
                for c in tcp_server.clients:
 
2569
                for c in tcp_server.clients.itervalues():
1987
2570
                    if c.dbus_object_path == object_path:
1988
 
                        tcp_server.clients.remove(c)
 
2571
                        del tcp_server.clients[c.name]
1989
2572
                        c.remove_from_connection()
1990
2573
                        # Don't signal anything except ClientRemoved
1991
2574
                        c.disable(quiet=True)
2002
2585
        "Cleanup function; run on exit"
2003
2586
        service.cleanup()
2004
2587
        
 
2588
        multiprocessing.active_children()
 
2589
        if not (tcp_server.clients or client_settings):
 
2590
            return
 
2591
        
 
2592
        # Store client before exiting. Secrets are encrypted with key
 
2593
        # based on what config file has. If config file is
 
2594
        # removed/edited, old secret will thus be unrecovable.
 
2595
        clients = {}
 
2596
        with PGPEngine() as pgp:
 
2597
            for client in tcp_server.clients.itervalues():
 
2598
                key = client_settings[client.name]["secret"]
 
2599
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2600
                                                      key)
 
2601
                client_dict = {}
 
2602
                
 
2603
                # A list of attributes that can not be pickled
 
2604
                # + secret.
 
2605
                exclude = set(("bus", "changedstate", "secret",
 
2606
                               "checker"))
 
2607
                for name, typ in (inspect.getmembers
 
2608
                                  (dbus.service.Object)):
 
2609
                    exclude.add(name)
 
2610
                
 
2611
                client_dict["encrypted_secret"] = (client
 
2612
                                                   .encrypted_secret)
 
2613
                for attr in client.client_structure:
 
2614
                    if attr not in exclude:
 
2615
                        client_dict[attr] = getattr(client, attr)
 
2616
                
 
2617
                clients[client.name] = client_dict
 
2618
                del client_settings[client.name]["secret"]
 
2619
        
 
2620
        try:
 
2621
            with (tempfile.NamedTemporaryFile
 
2622
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2623
                   dir=os.path.dirname(stored_state_path),
 
2624
                   delete=False)) as stored_state:
 
2625
                pickle.dump((clients, client_settings), stored_state)
 
2626
                tempname=stored_state.name
 
2627
            os.rename(tempname, stored_state_path)
 
2628
        except (IOError, OSError) as e:
 
2629
            if not debug:
 
2630
                try:
 
2631
                    os.remove(tempname)
 
2632
                except NameError:
 
2633
                    pass
 
2634
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2635
                logger.warning("Could not save persistent state: {0}"
 
2636
                               .format(os.strerror(e.errno)))
 
2637
            else:
 
2638
                logger.warning("Could not save persistent state:",
 
2639
                               exc_info=e)
 
2640
                raise e
 
2641
        
 
2642
        # Delete all clients, and settings from config
2005
2643
        while tcp_server.clients:
2006
 
            client = tcp_server.clients.pop()
 
2644
            name, client = tcp_server.clients.popitem()
2007
2645
            if use_dbus:
2008
2646
                client.remove_from_connection()
2009
 
            client.disable_hook = None
2010
2647
            # Don't signal anything except ClientRemoved
2011
2648
            client.disable(quiet=True)
2012
2649
            if use_dbus:
2013
2650
                # Emit D-Bus signal
2014
 
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
 
2651
                mandos_dbus_service.ClientRemoved(client
 
2652
                                                  .dbus_object_path,
2015
2653
                                                  client.name)
 
2654
        client_settings.clear()
2016
2655
    
2017
2656
    atexit.register(cleanup)
2018
2657
    
2019
 
    for client in tcp_server.clients:
 
2658
    for client in tcp_server.clients.itervalues():
2020
2659
        if use_dbus:
2021
2660
            # Emit D-Bus signal
2022
2661
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2023
 
        client.enable()
 
2662
        # Need to initiate checking of clients
 
2663
        if client.enabled:
 
2664
            client.init_checker()
2024
2665
    
2025
2666
    tcp_server.enable()
2026
2667
    tcp_server.server_activate()
2029
2670
    service.port = tcp_server.socket.getsockname()[1]
2030
2671
    if use_ipv6:
2031
2672
        logger.info("Now listening on address %r, port %d,"
2032
 
                    " flowinfo %d, scope_id %d"
2033
 
                    % tcp_server.socket.getsockname())
 
2673
                    " flowinfo %d, scope_id %d",
 
2674
                    *tcp_server.socket.getsockname())
2034
2675
    else:                       # IPv4
2035
 
        logger.info("Now listening on address %r, port %d"
2036
 
                    % tcp_server.socket.getsockname())
 
2676
        logger.info("Now listening on address %r, port %d",
 
2677
                    *tcp_server.socket.getsockname())
2037
2678
    
2038
2679
    #service.interface = tcp_server.socket.getsockname()[3]
2039
2680
    
2042
2683
        try:
2043
2684
            service.activate()
2044
2685
        except dbus.exceptions.DBusException as error:
2045
 
            logger.critical("DBusException: %s", error)
 
2686
            logger.critical("D-Bus Exception", exc_info=error)
2046
2687
            cleanup()
2047
2688
            sys.exit(1)
2048
2689
        # End of Avahi example code
2055
2696
        logger.debug("Starting main loop")
2056
2697
        main_loop.run()
2057
2698
    except AvahiError as error:
2058
 
        logger.critical("AvahiError: %s", error)
 
2699
        logger.critical("Avahi Error", exc_info=error)
2059
2700
        cleanup()
2060
2701
        sys.exit(1)
2061
2702
    except KeyboardInterrupt: