/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2011-04-02 06:37:18 UTC
  • Revision ID: teddy@fukt.bsnet.se-20110402063718-13ldrcuu0t33sdc4
* mandos: Tolerate restarting Avahi servers.  Also Changed to new
          "except x as y" exception syntax.
  (AvahiService.entry_group_state_changed_match): New; contains the
                                                  SignalMatch object.
  (AvahiService.remove): Really remove the group and the signal
                         connection, if any.
  (AvahiService.add): Always create a new group and signal connection.
  (AvahiService.cleanup): Changed to simply call remove().
  (AvahiService.server_state_changed): Handle and log more bad states.
  (AvahiService.activate): Set "follow_name_owner_changes=True" on the
                           Avahi Server proxy object.
  (ClientDBus.checked_ok): Do not return anything.
  (ClientDBus.CheckedOK): Do not return anything, as documented.
* mandos-monitor: Call D-Bus methods asynchronously.

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-2012 Teddy Hogeborn
15
 
# Copyright © 2008-2012 Björn Påhlsson
 
14
# Copyright © 2008-2011 Teddy Hogeborn
 
15
# Copyright © 2008-2011 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@recompile.se>.
 
31
# Contact the authors at <mandos@fukt.bsnet.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
 
 
39
37
import SocketServer as socketserver
40
38
import socket
41
39
import argparse
64
62
import functools
65
63
import cPickle as pickle
66
64
import multiprocessing
67
 
import types
68
 
import binascii
69
 
import tempfile
70
 
import itertools
71
65
 
72
66
import dbus
73
67
import dbus.service
78
72
import ctypes.util
79
73
import xml.dom.minidom
80
74
import inspect
81
 
import GnuPGInterface
82
75
 
83
76
try:
84
77
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
88
81
    except ImportError:
89
82
        SO_BINDTODEVICE = None
90
83
 
91
 
version = "1.5.4"
92
 
stored_state_file = "clients.pickle"
93
 
 
94
 
logger = logging.getLogger()
 
84
 
 
85
version = "1.3.0"
 
86
 
 
87
#logger = logging.getLogger('mandos')
 
88
logger = logging.Logger('mandos')
95
89
syslogger = (logging.handlers.SysLogHandler
96
90
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
97
91
              address = str("/dev/log")))
98
 
 
99
 
try:
100
 
    if_nametoindex = (ctypes.cdll.LoadLibrary
101
 
                      (ctypes.util.find_library("c"))
102
 
                      .if_nametoindex)
103
 
except (OSError, AttributeError):
104
 
    def if_nametoindex(interface):
105
 
        "Get an interface index the hard way, i.e. using fcntl()"
106
 
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
107
 
        with contextlib.closing(socket.socket()) as s:
108
 
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
109
 
                                struct.pack(str("16s16x"),
110
 
                                            interface))
111
 
        interface_index = struct.unpack(str("I"),
112
 
                                        ifreq[16:20])[0]
113
 
        return interface_index
114
 
 
115
 
 
116
 
def initlogger(debug, level=logging.WARNING):
117
 
    """init logger and add loglevel"""
118
 
    
119
 
    syslogger.setFormatter(logging.Formatter
120
 
                           ('Mandos [%(process)d]: %(levelname)s:'
121
 
                            ' %(message)s'))
122
 
    logger.addHandler(syslogger)
123
 
    
124
 
    if debug:
125
 
        console = logging.StreamHandler()
126
 
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
127
 
                                               ' [%(process)d]:'
128
 
                                               ' %(levelname)s:'
129
 
                                               ' %(message)s'))
130
 
        logger.addHandler(console)
131
 
    logger.setLevel(level)
132
 
 
133
 
 
134
 
class PGPError(Exception):
135
 
    """Exception if encryption/decryption fails"""
136
 
    pass
137
 
 
138
 
 
139
 
class PGPEngine(object):
140
 
    """A simple class for OpenPGP symmetric encryption & decryption"""
141
 
    def __init__(self):
142
 
        self.gnupg = GnuPGInterface.GnuPG()
143
 
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
144
 
        self.gnupg = GnuPGInterface.GnuPG()
145
 
        self.gnupg.options.meta_interactive = False
146
 
        self.gnupg.options.homedir = self.tempdir
147
 
        self.gnupg.options.extra_args.extend(['--force-mdc',
148
 
                                              '--quiet',
149
 
                                              '--no-use-agent'])
150
 
    
151
 
    def __enter__(self):
152
 
        return self
153
 
    
154
 
    def __exit__(self, exc_type, exc_value, traceback):
155
 
        self._cleanup()
156
 
        return False
157
 
    
158
 
    def __del__(self):
159
 
        self._cleanup()
160
 
    
161
 
    def _cleanup(self):
162
 
        if self.tempdir is not None:
163
 
            # Delete contents of tempdir
164
 
            for root, dirs, files in os.walk(self.tempdir,
165
 
                                             topdown = False):
166
 
                for filename in files:
167
 
                    os.remove(os.path.join(root, filename))
168
 
                for dirname in dirs:
169
 
                    os.rmdir(os.path.join(root, dirname))
170
 
            # Remove tempdir
171
 
            os.rmdir(self.tempdir)
172
 
            self.tempdir = None
173
 
    
174
 
    def password_encode(self, password):
175
 
        # Passphrase can not be empty and can not contain newlines or
176
 
        # NUL bytes.  So we prefix it and hex encode it.
177
 
        return b"mandos" + binascii.hexlify(password)
178
 
    
179
 
    def encrypt(self, data, password):
180
 
        self.gnupg.passphrase = self.password_encode(password)
181
 
        with open(os.devnull, "w") as devnull:
182
 
            try:
183
 
                proc = self.gnupg.run(['--symmetric'],
184
 
                                      create_fhs=['stdin', 'stdout'],
185
 
                                      attach_fhs={'stderr': devnull})
186
 
                with contextlib.closing(proc.handles['stdin']) as f:
187
 
                    f.write(data)
188
 
                with contextlib.closing(proc.handles['stdout']) as f:
189
 
                    ciphertext = f.read()
190
 
                proc.wait()
191
 
            except IOError as e:
192
 
                raise PGPError(e)
193
 
        self.gnupg.passphrase = None
194
 
        return ciphertext
195
 
    
196
 
    def decrypt(self, data, password):
197
 
        self.gnupg.passphrase = self.password_encode(password)
198
 
        with open(os.devnull, "w") as devnull:
199
 
            try:
200
 
                proc = self.gnupg.run(['--decrypt'],
201
 
                                      create_fhs=['stdin', 'stdout'],
202
 
                                      attach_fhs={'stderr': devnull})
203
 
                with contextlib.closing(proc.handles['stdin']) as f:
204
 
                    f.write(data)
205
 
                with contextlib.closing(proc.handles['stdout']) as f:
206
 
                    decrypted_plaintext = f.read()
207
 
                proc.wait()
208
 
            except IOError as e:
209
 
                raise PGPError(e)
210
 
        self.gnupg.passphrase = None
211
 
        return decrypted_plaintext
212
 
 
 
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)
213
102
 
214
103
class AvahiError(Exception):
215
104
    def __init__(self, value, *args, **kwargs):
245
134
    server: D-Bus Server
246
135
    bus: dbus.SystemBus()
247
136
    """
248
 
    
249
137
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
250
138
                 servicetype = None, port = None, TXT = None,
251
139
                 domain = "", host = "", max_renames = 32768,
264
152
        self.server = None
265
153
        self.bus = bus
266
154
        self.entry_group_state_changed_match = None
267
 
    
268
155
    def rename(self):
269
156
        """Derived from the Avahi example code"""
270
157
        if self.rename_count >= self.max_renames:
272
159
                            " after %i retries, exiting.",
273
160
                            self.rename_count)
274
161
            raise AvahiServiceError("Too many renames")
275
 
        self.name = unicode(self.server
276
 
                            .GetAlternativeServiceName(self.name))
 
162
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
277
163
        logger.info("Changing Zeroconf service name to %r ...",
278
164
                    self.name)
 
165
        syslogger.setFormatter(logging.Formatter
 
166
                               ('Mandos (%s) [%%(process)d]:'
 
167
                                ' %%(levelname)s: %%(message)s'
 
168
                                % self.name))
279
169
        self.remove()
280
170
        try:
281
171
            self.add()
282
172
        except dbus.exceptions.DBusException as error:
283
 
            logger.critical("D-Bus Exception", exc_info=error)
 
173
            logger.critical("DBusException: %s", error)
284
174
            self.cleanup()
285
175
            os._exit(1)
286
176
        self.rename_count += 1
287
 
    
288
177
    def remove(self):
289
178
        """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
290
186
        if self.entry_group_state_changed_match is not None:
291
187
            self.entry_group_state_changed_match.remove()
