/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: Björn Påhlsson
  • Date: 2011-06-23 22:27:15 UTC
  • mto: This revision was merged to the branch mainline in revision 485.
  • Revision ID: belorn@fukt.bsnet.se-20110623222715-q5wro9ma9iyjl367
* Makefile (CFLAGS): Added "-lrt" to include real time library.
* plugins.d/mandos-client.c: use scandir(3) instead of readdir(3)
                             Prefix all debug output with "Mandos plugin " + program_invocation_short_name
                             Retry servers that failed to provide password.
                             New option --retry SECONDS that sets the interval between rechecking.
                             --retry also controls how often it retries a server when using --connect.
* plugins.d/splashy.c:  Prefix all debug output with "Mandos plugin " + program_invocation_short_name
* plugins.d/usplash.c: --||--
* plugins.d/askpass-fifo.c: --||--
* plugins.d/password-prompt.c: --||--
* plugins.d/plymouth.c: --||--
* mandos: Lower logger level from warning to info on failed client requests because client was disabled or unknown fingerprint.
* plugins.d/plymouth.c (get_pid): bug fix. Was not calling free on direntries. 

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