292
188
            self.entry_group_state_changed_match = None
293
 
        if self.group is not None:
294
 
            self.group.Reset()
295
 
    
296
189
    def add(self):
297
190
        """Derived from the Avahi example code"""
298
191
        self.remove()
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)
 
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)
304
197
        self.entry_group_state_changed_match = (
305
198
            self.group.connect_to_signal(
306
 
                'StateChanged', self.entry_group_state_changed))
 
199
                'StateChanged', self .entry_group_state_changed))
307
200
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
308
201
                     self.name, self.type)
309
202
        self.group.AddService(
315
208
            dbus.UInt16(self.port),
316
209
            avahi.string_array_to_txt_array(self.TXT))
317
210
        self.group.Commit()
318
 
    
319
211
    def entry_group_state_changed(self, state, error):
320
212
        """Derived from the Avahi example code"""
321
213
        logger.debug("Avahi entry group state change: %i", state)
328
220
        elif state == avahi.ENTRY_GROUP_FAILURE:
329
221
            logger.critical("Avahi: Error in group state changed %s",
330
222
                            unicode(error))
331
 
            raise AvahiGroupError("State changed: {0!s}"
332
 
                                  .format(error))
333
 
    
 
223
            raise AvahiGroupError("State changed: %s"
 
224
                                  % unicode(error))
334
225
    def cleanup(self):
335
226
        """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
343
227
        self.remove()
344
 
    
345
228
    def server_state_changed(self, state, error=None):
346
229
        """Derived from the Avahi example code"""
347
230
        logger.debug("Avahi server state change: %i", state)
353
236
                       avahi.SERVER_FAILURE:
354
237
                           "Zeroconf server failure" }
355
238
        if state in bad_states:
356
 
            if bad_states[state] is not None:
357
 
                if error is None:
358
 
                    logger.error(bad_states[state])
359
 
                else:
360
 
                    logger.error(bad_states[state] + ": %r", error)
361
 
            self.cleanup()
 
239
            if bad_states[state]:
 
240
                logger.error(bad_states[state])
 
241
            self.remove()
362
242
        elif state == avahi.SERVER_RUNNING:
363
243
            self.add()
364
244
        else:
365
 
            if error is None:
366
 
                logger.debug("Unknown state: %r", state)
367
 
            else:
368
 
                logger.debug("Unknown state: %r: %r", state, error)
369
 
    
 
245
            logger.debug("Unknown state: %r", state)
370
246
    def activate(self):
371
247
        """Derived from the Avahi example code"""
372
248
        if self.server is None:
380
256
        self.server_state_changed(self.server.GetState())
381
257
 
382
258
 
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
 
 
401
259
class Client(object):
402
260
    """A representation of a client host served by this server.
403
261
    
404
262
    Attributes:
405
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
263
    _approved:   bool(); 'None' if not yet approved/disapproved
406
264
    approval_delay: datetime.timedelta(); Time to wait for approval
407
265
    approval_duration: datetime.timedelta(); Duration of one approval
408
266
    checker:    subprocess.Popen(); a running checker process used
415
273
                     instance %(name)s can be used in the command.
416
274
    checker_initiator_tag: a gobject event source tag, or None
417
275
    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
420
276
    current_checker_command: string; current running checker_command
 
277
    disable_hook:  If set, called by disable() as disable_hook(self)
421
278
    disable_initiator_tag: a gobject event source tag, or None
422
279
    enabled:    bool()
423
280
    fingerprint: string (40 or 32 hexadecimal digits); used to
426
283
    interval:   datetime.timedelta(); How often to start a new checker
427
284
    last_approval_request: datetime.datetime(); (UTC) or None
428
285
    last_checked_ok: datetime.datetime(); (UTC) or None
429
 
    last_checker_status: integer between 0 and 255 reflecting exit
430
 
                         status of last checker. -1 reflects crashed
431
 
                         checker, -2 means no checker completed yet.
432
 
    last_enabled: datetime.datetime(); (UTC) or None
 
286
    last_enabled: datetime.datetime(); (UTC)
433
287
    name:       string; from the config file, used in log messages and
434
288
                        D-Bus identifiers
435
289
    secret:     bytestring; sent verbatim (over TLS) to client
436
290
    timeout:    datetime.timedelta(); How long from last_checked_ok
437
291
                                      until this client is disabled
438
 
    extended_timeout:   extra long timeout when secret has been sent
439
292
    runtime_expansions: Allowed attributes for runtime expansion.
440
 
    expires:    datetime.datetime(); time (UTC) when a client will be
441
 
                disabled, or None
442
293
    """
443
294
    
444
295
    runtime_expansions = ("approval_delay", "approval_duration",
445
 
                          "created", "enabled", "expires",
446
 
                          "fingerprint", "host", "interval",
447
 
                          "last_approval_request", "last_checked_ok",
 
296
                          "created", "enabled", "fingerprint",
 
297
                          "host", "interval", "last_checked_ok",
448
298
                          "last_enabled", "name", "timeout")
449
 
    client_defaults = { "timeout": "5m",
450
 
                        "extended_timeout": "15m",
451
 
                        "interval": "2m",
452
 
                        "checker": "fping -q -- %%(host)s",
453
 
                        "host": "",
454
 
                        "approval_delay": "0s",
455
 
                        "approval_duration": "1s",
456
 
                        "approved_by_default": "True",
457
 
                        "enabled": "True",
458
 
                        }
 
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))
459
306
    
460
307
    def timeout_milliseconds(self):
461
308
        "Return the 'timeout' attribute in milliseconds"
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)
 
309
        return self._timedelta_to_milliseconds(self.timeout)
467
310
    
468
311
    def interval_milliseconds(self):
469
312
        "Return the 'interval' attribute in milliseconds"
470
 
        return timedelta_to_milliseconds(self.interval)
471
 
    
 
313
        return self._timedelta_to_milliseconds(self.interval)
 
314
 
472
315
    def approval_delay_milliseconds(self):
473
 
        return timedelta_to_milliseconds(self.approval_delay)
474
 
    
475
 
    @staticmethod
476
 
    def config_parser(config):
477
 
        """Construct a new dict of client settings of this form:
478
 
        { client_name: {setting_name: value, ...}, ...}
479
 
        with exceptions for any special settings as defined above.
480
 
        NOTE: Must be a pure function. Must return the same result
481
 
        value given the same arguments.
482
 
        """
483
 
        settings = {}
484
 
        for client_name in config.sections():
485
 
            section = dict(config.items(client_name))
486
 
            client = settings[client_name] = {}
487
 
            
488
 
            client["host"] = section["host"]
489
 
            # Reformat values from string types to Python types
490
 
            client["approved_by_default"] = config.getboolean(
491
 
                client_name, "approved_by_default")
492
 
            client["enabled"] = config.getboolean(client_name,
493
 
                                                  "enabled")
494
 
            
495
 
            client["fingerprint"] = (section["fingerprint"].upper()
496
 
                                     .replace(" ", ""))
497
 
            if "secret" in section:
498
 
                client["secret"] = section["secret"].decode("base64")
499
 
            elif "secfile" in section:
500
 
                with open(os.path.expanduser(os.path.expandvars
501
 
                                             (section["secfile"])),
502
 
                          "rb") as secfile:
503
 
                    client["secret"] = secfile.read()
504
 
            else:
505
 
                raise TypeError("No secret or secfile for section {0}"
506
 
                                .format(section))
507
 
            client["timeout"] = string_to_delta(section["timeout"])
508
 
            client["extended_timeout"] = string_to_delta(
509
 
                section["extended_timeout"])
510
 
            client["interval"] = string_to_delta(section["interval"])
511
 
            client["approval_delay"] = string_to_delta(
512
 
                section["approval_delay"])
513
 
            client["approval_duration"] = string_to_delta(
514
 
                section["approval_duration"])
515
 
            client["checker_command"] = section["checker"]
516
 
            client["last_approval_request"] = None
517
 
            client["last_checked_ok"] = None
518
 
            client["last_checker_status"] = -2
519
 
        
520
 
        return settings
521
 
    
522
 
    def __init__(self, settings, name = None):
 
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."""
523
322
        self.name = name
524
 
        # adding all client settings
525
 
        for setting, value in settings.iteritems():
526
 
            setattr(self, setting, value)
527
 
        
528
 
        if self.enabled:
529
 
            if not hasattr(self, "last_enabled"):
530
 
                self.last_enabled = datetime.datetime.utcnow()
531
 
            if not hasattr(self, "expires"):
532
 
                self.expires = (datetime.datetime.utcnow()
533
 
                                + self.timeout)
534
 
        else:
535
 
            self.last_enabled = None
536
 
            self.expires = None
537
 
        
 
323
        if config is None:
 
324
            config = {}
538
325
        logger.debug("Creating client %r", self.name)
539
326
        # Uppercase and remove spaces from fingerprint for later
540
327
        # comparison purposes with return value from the fingerprint()
541
328
        # function
 
329
        self.fingerprint = (config["fingerprint"].upper()
 
330
                            .replace(" ", ""))
542
331
        logger.debug("  Fingerprint: %s", self.fingerprint)
543
 
        self.created = settings.get("created",
544
 
                                    datetime.datetime.utcnow())
545
 
        
546
 
        # attributes specific for this server instance
 
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
547
351
        self.checker = None
548
352
        self.checker_initiator_tag = None
549
353
        self.disable_initiator_tag = None
550
354
        self.checker_callback_tag = None
 
355
        self.checker_command = config["checker"]
551
356
        self.current_checker_command = None
552
 
        self.approved = None
 
357
        self.last_connect = None
 
358
        self._approved = None
 
359
        self.approved_by_default = config.get("approved_by_default",
 
360
                                              True)
553
361
        self.approvals_pending = 0
554
 
        self.changedstate = (multiprocessing_manager
555
 
                             .Condition(multiprocessing_manager
556
 
                                        .Lock()))
557
 
        self.client_structure = [attr for attr in
558
 
                                 self.__dict__.iterkeys()
559
 
                                 if not attr.startswith("_")]
560
 
        self.client_structure.append("client_structure")
561
 
        
562
 
        for name, t in inspect.getmembers(type(self),
563
 
                                          lambda obj:
564
 
                                              isinstance(obj,
565
 
                                                         property)):
566
 
            if not name.startswith("_"):
567
 
                self.client_structure.append(name)
 
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())
568
367
    
569
 
    # Send notice to process children that client state has changed
570
368
    def send_changedstate(self):
571
 
        with self.changedstate:
572
 
            self.changedstate.notify_all()
573
 
    
 
369
        self.changedstate.acquire()
 
370
        self.changedstate.notify_all()
 
371
        self.changedstate.release()
 
372
        
574
373
    def enable(self):
575
374
        """Start this client's checker and timeout hooks"""
576
375
        if getattr(self, "enabled", False):
577
376
            # Already enabled
578
377
            return
579
 
        self.expires = datetime.datetime.utcnow() + self.timeout
580
 
        self.enabled = True
 
378
        self.send_changedstate()
581
379
        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):
609
380
        # Schedule a new checker to be started an 'interval' from now,
610
381
        # and every interval from then on.
611
 
        if self.checker_initiator_tag is not None:
612
 
            gobject.source_remove(self.checker_initiator_tag)
613
382
        self.checker_initiator_tag = (gobject.timeout_add
614
383
                                      (self.interval_milliseconds(),
615
384
                                       self.start_checker))
616
385
        # Schedule a disable() when 'timeout' has passed
617
 
        if self.disable_initiator_tag is not None:
618
 
            gobject.source_remove(self.disable_initiator_tag)
619
386
        self.disable_initiator_tag = (gobject.timeout_add
620
387
                                   (self.timeout_milliseconds(),
621
388
                                    self.disable))
 
389
        self.enabled = True
622
390
        # Also start a new checker *right now*.
623
391
        self.start_checker()
624
392
    
 
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
    
625
418
    def checker_callback(self, pid, condition, command):
626
419
        """The checker has completed, so take appropriate actions."""
627
420
        self.checker_callback_tag = None
628
421
        self.checker = None
629
422
        if os.WIFEXITED(condition):
630
 
            self.last_checker_status = os.WEXITSTATUS(condition)
631
 
            if self.last_checker_status == 0:
 
423
            exitstatus = os.WEXITSTATUS(condition)
 
424
            if exitstatus == 0:
632
425
                logger.info("Checker for %(name)s succeeded",
633
426
                            vars(self))
634
427
                self.checked_ok()
636
429
                logger.info("Checker for %(name)s failed",
637
430
                            vars(self))
638
431
        else:
639
 
            self.last_checker_status = -1
640
432
            logger.warning("Checker for %(name)s crashed?",
641
433
                           vars(self))
642
434
    
643
435
    def checked_ok(self):
644
 
        """Assert that the client has been seen, alive and well."""
 
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
        """
645
441
        self.last_checked_ok = datetime.datetime.utcnow()
646
 
        self.last_checker_status = 0
647
 
        self.bump_timeout()
648
 
    
649
 
    def bump_timeout(self, timeout=None):
650
 
        """Bump up the timeout for this client."""
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
 
442
        gobject.source_remove(self.disable_initiator_tag)
 
443
        self.disable_initiator_tag = (gobject.timeout_add
 
444
                                      (self.timeout_milliseconds(),
 
445
                                       self.disable))
661
446
    
662
447
    def need_approval(self):
663
448
        self.last_approval_request = datetime.datetime.utcnow()
668
453
        If a checker already exists, leave it running and do
669
454
        nothing."""
670
455
        # The reason for not killing a running checker is that if we
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
 
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
675
460
        # checkers alone, the checker would have to take more time
676
461
        # than 'timeout' for the client to be disabled, which is as it
677
462
        # should be.
691
476
                                      self.current_checker_command)
692
477
        # Start a new checker if needed
693
478
        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)
699
479
            try:
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
 
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
705
498
            self.current_checker_command = command
706
499
            try:
707
500
                logger.info("Starting checker %r for %s",
713
506
                self.checker = subprocess.Popen(command,
714
507
                                                close_fds=True,
715
508
                                                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)
716
519
            except OSError as error:
717
 
                logger.error("Failed to start subprocess",
718
 
                             exc_info=error)
719
 
            self.checker_callback_tag = (gobject.child_watch_add
720
 
                                         (self.checker.pid,
721
 
                                          self.checker_callback,
722
 
                                          data=command))
723
 
            # The checker may have completed before the gobject
724
 
            # watch was added.  Check for this.
725
 
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
726
 
            if pid:
727
 
                gobject.source_remove(self.checker_callback_tag)
728
 
                self.checker_callback(pid, status, command)
 
520
                logger.error("Failed to start subprocess: %s",
 
521
                             error)
729
522
        # Re-run this periodically if run by gobject.timeout_add
730
523
        return True
731
524
    
738
531
            return
739
532
        logger.debug("Stopping checker for %(name)s", vars(self))
740
533
        try:
741
 
            self.checker.terminate()
 
534
            os.kill(self.checker.pid, signal.SIGTERM)
742
535
            #time.sleep(0.5)
743
536
            #if self.checker.poll() is None:
744
 
            #    self.checker.kill()
 
537
            #    os.kill(self.checker.pid, signal.SIGKILL)
745
538
        except OSError as error:
746
539
            if error.errno != errno.ESRCH: # No such process
747
540
                raise
748
541
        self.checker = None
749
542
 
750
 
 
751
543
def dbus_service_property(dbus_interface, signature="v",
752
544
                          access="readwrite", byte_arrays=False):
753
545
    """Decorators for marking methods of a DBusObjectWithProperties to
764
556
    # "Set" method, so we fail early here:
765
557
    if byte_arrays and signature != "ay":
766
558
        raise ValueError("Byte arrays not supported for non-'ay'"
767
 
                         " signature {0!r}".format(signature))
 
559
                         " signature %r" % signature)
768
560
    def decorator(func):
769
561
        func._dbus_is_property = True
770
562
        func._dbus_interface = dbus_interface
778
570
    return decorator
779
571
 
780
572
 
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
 
 
818
573
class DBusPropertyException(dbus.exceptions.DBusException):
819
574
    """A base class for D-Bus property-related exceptions
820
575
    """
836
591
 
837
592
class DBusObjectWithProperties(dbus.service.Object):
838
593
    """A D-Bus object with properties.
839
 
    
 
594
 
840
595
    Classes inheriting from this can use the dbus_service_property
841
596
    decorator to expose methods as D-Bus properties.  It exposes the
842
597
    standard Get(), Set(), and GetAll() methods on the D-Bus.
843
598
    """
844
599
    
845
600
    @staticmethod
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)
 
601
    def _is_dbus_property(obj):
 
602
        return getattr(obj, "_dbus_is_property", False)
854
603
    
855
 
    def _get_all_dbus_things(self, thing):
 
604
    def _get_all_dbus_properties(self):
856
605
        """Returns a generator of (name, attribute) pairs
857
606
        """
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)))
 
607
        return ((prop._dbus_name, prop)
 
608
                for name, prop in
 
609
                inspect.getmembers(self, self._is_dbus_property))
865
610
    
866
611
    def _get_dbus_property(self, interface_name, property_name):
867
612
        """Returns a bound method if one exists which is a D-Bus
868
613
        property with the specified name and interface.
869
614
        """
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
 
        
 
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
878
625
        # No such property
879
626
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
880
627
                                   + interface_name + "."
905
652
            # signatures other than "ay".
906
653
            if prop._dbus_signature != "ay":
907
654
                raise ValueError
908
 
            value = dbus.ByteArray(b''.join(chr(byte)
909
 
                                            for byte in value))
 
655
            value = dbus.ByteArray(''.join(unichr(byte)
 
656
                                           for byte in value))
910
657
        prop(value)
911
658
    
912
659
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
914
661
    def GetAll(self, interface_name):
915
662
        """Standard D-Bus property GetAll() method, see D-Bus
916
663
        standard.
917
 
        
 
664
 
918
665
        Note: Will not include properties with access="write".
919
666
        """
920
 
        properties = {}
921
 
        for name, prop in self._get_all_dbus_things("property"):
 
667
        all = {}
 
668
        for name, prop in self._get_all_dbus_properties():
922
669
            if (interface_name
923
670
                and interface_name != prop._dbus_interface):
924
671
                # Interface non-empty but did not match
928
675
                continue
929
676
            value = prop()
930
677
            if not hasattr(value, "variant_level"):
931
 
                properties[name] = value
 
678
                all[name] = value
932
679
                continue
933
 
            properties[name] = type(value)(value, variant_level=
934
 
                                           value.variant_level+1)
935
 
        return dbus.Dictionary(properties, signature="sv")
 
680
            all[name] = type(value)(value, variant_level=
 
681
                                    value.variant_level+1)
 
682
        return dbus.Dictionary(all, signature="sv")
936
683
    
937
684
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
938
685
                         out_signature="s",
939
686
                         path_keyword='object_path',
940
687
                         connection_keyword='connection')
941
688
    def Introspect(self, object_path, connection):
942
 
        """Overloading of standard D-Bus method.
943
 
        
944
 
        Inserts property tags and interface annotation tags.
 
689
        """Standard D-Bus method, overloaded to insert property tags.
945
690
        """
946
691
        xmlstring = dbus.service.Object.Introspect(self, object_path,
947
692
                                                   connection)
954
699
                e.setAttribute("access", prop._dbus_access)
955
700
                return e
956
701
            for if_tag in document.getElementsByTagName("interface"):
957
 
                # Add property tags
958
702
                for tag in (make_tag(document, name, prop)
959
703
                            for name, prop
960
 
                            in self._get_all_dbus_things("property")
 
704
                            in self._get_all_dbus_properties()
961
705
                            if prop._dbus_interface
962
706
                            == if_tag.getAttribute("name")):
963
707
                    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)
995
708
                # Add the names to the return values for the
996
709
                # "org.freedesktop.DBus.Properties" methods
997
710
                if (if_tag.getAttribute("name")
1012
725
        except (AttributeError, xml.dom.DOMException,
1013
726
                xml.parsers.expat.ExpatError) as error:
1014
727
            logger.error("Failed to override Introspection method",
1015
 
                         exc_info=error)
 
728
                         error)
1016
729
        return xmlstring
1017
730
 
1018
731
 
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"})
1198
732
class ClientDBus(Client, DBusObjectWithProperties):
1199
733
    """A Client class using D-Bus
1200
734
    
1209
743
    # dbus.service.Object doesn't use super(), so we can't either.
1210
744
    
1211
745
    def __init__(self, bus = None, *args, **kwargs):
 
746
        self._approvals_pending = 0
1212
747
        self.bus = bus
1213
748
        Client.__init__(self, *args, **kwargs)
1214
749
        # Only now, when this client is initialized, can it show up on
1220
755
                                 ("/clients/" + client_object_name))
1221
756
        DBusObjectWithProperties.__init__(self, self.bus,
1222
757
                                          self.dbus_object_path)
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
 
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
1291
802
    
1292
803
    def __del__(self, *args, **kwargs):
1293
804
        try:
1302
813
                         *args, **kwargs):
1303
814
        self.checker_callback_tag = None
1304
815
        self.checker = None
 
816
        # Emit D-Bus signal
 
817
        self.PropertyChanged(dbus.String("CheckerRunning"),
 
818
                             dbus.Boolean(False, variant_level=1))
1305
819
        if os.WIFEXITED(condition):
1306
820
            exitstatus = os.WEXITSTATUS(condition)
1307
821
            # Emit D-Bus signal
1317
831
        return Client.checker_callback(self, pid, condition, command,
1318
832
                                       *args, **kwargs)
1319
833
    
 
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
    
1320
851
    def start_checker(self, *args, **kwargs):
1321
852
        old_checker = self.checker
1322
853
        if self.checker is not None:
1329
860
            and old_checker_pid != self.checker.pid):
1330
861
            # Emit D-Bus signal
1331
862
            self.CheckerStarted(self.current_checker_command)
 
863
            self.PropertyChanged(
 
864
                dbus.String("CheckerRunning"),
 
865
                dbus.Boolean(True, variant_level=1))
1332
866
        return r
1333
867
    
 
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
 
1334
877
    def _reset_approved(self):
1335
 
        self.approved = None
 
878
        self._approved = None
1336
879
        return False
1337
880
    
1338
881
    def approve(self, value=True):
1339
 
        self.approved = value
1340
 
        gobject.timeout_add(timedelta_to_milliseconds
 
882
        self.send_changedstate()
 
883
        self._approved = value
 
884
        gobject.timeout_add(self._timedelta_to_milliseconds
1341
885
                            (self.approval_duration),
1342
886
                            self._reset_approved)
1343
 
        self.send_changedstate()
 
887
    
1344
888
    
1345
889
    ## D-Bus methods, signals & properties
1346
 
    _interface = "se.recompile.Mandos.Client"
1347
 
    
1348
 
    ## Interfaces
1349
 
    
1350
 
    @dbus_interface_annotations(_interface)
1351
 
    def _foo(self):
1352
 
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1353
 
                     "false"}
 
890
    _interface = "se.bsnet.fukt.Mandos.Client"
1354
891
    
1355
892
    ## Signals
1356
893
    
1442
979
        if value is None:       # get
1443
980
            return dbus.Boolean(self.approved_by_default)
1444
981
        self.approved_by_default = bool(value)
 
982
        # Emit D-Bus signal
 
983
        self.PropertyChanged(dbus.String("ApprovedByDefault"),
 
984
                             dbus.Boolean(value, variant_level=1))
1445
985
    
1446
986
    # ApprovalDelay - property
1447
987
    @dbus_service_property(_interface, signature="t",
1450
990
        if value is None:       # get
1451
991
            return dbus.UInt64(self.approval_delay_milliseconds())
1452
992
        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))
1453
996
    
1454
997
    # ApprovalDuration - property
1455
998
    @dbus_service_property(_interface, signature="t",
1456
999
                           access="readwrite")
1457
1000
    def ApprovalDuration_dbus_property(self, value=None):
1458
1001
        if value is None:       # get
1459
 
            return dbus.UInt64(timedelta_to_milliseconds(
 
1002
            return dbus.UInt64(self._timedelta_to_milliseconds(
1460
1003
                    self.approval_duration))
1461
1004
        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))
1462
1008
    
1463
1009
    # Name - property
1464
1010
    @dbus_service_property(_interface, signature="s", access="read")
1476
1022
    def Host_dbus_property(self, value=None):
1477
1023
        if value is None:       # get
1478
1024
            return dbus.String(self.host)
1479
 
        self.host = unicode(value)
 
1025
        self.host = value
 
1026
        # Emit D-Bus signal
 
1027
        self.PropertyChanged(dbus.String("Host"),
 
1028
                             dbus.String(value, variant_level=1))
1480
1029
    
1481
1030
    # Created - property
1482
1031
    @dbus_service_property(_interface, signature="s", access="read")
1483
1032
    def Created_dbus_property(self):
1484
 
        return datetime_to_dbus(self.created)
 
1033
        return dbus.String(self._datetime_to_dbus(self.created))
1485
1034
    
1486
1035
    # LastEnabled - property
1487
1036
    @dbus_service_property(_interface, signature="s", access="read")
1488
1037
    def LastEnabled_dbus_property(self):
1489
 
        return datetime_to_dbus(self.last_enabled)
 
1038
        if self.last_enabled is None:
 
1039
            return dbus.String("")
 
1040
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
1490
1041
    
1491
1042
    # Enabled - property
1492
1043
    @dbus_service_property(_interface, signature="b",
1506
1057
        if value is not None:
1507
1058
            self.checked_ok()
1508
1059
            return
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)
 
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))
1521
1064
    
1522
1065
    # LastApprovalRequest - property
1523
1066
    @dbus_service_property(_interface, signature="s", access="read")
1524
1067
    def LastApprovalRequest_dbus_property(self):
1525
 
        return datetime_to_dbus(self.last_approval_request)
 
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))
1526
1073
    
1527
1074
    # Timeout - property
1528
1075
    @dbus_service_property(_interface, signature="t",
1530
1077
    def Timeout_dbus_property(self, value=None):
1531
1078
        if value is None:       # get
1532
1079
            return dbus.UInt64(self.timeout_milliseconds())
1533
 
        old_timeout = self.timeout
1534
1080
        self.timeout = datetime.timedelta(0, 0, 0, value)
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)
 
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))
1559
1101
    
1560
1102
    # Interval - property
1561
1103
    @dbus_service_property(_interface, signature="t",
1564
1106
        if value is None:       # get
1565
1107
            return dbus.UInt64(self.interval_milliseconds())
1566
1108
        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))
1567
1112
        if getattr(self, "checker_initiator_tag", None) is None:
1568
1113
            return
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
 
    
 
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
 
1576
1120
    # Checker - property
1577
1121
    @dbus_service_property(_interface, signature="s",
1578
1122
                           access="readwrite")
1579
1123
    def Checker_dbus_property(self, value=None):
1580
1124
        if value is None:       # get
1581
1125
            return dbus.String(self.checker_command)
1582
 
        self.checker_command = unicode(value)
 
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))
1583
1131
    
1584
1132
    # CheckerRunning - property
1585
1133
    @dbus_service_property(_interface, signature="b",
1612
1160
        self._pipe.send(('init', fpr, address))
1613
1161
        if not self._pipe.recv():
1614
1162
            raise KeyError()
1615
 
    
 
1163
 
1616
1164
    def __getattribute__(self, name):
1617
 
        if name == '_pipe':
 
1165
        if(name == '_pipe'):
1618
1166
            return super(ProxyClient, self).__getattribute__(name)
1619
1167
        self._pipe.send(('getattr', name))
1620
1168
        data = self._pipe.recv()
1625
1173
                self._pipe.send(('funcall', name, args, kwargs))
1626
1174
                return self._pipe.recv()[1]
1627
1175
            return func
1628
 
    
 
1176
 
1629
1177
    def __setattr__(self, name, value):
1630
 
        if name == '_pipe':
 
1178
        if(name == '_pipe'):
1631
1179
            return super(ProxyClient, self).__setattr__(name, value)
1632
1180
        self._pipe.send(('setattr', name, value))
1633
1181
 
1644
1192
                        unicode(self.client_address))
1645
1193
            logger.debug("Pipe FD: %d",
1646
1194
                         self.server.child_pipe.fileno())
1647
 
            
 
1195
 
1648
1196
            session = (gnutls.connection
1649
1197
                       .ClientSession(self.request,
1650
1198
                                      gnutls.connection
1651
1199
                                      .X509Credentials()))
1652
 
            
 
1200
 
1653
1201
            # Note: gnutls.connection.X509Credentials is really a
1654
1202
            # generic GnuTLS certificate credentials object so long as
1655
1203
            # no X.509 keys are added to it.  Therefore, we can use it
1656
1204
            # here despite using OpenPGP certificates.
1657
 
            
 
1205
 
1658
1206
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1659
1207
            #                      "+AES-256-CBC", "+SHA1",
1660
1208
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1666
1214
            (gnutls.library.functions
1667
1215
             .gnutls_priority_set_direct(session._c_object,
1668
1216
                                         priority, None))
1669
 
            
 
1217
 
1670
1218
            # Start communication using the Mandos protocol
1671
1219
            # Get protocol number
1672
1220
            line = self.request.makefile().readline()
1677
1225
            except (ValueError, IndexError, RuntimeError) as error:
1678
1226
                logger.error("Unknown protocol version: %s", error)
1679
1227
                return
1680
 
            
 
1228
 
1681
1229
            # Start GnuTLS connection
1682
1230
            try:
1683
1231
                session.handshake()
1687
1235
                # established.  Just abandon the request.
1688
1236
                return
1689
1237
            logger.debug("Handshake succeeded")
1690
 
            
 
1238
 
1691
1239
            approval_required = False
1692
1240
            try:
1693
1241
                try:
1698
1246
                    logger.warning("Bad certificate: %s", error)
1699
1247
                    return
1700
1248
                logger.debug("Fingerprint: %s", fpr)
1701
 
                
 
1249
 
1702
1250
                try:
1703
1251
                    client = ProxyClient(child_pipe, fpr,
1704
1252
                                         self.client_address)
1712
1260
                
1713
1261
                while True:
1714
1262
                    if not client.enabled:
1715
 
                        logger.info("Client %s is disabled",
 
1263
                        logger.warning("Client %s is disabled",
1716
1264
                                       client.name)
1717
1265
                        if self.server.use_dbus:
1718
1266
                            # Emit D-Bus signal
1719
 
                            client.Rejected("Disabled")
 
1267
                            client.Rejected("Disabled")                    
1720
1268
                        return
1721
1269
                    
1722
 
                    if client.approved or not client.approval_delay:
 
1270
                    if client._approved or not client.approval_delay:
1723
1271
                        #We are approved or approval is disabled
1724
1272
                        break
1725
 
                    elif client.approved is None:
 
1273
                    elif client._approved is None:
1726
1274
                        logger.info("Client %s needs approval",
1727
1275
                                    client.name)
1728
1276
                        if self.server.use_dbus:
1739
1287
                        return
1740
1288
                    
1741
1289
                    #wait until timeout or approved
 
1290
                    #x = float(client._timedelta_to_milliseconds(delay))
1742
1291
                    time = datetime.datetime.now()
1743
1292
                    client.changedstate.acquire()
1744
 
                    client.changedstate.wait(
1745
 
                        float(timedelta_to_milliseconds(delay)
1746
 
                              / 1000))
 
1293
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
1747
1294
                    client.changedstate.release()
1748
1295
                    time2 = datetime.datetime.now()
1749
1296
                    if (time2 - time) >= delay:
1765
1312
                    try:
1766
1313
                        sent = session.send(client.secret[sent_size:])
1767
1314
                    except gnutls.errors.GNUTLSError as error:
1768
 
                        logger.warning("gnutls send failed",
1769
 
                                       exc_info=error)
 
1315
                        logger.warning("gnutls send failed")
1770
1316
                        return
1771
1317
                    logger.debug("Sent: %d, remaining: %d",
1772
1318
                                 sent, len(client.secret)
1773
1319
                                 - (sent_size + sent))
1774
1320
                    sent_size += sent
1775
 
                
 
1321
 
1776
1322
                logger.info("Sending secret to %s", client.name)
1777
 
                # bump the timeout using extended_timeout
1778
 
                client.bump_timeout(client.extended_timeout)
 
1323
                # bump the timeout as if seen
 
1324
                client.checked_ok()
1779
1325
                if self.server.use_dbus:
1780
1326
                    # Emit D-Bus signal
1781
1327
                    client.GotSecret()
1786
1332
                try:
1787
1333
                    session.bye()
1788
1334
                except gnutls.errors.GNUTLSError as error:
1789
 
                    logger.warning("GnuTLS bye failed",
1790
 
                                   exc_info=error)
 
1335
                    logger.warning("GnuTLS bye failed")
1791
1336
    
1792
1337
    @staticmethod
1793
1338
    def peer_certificate(session):
1849
1394
        # Convert the buffer to a Python bytestring
1850
1395
        fpr = ctypes.string_at(buf, buf_len.value)
1851
1396
        # Convert the bytestring to hexadecimal notation
1852
 
        hex_fpr = binascii.hexlify(fpr).upper()
 
1397
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
1853
1398
        return hex_fpr
1854
1399
 
1855
1400
 
1858
1403
    def sub_process_main(self, request, address):
1859
1404
        try:
1860
1405
            self.finish_request(request, address)
1861
 
        except Exception:
 
1406
        except:
1862
1407
            self.handle_error(request, address)
1863
1408
        self.close_request(request)
1864
 
    
 
1409
            
1865
1410
    def process_request(self, request, address):
1866
1411
        """Start a new process to process the request."""
1867
 
        proc = multiprocessing.Process(target = self.sub_process_main,
1868
 
                                       args = (request, address))
1869
 
        proc.start()
1870
 
        return proc
1871
 
 
 
1412
        multiprocessing.Process(target = self.sub_process_main,
 
1413
                                args = (request, address)).start()
1872
1414
 
1873
1415
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1874
1416
    """ adds a pipe to the MixIn """
1878
1420
        This function creates a new pipe in self.pipe
1879
1421
        """
1880
1422
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1881
 
        
1882
 
        proc = MultiprocessingMixIn.process_request(self, request,
1883
 
                                                    client_address)
 
1423
 
 
1424
        super(MultiprocessingMixInWithPipe,
 
1425
              self).process_request(request, client_address)
1884
1426
        self.child_pipe.close()
1885
 
        self.add_pipe(parent_pipe, proc)
1886
 
    
1887
 
    def add_pipe(self, parent_pipe, proc):
 
1427
        self.add_pipe(parent_pipe)
 
1428
 
 
1429
    def add_pipe(self, parent_pipe):
1888
1430
        """Dummy function; override as necessary"""
1889
1431
        raise NotImplementedError
1890
1432
 
1891
 
 
1892
1433
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1893
1434
                     socketserver.TCPServer, object):
1894
1435
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
1921
1462
                                           str(self.interface
1922
1463
                                               + '\0'))
1923
1464
                except socket.error as error:
1924
 
                    if error.errno == errno.EPERM:
 
1465
                    if error[0] == errno.EPERM:
1925
1466
                        logger.error("No permission to"
1926
1467
                                     " bind to interface %s",
1927
1468
                                     self.interface)
1928
 
                    elif error.errno == errno.ENOPROTOOPT:
 
1469
                    elif error[0] == errno.ENOPROTOOPT:
1929
1470
                        logger.error("SO_BINDTODEVICE not available;"
1930
1471
                                     " cannot bind to interface %s",
1931
1472
                                     self.interface)
1932
 
                    elif error.errno == errno.ENODEV:
1933
 
                        logger.error("Interface %s does not"
1934
 
                                     " exist, cannot bind",
1935
 
                                     self.interface)
1936
1473
                    else:
1937
1474
                        raise
1938
1475
        # Only bind(2) the socket if we really need to.
1972
1509
        self.enabled = False
1973
1510
        self.clients = clients
1974
1511
        if self.clients is None:
1975
 
            self.clients = {}
 
1512
            self.clients = set()
1976
1513
        self.use_dbus = use_dbus
1977
1514
        self.gnutls_priority = gnutls_priority
1978
1515
        IPv6_TCPServer.__init__(self, server_address,
1982
1519
    def server_activate(self):
1983
1520
        if self.enabled:
1984
1521
            return socketserver.TCPServer.server_activate(self)
1985
 
    
1986
1522
    def enable(self):
1987
1523
        self.enabled = True
1988
 
    
1989
 
    def add_pipe(self, parent_pipe, proc):
 
1524
    def add_pipe(self, parent_pipe):
1990
1525
        # Call "handle_ipc" for both data and EOF events
1991
1526
        gobject.io_add_watch(parent_pipe.fileno(),
1992
1527
                             gobject.IO_IN | gobject.IO_HUP,
1993
1528
                             functools.partial(self.handle_ipc,
1994
 
                                               parent_pipe =
1995
 
                                               parent_pipe,
1996
 
                                               proc = proc))
1997
 
    
 
1529
                                               parent_pipe = parent_pipe))
 
1530
        
1998
1531
    def handle_ipc(self, source, condition, parent_pipe=None,
1999
 
                   proc = None, client_object=None):
2000
 
        # error, or the other end of multiprocessing.Pipe has closed
2001
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
2002
 
            # Wait for other process to exit
2003
 
            proc.join()
 
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):
2004
1549
            return False
2005
1550
        
2006
1551
        # Read a request from the child
2011
1556
            fpr = request[1]
2012
1557
            address = request[2]
2013
1558
            
2014
 
            for c in self.clients.itervalues():
 
1559
            for c in self.clients:
2015
1560
                if c.fingerprint == fpr:
2016
1561
                    client = c
2017
1562
                    break
2018
1563
            else:
2019
 
                logger.info("Client not found for fingerprint: %s, ad"
2020
 
                            "dress: %s", fpr, address)
 
1564
                logger.warning("Client not found for fingerprint: %s, ad"
 
1565
                               "dress: %s", fpr, address)
2021
1566
                if self.use_dbus:
2022
1567
                    # Emit D-Bus signal
2023
 
                    mandos_dbus_service.ClientNotFound(fpr,
2024
 
                                                       address[0])
 
1568
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
2025
1569
                parent_pipe.send(False)
2026
1570
                return False
2027
1571
            
2028
1572
            gobject.io_add_watch(parent_pipe.fileno(),
2029
1573
                                 gobject.IO_IN | gobject.IO_HUP,
2030
1574
                                 functools.partial(self.handle_ipc,
2031
 
                                                   parent_pipe =
2032
 
                                                   parent_pipe,
2033
 
                                                   proc = proc,
2034
 
                                                   client_object =
2035
 
                                                   client))
 
1575
                                                   parent_pipe = parent_pipe,
 
1576
                                                   client_object = client))
2036
1577
            parent_pipe.send(True)
2037
 
            # remove the old hook in favor of the new above hook on
2038
 
            # same fileno
 
1578
            # remove the old hook in favor of the new above hook on same fileno
2039
1579
            return False
2040
1580
        if command == 'funcall':
2041
1581
            funcname = request[1]
2042
1582
            args = request[2]
2043
1583
            kwargs = request[3]
2044
1584
            
2045
 
            parent_pipe.send(('data', getattr(client_object,
2046
 
                                              funcname)(*args,
2047
 
                                                         **kwargs)))
2048
 
        
 
1585
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
 
1586
 
2049
1587
        if command == 'getattr':
2050
1588
            attrname = request[1]
2051
1589
            if callable(client_object.__getattribute__(attrname)):
2052
1590
                parent_pipe.send(('function',))
2053
1591
            else:
2054
 
                parent_pipe.send(('data', client_object
2055
 
                                  .__getattribute__(attrname)))
 
1592
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2056
1593
        
2057
1594
        if command == 'setattr':
2058
1595
            attrname = request[1]
2059
1596
            value = request[2]
2060
1597
            setattr(client_object, attrname, value)
2061
 
        
 
1598
 
2062
1599
        return True
2063
1600
 
2064
1601
 
2094
1631
            elif suffix == "w":
2095
1632
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2096
1633
            else:
2097
 
                raise ValueError("Unknown suffix {0!r}"
2098
 
                                 .format(suffix))
 
1634
                raise ValueError("Unknown suffix %r" % suffix)
2099
1635
        except (ValueError, IndexError) as e:
2100
1636
            raise ValueError(*(e.args))
2101
1637
        timevalue += delta
2102
1638
    return timevalue
2103
1639
 
2104
1640
 
 
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
 
2105
1665
def daemon(nochdir = False, noclose = False):
2106
1666
    """See daemon(3).  Standard BSD Unix function.
2107
1667
    
2115
1675
        sys.exit()
2116
1676
    if not noclose:
2117
1677
        # Close all standard open file descriptors
2118
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1678
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2119
1679
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2120
1680
            raise OSError(errno.ENODEV,
2121
 
                          "{0} not a character device"
2122
 
                          .format(os.devnull))
 
1681
                          "%s not a character device"
 
1682
                          % os.path.devnull)
2123
1683
        os.dup2(null, sys.stdin.fileno())
2124
1684
        os.dup2(null, sys.stdout.fileno())
2125
1685
        os.dup2(null, sys.stderr.fileno())
2134
1694
    
2135
1695
    parser = argparse.ArgumentParser()
2136
1696
    parser.add_argument("-v", "--version", action="version",
2137
 
                        version = "%(prog)s {0}".format(version),
 
1697
                        version = "%%(prog)s %s" % version,
2138
1698
                        help="show version number and exit")
2139
1699
    parser.add_argument("-i", "--interface", metavar="IF",
2140
1700
                        help="Bind to interface IF")
2162
1722
                        " system bus interface")
2163
1723
    parser.add_argument("--no-ipv6", action="store_false",
2164
1724
                        dest="use_ipv6", help="Do not use IPv6")
2165
 
    parser.add_argument("--no-restore", action="store_false",
2166
 
                        dest="restore", help="Do not restore stored"
2167
 
                        " state")
2168
 
    parser.add_argument("--statedir", metavar="DIR",
2169
 
                        help="Directory to save/restore state in")
2170
 
    
2171
1725
    options = parser.parse_args()
2172
1726
    
2173
1727
    if options.check:
2186
1740
                        "use_dbus": "True",
2187
1741
                        "use_ipv6": "True",
2188
1742
                        "debuglevel": "",
2189
 
                        "restore": "True",
2190
 
                        "statedir": "/var/lib/mandos"
2191
1743
                        }
2192
1744
    
2193
1745
    # Parse config file for server-global settings
2210
1762
    # options, if set.
2211
1763
    for option in ("interface", "address", "port", "debug",
2212
1764
                   "priority", "servicename", "configdir",
2213
 
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2214
 
                   "statedir"):
 
1765
                   "use_dbus", "use_ipv6", "debuglevel"):
2215
1766
        value = getattr(options, option)
2216
1767
        if value is not None:
2217
1768
            server_settings[option] = value
2229
1780
    debuglevel = server_settings["debuglevel"]
2230
1781
    use_dbus = server_settings["use_dbus"]
2231
1782
    use_ipv6 = server_settings["use_ipv6"]
2232
 
    stored_state_path = os.path.join(server_settings["statedir"],
2233
 
                                     stored_state_file)
2234
 
    
2235
 
    if debug:
2236
 
        initlogger(debug, logging.DEBUG)
2237
 
    else:
2238
 
        if not debuglevel:
2239
 
            initlogger(debug)
2240
 
        else:
2241
 
            level = getattr(logging, debuglevel.upper())
2242
 
            initlogger(debug, level)
2243
 
    
 
1783
 
2244
1784
    if server_settings["servicename"] != "Mandos":
2245
1785
        syslogger.setFormatter(logging.Formatter
2246
 
                               ('Mandos ({0}) [%(process)d]:'
2247
 
                                ' %(levelname)s: %(message)s'
2248
 
                                .format(server_settings
2249
 
                                        ["servicename"])))
 
1786
                               ('Mandos (%s) [%%(process)d]:'
 
1787
                                ' %%(levelname)s: %%(message)s'
 
1788
                                % server_settings["servicename"]))
2250
1789
    
2251
1790
    # Parse config file with clients
2252
 
    client_config = configparser.SafeConfigParser(Client
2253
 
                                                  .client_defaults)
 
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)
2254
1799
    client_config.read(os.path.join(server_settings["configdir"],
2255
1800
                                    "clients.conf"))
2256
1801
    
2270
1815
        pidfilename = "/var/run/mandos.pid"
2271
1816
        try:
2272
1817
            pidfile = open(pidfilename, "w")
2273
 
        except IOError as e:
2274
 
            logger.error("Could not open file %r", pidfilename,
2275
 
                         exc_info=e)
 
1818
        except IOError:
 
1819
            logger.error("Could not open file %r", pidfilename)
2276
1820
    
2277
 
    for name in ("_mandos", "mandos", "nobody"):
 
1821
    try:
 
1822
        uid = pwd.getpwnam("_mandos").pw_uid
 
1823
        gid = pwd.getpwnam("_mandos").pw_gid
 
1824
    except KeyError:
2278
1825
        try:
2279
 
            uid = pwd.getpwnam(name).pw_uid
2280
 
            gid = pwd.getpwnam(name).pw_gid
2281
 
            break
 
1826
            uid = pwd.getpwnam("mandos").pw_uid
 
1827
            gid = pwd.getpwnam("mandos").pw_gid
2282
1828
        except KeyError:
2283
 
            continue
2284
 
    else:
2285
 
        uid = 65534
2286
 
        gid = 65534
 
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
2287
1835
    try:
2288
1836
        os.setgid(gid)
2289
1837
        os.setuid(uid)
2290
1838
    except OSError as error:
2291
 
        if error.errno != errno.EPERM:
 
1839
        if error[0] != errno.EPERM:
2292
1840
            raise error
2293
1841
    
 
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
 
2294
1850
    if debug:
2295
1851
        # Enable all possible GnuTLS debugging
2296
1852
        
2306
1862
         .gnutls_global_set_log_function(debug_gnutls))
2307
1863
        
2308
1864
        # Redirect stdin so all checkers get /dev/null
2309
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1865
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2310
1866
        os.dup2(null, sys.stdin.fileno())
2311
1867
        if null > 2:
2312
1868
            os.close(null)
 
1869
    else:
 
1870
        # No console logging
 
1871
        logger.removeHandler(console)
2313
1872
    
2314
1873
    # Need to fork before connecting to D-Bus
2315
1874
    if not debug:
2316
1875
        # Close all input and output, do double fork, etc.
2317
1876
        daemon()
2318
1877
    
2319
 
    # multiprocessing will use threads, so before we use gobject we
2320
 
    # need to inform gobject that threads will be used.
2321
 
    gobject.threads_init()
2322
 
    
2323
1878
    global main_loop
2324
1879
    # From the Avahi example code
2325
 
    DBusGMainLoop(set_as_default=True)
 
1880
    DBusGMainLoop(set_as_default=True )
2326
1881
    main_loop = gobject.MainLoop()
2327
1882
    bus = dbus.SystemBus()
2328
1883
    # End of Avahi example code
2329
1884
    if use_dbus:
2330
1885
        try:
2331
 
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
1886
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
2332
1887
                                            bus, do_not_queue=True)
2333
 
            old_bus_name = (dbus.service.BusName
2334
 
                            ("se.bsnet.fukt.Mandos", bus,
2335
 
                             do_not_queue=True))
2336
1888
        except dbus.exceptions.NameExistsException as e:
2337
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
1889
            logger.error(unicode(e) + ", disabling D-Bus")
2338
1890
            use_dbus = False
2339
1891
            server_settings["use_dbus"] = False
2340
1892
            tcp_server.use_dbus = False
2341
1893
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2342
 
    service = AvahiServiceToSyslog(name =
2343
 
                                   server_settings["servicename"],
2344
 
                                   servicetype = "_mandos._tcp",
2345
 
                                   protocol = protocol, bus = bus)
 
1894
    service = AvahiService(name = server_settings["servicename"],
 
1895
                           servicetype = "_mandos._tcp",
 
1896
                           protocol = protocol, bus = bus)
2346
1897
    if server_settings["interface"]:
2347
1898
        service.interface = (if_nametoindex
2348
1899
                             (str(server_settings["interface"])))
2353
1904
    client_class = Client
2354
1905
    if use_dbus:
2355
1906
        client_class = functools.partial(ClientDBus, bus = bus)
2356
 
    
2357
 
    client_settings = Client.config_parser(client_config)
2358
 
    old_client_settings = {}
2359
 
    clients_data = {}
2360
 
    
2361
 
    # Get client data and settings from last running state.
2362
 
    if server_settings["restore"]:
2363
 
        try:
2364
 
            with open(stored_state_path, "rb") as stored_state:
2365
 
                clients_data, old_client_settings = (pickle.load
2366
 
                                                     (stored_state))
2367
 
            os.remove(stored_state_path)
2368
 
        except IOError as e:
2369
 
            if e.errno == errno.ENOENT:
2370
 
                logger.warning("Could not load persistent state: {0}"
2371
 
                                .format(os.strerror(e.errno)))
2372
 
            else:
2373
 
                logger.critical("Could not load persistent state:",
2374
 
                                exc_info=e)
2375
 
                raise
2376
 
        except EOFError as e:
2377
 
            logger.warning("Could not load persistent state: "
2378
 
                           "EOFError:", exc_info=e)
2379
 
    
2380
 
    with PGPEngine() as pgp:
2381
 
        for client_name, client in clients_data.iteritems():
2382
 
            # Decide which value to use after restoring saved state.
2383
 
            # We have three different values: Old config file,
2384
 
            # new config file, and saved state.
2385
 
            # New config value takes precedence if it differs from old
2386
 
            # config value, otherwise use saved state.
2387
 
            for name, value in client_settings[client_name].items():
2388
 
                try:
2389
 
                    # For each value in new config, check if it
2390
 
                    # differs from the old config value (Except for
2391
 
                    # the "secret" attribute)
2392
 
                    if (name != "secret" and
2393
 
                        value != old_client_settings[client_name]
2394
 
                        [name]):
2395
 
                        client[name] = value
2396
 
                except KeyError:
2397
 
                    pass
2398
 
            
2399
 
            # Clients who has passed its expire date can still be
2400
 
            # enabled if its last checker was successful.  Clients
2401
 
            # whose checker succeeded before we stored its state is
2402
 
            # assumed to have successfully run all checkers during
2403
 
            # downtime.
2404
 
            if client["enabled"]:
2405
 
                if datetime.datetime.utcnow() >= client["expires"]:
2406
 
                    if not client["last_checked_ok"]:
2407
 
                        logger.warning(
2408
 
                            "disabling client {0} - Client never "
2409
 
                            "performed a successful checker"
2410
 
                            .format(client_name))
2411
 
                        client["enabled"] = False
2412
 
                    elif client["last_checker_status"] != 0:
2413
 
                        logger.warning(
2414
 
                            "disabling client {0} - Client "
2415
 
                            "last checker failed with error code {1}"
2416
 
                            .format(client_name,
2417
 
                                    client["last_checker_status"]))
2418
 
                        client["enabled"] = False
2419
 
                    else:
2420
 
                        client["expires"] = (datetime.datetime
2421
 
                                             .utcnow()
2422
 
                                             + client["timeout"])
2423
 
                        logger.debug("Last checker succeeded,"
2424
 
                                     " keeping {0} enabled"
2425
 
                                     .format(client_name))
 
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):
2426
1914
            try:
2427
 
                client["secret"] = (
2428
 
                    pgp.decrypt(client["encrypted_secret"],
2429
 
                                client_settings[client_name]
2430
 
                                ["secret"]))
2431
 
            except PGPError:
2432
 
                # If decryption fails, we use secret from new settings
2433
 
                logger.debug("Failed to decrypt {0} old secret"
2434
 
                             .format(client_name))
2435
 
                client["secret"] = (
2436
 
                    client_settings[client_name]["secret"])
2437
 
    
2438
 
    # Add/remove clients based on new changes made to config
2439
 
    for client_name in (set(old_client_settings)
2440
 
                        - set(client_settings)):
2441
 
        del clients_data[client_name]
2442
 
    for client_name in (set(client_settings)
2443
 
                        - set(old_client_settings)):
2444
 
        clients_data[client_name] = client_settings[client_name]
2445
 
    
2446
 
    # Create all client objects
2447
 
    for client_name, client in clients_data.iteritems():
2448
 
        tcp_server.clients[client_name] = client_class(
2449
 
            name = client_name, settings = client)
2450
 
    
 
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()))
2451
1924
    if not tcp_server.clients:
2452
1925
        logger.warning("No clients defined")
2453
 
    
 
1926
        
2454
1927
    if not debug:
2455
1928
        try:
2456
1929
            with pidfile:
2464
1937
            # "pidfile" was never created
2465
1938
            pass
2466
1939
        del pidfilename
2467
 
    
 
1940
        
 
1941
        signal.signal(signal.SIGINT, signal.SIG_IGN)
 
1942
 
2468
1943
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2469
1944
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2470
1945
    
2471
1946
    if use_dbus:
2472
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2473
 
                                        "se.bsnet.fukt.Mandos"})
2474
 
        class MandosDBusService(DBusObjectWithProperties):
 
1947
        class MandosDBusService(dbus.service.Object):
2475
1948
            """A D-Bus proxy object"""
2476
1949
            def __init__(self):
2477
1950
                dbus.service.Object.__init__(self, bus, "/")
2478
 
            _interface = "se.recompile.Mandos"
2479
 
            
2480
 
            @dbus_interface_annotations(_interface)
2481
 
            def _foo(self):
2482
 
                return { "org.freedesktop.DBus.Property"
2483
 
                         ".EmitsChangedSignal":
2484
 
                             "false"}
 
1951
            _interface = "se.bsnet.fukt.Mandos"
2485
1952
            
2486
1953
            @dbus.service.signal(_interface, signature="o")
2487
1954
            def ClientAdded(self, objpath):
2502
1969
            def GetAllClients(self):
2503
1970
                "D-Bus method"
2504
1971
                return dbus.Array(c.dbus_object_path
2505
 
                                  for c in
2506
 
                                  tcp_server.clients.itervalues())
 
1972
                                  for c in tcp_server.clients)
2507
1973
            
2508
1974
            @dbus.service.method(_interface,
2509
1975
                                 out_signature="a{oa{sv}}")
2511
1977
                "D-Bus method"
2512
1978
                return dbus.Dictionary(
2513
1979
                    ((c.dbus_object_path, c.GetAll(""))
2514
 
                     for c in tcp_server.clients.itervalues()),
 
1980
                     for c in tcp_server.clients),
2515
1981
                    signature="oa{sv}")
2516
1982
            
2517
1983
            @dbus.service.method(_interface, in_signature="o")
2518
1984
            def RemoveClient(self, object_path):
2519
1985
                "D-Bus method"
2520
 
                for c in tcp_server.clients.itervalues():
 
1986
                for c in tcp_server.clients:
2521
1987
                    if c.dbus_object_path == object_path:
2522
 
                        del tcp_server.clients[c.name]
 
1988
                        tcp_server.clients.remove(c)
2523
1989
                        c.remove_from_connection()
2524
1990
                        # Don't signal anything except ClientRemoved
2525
1991
                        c.disable(quiet=True)
2536
2002
        "Cleanup function; run on exit"
2537
2003
        service.cleanup()
2538
2004
        
2539
 
        multiprocessing.active_children()
2540
 
        if not (tcp_server.clients or client_settings):
2541
 
            return
2542
 
        
2543
 
        # Store client before exiting. Secrets are encrypted with key
2544
 
        # based on what config file has. If config file is
2545
 
        # removed/edited, old secret will thus be unrecovable.
2546
 
        clients = {}
2547
 
        with PGPEngine() as pgp:
2548
 
            for client in tcp_server.clients.itervalues():
2549
 
                key = client_settings[client.name]["secret"]
2550
 
                client.encrypted_secret = pgp.encrypt(client.secret,
2551
 
                                                      key)
2552
 
                client_dict = {}
2553
 
                
2554
 
                # A list of attributes that can not be pickled
2555
 
                # + secret.
2556
 
                exclude = set(("bus", "changedstate", "secret",
2557
 
                               "checker"))
2558
 
                for name, typ in (inspect.getmembers
2559
 
                                  (dbus.service.Object)):
2560
 
                    exclude.add(name)
2561
 
                
2562
 
                client_dict["encrypted_secret"] = (client
2563
 
                                                   .encrypted_secret)
2564
 
                for attr in client.client_structure:
2565
 
                    if attr not in exclude:
2566
 
                        client_dict[attr] = getattr(client, attr)
2567
 
                
2568
 
                clients[client.name] = client_dict
2569
 
                del client_settings[client.name]["secret"]
2570
 
        
2571
 
        try:
2572
 
            with (tempfile.NamedTemporaryFile
2573
 
                  (mode='wb', suffix=".pickle", prefix='clients-',
2574
 
                   dir=os.path.dirname(stored_state_path),
2575
 
                   delete=False)) as stored_state:
2576
 
                pickle.dump((clients, client_settings), stored_state)
2577
 
                tempname=stored_state.name
2578
 
            os.rename(tempname, stored_state_path)
2579
 
        except (IOError, OSError) as e:
2580
 
            if not debug:
2581
 
                try:
2582
 
                    os.remove(tempname)
2583
 
                except NameError:
2584
 
                    pass
2585
 
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2586
 
                logger.warning("Could not save persistent state: {0}"
2587
 
                               .format(os.strerror(e.errno)))
2588
 
            else:
2589
 
                logger.warning("Could not save persistent state:",
2590
 
                               exc_info=e)
2591
 
                raise e
2592
 
        
2593
 
        # Delete all clients, and settings from config
2594
2005
        while tcp_server.clients:
2595
 
            name, client = tcp_server.clients.popitem()
 
2006
            client = tcp_server.clients.pop()
2596
2007
            if use_dbus:
2597
2008
                client.remove_from_connection()
 
2009
            client.disable_hook = None
2598
2010
            # Don't signal anything except ClientRemoved
2599
2011
            client.disable(quiet=True)
2600
2012
            if use_dbus:
2601
2013
                # Emit D-Bus signal
2602
 
                mandos_dbus_service.ClientRemoved(client
2603
 
                                                  .dbus_object_path,
 
2014
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
2604
2015
                                                  client.name)
2605
 
        client_settings.clear()
2606
2016
    
2607
2017
    atexit.register(cleanup)
2608
2018
    
2609
 
    for client in tcp_server.clients.itervalues():
 
2019
    for client in tcp_server.clients:
2610
2020
        if use_dbus:
2611
2021
            # Emit D-Bus signal
2612
2022
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2613
 
        # Need to initiate checking of clients
2614
 
        if client.enabled:
2615
 
            client.init_checker()
 
2023
        client.enable()
2616
2024
    
2617
2025
    tcp_server.enable()
2618
2026
    tcp_server.server_activate()
2621
2029
    service.port = tcp_server.socket.getsockname()[1]
2622
2030
    if use_ipv6:
2623
2031
        logger.info("Now listening on address %r, port %d,"
2624
 
                    " flowinfo %d, scope_id %d",
2625
 
                    *tcp_server.socket.getsockname())
 
2032
                    " flowinfo %d, scope_id %d"
 
2033
                    % tcp_server.socket.getsockname())
2626
2034
    else:                       # IPv4
2627
 
        logger.info("Now listening on address %r, port %d",
2628
 
                    *tcp_server.socket.getsockname())
 
2035
        logger.info("Now listening on address %r, port %d"
 
2036
                    % tcp_server.socket.getsockname())
2629
2037
    
2630
2038
    #service.interface = tcp_server.socket.getsockname()[3]
2631
2039
    
2634
2042
        try:
2635
2043
            service.activate()
2636
2044
        except dbus.exceptions.DBusException as error:
2637
 
            logger.critical("D-Bus Exception", exc_info=error)
 
2045
            logger.critical("DBusException: %s", error)
2638
2046
            cleanup()
2639
2047
            sys.exit(1)
2640
2048
        # End of Avahi example code
2647
2055
        logger.debug("Starting main loop")
2648
2056
        main_loop.run()
2649
2057
    except AvahiError as error:
2650
 
        logger.critical("Avahi Error", exc_info=error)
 
2058
        logger.critical("AvahiError: %s", error)
2651
2059
        cleanup()
2652
2060
        sys.exit(1)
2653
2061
    except KeyboardInterrupt: