/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2012-06-23 00:58:49 UTC
  • Revision ID: teddy@recompile.se-20120623005849-02wj82cng433rt2k
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
* mandos: All client options for time intervals now take an RFC 3339
          duration.
  (rfc3339_duration_to_delta): New function.
  (string_to_delta): Try rfc3339_duration_to_delta first.
* mandos-clients.conf.xml (OPTIONS/timeout): Document new format.
  (EXAMPLE): Update to new interval format.
  (SEE ALSO): Reference RFC 3339.

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2011 Teddy Hogeborn
15
 
# Copyright © 2008-2011 Björn Påhlsson
 
14
# Copyright © 2008-2012 Teddy Hogeborn
 
15
# Copyright © 2008-2012 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
28
28
# along with this program.  If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
31
 
# Contact the authors at <mandos@fukt.bsnet.se>.
 
31
# Contact the authors at <mandos@recompile.se>.
32
32
33
33
 
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
 
37
from future_builtins import *
 
38
 
37
39
import SocketServer as socketserver
38
40
import socket
39
41
import argparse
62
64
import functools
63
65
import cPickle as pickle
64
66
import multiprocessing
 
67
import types
 
68
import binascii
 
69
import tempfile
 
70
import itertools
 
71
import collections
65
72
 
66
73
import dbus
67
74
import dbus.service
72
79
import ctypes.util
73
80
import xml.dom.minidom
74
81
import inspect
 
82
import GnuPGInterface
75
83
 
76
84
try:
77
85
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
81
89
    except ImportError:
82
90
        SO_BINDTODEVICE = None
83
91
 
84
 
 
85
 
version = "1.3.0"
86
 
 
87
 
#logger = logging.getLogger('mandos')
88
 
logger = logging.Logger('mandos')
 
92
version = "1.6.0"
 
93
stored_state_file = "clients.pickle"
 
94
 
 
95
logger = logging.getLogger()
89
96
syslogger = (logging.handlers.SysLogHandler
90
97
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
91
98
              address = str("/dev/log")))
92
 
syslogger.setFormatter(logging.Formatter
93
 
                       ('Mandos [%(process)d]: %(levelname)s:'
94
 
                        ' %(message)s'))
95
 
logger.addHandler(syslogger)
96
 
 
97
 
console = logging.StreamHandler()
98
 
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
99
 
                                       ' %(levelname)s:'
100
 
                                       ' %(message)s'))
101
 
logger.addHandler(console)
 
99
 
 
100
try:
 
101
    if_nametoindex = (ctypes.cdll.LoadLibrary
 
102
                      (ctypes.util.find_library("c"))
 
103
                      .if_nametoindex)
 
104
except (OSError, AttributeError):
 
105
    def if_nametoindex(interface):
 
106
        "Get an interface index the hard way, i.e. using fcntl()"
 
107
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
108
        with contextlib.closing(socket.socket()) as s:
 
109
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
110
                                struct.pack(str("16s16x"),
 
111
                                            interface))
 
112
        interface_index = struct.unpack(str("I"),
 
113
                                        ifreq[16:20])[0]
 
114
        return interface_index
 
115
 
 
116
 
 
117
def initlogger(debug, level=logging.WARNING):
 
118
    """init logger and add loglevel"""
 
119
    
 
120
    syslogger.setFormatter(logging.Formatter
 
121
                           ('Mandos [%(process)d]: %(levelname)s:'
 
122
                            ' %(message)s'))
 
123
    logger.addHandler(syslogger)
 
124
    
 
125
    if debug:
 
126
        console = logging.StreamHandler()
 
127
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
128
                                               ' [%(process)d]:'
 
129
                                               ' %(levelname)s:'
 
130
                                               ' %(message)s'))
 
131
        logger.addHandler(console)
 
132
    logger.setLevel(level)
 
133
 
 
134
 
 
135
class PGPError(Exception):
 
136
    """Exception if encryption/decryption fails"""
 
137
    pass
 
138
 
 
139
 
 
140
class PGPEngine(object):
 
141
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
142
    def __init__(self):
 
143
        self.gnupg = GnuPGInterface.GnuPG()
 
144
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
145
        self.gnupg = GnuPGInterface.GnuPG()
 
146
        self.gnupg.options.meta_interactive = False
 
147
        self.gnupg.options.homedir = self.tempdir
 
148
        self.gnupg.options.extra_args.extend(['--force-mdc',
 
149
                                              '--quiet',
 
150
                                              '--no-use-agent'])
 
151
    
 
152
    def __enter__(self):
 
153
        return self
 
154
    
 
155
    def __exit__(self, exc_type, exc_value, traceback):
 
156
        self._cleanup()
 
157
        return False
 
158
    
 
159
    def __del__(self):
 
160
        self._cleanup()
 
161
    
 
162
    def _cleanup(self):
 
163
        if self.tempdir is not None:
 
164
            # Delete contents of tempdir
 
165
            for root, dirs, files in os.walk(self.tempdir,
 
166
                                             topdown = False):
 
167
                for filename in files:
 
168
                    os.remove(os.path.join(root, filename))
 
169
                for dirname in dirs:
 
170
                    os.rmdir(os.path.join(root, dirname))
 
171
            # Remove tempdir
 
172
            os.rmdir(self.tempdir)
 
173
            self.tempdir = None
 
174
    
 
175
    def password_encode(self, password):
 
176
        # Passphrase can not be empty and can not contain newlines or
 
177
        # NUL bytes.  So we prefix it and hex encode it.
 
178
        return b"mandos" + binascii.hexlify(password)
 
179
    
 
180
    def encrypt(self, data, password):
 
181
        self.gnupg.passphrase = self.password_encode(password)
 
182
        with open(os.devnull, "w") as devnull:
 
183
            try:
 
184
                proc = self.gnupg.run(['--symmetric'],
 
185
                                      create_fhs=['stdin', 'stdout'],
 
186
                                      attach_fhs={'stderr': devnull})
 
187
                with contextlib.closing(proc.handles['stdin']) as f:
 
188
                    f.write(data)
 
189
                with contextlib.closing(proc.handles['stdout']) as f:
 
190
                    ciphertext = f.read()
 
191
                proc.wait()
 
192
            except IOError as e:
 
193
                raise PGPError(e)
 
194
        self.gnupg.passphrase = None
 
195
        return ciphertext
 
196
    
 
197
    def decrypt(self, data, password):
 
198
        self.gnupg.passphrase = self.password_encode(password)
 
199
        with open(os.devnull, "w") as devnull:
 
200
            try:
 
201
                proc = self.gnupg.run(['--decrypt'],
 
202
                                      create_fhs=['stdin', 'stdout'],
 
203
                                      attach_fhs={'stderr': devnull})
 
204
                with contextlib.closing(proc.handles['stdin']) as f:
 
205
                    f.write(data)
 
206
                with contextlib.closing(proc.handles['stdout']) as f:
 
207
                    decrypted_plaintext = f.read()
 
208
                proc.wait()
 
209
            except IOError as e:
 
210
                raise PGPError(e)
 
211
        self.gnupg.passphrase = None
 
212
        return decrypted_plaintext
 
213
 
102
214
 
103
215
class AvahiError(Exception):
104
216
    def __init__(self, value, *args, **kwargs):
134
246
    server: D-Bus Server
135
247
    bus: dbus.SystemBus()
136
248
    """
 
249
    
137
250
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
138
251
                 servicetype = None, port = None, TXT = None,
139
252
                 domain = "", host = "", max_renames = 32768,
152
265
        self.server = None
153
266
        self.bus = bus
154
267
        self.entry_group_state_changed_match = None
 
268
    
155
269
    def rename(self):
156
270
        """Derived from the Avahi example code"""
157
271
        if self.rename_count >= self.max_renames:
159
273
                            " after %i retries, exiting.",
160
274
                            self.rename_count)
161
275
            raise AvahiServiceError("Too many renames")
162
 
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
 
276
        self.name = unicode(self.server
 
277
                            .GetAlternativeServiceName(self.name))
163
278
        logger.info("Changing Zeroconf service name to %r ...",
164
279
                    self.name)
165
 
        syslogger.setFormatter(logging.Formatter
166
 
                               ('Mandos (%s) [%%(process)d]:'
167
 
                                ' %%(levelname)s: %%(message)s'
168
 
                                % self.name))
169
280
        self.remove()
170
281
        try:
171
282
            self.add()
172
283
        except dbus.exceptions.DBusException as error:
173
 
            logger.critical("DBusException: %s", error)
 
284
            logger.critical("D-Bus Exception", exc_info=error)
174
285
            self.cleanup()
175
286
            os._exit(1)
176
287
        self.rename_count += 1
 
288
    
177
289
    def remove(self):
178
290
        """Derived from the Avahi example code"""
179
291
        if self.entry_group_state_changed_match is not None:
181
293
            self.entry_group_state_changed_match = None
182
294
        if self.group is not None:
183
295
            self.group.Reset()
 
296
    
184
297
    def add(self):
185
298
        """Derived from the Avahi example code"""
186
299
        self.remove()
191
304
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
192
305
        self.entry_group_state_changed_match = (
193
306
            self.group.connect_to_signal(
194
 
                'StateChanged', self .entry_group_state_changed))
 
307
                'StateChanged', self.entry_group_state_changed))
195
308
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
196
309
                     self.name, self.type)
197
310
        self.group.AddService(
203
316
            dbus.UInt16(self.port),
204
317
            avahi.string_array_to_txt_array(self.TXT))
205
318
        self.group.Commit()
 
319
    
206
320
    def entry_group_state_changed(self, state, error):
207
321
        """Derived from the Avahi example code"""
208
322
        logger.debug("Avahi entry group state change: %i", state)
215
329
        elif state == avahi.ENTRY_GROUP_FAILURE:
216
330
            logger.critical("Avahi: Error in group state changed %s",
217
331
                            unicode(error))
218
 
            raise AvahiGroupError("State changed: %s"
219
 
                                  % unicode(error))
 
332
            raise AvahiGroupError("State changed: {0!s}"
 
333
                                  .format(error))
 
334
    
220
335
    def cleanup(self):
221
336
        """Derived from the Avahi example code"""
222
337
        if self.group is not None:
223
338
            try:
224
339
                self.group.Free()
225
340
            except (dbus.exceptions.UnknownMethodException,
226
 
                    dbus.exceptions.DBusException) as e:
 
341
                    dbus.exceptions.DBusException):
227
342
                pass
228
343
            self.group = None
229
344
        self.remove()
 
345
    
230
346
    def server_state_changed(self, state, error=None):
231
347
        """Derived from the Avahi example code"""
232
348
        logger.debug("Avahi server state change: %i", state)
251
367
                logger.debug("Unknown state: %r", state)
252
368
            else:
253
369
                logger.debug("Unknown state: %r: %r", state, error)
 
370
    
254
371
    def activate(self):
255
372
        """Derived from the Avahi example code"""
256
373
        if self.server is None:
264
381
        self.server_state_changed(self.server.GetState())
265
382
 
266
383
 
 
384
class AvahiServiceToSyslog(AvahiService):
 
385
    def rename(self):
 
386
        """Add the new name to the syslog messages"""
 
387
        ret = AvahiService.rename(self)
 
388
        syslogger.setFormatter(logging.Formatter
 
389
                               ('Mandos ({0}) [%(process)d]:'
 
390
                                ' %(levelname)s: %(message)s'
 
391
                                .format(self.name)))
 
392
        return ret
 
393
 
 
394
 
 
395
def timedelta_to_milliseconds(td):
 
396
    "Convert a datetime.timedelta() to milliseconds"
 
397
    return ((td.days * 24 * 60 * 60 * 1000)
 
398
            + (td.seconds * 1000)
 
399
            + (td.microseconds // 1000))
 
400
 
 
401
 
267
402
class Client(object):
268
403
    """A representation of a client host served by this server.
269
404
    
270
405
    Attributes:
271
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
406
    approved:   bool(); 'None' if not yet approved/disapproved
272
407
    approval_delay: datetime.timedelta(); Time to wait for approval
273
408
    approval_duration: datetime.timedelta(); Duration of one approval
274
409
    checker:    subprocess.Popen(); a running checker process used
281
416
                     instance %(name)s can be used in the command.
282
417
    checker_initiator_tag: a gobject event source tag, or None
283
418
    created:    datetime.datetime(); (UTC) object creation
 
419
    client_structure: Object describing what attributes a client has
 
420
                      and is used for storing the client at exit
284
421
    current_checker_command: string; current running checker_command
285
 
    disable_hook:  If set, called by disable() as disable_hook(self)
286
422
    disable_initiator_tag: a gobject event source tag, or None
287
423
    enabled:    bool()
288
424
    fingerprint: string (40 or 32 hexadecimal digits); used to
291
427
    interval:   datetime.timedelta(); How often to start a new checker
292
428
    last_approval_request: datetime.datetime(); (UTC) or None
293
429
    last_checked_ok: datetime.datetime(); (UTC) or None
294
 
    last_enabled: datetime.datetime(); (UTC)
 
430
    last_checker_status: integer between 0 and 255 reflecting exit
 
431
                         status of last checker. -1 reflects crashed
 
432
                         checker, -2 means no checker completed yet.
 
433
    last_enabled: datetime.datetime(); (UTC) or None
295
434
    name:       string; from the config file, used in log messages and
296
435
                        D-Bus identifiers
297
436
    secret:     bytestring; sent verbatim (over TLS) to client
298
437
    timeout:    datetime.timedelta(); How long from last_checked_ok
299
438
                                      until this client is disabled
 
439
    extended_timeout:   extra long timeout when secret has been sent
300
440
    runtime_expansions: Allowed attributes for runtime expansion.
 
441
    expires:    datetime.datetime(); time (UTC) when a client will be
 
442
                disabled, or None
301
443
    """
302
444
    
303
445
    runtime_expansions = ("approval_delay", "approval_duration",
304
 
                          "created", "enabled", "fingerprint",
305
 
                          "host", "interval", "last_checked_ok",
 
446
                          "created", "enabled", "expires",
 
447
                          "fingerprint", "host", "interval",
 
448
                          "last_approval_request", "last_checked_ok",
306
449
                          "last_enabled", "name", "timeout")
307
 
    
308
 
    @staticmethod
309
 
    def _timedelta_to_milliseconds(td):
310
 
        "Convert a datetime.timedelta() to milliseconds"
311
 
        return ((td.days * 24 * 60 * 60 * 1000)
312
 
                + (td.seconds * 1000)
313
 
                + (td.microseconds // 1000))
 
450
    client_defaults = { "timeout": "PT5M",
 
451
                        "extended_timeout": "PT15M",
 
452
                        "interval": "PT2M",
 
453
                        "checker": "fping -q -- %%(host)s",
 
454
                        "host": "",
 
455
                        "approval_delay": "PT0S",
 
456
                        "approval_duration": "PT1S",
 
457
                        "approved_by_default": "True",
 
458
                        "enabled": "True",
 
459
                        }
314
460
    
315
461
    def timeout_milliseconds(self):
316
462
        "Return the 'timeout' attribute in milliseconds"
317
 
        return self._timedelta_to_milliseconds(self.timeout)
 
463
        return timedelta_to_milliseconds(self.timeout)
 
464
    
 
465
    def extended_timeout_milliseconds(self):
 
466
        "Return the 'extended_timeout' attribute in milliseconds"
 
467
        return timedelta_to_milliseconds(self.extended_timeout)
318
468
    
319
469
    def interval_milliseconds(self):
320
470
        "Return the 'interval' attribute in milliseconds"
321
 
        return self._timedelta_to_milliseconds(self.interval)
322
 
 
 
471
        return timedelta_to_milliseconds(self.interval)
 
472
    
323
473
    def approval_delay_milliseconds(self):
324
 
        return self._timedelta_to_milliseconds(self.approval_delay)
325
 
    
326
 
    def __init__(self, name = None, disable_hook=None, config=None):
327
 
        """Note: the 'checker' key in 'config' sets the
328
 
        'checker_command' attribute and *not* the 'checker'
329
 
        attribute."""
 
474
        return timedelta_to_milliseconds(self.approval_delay)
 
475
    
 
476
    @staticmethod
 
477
    def config_parser(config):
 
478
        """Construct a new dict of client settings of this form:
 
479
        { client_name: {setting_name: value, ...}, ...}
 
480
        with exceptions for any special settings as defined above.
 
481
        NOTE: Must be a pure function. Must return the same result
 
482
        value given the same arguments.
 
483
        """
 
484
        settings = {}
 
485
        for client_name in config.sections():
 
486
            section = dict(config.items(client_name))
 
487
            client = settings[client_name] = {}
 
488
            
 
489
            client["host"] = section["host"]
 
490
            # Reformat values from string types to Python types
 
491
            client["approved_by_default"] = config.getboolean(
 
492
                client_name, "approved_by_default")
 
493
            client["enabled"] = config.getboolean(client_name,
 
494
                                                  "enabled")
 
495
            
 
496
            client["fingerprint"] = (section["fingerprint"].upper()
 
497
                                     .replace(" ", ""))
 
498
            if "secret" in section:
 
499
                client["secret"] = section["secret"].decode("base64")
 
500
            elif "secfile" in section:
 
501
                with open(os.path.expanduser(os.path.expandvars
 
502
                                             (section["secfile"])),
 
503
                          "rb") as secfile:
 
504
                    client["secret"] = secfile.read()
 
505
            else:
 
506
                raise TypeError("No secret or secfile for section {0}"
 
507
                                .format(section))
 
508
            client["timeout"] = string_to_delta(section["timeout"])
 
509
            client["extended_timeout"] = string_to_delta(
 
510
                section["extended_timeout"])
 
511
            client["interval"] = string_to_delta(section["interval"])
 
512
            client["approval_delay"] = string_to_delta(
 
513
                section["approval_delay"])
 
514
            client["approval_duration"] = string_to_delta(
 
515
                section["approval_duration"])
 
516
            client["checker_command"] = section["checker"]
 
517
            client["last_approval_request"] = None
 
518
            client["last_checked_ok"] = None
 
519
            client["last_checker_status"] = -2
 
520
        
 
521
        return settings
 
522
    
 
523
    def __init__(self, settings, name = None):
330
524
        self.name = name
331
 
        if config is None:
332
 
            config = {}
 
525
        # adding all client settings
 
526
        for setting, value in settings.iteritems():
 
527
            setattr(self, setting, value)
 
528
        
 
529
        if self.enabled:
 
530
            if not hasattr(self, "last_enabled"):
 
531
                self.last_enabled = datetime.datetime.utcnow()
 
532
            if not hasattr(self, "expires"):
 
533
                self.expires = (datetime.datetime.utcnow()
 
534
                                + self.timeout)
 
535
        else:
 
536
            self.last_enabled = None
 
537
            self.expires = None
 
538
        
333
539
        logger.debug("Creating client %r", self.name)
334
540
        # Uppercase and remove spaces from fingerprint for later
335
541
        # comparison purposes with return value from the fingerprint()
336
542
        # function
337
 
        self.fingerprint = (config["fingerprint"].upper()
338
 
                            .replace(" ", ""))
339
543
        logger.debug("  Fingerprint: %s", self.fingerprint)
340
 
        if "secret" in config:
341
 
            self.secret = config["secret"].decode("base64")
342
 
        elif "secfile" in config:
343
 
            with open(os.path.expanduser(os.path.expandvars
344
 
                                         (config["secfile"])),
345
 
                      "rb") as secfile:
346
 
                self.secret = secfile.read()
347
 
        else:
348
 
            raise TypeError("No secret or secfile for client %s"
349
 
                            % self.name)
350
 
        self.host = config.get("host", "")
351
 
        self.created = datetime.datetime.utcnow()
352
 
        self.enabled = False
353
 
        self.last_approval_request = None
354
 
        self.last_enabled = None
355
 
        self.last_checked_ok = None
356
 
        self.timeout = string_to_delta(config["timeout"])
357
 
        self.interval = string_to_delta(config["interval"])
358
 
        self.disable_hook = disable_hook
 
544
        self.created = settings.get("created",
 
545
                                    datetime.datetime.utcnow())
 
546
        
 
547
        # attributes specific for this server instance
359
548
        self.checker = None
360
549
        self.checker_initiator_tag = None
361
550
        self.disable_initiator_tag = None
362
551
        self.checker_callback_tag = None
363
 
        self.checker_command = config["checker"]
364
552
        self.current_checker_command = None
365
 
        self.last_connect = None
366
 
        self._approved = None
367
 
        self.approved_by_default = config.get("approved_by_default",
368
 
                                              True)
 
553
        self.approved = None
369
554
        self.approvals_pending = 0
370
 
        self.approval_delay = string_to_delta(
371
 
            config["approval_delay"])
372
 
        self.approval_duration = string_to_delta(
373
 
            config["approval_duration"])
374
 
        self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
 
555
        self.changedstate = (multiprocessing_manager
 
556
                             .Condition(multiprocessing_manager
 
557
                                        .Lock()))
 
558
        self.client_structure = [attr for attr in
 
559
                                 self.__dict__.iterkeys()
 
560
                                 if not attr.startswith("_")]
 
561
        self.client_structure.append("client_structure")
 
562
        
 
563
        for name, t in inspect.getmembers(type(self),
 
564
                                          lambda obj:
 
565
                                              isinstance(obj,
 
566
                                                         property)):
 
567
            if not name.startswith("_"):
 
568
                self.client_structure.append(name)
375
569
    
 
570
    # Send notice to process children that client state has changed
376
571
    def send_changedstate(self):
377
 
        self.changedstate.acquire()
378
 
        self.changedstate.notify_all()
379
 
        self.changedstate.release()
380
 
        
 
572
        with self.changedstate:
 
573
            self.changedstate.notify_all()
 
574
    
381
575
    def enable(self):
382
576
        """Start this client's checker and timeout hooks"""
383
577
        if getattr(self, "enabled", False):
384
578
            # Already enabled
385
579
            return
386
 
        self.send_changedstate()
 
580
        self.expires = datetime.datetime.utcnow() + self.timeout
 
581
        self.enabled = True
387
582
        self.last_enabled = datetime.datetime.utcnow()
 
583
        self.init_checker()
 
584
        self.send_changedstate()
 
585
    
 
586
    def disable(self, quiet=True):
 
587
        """Disable this client."""
 
588
        if not getattr(self, "enabled", False):
 
589
            return False
 
590
        if not quiet:
 
591
            logger.info("Disabling client %s", self.name)
 
592
        if getattr(self, "disable_initiator_tag", None) is not None:
 
593
            gobject.source_remove(self.disable_initiator_tag)
 
594
            self.disable_initiator_tag = None
 
595
        self.expires = None
 
596
        if getattr(self, "checker_initiator_tag", None) is not None:
 
597
            gobject.source_remove(self.checker_initiator_tag)
 
598
            self.checker_initiator_tag = None
 
599
        self.stop_checker()
 
600
        self.enabled = False
 
601
        if not quiet:
 
602
            self.send_changedstate()
 
603
        # Do not run this again if called by a gobject.timeout_add
 
604
        return False
 
605
    
 
606
    def __del__(self):
 
607
        self.disable()
 
608
    
 
609
    def init_checker(self):
388
610
        # Schedule a new checker to be started an 'interval' from now,
389
611
        # and every interval from then on.
 
612
        if self.checker_initiator_tag is not None:
 
613
            gobject.source_remove(self.checker_initiator_tag)
390
614
        self.checker_initiator_tag = (gobject.timeout_add
391
615
                                      (self.interval_milliseconds(),
392
616
                                       self.start_checker))
393
617
        # Schedule a disable() when 'timeout' has passed
 
618
        if self.disable_initiator_tag is not None:
 
619
            gobject.source_remove(self.disable_initiator_tag)
394
620
        self.disable_initiator_tag = (gobject.timeout_add
395
621
                                   (self.timeout_milliseconds(),
396
622
                                    self.disable))
397
 
        self.enabled = True
398
623
        # Also start a new checker *right now*.
399
624
        self.start_checker()
400
625
    
401
 
    def disable(self, quiet=True):
402
 
        """Disable this client."""
403
 
        if not getattr(self, "enabled", False):
404
 
            return False
405
 
        if not quiet:
406
 
            self.send_changedstate()
407
 
        if not quiet:
408
 
            logger.info("Disabling client %s", self.name)
409
 
        if getattr(self, "disable_initiator_tag", False):
410
 
            gobject.source_remove(self.disable_initiator_tag)
411
 
            self.disable_initiator_tag = None
412
 
        if getattr(self, "checker_initiator_tag", False):
413
 
            gobject.source_remove(self.checker_initiator_tag)
414
 
            self.checker_initiator_tag = None
415
 
        self.stop_checker()
416
 
        if self.disable_hook:
417
 
            self.disable_hook(self)
418
 
        self.enabled = False
419
 
        # Do not run this again if called by a gobject.timeout_add
420
 
        return False
421
 
    
422
 
    def __del__(self):
423
 
        self.disable_hook = None
424
 
        self.disable()
425
 
    
426
626
    def checker_callback(self, pid, condition, command):
427
627
        """The checker has completed, so take appropriate actions."""
428
628
        self.checker_callback_tag = None
429
629
        self.checker = None
430
630
        if os.WIFEXITED(condition):
431
 
            exitstatus = os.WEXITSTATUS(condition)
432
 
            if exitstatus == 0:
 
631
            self.last_checker_status = os.WEXITSTATUS(condition)
 
632
            if self.last_checker_status == 0:
433
633
                logger.info("Checker for %(name)s succeeded",
434
634
                            vars(self))
435
635
                self.checked_ok()
437
637
                logger.info("Checker for %(name)s failed",
438
638
                            vars(self))
439
639
        else:
 
640
            self.last_checker_status = -1
440
641
            logger.warning("Checker for %(name)s crashed?",
441
642
                           vars(self))
442
643
    
443
644
    def checked_ok(self):
444
 
        """Bump up the timeout for this client.
445
 
        
446
 
        This should only be called when the client has been seen,
447
 
        alive and well.
448
 
        """
 
645
        """Assert that the client has been seen, alive and well."""
449
646
        self.last_checked_ok = datetime.datetime.utcnow()
450
 
        gobject.source_remove(self.disable_initiator_tag)
451
 
        self.disable_initiator_tag = (gobject.timeout_add
452
 
                                      (self.timeout_milliseconds(),
453
 
                                       self.disable))
 
647
        self.last_checker_status = 0
 
648
        self.bump_timeout()
 
649
    
 
650
    def bump_timeout(self, timeout=None):
 
651
        """Bump up the timeout for this client."""
 
652
        if timeout is None:
 
653
            timeout = self.timeout
 
654
        if self.disable_initiator_tag is not None:
 
655
            gobject.source_remove(self.disable_initiator_tag)
 
656
            self.disable_initiator_tag = None
 
657
        if getattr(self, "enabled", False):
 
658
            self.disable_initiator_tag = (gobject.timeout_add
 
659
                                          (timedelta_to_milliseconds
 
660
                                           (timeout), self.disable))
 
661
            self.expires = datetime.datetime.utcnow() + timeout
454
662
    
455
663
    def need_approval(self):
456
664
        self.last_approval_request = datetime.datetime.utcnow()
461
669
        If a checker already exists, leave it running and do
462
670
        nothing."""
463
671
        # The reason for not killing a running checker is that if we
464
 
        # did that, then if a checker (for some reason) started
465
 
        # running slowly and taking more than 'interval' time, the
466
 
        # client would inevitably timeout, since no checker would get
467
 
        # a chance to run to completion.  If we instead leave running
 
672
        # did that, and if a checker (for some reason) started running
 
673
        # slowly and taking more than 'interval' time, then the client
 
674
        # would inevitably timeout, since no checker would get a
 
675
        # chance to run to completion.  If we instead leave running
468
676
        # checkers alone, the checker would have to take more time
469
677
        # than 'timeout' for the client to be disabled, which is as it
470
678
        # should be.
484
692
                                      self.current_checker_command)
485
693
        # Start a new checker if needed
486
694
        if self.checker is None:
 
695
            # Escape attributes for the shell
 
696
            escaped_attrs = dict(
 
697
                (attr, re.escape(unicode(getattr(self, attr))))
 
698
                for attr in
 
699
                self.runtime_expansions)
487
700
            try:
488
 
                # In case checker_command has exactly one % operator
489
 
                command = self.checker_command % self.host
490
 
            except TypeError:
491
 
                # Escape attributes for the shell
492
 
                escaped_attrs = dict(
493
 
                    (attr,
494
 
                     re.escape(unicode(str(getattr(self, attr, "")),
495
 
                                       errors=
496
 
                                       'replace')))
497
 
                    for attr in
498
 
                    self.runtime_expansions)
499
 
 
500
 
                try:
501
 
                    command = self.checker_command % escaped_attrs
502
 
                except TypeError as error:
503
 
                    logger.error('Could not format string "%s":'
504
 
                                 ' %s', self.checker_command, error)
505
 
                    return True # Try again later
 
701
                command = self.checker_command % escaped_attrs
 
702
            except TypeError as error:
 
703
                logger.error('Could not format string "%s"',
 
704
                             self.checker_command, exc_info=error)
 
705
                return True # Try again later
506
706
            self.current_checker_command = command
507
707
            try:
508
708
                logger.info("Starting checker %r for %s",
514
714
                self.checker = subprocess.Popen(command,
515
715
                                                close_fds=True,
516
716
                                                shell=True, cwd="/")
517
 
                self.checker_callback_tag = (gobject.child_watch_add
518
 
                                             (self.checker.pid,
519
 
                                              self.checker_callback,
520
 
                                              data=command))
521
 
                # The checker may have completed before the gobject
522
 
                # watch was added.  Check for this.
523
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
524
 
                if pid:
525
 
                    gobject.source_remove(self.checker_callback_tag)
526
 
                    self.checker_callback(pid, status, command)
527
717
            except OSError as error:
528
 
                logger.error("Failed to start subprocess: %s",
529
 
                             error)
 
718
                logger.error("Failed to start subprocess",
 
719
                             exc_info=error)
 
720
            self.checker_callback_tag = (gobject.child_watch_add
 
721
                                         (self.checker.pid,
 
722
                                          self.checker_callback,
 
723
                                          data=command))
 
724
            # The checker may have completed before the gobject
 
725
            # watch was added.  Check for this.
 
726
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
727
            if pid:
 
728
                gobject.source_remove(self.checker_callback_tag)
 
729
                self.checker_callback(pid, status, command)
530
730
        # Re-run this periodically if run by gobject.timeout_add
531
731
        return True
532
732
    
539
739
            return
540
740
        logger.debug("Stopping checker for %(name)s", vars(self))
541
741
        try:
542
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
742
            self.checker.terminate()
543
743
            #time.sleep(0.5)
544
744
            #if self.checker.poll() is None:
545
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
745
            #    self.checker.kill()
546
746
        except OSError as error:
547
747
            if error.errno != errno.ESRCH: # No such process
548
748
                raise
549
749
        self.checker = None
550
750
 
 
751
 
551
752
def dbus_service_property(dbus_interface, signature="v",
552
753
                          access="readwrite", byte_arrays=False):
553
754
    """Decorators for marking methods of a DBusObjectWithProperties to
564
765
    # "Set" method, so we fail early here:
565
766
    if byte_arrays and signature != "ay":
566
767
        raise ValueError("Byte arrays not supported for non-'ay'"
567
 
                         " signature %r" % signature)
 
768
                         " signature {0!r}".format(signature))
568
769
    def decorator(func):
569
770
        func._dbus_is_property = True
570
771
        func._dbus_interface = dbus_interface
578
779
    return decorator
579
780
 
580
781
 
 
782
def dbus_interface_annotations(dbus_interface):
 
783
    """Decorator for marking functions returning interface annotations
 
784
    
 
785
    Usage:
 
786
    
 
787
    @dbus_interface_annotations("org.example.Interface")
 
788
    def _foo(self):  # Function name does not matter
 
789
        return {"org.freedesktop.DBus.Deprecated": "true",
 
790
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
791
                    "false"}
 
792
    """
 
793
    def decorator(func):
 
794
        func._dbus_is_interface = True
 
795
        func._dbus_interface = dbus_interface
 
796
        func._dbus_name = dbus_interface
 
797
        return func
 
798
    return decorator
 
799
 
 
800
 
 
801
def dbus_annotations(annotations):
 
802
    """Decorator to annotate D-Bus methods, signals or properties
 
803
    Usage:
 
804
    
 
805
    @dbus_service_property("org.example.Interface", signature="b",
 
806
                           access="r")
 
807
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
 
808
                        "org.freedesktop.DBus.Property."
 
809
                        "EmitsChangedSignal": "false"})
 
810
    def Property_dbus_property(self):
 
811
        return dbus.Boolean(False)
 
812
    """
 
813
    def decorator(func):
 
814
        func._dbus_annotations = annotations
 
815
        return func
 
816
    return decorator
 
817
 
 
818
 
581
819
class DBusPropertyException(dbus.exceptions.DBusException):
582
820
    """A base class for D-Bus property-related exceptions
583
821
    """
599
837
 
600
838
class DBusObjectWithProperties(dbus.service.Object):
601
839
    """A D-Bus object with properties.
602
 
 
 
840
    
603
841
    Classes inheriting from this can use the dbus_service_property
604
842
    decorator to expose methods as D-Bus properties.  It exposes the
605
843
    standard Get(), Set(), and GetAll() methods on the D-Bus.
606
844
    """
607
845
    
608
846
    @staticmethod
609
 
    def _is_dbus_property(obj):
610
 
        return getattr(obj, "_dbus_is_property", False)
 
847
    def _is_dbus_thing(thing):
 
848
        """Returns a function testing if an attribute is a D-Bus thing
 
849
        
 
850
        If called like _is_dbus_thing("method") it returns a function
 
851
        suitable for use as predicate to inspect.getmembers().
 
852
        """
 
853
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
 
854
                                   False)
611
855
    
612
 
    def _get_all_dbus_properties(self):
 
856
    def _get_all_dbus_things(self, thing):
613
857
        """Returns a generator of (name, attribute) pairs
614
858
        """
615
 
        return ((prop._dbus_name, prop)
616
 
                for name, prop in
617
 
                inspect.getmembers(self, self._is_dbus_property))
 
859
        return ((getattr(athing.__get__(self), "_dbus_name",
 
860
                         name),
 
861
                 athing.__get__(self))
 
862
                for cls in self.__class__.__mro__
 
863
                for name, athing in
 
864
                inspect.getmembers(cls,
 
865
                                   self._is_dbus_thing(thing)))
618
866
    
619
867
    def _get_dbus_property(self, interface_name, property_name):
620
868
        """Returns a bound method if one exists which is a D-Bus
621
869
        property with the specified name and interface.
622
870
        """
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
 
871
        for cls in  self.__class__.__mro__:
 
872
            for name, value in (inspect.getmembers
 
873
                                (cls,
 
874
                                 self._is_dbus_thing("property"))):
 
875
                if (value._dbus_name == property_name
 
876
                    and value._dbus_interface == interface_name):
 
877
                    return value.__get__(self)
 
878
        
633
879
        # No such property
634
880
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
635
881
                                   + interface_name + "."
660
906
            # signatures other than "ay".
661
907
            if prop._dbus_signature != "ay":
662
908
                raise ValueError
663
 
            value = dbus.ByteArray(''.join(unichr(byte)
664
 
                                           for byte in value))
 
909
            value = dbus.ByteArray(b''.join(chr(byte)
 
910
                                            for byte in value))
665
911
        prop(value)
666
912
    
667
913
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
669
915
    def GetAll(self, interface_name):
670
916
        """Standard D-Bus property GetAll() method, see D-Bus
671
917
        standard.
672
 
 
 
918
        
673
919
        Note: Will not include properties with access="write".
674
920
        """
675
 
        all = {}
676
 
        for name, prop in self._get_all_dbus_properties():
 
921
        properties = {}
 
922
        for name, prop in self._get_all_dbus_things("property"):
677
923
            if (interface_name
678
924
                and interface_name != prop._dbus_interface):
679
925
                # Interface non-empty but did not match
683
929
                continue
684
930
            value = prop()
685
931
            if not hasattr(value, "variant_level"):
686
 
                all[name] = value
 
932
                properties[name] = value
687
933
                continue
688
 
            all[name] = type(value)(value, variant_level=
689
 
                                    value.variant_level+1)
690
 
        return dbus.Dictionary(all, signature="sv")
 
934
            properties[name] = type(value)(value, variant_level=
 
935
                                           value.variant_level+1)
 
936
        return dbus.Dictionary(properties, signature="sv")
691
937
    
692
938
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
693
939
                         out_signature="s",
694
940
                         path_keyword='object_path',
695
941
                         connection_keyword='connection')
696
942
    def Introspect(self, object_path, connection):
697
 
        """Standard D-Bus method, overloaded to insert property tags.
 
943
        """Overloading of standard D-Bus method.
 
944
        
 
945
        Inserts property tags and interface annotation tags.
698
946
        """
699
947
        xmlstring = dbus.service.Object.Introspect(self, object_path,
700
948
                                                   connection)
707
955
                e.setAttribute("access", prop._dbus_access)
708
956
                return e
709
957
            for if_tag in document.getElementsByTagName("interface"):
 
958
                # Add property tags
710
959
                for tag in (make_tag(document, name, prop)
711
960
                            for name, prop
712
 
                            in self._get_all_dbus_properties()
 
961
                            in self._get_all_dbus_things("property")
713
962
                            if prop._dbus_interface
714
963
                            == if_tag.getAttribute("name")):
715
964
                    if_tag.appendChild(tag)
 
965
                # Add annotation tags
 
966
                for typ in ("method", "signal", "property"):
 
967
                    for tag in if_tag.getElementsByTagName(typ):
 
968
                        annots = dict()
 
969
                        for name, prop in (self.
 
970
                                           _get_all_dbus_things(typ)):
 
971
                            if (name == tag.getAttribute("name")
 
972
                                and prop._dbus_interface
 
973
                                == if_tag.getAttribute("name")):
 
974
                                annots.update(getattr
 
975
                                              (prop,
 
976
                                               "_dbus_annotations",
 
977
                                               {}))
 
978
                        for name, value in annots.iteritems():
 
979
                            ann_tag = document.createElement(
 
980
                                "annotation")
 
981
                            ann_tag.setAttribute("name", name)
 
982
                            ann_tag.setAttribute("value", value)
 
983
                            tag.appendChild(ann_tag)
 
984
                # Add interface annotation tags
 
985
                for annotation, value in dict(
 
986
                    itertools.chain.from_iterable(
 
987
                        annotations().iteritems()
 
988
                        for name, annotations in
 
989
                        self._get_all_dbus_things("interface")
 
990
                        if name == if_tag.getAttribute("name")
 
991
                        )).iteritems():
 
992
                    ann_tag = document.createElement("annotation")
 
993
                    ann_tag.setAttribute("name", annotation)
 
994
                    ann_tag.setAttribute("value", value)
 
995
                    if_tag.appendChild(ann_tag)
716
996
                # Add the names to the return values for the
717
997
                # "org.freedesktop.DBus.Properties" methods
718
998
                if (if_tag.getAttribute("name")
733
1013
        except (AttributeError, xml.dom.DOMException,
734
1014
                xml.parsers.expat.ExpatError) as error:
735
1015
            logger.error("Failed to override Introspection method",
736
 
                         error)
 
1016
                         exc_info=error)
737
1017
        return xmlstring
738
1018
 
739
1019
 
 
1020
def datetime_to_dbus(dt, variant_level=0):
 
1021
    """Convert a UTC datetime.datetime() to a D-Bus type."""
 
1022
    if dt is None:
 
1023
        return dbus.String("", variant_level = variant_level)
 
1024
    return dbus.String(dt.isoformat(),
 
1025
                       variant_level=variant_level)
 
1026
 
 
1027
 
 
1028
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1029
    """A class decorator; applied to a subclass of
 
1030
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1031
    interface names according to the "alt_interface_names" mapping.
 
1032
    Usage:
 
1033
    
 
1034
    @alternate_dbus_interfaces({"org.example.Interface":
 
1035
                                    "net.example.AlternateInterface"})
 
1036
    class SampleDBusObject(dbus.service.Object):
 
1037
        @dbus.service.method("org.example.Interface")
 
1038
        def SampleDBusMethod():
 
1039
            pass
 
1040
    
 
1041
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1042
    reachable via two interfaces: "org.example.Interface" and
 
1043
    "net.example.AlternateInterface", the latter of which will have
 
1044
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1045
    "true", unless "deprecate" is passed with a False value.
 
1046
    
 
1047
    This works for methods and signals, and also for D-Bus properties
 
1048
    (from DBusObjectWithProperties) and interfaces (from the
 
1049
    dbus_interface_annotations decorator).
 
1050
    """
 
1051
    def wrapper(cls):
 
1052
        for orig_interface_name, alt_interface_name in (
 
1053
            alt_interface_names.iteritems()):
 
1054
            attr = {}
 
1055
            interface_names = set()
 
1056
            # Go though all attributes of the class
 
1057
            for attrname, attribute in inspect.getmembers(cls):
 
1058
                # Ignore non-D-Bus attributes, and D-Bus attributes
 
1059
                # with the wrong interface name
 
1060
                if (not hasattr(attribute, "_dbus_interface")
 
1061
                    or not attribute._dbus_interface
 
1062
                    .startswith(orig_interface_name)):
 
1063
                    continue
 
1064
                # Create an alternate D-Bus interface name based on
 
1065
                # the current name
 
1066
                alt_interface = (attribute._dbus_interface
 
1067
                                 .replace(orig_interface_name,
 
1068
                                          alt_interface_name))
 
1069
                interface_names.add(alt_interface)
 
1070
                # Is this a D-Bus signal?
 
1071
                if getattr(attribute, "_dbus_is_signal", False):
 
1072
                    # Extract the original non-method function by
 
1073
                    # black magic
 
1074
                    nonmethod_func = (dict(
 
1075
                            zip(attribute.func_code.co_freevars,
 
1076
                                attribute.__closure__))["func"]
 
1077
                                      .cell_contents)
 
1078
                    # Create a new, but exactly alike, function
 
1079
                    # object, and decorate it to be a new D-Bus signal
 
1080
                    # with the alternate D-Bus interface name
 
1081
                    new_function = (dbus.service.signal
 
1082
                                    (alt_interface,
 
1083
                                     attribute._dbus_signature)
 
1084
                                    (types.FunctionType(
 
1085
                                nonmethod_func.func_code,
 
1086
                                nonmethod_func.func_globals,
 
1087
                                nonmethod_func.func_name,
 
1088
                                nonmethod_func.func_defaults,
 
1089
                                nonmethod_func.func_closure)))
 
1090
                    # Copy annotations, if any
 
1091
                    try:
 
1092
                        new_function._dbus_annotations = (
 
1093
                            dict(attribute._dbus_annotations))
 
1094
                    except AttributeError:
 
1095
                        pass
 
1096
                    # Define a creator of a function to call both the
 
1097
                    # original and alternate functions, so both the
 
1098
                    # original and alternate signals gets sent when
 
1099
                    # the function is called
 
1100
                    def fixscope(func1, func2):
 
1101
                        """This function is a scope container to pass
 
1102
                        func1 and func2 to the "call_both" function
 
1103
                        outside of its arguments"""
 
1104
                        def call_both(*args, **kwargs):
 
1105
                            """This function will emit two D-Bus
 
1106
                            signals by calling func1 and func2"""
 
1107
                            func1(*args, **kwargs)
 
1108
                            func2(*args, **kwargs)
 
1109
                        return call_both
 
1110
                    # Create the "call_both" function and add it to
 
1111
                    # the class
 
1112
                    attr[attrname] = fixscope(attribute, new_function)
 
1113
                # Is this a D-Bus method?
 
1114
                elif getattr(attribute, "_dbus_is_method", False):
 
1115
                    # Create a new, but exactly alike, function
 
1116
                    # object.  Decorate it to be a new D-Bus method
 
1117
                    # with the alternate D-Bus interface name.  Add it
 
1118
                    # to the class.
 
1119
                    attr[attrname] = (dbus.service.method
 
1120
                                      (alt_interface,
 
1121
                                       attribute._dbus_in_signature,
 
1122
                                       attribute._dbus_out_signature)
 
1123
                                      (types.FunctionType
 
1124
                                       (attribute.func_code,
 
1125
                                        attribute.func_globals,
 
1126
                                        attribute.func_name,
 
1127
                                        attribute.func_defaults,
 
1128
                                        attribute.func_closure)))
 
1129
                    # Copy annotations, if any
 
1130
                    try:
 
1131
                        attr[attrname]._dbus_annotations = (
 
1132
                            dict(attribute._dbus_annotations))
 
1133
                    except AttributeError:
 
1134
                        pass
 
1135
                # Is this a D-Bus property?
 
1136
                elif getattr(attribute, "_dbus_is_property", False):
 
1137
                    # Create a new, but exactly alike, function
 
1138
                    # object, and decorate it to be a new D-Bus
 
1139
                    # property with the alternate D-Bus interface
 
1140
                    # name.  Add it to the class.
 
1141
                    attr[attrname] = (dbus_service_property
 
1142
                                      (alt_interface,
 
1143
                                       attribute._dbus_signature,
 
1144
                                       attribute._dbus_access,
 
1145
                                       attribute
 
1146
                                       ._dbus_get_args_options
 
1147
                                       ["byte_arrays"])
 
1148
                                      (types.FunctionType
 
1149
                                       (attribute.func_code,
 
1150
                                        attribute.func_globals,
 
1151
                                        attribute.func_name,
 
1152
                                        attribute.func_defaults,
 
1153
                                        attribute.func_closure)))
 
1154
                    # Copy annotations, if any
 
1155
                    try:
 
1156
                        attr[attrname]._dbus_annotations = (
 
1157
                            dict(attribute._dbus_annotations))
 
1158
                    except AttributeError:
 
1159
                        pass
 
1160
                # Is this a D-Bus interface?
 
1161
                elif getattr(attribute, "_dbus_is_interface", False):
 
1162
                    # Create a new, but exactly alike, function
 
1163
                    # object.  Decorate it to be a new D-Bus interface
 
1164
                    # with the alternate D-Bus interface name.  Add it
 
1165
                    # to the class.
 
1166
                    attr[attrname] = (dbus_interface_annotations
 
1167
                                      (alt_interface)
 
1168
                                      (types.FunctionType
 
1169
                                       (attribute.func_code,
 
1170
                                        attribute.func_globals,
 
1171
                                        attribute.func_name,
 
1172
                                        attribute.func_defaults,
 
1173
                                        attribute.func_closure)))
 
1174
            if deprecate:
 
1175
                # Deprecate all alternate interfaces
 
1176
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1177
                for interface_name in interface_names:
 
1178
                    @dbus_interface_annotations(interface_name)
 
1179
                    def func(self):
 
1180
                        return { "org.freedesktop.DBus.Deprecated":
 
1181
                                     "true" }
 
1182
                    # Find an unused name
 
1183
                    for aname in (iname.format(i)
 
1184
                                  for i in itertools.count()):
 
1185
                        if aname not in attr:
 
1186
                            attr[aname] = func
 
1187
                            break
 
1188
            if interface_names:
 
1189
                # Replace the class with a new subclass of it with
 
1190
                # methods, signals, etc. as created above.
 
1191
                cls = type(b"{0}Alternate".format(cls.__name__),
 
1192
                           (cls,), attr)
 
1193
        return cls
 
1194
    return wrapper
 
1195
 
 
1196
 
 
1197
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1198
                                "se.bsnet.fukt.Mandos"})
740
1199
class ClientDBus(Client, DBusObjectWithProperties):
741
1200
    """A Client class using D-Bus
742
1201
    
751
1210
    # dbus.service.Object doesn't use super(), so we can't either.
752
1211
    
753
1212
    def __init__(self, bus = None, *args, **kwargs):
754
 
        self._approvals_pending = 0
755
1213
        self.bus = bus
756
1214
        Client.__init__(self, *args, **kwargs)
757
1215
        # Only now, when this client is initialized, can it show up on
763
1221
                                 ("/clients/" + client_object_name))
764
1222
        DBusObjectWithProperties.__init__(self, self.bus,
765
1223
                                          self.dbus_object_path)
766
 
        
767
 
    def _get_approvals_pending(self):
768
 
        return self._approvals_pending
769
 
    def _set_approvals_pending(self, value):
770
 
        old_value = self._approvals_pending
771
 
        self._approvals_pending = value
772
 
        bval = bool(value)
773
 
        if (hasattr(self, "dbus_object_path")
774
 
            and bval is not bool(old_value)):
775
 
            dbus_bool = dbus.Boolean(bval, variant_level=1)
776
 
            self.PropertyChanged(dbus.String("ApprovalPending"),
777
 
                                 dbus_bool)
778
 
 
779
 
    approvals_pending = property(_get_approvals_pending,
780
 
                                 _set_approvals_pending)
781
 
    del _get_approvals_pending, _set_approvals_pending
782
 
    
783
 
    @staticmethod
784
 
    def _datetime_to_dbus(dt, variant_level=0):
785
 
        """Convert a UTC datetime.datetime() to a D-Bus type."""
786
 
        return dbus.String(dt.isoformat(),
787
 
                           variant_level=variant_level)
788
 
    
789
 
    def enable(self):
790
 
        oldstate = getattr(self, "enabled", False)
791
 
        r = Client.enable(self)
792
 
        if oldstate != self.enabled:
793
 
            # Emit D-Bus signals
794
 
            self.PropertyChanged(dbus.String("Enabled"),
795
 
                                 dbus.Boolean(True, variant_level=1))
796
 
            self.PropertyChanged(
797
 
                dbus.String("LastEnabled"),
798
 
                self._datetime_to_dbus(self.last_enabled,
799
 
                                       variant_level=1))
800
 
        return r
801
 
    
802
 
    def disable(self, quiet = False):
803
 
        oldstate = getattr(self, "enabled", False)
804
 
        r = Client.disable(self, quiet=quiet)
805
 
        if not quiet and oldstate != self.enabled:
806
 
            # Emit D-Bus signal
807
 
            self.PropertyChanged(dbus.String("Enabled"),
808
 
                                 dbus.Boolean(False, variant_level=1))
809
 
        return r
 
1224
    
 
1225
    def notifychangeproperty(transform_func,
 
1226
                             dbus_name, type_func=lambda x: x,
 
1227
                             variant_level=1):
 
1228
        """ Modify a variable so that it's a property which announces
 
1229
        its changes to DBus.
 
1230
        
 
1231
        transform_fun: Function that takes a value and a variant_level
 
1232
                       and transforms it to a D-Bus type.
 
1233
        dbus_name: D-Bus name of the variable
 
1234
        type_func: Function that transform the value before sending it
 
1235
                   to the D-Bus.  Default: no transform
 
1236
        variant_level: D-Bus variant level.  Default: 1
 
1237
        """
 
1238
        attrname = "_{0}".format(dbus_name)
 
1239
        def setter(self, value):
 
1240
            if hasattr(self, "dbus_object_path"):
 
1241
                if (not hasattr(self, attrname) or
 
1242
                    type_func(getattr(self, attrname, None))
 
1243
                    != type_func(value)):
 
1244
                    dbus_value = transform_func(type_func(value),
 
1245
                                                variant_level
 
1246
                                                =variant_level)
 
1247
                    self.PropertyChanged(dbus.String(dbus_name),
 
1248
                                         dbus_value)
 
1249
            setattr(self, attrname, value)
 
1250
        
 
1251
        return property(lambda self: getattr(self, attrname), setter)
 
1252
    
 
1253
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
 
1254
    approvals_pending = notifychangeproperty(dbus.Boolean,
 
1255
                                             "ApprovalPending",
 
1256
                                             type_func = bool)
 
1257
    enabled = notifychangeproperty(dbus.Boolean, "Enabled")
 
1258
    last_enabled = notifychangeproperty(datetime_to_dbus,
 
1259
                                        "LastEnabled")
 
1260
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
 
1261
                                   type_func = lambda checker:
 
1262
                                       checker is not None)
 
1263
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
 
1264
                                           "LastCheckedOK")
 
1265
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1266
                                               "LastCheckerStatus")
 
1267
    last_approval_request = notifychangeproperty(
 
1268
        datetime_to_dbus, "LastApprovalRequest")
 
1269
    approved_by_default = notifychangeproperty(dbus.Boolean,
 
1270
                                               "ApprovedByDefault")
 
1271
    approval_delay = notifychangeproperty(dbus.UInt64,
 
1272
                                          "ApprovalDelay",
 
1273
                                          type_func =
 
1274
                                          timedelta_to_milliseconds)
 
1275
    approval_duration = notifychangeproperty(
 
1276
        dbus.UInt64, "ApprovalDuration",
 
1277
        type_func = timedelta_to_milliseconds)
 
1278
    host = notifychangeproperty(dbus.String, "Host")
 
1279
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
1280
                                   type_func =
 
1281
                                   timedelta_to_milliseconds)
 
1282
    extended_timeout = notifychangeproperty(
 
1283
        dbus.UInt64, "ExtendedTimeout",
 
1284
        type_func = timedelta_to_milliseconds)
 
1285
    interval = notifychangeproperty(dbus.UInt64,
 
1286
                                    "Interval",
 
1287
                                    type_func =
 
1288
                                    timedelta_to_milliseconds)
 
1289
    checker_command = notifychangeproperty(dbus.String, "Checker")
 
1290
    
 
1291
    del notifychangeproperty
810
1292
    
811
1293
    def __del__(self, *args, **kwargs):
812
1294
        try:
821
1303
                         *args, **kwargs):
822
1304
        self.checker_callback_tag = None
823
1305
        self.checker = None
824
 
        # Emit D-Bus signal
825
 
        self.PropertyChanged(dbus.String("CheckerRunning"),
826
 
                             dbus.Boolean(False, variant_level=1))
827
1306
        if os.WIFEXITED(condition):
828
1307
            exitstatus = os.WEXITSTATUS(condition)
829
1308
            # Emit D-Bus signal
839
1318
        return Client.checker_callback(self, pid, condition, command,
840
1319
                                       *args, **kwargs)
841
1320
    
842
 
    def checked_ok(self, *args, **kwargs):
843
 
        Client.checked_ok(self, *args, **kwargs)
844
 
        # Emit D-Bus signal
845
 
        self.PropertyChanged(
846
 
            dbus.String("LastCheckedOK"),
847
 
            (self._datetime_to_dbus(self.last_checked_ok,
848
 
                                    variant_level=1)))
849
 
    
850
 
    def need_approval(self, *args, **kwargs):
851
 
        r = Client.need_approval(self, *args, **kwargs)
852
 
        # Emit D-Bus signal
853
 
        self.PropertyChanged(
854
 
            dbus.String("LastApprovalRequest"),
855
 
            (self._datetime_to_dbus(self.last_approval_request,
856
 
                                    variant_level=1)))
857
 
        return r
858
 
    
859
1321
    def start_checker(self, *args, **kwargs):
860
1322
        old_checker = self.checker
861
1323
        if self.checker is not None:
868
1330
            and old_checker_pid != self.checker.pid):
869
1331
            # Emit D-Bus signal
870
1332
            self.CheckerStarted(self.current_checker_command)
871
 
            self.PropertyChanged(
872
 
                dbus.String("CheckerRunning"),
873
 
                dbus.Boolean(True, variant_level=1))
874
1333
        return r
875
1334
    
876
 
    def stop_checker(self, *args, **kwargs):
877
 
        old_checker = getattr(self, "checker", None)
878
 
        r = Client.stop_checker(self, *args, **kwargs)
879
 
        if (old_checker is not None
880
 
            and getattr(self, "checker", None) is None):
881
 
            self.PropertyChanged(dbus.String("CheckerRunning"),
882
 
                                 dbus.Boolean(False, variant_level=1))
883
 
        return r
884
 
 
885
1335
    def _reset_approved(self):
886
 
        self._approved = None
 
1336
        self.approved = None
887
1337
        return False
888
1338
    
889
1339
    def approve(self, value=True):
890
 
        self.send_changedstate()
891
 
        self._approved = value
892
 
        gobject.timeout_add(self._timedelta_to_milliseconds
 
1340
        self.approved = value
 
1341
        gobject.timeout_add(timedelta_to_milliseconds
893
1342
                            (self.approval_duration),
894
1343
                            self._reset_approved)
895
 
    
 
1344
        self.send_changedstate()
896
1345
    
897
1346
    ## D-Bus methods, signals & properties
898
 
    _interface = "se.bsnet.fukt.Mandos.Client"
 
1347
    _interface = "se.recompile.Mandos.Client"
 
1348
    
 
1349
    ## Interfaces
 
1350
    
 
1351
    @dbus_interface_annotations(_interface)
 
1352
    def _foo(self):
 
1353
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1354
                     "false"}
899
1355
    
900
1356
    ## Signals
901
1357
    
987
1443
        if value is None:       # get
988
1444
            return dbus.Boolean(self.approved_by_default)
989
1445
        self.approved_by_default = bool(value)
990
 
        # Emit D-Bus signal
991
 
        self.PropertyChanged(dbus.String("ApprovedByDefault"),
992
 
                             dbus.Boolean(value, variant_level=1))
993
1446
    
994
1447
    # ApprovalDelay - property
995
1448
    @dbus_service_property(_interface, signature="t",
998
1451
        if value is None:       # get
999
1452
            return dbus.UInt64(self.approval_delay_milliseconds())
1000
1453
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
1001
 
        # Emit D-Bus signal
1002
 
        self.PropertyChanged(dbus.String("ApprovalDelay"),
1003
 
                             dbus.UInt64(value, variant_level=1))
1004
1454
    
1005
1455
    # ApprovalDuration - property
1006
1456
    @dbus_service_property(_interface, signature="t",
1007
1457
                           access="readwrite")
1008
1458
    def ApprovalDuration_dbus_property(self, value=None):
1009
1459
        if value is None:       # get
1010
 
            return dbus.UInt64(self._timedelta_to_milliseconds(
 
1460
            return dbus.UInt64(timedelta_to_milliseconds(
1011
1461
                    self.approval_duration))
1012
1462
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1013
 
        # Emit D-Bus signal
1014
 
        self.PropertyChanged(dbus.String("ApprovalDuration"),
1015
 
                             dbus.UInt64(value, variant_level=1))
1016
1463
    
1017
1464
    # Name - property
1018
1465
    @dbus_service_property(_interface, signature="s", access="read")
1030
1477
    def Host_dbus_property(self, value=None):
1031
1478
        if value is None:       # get
1032
1479
            return dbus.String(self.host)
1033
 
        self.host = value
1034
 
        # Emit D-Bus signal
1035
 
        self.PropertyChanged(dbus.String("Host"),
1036
 
                             dbus.String(value, variant_level=1))
 
1480
        self.host = unicode(value)
1037
1481
    
1038
1482
    # Created - property
1039
1483
    @dbus_service_property(_interface, signature="s", access="read")
1040
1484
    def Created_dbus_property(self):
1041
 
        return dbus.String(self._datetime_to_dbus(self.created))
 
1485
        return datetime_to_dbus(self.created)
1042
1486
    
1043
1487
    # LastEnabled - property
1044
1488
    @dbus_service_property(_interface, signature="s", access="read")
1045
1489
    def LastEnabled_dbus_property(self):
1046
 
        if self.last_enabled is None:
1047
 
            return dbus.String("")
1048
 
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
 
1490
        return datetime_to_dbus(self.last_enabled)
1049
1491
    
1050
1492
    # Enabled - property
1051
1493
    @dbus_service_property(_interface, signature="b",
1065
1507
        if value is not None:
1066
1508
            self.checked_ok()
1067
1509
            return
1068
 
        if self.last_checked_ok is None:
1069
 
            return dbus.String("")
1070
 
        return dbus.String(self._datetime_to_dbus(self
1071
 
                                                  .last_checked_ok))
 
1510
        return datetime_to_dbus(self.last_checked_ok)
 
1511
    
 
1512
    # LastCheckerStatus - property
 
1513
    @dbus_service_property(_interface, signature="n",
 
1514
                           access="read")
 
1515
    def LastCheckerStatus_dbus_property(self):
 
1516
        return dbus.Int16(self.last_checker_status)
 
1517
    
 
1518
    # Expires - property
 
1519
    @dbus_service_property(_interface, signature="s", access="read")
 
1520
    def Expires_dbus_property(self):
 
1521
        return datetime_to_dbus(self.expires)
1072
1522
    
1073
1523
    # LastApprovalRequest - property
1074
1524
    @dbus_service_property(_interface, signature="s", access="read")
1075
1525
    def LastApprovalRequest_dbus_property(self):
1076
 
        if self.last_approval_request is None:
1077
 
            return dbus.String("")
1078
 
        return dbus.String(self.
1079
 
                           _datetime_to_dbus(self
1080
 
                                             .last_approval_request))
 
1526
        return datetime_to_dbus(self.last_approval_request)
1081
1527
    
1082
1528
    # Timeout - property
1083
1529
    @dbus_service_property(_interface, signature="t",
1085
1531
    def Timeout_dbus_property(self, value=None):
1086
1532
        if value is None:       # get
1087
1533
            return dbus.UInt64(self.timeout_milliseconds())
 
1534
        old_timeout = self.timeout
1088
1535
        self.timeout = datetime.timedelta(0, 0, 0, value)
1089
 
        # Emit D-Bus signal
1090
 
        self.PropertyChanged(dbus.String("Timeout"),
1091
 
                             dbus.UInt64(value, variant_level=1))
1092
 
        if getattr(self, "disable_initiator_tag", None) is None:
1093
 
            return
1094
 
        # Reschedule timeout
1095
 
        gobject.source_remove(self.disable_initiator_tag)
1096
 
        self.disable_initiator_tag = None
1097
 
        time_to_die = (self.
1098
 
                       _timedelta_to_milliseconds((self
1099
 
                                                   .last_checked_ok
1100
 
                                                   + self.timeout)
1101
 
                                                  - datetime.datetime
1102
 
                                                  .utcnow()))
1103
 
        if time_to_die <= 0:
1104
 
            # The timeout has passed
1105
 
            self.disable()
1106
 
        else:
1107
 
            self.disable_initiator_tag = (gobject.timeout_add
1108
 
                                          (time_to_die, self.disable))
 
1536
        # Reschedule disabling
 
1537
        if self.enabled:
 
1538
            now = datetime.datetime.utcnow()
 
1539
            self.expires += self.timeout - old_timeout
 
1540
            if self.expires <= now:
 
1541
                # The timeout has passed
 
1542
                self.disable()
 
1543
            else:
 
1544
                if (getattr(self, "disable_initiator_tag", None)
 
1545
                    is None):
 
1546
                    return
 
1547
                gobject.source_remove(self.disable_initiator_tag)
 
1548
                self.disable_initiator_tag = (
 
1549
                    gobject.timeout_add(
 
1550
                        timedelta_to_milliseconds(self.expires - now),
 
1551
                        self.disable))
 
1552
    
 
1553
    # ExtendedTimeout - property
 
1554
    @dbus_service_property(_interface, signature="t",
 
1555
                           access="readwrite")
 
1556
    def ExtendedTimeout_dbus_property(self, value=None):
 
1557
        if value is None:       # get
 
1558
            return dbus.UInt64(self.extended_timeout_milliseconds())
 
1559
        self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1109
1560
    
1110
1561
    # Interval - property
1111
1562
    @dbus_service_property(_interface, signature="t",
1114
1565
        if value is None:       # get
1115
1566
            return dbus.UInt64(self.interval_milliseconds())
1116
1567
        self.interval = datetime.timedelta(0, 0, 0, value)
1117
 
        # Emit D-Bus signal
1118
 
        self.PropertyChanged(dbus.String("Interval"),
1119
 
                             dbus.UInt64(value, variant_level=1))
1120
1568
        if getattr(self, "checker_initiator_tag", None) is None:
1121
1569
            return
1122
 
        # Reschedule checker run
1123
 
        gobject.source_remove(self.checker_initiator_tag)
1124
 
        self.checker_initiator_tag = (gobject.timeout_add
1125
 
                                      (value, self.start_checker))
1126
 
        self.start_checker()    # Start one now, too
1127
 
 
 
1570
        if self.enabled:
 
1571
            # Reschedule checker run
 
1572
            gobject.source_remove(self.checker_initiator_tag)
 
1573
            self.checker_initiator_tag = (gobject.timeout_add
 
1574
                                          (value, self.start_checker))
 
1575
            self.start_checker()    # Start one now, too
 
1576
    
1128
1577
    # Checker - property
1129
1578
    @dbus_service_property(_interface, signature="s",
1130
1579
                           access="readwrite")
1131
1580
    def Checker_dbus_property(self, value=None):
1132
1581
        if value is None:       # get
1133
1582
            return dbus.String(self.checker_command)
1134
 
        self.checker_command = value
1135
 
        # Emit D-Bus signal
1136
 
        self.PropertyChanged(dbus.String("Checker"),
1137
 
                             dbus.String(self.checker_command,
1138
 
                                         variant_level=1))
 
1583
        self.checker_command = unicode(value)
1139
1584
    
1140
1585
    # CheckerRunning - property
1141
1586
    @dbus_service_property(_interface, signature="b",
1168
1613
        self._pipe.send(('init', fpr, address))
1169
1614
        if not self._pipe.recv():
1170
1615
            raise KeyError()
1171
 
 
 
1616
    
1172
1617
    def __getattribute__(self, name):
1173
 
        if(name == '_pipe'):
 
1618
        if name == '_pipe':
1174
1619
            return super(ProxyClient, self).__getattribute__(name)
1175
1620
        self._pipe.send(('getattr', name))
1176
1621
        data = self._pipe.recv()
1181
1626
                self._pipe.send(('funcall', name, args, kwargs))
1182
1627
                return self._pipe.recv()[1]
1183
1628
            return func
1184
 
 
 
1629
    
1185
1630
    def __setattr__(self, name, value):
1186
 
        if(name == '_pipe'):
 
1631
        if name == '_pipe':
1187
1632
            return super(ProxyClient, self).__setattr__(name, value)
1188
1633
        self._pipe.send(('setattr', name, value))
1189
1634
 
1200
1645
                        unicode(self.client_address))
1201
1646
            logger.debug("Pipe FD: %d",
1202
1647
                         self.server.child_pipe.fileno())
1203
 
 
 
1648
            
1204
1649
            session = (gnutls.connection
1205
1650
                       .ClientSession(self.request,
1206
1651
                                      gnutls.connection
1207
1652
                                      .X509Credentials()))
1208
 
 
 
1653
            
1209
1654
            # Note: gnutls.connection.X509Credentials is really a
1210
1655
            # generic GnuTLS certificate credentials object so long as
1211
1656
            # no X.509 keys are added to it.  Therefore, we can use it
1212
1657
            # here despite using OpenPGP certificates.
1213
 
 
 
1658
            
1214
1659
            #priority = ':'.join(("NONE", "+VERS-TLS1.1",
1215
1660
            #                      "+AES-256-CBC", "+SHA1",
1216
1661
            #                      "+COMP-NULL", "+CTYPE-OPENPGP",
1222
1667
            (gnutls.library.functions
1223
1668
             .gnutls_priority_set_direct(session._c_object,
1224
1669
                                         priority, None))
1225
 
 
 
1670
            
1226
1671
            # Start communication using the Mandos protocol
1227
1672
            # Get protocol number
1228
1673
            line = self.request.makefile().readline()
1233
1678
            except (ValueError, IndexError, RuntimeError) as error:
1234
1679
                logger.error("Unknown protocol version: %s", error)
1235
1680
                return
1236
 
 
 
1681
            
1237
1682
            # Start GnuTLS connection
1238
1683
            try:
1239
1684
                session.handshake()
1243
1688
                # established.  Just abandon the request.
1244
1689
                return
1245
1690
            logger.debug("Handshake succeeded")
1246
 
 
 
1691
            
1247
1692
            approval_required = False
1248
1693
            try:
1249
1694
                try:
1254
1699
                    logger.warning("Bad certificate: %s", error)
1255
1700
                    return
1256
1701
                logger.debug("Fingerprint: %s", fpr)
1257
 
 
 
1702
                
1258
1703
                try:
1259
1704
                    client = ProxyClient(child_pipe, fpr,
1260
1705
                                         self.client_address)
1272
1717
                                       client.name)
1273
1718
                        if self.server.use_dbus:
1274
1719
                            # Emit D-Bus signal
1275
 
                            client.Rejected("Disabled")                    
 
1720
                            client.Rejected("Disabled")
1276
1721
                        return
1277
1722
                    
1278
 
                    if client._approved or not client.approval_delay:
 
1723
                    if client.approved or not client.approval_delay:
1279
1724
                        #We are approved or approval is disabled
1280
1725
                        break
1281
 
                    elif client._approved is None:
 
1726
                    elif client.approved is None:
1282
1727
                        logger.info("Client %s needs approval",
1283
1728
                                    client.name)
1284
1729
                        if self.server.use_dbus:
1295
1740
                        return
1296
1741
                    
1297
1742
                    #wait until timeout or approved
1298
 
                    #x = float(client._timedelta_to_milliseconds(delay))
1299
1743
                    time = datetime.datetime.now()
1300
1744
                    client.changedstate.acquire()
1301
 
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
 
1745
                    client.changedstate.wait(
 
1746
                        float(timedelta_to_milliseconds(delay)
 
1747
                              / 1000))
1302
1748
                    client.changedstate.release()
1303
1749
                    time2 = datetime.datetime.now()
1304
1750
                    if (time2 - time) >= delay:
1320
1766
                    try:
1321
1767
                        sent = session.send(client.secret[sent_size:])
1322
1768
                    except gnutls.errors.GNUTLSError as error:
1323
 
                        logger.warning("gnutls send failed")
 
1769
                        logger.warning("gnutls send failed",
 
1770
                                       exc_info=error)
1324
1771
                        return
1325
1772
                    logger.debug("Sent: %d, remaining: %d",
1326
1773
                                 sent, len(client.secret)
1327
1774
                                 - (sent_size + sent))
1328
1775
                    sent_size += sent
1329
 
 
 
1776
                
1330
1777
                logger.info("Sending secret to %s", client.name)
1331
 
                # bump the timeout as if seen
1332
 
                client.checked_ok()
 
1778
                # bump the timeout using extended_timeout
 
1779
                client.bump_timeout(client.extended_timeout)
1333
1780
                if self.server.use_dbus:
1334
1781
                    # Emit D-Bus signal
1335
1782
                    client.GotSecret()
1340
1787
                try:
1341
1788
                    session.bye()
1342
1789
                except gnutls.errors.GNUTLSError as error:
1343
 
                    logger.warning("GnuTLS bye failed")
 
1790
                    logger.warning("GnuTLS bye failed",
 
1791
                                   exc_info=error)
1344
1792
    
1345
1793
    @staticmethod
1346
1794
    def peer_certificate(session):
1402
1850
        # Convert the buffer to a Python bytestring
1403
1851
        fpr = ctypes.string_at(buf, buf_len.value)
1404
1852
        # Convert the bytestring to hexadecimal notation
1405
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
1853
        hex_fpr = binascii.hexlify(fpr).upper()
1406
1854
        return hex_fpr
1407
1855
 
1408
1856
 
1411
1859
    def sub_process_main(self, request, address):
1412
1860
        try:
1413
1861
            self.finish_request(request, address)
1414
 
        except:
 
1862
        except Exception:
1415
1863
            self.handle_error(request, address)
1416
1864
        self.close_request(request)
1417
 
            
 
1865
    
1418
1866
    def process_request(self, request, address):
1419
1867
        """Start a new process to process the request."""
1420
 
        multiprocessing.Process(target = self.sub_process_main,
1421
 
                                args = (request, address)).start()
 
1868
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1869
                                       args = (request, address))
 
1870
        proc.start()
 
1871
        return proc
 
1872
 
1422
1873
 
1423
1874
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1424
1875
    """ adds a pipe to the MixIn """
1428
1879
        This function creates a new pipe in self.pipe
1429
1880
        """
1430
1881
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1431
 
 
1432
 
        super(MultiprocessingMixInWithPipe,
1433
 
              self).process_request(request, client_address)
 
1882
        
 
1883
        proc = MultiprocessingMixIn.process_request(self, request,
 
1884
                                                    client_address)
1434
1885
        self.child_pipe.close()
1435
 
        self.add_pipe(parent_pipe)
1436
 
 
1437
 
    def add_pipe(self, parent_pipe):
 
1886
        self.add_pipe(parent_pipe, proc)
 
1887
    
 
1888
    def add_pipe(self, parent_pipe, proc):
1438
1889
        """Dummy function; override as necessary"""
1439
1890
        raise NotImplementedError
1440
1891
 
 
1892
 
1441
1893
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1442
1894
                     socketserver.TCPServer, object):
1443
1895
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
1448
1900
        use_ipv6:       Boolean; to use IPv6 or not
1449
1901
    """
1450
1902
    def __init__(self, server_address, RequestHandlerClass,
1451
 
                 interface=None, use_ipv6=True):
 
1903
                 interface=None, use_ipv6=True, socketfd=None):
 
1904
        """If socketfd is set, use that file descriptor instead of
 
1905
        creating a new one with socket.socket().
 
1906
        """
1452
1907
        self.interface = interface
1453
1908
        if use_ipv6:
1454
1909
            self.address_family = socket.AF_INET6
 
1910
        if socketfd is not None:
 
1911
            # Save the file descriptor
 
1912
            self.socketfd = socketfd
 
1913
            # Save the original socket.socket() function
 
1914
            self.socket_socket = socket.socket
 
1915
            # To implement --socket, we monkey patch socket.socket.
 
1916
            # 
 
1917
            # (When socketserver.TCPServer is a new-style class, we
 
1918
            # could make self.socket into a property instead of monkey
 
1919
            # patching socket.socket.)
 
1920
            # 
 
1921
            # Create a one-time-only replacement for socket.socket()
 
1922
            @functools.wraps(socket.socket)
 
1923
            def socket_wrapper(*args, **kwargs):
 
1924
                # Restore original function so subsequent calls are
 
1925
                # not affected.
 
1926
                socket.socket = self.socket_socket
 
1927
                del self.socket_socket
 
1928
                # This time only, return a new socket object from the
 
1929
                # saved file descriptor.
 
1930
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
1931
            # Replace socket.socket() function with wrapper
 
1932
            socket.socket = socket_wrapper
 
1933
        # The socketserver.TCPServer.__init__ will call
 
1934
        # socket.socket(), which might be our replacement,
 
1935
        # socket_wrapper(), if socketfd was set.
1455
1936
        socketserver.TCPServer.__init__(self, server_address,
1456
1937
                                        RequestHandlerClass)
 
1938
    
1457
1939
    def server_bind(self):
1458
1940
        """This overrides the normal server_bind() function
1459
1941
        to bind to an interface if one was specified, and also NOT to
1467
1949
                try:
1468
1950
                    self.socket.setsockopt(socket.SOL_SOCKET,
1469
1951
                                           SO_BINDTODEVICE,
1470
 
                                           str(self.interface
1471
 
                                               + '\0'))
 
1952
                                           str(self.interface + '\0'))
1472
1953
                except socket.error as error:
1473
 
                    if error[0] == errno.EPERM:
1474
 
                        logger.error("No permission to"
1475
 
                                     " bind to interface %s",
1476
 
                                     self.interface)
1477
 
                    elif error[0] == errno.ENOPROTOOPT:
 
1954
                    if error.errno == errno.EPERM:
 
1955
                        logger.error("No permission to bind to"
 
1956
                                     " interface %s", self.interface)
 
1957
                    elif error.errno == errno.ENOPROTOOPT:
1478
1958
                        logger.error("SO_BINDTODEVICE not available;"
1479
1959
                                     " cannot bind to interface %s",
1480
1960
                                     self.interface)
 
1961
                    elif error.errno == errno.ENODEV:
 
1962
                        logger.error("Interface %s does not exist,"
 
1963
                                     " cannot bind", self.interface)
1481
1964
                    else:
1482
1965
                        raise
1483
1966
        # Only bind(2) the socket if we really need to.
1513
1996
    """
1514
1997
    def __init__(self, server_address, RequestHandlerClass,
1515
1998
                 interface=None, use_ipv6=True, clients=None,
1516
 
                 gnutls_priority=None, use_dbus=True):
 
1999
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1517
2000
        self.enabled = False
1518
2001
        self.clients = clients
1519
2002
        if self.clients is None:
1520
 
            self.clients = set()
 
2003
            self.clients = {}
1521
2004
        self.use_dbus = use_dbus
1522
2005
        self.gnutls_priority = gnutls_priority
1523
2006
        IPv6_TCPServer.__init__(self, server_address,
1524
2007
                                RequestHandlerClass,
1525
2008
                                interface = interface,
1526
 
                                use_ipv6 = use_ipv6)
 
2009
                                use_ipv6 = use_ipv6,
 
2010
                                socketfd = socketfd)
1527
2011
    def server_activate(self):
1528
2012
        if self.enabled:
1529
2013
            return socketserver.TCPServer.server_activate(self)
 
2014
    
1530
2015
    def enable(self):
1531
2016
        self.enabled = True
1532
 
    def add_pipe(self, parent_pipe):
 
2017
    
 
2018
    def add_pipe(self, parent_pipe, proc):
1533
2019
        # Call "handle_ipc" for both data and EOF events
1534
2020
        gobject.io_add_watch(parent_pipe.fileno(),
1535
2021
                             gobject.IO_IN | gobject.IO_HUP,
1536
2022
                             functools.partial(self.handle_ipc,
1537
 
                                               parent_pipe = parent_pipe))
1538
 
        
 
2023
                                               parent_pipe =
 
2024
                                               parent_pipe,
 
2025
                                               proc = proc))
 
2026
    
1539
2027
    def handle_ipc(self, source, condition, parent_pipe=None,
1540
 
                   client_object=None):
1541
 
        condition_names = {
1542
 
            gobject.IO_IN: "IN",   # There is data to read.
1543
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1544
 
                                    # blocking).
1545
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1546
 
            gobject.IO_ERR: "ERR", # Error condition.
1547
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1548
 
                                    # broken, usually for pipes and
1549
 
                                    # sockets).
1550
 
            }
1551
 
        conditions_string = ' | '.join(name
1552
 
                                       for cond, name in
1553
 
                                       condition_names.iteritems()
1554
 
                                       if cond & condition)
1555
 
        # error or the other end of multiprocessing.Pipe has closed
1556
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2028
                   proc = None, client_object=None):
 
2029
        # error, or the other end of multiprocessing.Pipe has closed
 
2030
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
2031
            # Wait for other process to exit
 
2032
            proc.join()
1557
2033
            return False
1558
2034
        
1559
2035
        # Read a request from the child
1564
2040
            fpr = request[1]
1565
2041
            address = request[2]
1566
2042
            
1567
 
            for c in self.clients:
 
2043
            for c in self.clients.itervalues():
1568
2044
                if c.fingerprint == fpr:
1569
2045
                    client = c
1570
2046
                    break
1573
2049
                            "dress: %s", fpr, address)
1574
2050
                if self.use_dbus:
1575
2051
                    # Emit D-Bus signal
1576
 
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
 
2052
                    mandos_dbus_service.ClientNotFound(fpr,
 
2053
                                                       address[0])
1577
2054
                parent_pipe.send(False)
1578
2055
                return False
1579
2056
            
1580
2057
            gobject.io_add_watch(parent_pipe.fileno(),
1581
2058
                                 gobject.IO_IN | gobject.IO_HUP,
1582
2059
                                 functools.partial(self.handle_ipc,
1583
 
                                                   parent_pipe = parent_pipe,
1584
 
                                                   client_object = client))
 
2060
                                                   parent_pipe =
 
2061
                                                   parent_pipe,
 
2062
                                                   proc = proc,
 
2063
                                                   client_object =
 
2064
                                                   client))
1585
2065
            parent_pipe.send(True)
1586
 
            # remove the old hook in favor of the new above hook on same fileno
 
2066
            # remove the old hook in favor of the new above hook on
 
2067
            # same fileno
1587
2068
            return False
1588
2069
        if command == 'funcall':
1589
2070
            funcname = request[1]
1590
2071
            args = request[2]
1591
2072
            kwargs = request[3]
1592
2073
            
1593
 
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
1594
 
 
 
2074
            parent_pipe.send(('data', getattr(client_object,
 
2075
                                              funcname)(*args,
 
2076
                                                         **kwargs)))
 
2077
        
1595
2078
        if command == 'getattr':
1596
2079
            attrname = request[1]
1597
2080
            if callable(client_object.__getattribute__(attrname)):
1598
2081
                parent_pipe.send(('function',))
1599
2082
            else:
1600
 
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
 
2083
                parent_pipe.send(('data', client_object
 
2084
                                  .__getattribute__(attrname)))
1601
2085
        
1602
2086
        if command == 'setattr':
1603
2087
            attrname = request[1]
1604
2088
            value = request[2]
1605
2089
            setattr(client_object, attrname, value)
1606
 
 
 
2090
        
1607
2091
        return True
1608
2092
 
1609
2093
 
 
2094
def rfc3339_duration_to_delta(duration):
 
2095
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2096
    
 
2097
    >>> rfc3339_duration_to_delta("P7D")
 
2098
    datetime.timedelta(7)
 
2099
    >>> rfc3339_duration_to_delta("PT60S")
 
2100
    datetime.timedelta(0, 60)
 
2101
    >>> rfc3339_duration_to_delta("PT60M")
 
2102
    datetime.timedelta(0, 3600)
 
2103
    >>> rfc3339_duration_to_delta("PT24H")
 
2104
    datetime.timedelta(1)
 
2105
    >>> rfc3339_duration_to_delta("P1W")
 
2106
    datetime.timedelta(7)
 
2107
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2108
    datetime.timedelta(0, 330)
 
2109
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2110
    datetime.timedelta(1, 200)
 
2111
    """
 
2112
    
 
2113
    # Parsing an RFC 3339 duration with regular expressions is not
 
2114
    # possible - there would have to be multiple places for the same
 
2115
    # values, like seconds.  The current code, while more esoteric, is
 
2116
    # cleaner without depending on a parsing library.  If Python had a
 
2117
    # built-in library for parsing we would use it, but we'd like to
 
2118
    # avoid excessive use of external libraries.
 
2119
    
 
2120
    # New type for defining tokens, syntax, and semantics all-in-one
 
2121
    Token = collections.namedtuple("Token",
 
2122
                                   ("regexp", # To match token; if
 
2123
                                              # "value" is not None,
 
2124
                                              # must have a "group"
 
2125
                                              # containing digits
 
2126
                                    "value",  # datetime.timedelta or
 
2127
                                              # None
 
2128
                                    "followers")) # Tokens valid after
 
2129
                                                  # this token
 
2130
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2131
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2132
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2133
    token_second = Token(re.compile(r"(\d+)S"),
 
2134
                         datetime.timedelta(seconds=1),
 
2135
                         frozenset((token_end,)))
 
2136
    token_minute = Token(re.compile(r"(\d+)M"),
 
2137
                         datetime.timedelta(minutes=1),
 
2138
                         frozenset((token_second, token_end)))
 
2139
    token_hour = Token(re.compile(r"(\d+)H"),
 
2140
                       datetime.timedelta(hours=1),
 
2141
                       frozenset((token_minute, token_end)))
 
2142
    token_time = Token(re.compile(r"T"),
 
2143
                       None,
 
2144
                       frozenset((token_hour, token_minute,
 
2145
                                  token_second)))
 
2146
    token_day = Token(re.compile(r"(\d+)D"),
 
2147
                      datetime.timedelta(days=1),
 
2148
                      frozenset((token_time, token_end)))
 
2149
    token_month = Token(re.compile(r"(\d+)M"),
 
2150
                        datetime.timedelta(weeks=4),
 
2151
                        frozenset((token_day, token_end)))
 
2152
    token_year = Token(re.compile(r"(\d+)Y"),
 
2153
                       datetime.timedelta(weeks=52),
 
2154
                       frozenset((token_month, token_end)))
 
2155
    token_week = Token(re.compile(r"(\d+)W"),
 
2156
                       datetime.timedelta(weeks=1),
 
2157
                       frozenset((token_end,)))
 
2158
    token_duration = Token(re.compile(r"P"), None,
 
2159
                           frozenset((token_year, token_month,
 
2160
                                      token_day, token_time,
 
2161
                                      token_week))),
 
2162
    # Define starting values
 
2163
    value = datetime.timedelta() # Value so far
 
2164
    found_token = None
 
2165
    followers = frozenset(token_duration,) # Following valid tokens
 
2166
    s = duration                # String left to parse
 
2167
    # Loop until end token is found
 
2168
    while found_token is not token_end:
 
2169
        # Search for any currently valid tokens
 
2170
        for token in followers:
 
2171
            match = token.regexp.match(s)
 
2172
            if match is not None:
 
2173
                # Token found
 
2174
                if token.value is not None:
 
2175
                    # Value found, parse digits
 
2176
                    factor = int(match.group(1), 10)
 
2177
                    # Add to value so far
 
2178
                    value += factor * token.value
 
2179
                # Strip token from string
 
2180
                s = token.regexp.sub("", s, 1)
 
2181
                # Go to found token
 
2182
                found_token = token
 
2183
                # Set valid next tokens
 
2184
                followers = found_token.followers
 
2185
                break
 
2186
        else:
 
2187
            # No currently valid tokens were found
 
2188
            raise ValueError("Invalid RFC 3339 duration")
 
2189
    # End token found
 
2190
    return value
 
2191
 
 
2192
 
1610
2193
def string_to_delta(interval):
1611
2194
    """Parse a string and return a datetime.timedelta
1612
2195
    
1623
2206
    >>> string_to_delta('5m 30s')
1624
2207
    datetime.timedelta(0, 330)
1625
2208
    """
 
2209
    
 
2210
    try:
 
2211
        return rfc3339_duration_to_delta(interval)
 
2212
    except ValueError:
 
2213
        pass
 
2214
    
1626
2215
    timevalue = datetime.timedelta(0)
1627
2216
    for s in interval.split():
1628
2217
        try:
1639
2228
            elif suffix == "w":
1640
2229
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1641
2230
            else:
1642
 
                raise ValueError("Unknown suffix %r" % suffix)
 
2231
                raise ValueError("Unknown suffix {0!r}"
 
2232
                                 .format(suffix))
1643
2233
        except (ValueError, IndexError) as e:
1644
2234
            raise ValueError(*(e.args))
1645
2235
        timevalue += delta
1646
2236
    return timevalue
1647
2237
 
1648
2238
 
1649
 
def if_nametoindex(interface):
1650
 
    """Call the C function if_nametoindex(), or equivalent
1651
 
    
1652
 
    Note: This function cannot accept a unicode string."""
1653
 
    global if_nametoindex
1654
 
    try:
1655
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1656
 
                          (ctypes.util.find_library("c"))
1657
 
                          .if_nametoindex)
1658
 
    except (OSError, AttributeError):
1659
 
        logger.warning("Doing if_nametoindex the hard way")
1660
 
        def if_nametoindex(interface):
1661
 
            "Get an interface index the hard way, i.e. using fcntl()"
1662
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1663
 
            with contextlib.closing(socket.socket()) as s:
1664
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1665
 
                                    struct.pack(str("16s16x"),
1666
 
                                                interface))
1667
 
            interface_index = struct.unpack(str("I"),
1668
 
                                            ifreq[16:20])[0]
1669
 
            return interface_index
1670
 
    return if_nametoindex(interface)
1671
 
 
1672
 
 
1673
2239
def daemon(nochdir = False, noclose = False):
1674
2240
    """See daemon(3).  Standard BSD Unix function.
1675
2241
    
1683
2249
        sys.exit()
1684
2250
    if not noclose:
1685
2251
        # Close all standard open file descriptors
1686
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2252
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1687
2253
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1688
2254
            raise OSError(errno.ENODEV,
1689
 
                          "%s not a character device"
1690
 
                          % os.path.devnull)
 
2255
                          "{0} not a character device"
 
2256
                          .format(os.devnull))
1691
2257
        os.dup2(null, sys.stdin.fileno())
1692
2258
        os.dup2(null, sys.stdout.fileno())
1693
2259
        os.dup2(null, sys.stderr.fileno())
1702
2268
    
1703
2269
    parser = argparse.ArgumentParser()
1704
2270
    parser.add_argument("-v", "--version", action="version",
1705
 
                        version = "%%(prog)s %s" % version,
 
2271
                        version = "%(prog)s {0}".format(version),
1706
2272
                        help="show version number and exit")
1707
2273
    parser.add_argument("-i", "--interface", metavar="IF",
1708
2274
                        help="Bind to interface IF")
1730
2296
                        " system bus interface")
1731
2297
    parser.add_argument("--no-ipv6", action="store_false",
1732
2298
                        dest="use_ipv6", help="Do not use IPv6")
 
2299
    parser.add_argument("--no-restore", action="store_false",
 
2300
                        dest="restore", help="Do not restore stored"
 
2301
                        " state")
 
2302
    parser.add_argument("--socket", type=int,
 
2303
                        help="Specify a file descriptor to a network"
 
2304
                        " socket to use instead of creating one")
 
2305
    parser.add_argument("--statedir", metavar="DIR",
 
2306
                        help="Directory to save/restore state in")
 
2307
    parser.add_argument("--foreground", action="store_true",
 
2308
                        help="Run in foreground")
 
2309
    
1733
2310
    options = parser.parse_args()
1734
2311
    
1735
2312
    if options.check:
1748
2325
                        "use_dbus": "True",
1749
2326
                        "use_ipv6": "True",
1750
2327
                        "debuglevel": "",
 
2328
                        "restore": "True",
 
2329
                        "socket": "",
 
2330
                        "statedir": "/var/lib/mandos",
 
2331
                        "foreground": "False",
1751
2332
                        }
1752
2333
    
1753
2334
    # Parse config file for server-global settings
1758
2339
    # Convert the SafeConfigParser object to a dict
1759
2340
    server_settings = server_config.defaults()
1760
2341
    # Use the appropriate methods on the non-string config options
1761
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2342
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
1762
2343
        server_settings[option] = server_config.getboolean("DEFAULT",
1763
2344
                                                           option)
1764
2345
    if server_settings["port"]:
1765
2346
        server_settings["port"] = server_config.getint("DEFAULT",
1766
2347
                                                       "port")
 
2348
    if server_settings["socket"]:
 
2349
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2350
                                                         "socket")
 
2351
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2352
        # over with an opened os.devnull.  But we don't want this to
 
2353
        # happen with a supplied network socket.
 
2354
        if 0 <= server_settings["socket"] <= 2:
 
2355
            server_settings["socket"] = os.dup(server_settings
 
2356
                                               ["socket"])
1767
2357
    del server_config
1768
2358
    
1769
2359
    # Override the settings from the config file with command line
1770
2360
    # options, if set.
1771
2361
    for option in ("interface", "address", "port", "debug",
1772
2362
                   "priority", "servicename", "configdir",
1773
 
                   "use_dbus", "use_ipv6", "debuglevel"):
 
2363
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2364
                   "statedir", "socket", "foreground"):
1774
2365
        value = getattr(options, option)
1775
2366
        if value is not None:
1776
2367
            server_settings[option] = value
1779
2370
    for option in server_settings.keys():
1780
2371
        if type(server_settings[option]) is str:
1781
2372
            server_settings[option] = unicode(server_settings[option])
 
2373
    # Debug implies foreground
 
2374
    if server_settings["debug"]:
 
2375
        server_settings["foreground"] = True
1782
2376
    # Now we have our good server settings in "server_settings"
1783
2377
    
1784
2378
    ##################################################################
1788
2382
    debuglevel = server_settings["debuglevel"]
1789
2383
    use_dbus = server_settings["use_dbus"]
1790
2384
    use_ipv6 = server_settings["use_ipv6"]
1791
 
 
 
2385
    stored_state_path = os.path.join(server_settings["statedir"],
 
2386
                                     stored_state_file)
 
2387
    foreground = server_settings["foreground"]
 
2388
    
 
2389
    if debug:
 
2390
        initlogger(debug, logging.DEBUG)
 
2391
    else:
 
2392
        if not debuglevel:
 
2393
            initlogger(debug)
 
2394
        else:
 
2395
            level = getattr(logging, debuglevel.upper())
 
2396
            initlogger(debug, level)
 
2397
    
1792
2398
    if server_settings["servicename"] != "Mandos":
1793
2399
        syslogger.setFormatter(logging.Formatter
1794
 
                               ('Mandos (%s) [%%(process)d]:'
1795
 
                                ' %%(levelname)s: %%(message)s'
1796
 
                                % server_settings["servicename"]))
 
2400
                               ('Mandos ({0}) [%(process)d]:'
 
2401
                                ' %(levelname)s: %(message)s'
 
2402
                                .format(server_settings
 
2403
                                        ["servicename"])))
1797
2404
    
1798
2405
    # Parse config file with clients
1799
 
    client_defaults = { "timeout": "1h",
1800
 
                        "interval": "5m",
1801
 
                        "checker": "fping -q -- %%(host)s",
1802
 
                        "host": "",
1803
 
                        "approval_delay": "0s",
1804
 
                        "approval_duration": "1s",
1805
 
                        }
1806
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2406
    client_config = configparser.SafeConfigParser(Client
 
2407
                                                  .client_defaults)
1807
2408
    client_config.read(os.path.join(server_settings["configdir"],
1808
2409
                                    "clients.conf"))
1809
2410
    
1818
2419
                              use_ipv6=use_ipv6,
1819
2420
                              gnutls_priority=
1820
2421
                              server_settings["priority"],
1821
 
                              use_dbus=use_dbus)
1822
 
    if not debug:
 
2422
                              use_dbus=use_dbus,
 
2423
                              socketfd=(server_settings["socket"]
 
2424
                                        or None))
 
2425
    if not foreground:
1823
2426
        pidfilename = "/var/run/mandos.pid"
 
2427
        pidfile = None
1824
2428
        try:
1825
2429
            pidfile = open(pidfilename, "w")
1826
 
        except IOError:
1827
 
            logger.error("Could not open file %r", pidfilename)
 
2430
        except IOError as e:
 
2431
            logger.error("Could not open file %r", pidfilename,
 
2432
                         exc_info=e)
1828
2433
    
1829
 
    try:
1830
 
        uid = pwd.getpwnam("_mandos").pw_uid
1831
 
        gid = pwd.getpwnam("_mandos").pw_gid
1832
 
    except KeyError:
 
2434
    for name in ("_mandos", "mandos", "nobody"):
1833
2435
        try:
1834
 
            uid = pwd.getpwnam("mandos").pw_uid
1835
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2436
            uid = pwd.getpwnam(name).pw_uid
 
2437
            gid = pwd.getpwnam(name).pw_gid
 
2438
            break
1836
2439
        except KeyError:
1837
 
            try:
1838
 
                uid = pwd.getpwnam("nobody").pw_uid
1839
 
                gid = pwd.getpwnam("nobody").pw_gid
1840
 
            except KeyError:
1841
 
                uid = 65534
1842
 
                gid = 65534
 
2440
            continue
 
2441
    else:
 
2442
        uid = 65534
 
2443
        gid = 65534
1843
2444
    try:
1844
2445
        os.setgid(gid)
1845
2446
        os.setuid(uid)
1846
2447
    except OSError as error:
1847
 
        if error[0] != errno.EPERM:
 
2448
        if error.errno != errno.EPERM:
1848
2449
            raise error
1849
2450
    
1850
 
    if not debug and not debuglevel:
1851
 
        syslogger.setLevel(logging.WARNING)
1852
 
        console.setLevel(logging.WARNING)
1853
 
    if debuglevel:
1854
 
        level = getattr(logging, debuglevel.upper())
1855
 
        syslogger.setLevel(level)
1856
 
        console.setLevel(level)
1857
 
 
1858
2451
    if debug:
1859
2452
        # Enable all possible GnuTLS debugging
1860
2453
        
1870
2463
         .gnutls_global_set_log_function(debug_gnutls))
1871
2464
        
1872
2465
        # Redirect stdin so all checkers get /dev/null
1873
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2466
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1874
2467
        os.dup2(null, sys.stdin.fileno())
1875
2468
        if null > 2:
1876
2469
            os.close(null)
1877
 
    else:
1878
 
        # No console logging
1879
 
        logger.removeHandler(console)
1880
2470
    
1881
2471
    # Need to fork before connecting to D-Bus
1882
 
    if not debug:
 
2472
    if not foreground:
1883
2473
        # Close all input and output, do double fork, etc.
1884
2474
        daemon()
1885
2475
    
 
2476
    # multiprocessing will use threads, so before we use gobject we
 
2477
    # need to inform gobject that threads will be used.
 
2478
    gobject.threads_init()
 
2479
    
1886
2480
    global main_loop
1887
2481
    # From the Avahi example code
1888
 
    DBusGMainLoop(set_as_default=True )
 
2482
    DBusGMainLoop(set_as_default=True)
1889
2483
    main_loop = gobject.MainLoop()
1890
2484
    bus = dbus.SystemBus()
1891
2485
    # End of Avahi example code
1892
2486
    if use_dbus:
1893
2487
        try:
1894
 
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
 
2488
            bus_name = dbus.service.BusName("se.recompile.Mandos",
1895
2489
                                            bus, do_not_queue=True)
 
2490
            old_bus_name = (dbus.service.BusName
 
2491
                            ("se.bsnet.fukt.Mandos", bus,
 
2492
                             do_not_queue=True))
1896
2493
        except dbus.exceptions.NameExistsException as e:
1897
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2494
            logger.error("Disabling D-Bus:", exc_info=e)
1898
2495
            use_dbus = False
1899
2496
            server_settings["use_dbus"] = False
1900
2497
            tcp_server.use_dbus = False
1901
2498
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1902
 
    service = AvahiService(name = server_settings["servicename"],
1903
 
                           servicetype = "_mandos._tcp",
1904
 
                           protocol = protocol, bus = bus)
 
2499
    service = AvahiServiceToSyslog(name =
 
2500
                                   server_settings["servicename"],
 
2501
                                   servicetype = "_mandos._tcp",
 
2502
                                   protocol = protocol, bus = bus)
1905
2503
    if server_settings["interface"]:
1906
2504
        service.interface = (if_nametoindex
1907
2505
                             (str(server_settings["interface"])))
1912
2510
    client_class = Client
1913
2511
    if use_dbus:
1914
2512
        client_class = functools.partial(ClientDBus, bus = bus)
1915
 
    def client_config_items(config, section):
1916
 
        special_settings = {
1917
 
            "approved_by_default":
1918
 
                lambda: config.getboolean(section,
1919
 
                                          "approved_by_default"),
1920
 
            }
1921
 
        for name, value in config.items(section):
 
2513
    
 
2514
    client_settings = Client.config_parser(client_config)
 
2515
    old_client_settings = {}
 
2516
    clients_data = {}
 
2517
    
 
2518
    # Get client data and settings from last running state.
 
2519
    if server_settings["restore"]:
 
2520
        try:
 
2521
            with open(stored_state_path, "rb") as stored_state:
 
2522
                clients_data, old_client_settings = (pickle.load
 
2523
                                                     (stored_state))
 
2524
            os.remove(stored_state_path)
 
2525
        except IOError as e:
 
2526
            if e.errno == errno.ENOENT:
 
2527
                logger.warning("Could not load persistent state: {0}"
 
2528
                                .format(os.strerror(e.errno)))
 
2529
            else:
 
2530
                logger.critical("Could not load persistent state:",
 
2531
                                exc_info=e)
 
2532
                raise
 
2533
        except EOFError as e:
 
2534
            logger.warning("Could not load persistent state: "
 
2535
                           "EOFError:", exc_info=e)
 
2536
    
 
2537
    with PGPEngine() as pgp:
 
2538
        for client_name, client in clients_data.iteritems():
 
2539
            # Decide which value to use after restoring saved state.
 
2540
            # We have three different values: Old config file,
 
2541
            # new config file, and saved state.
 
2542
            # New config value takes precedence if it differs from old
 
2543
            # config value, otherwise use saved state.
 
2544
            for name, value in client_settings[client_name].items():
 
2545
                try:
 
2546
                    # For each value in new config, check if it
 
2547
                    # differs from the old config value (Except for
 
2548
                    # the "secret" attribute)
 
2549
                    if (name != "secret" and
 
2550
                        value != old_client_settings[client_name]
 
2551
                        [name]):
 
2552
                        client[name] = value
 
2553
                except KeyError:
 
2554
                    pass
 
2555
            
 
2556
            # Clients who has passed its expire date can still be
 
2557
            # enabled if its last checker was successful.  Clients
 
2558
            # whose checker succeeded before we stored its state is
 
2559
            # assumed to have successfully run all checkers during
 
2560
            # downtime.
 
2561
            if client["enabled"]:
 
2562
                if datetime.datetime.utcnow() >= client["expires"]:
 
2563
                    if not client["last_checked_ok"]:
 
2564
                        logger.warning(
 
2565
                            "disabling client {0} - Client never "
 
2566
                            "performed a successful checker"
 
2567
                            .format(client_name))
 
2568
                        client["enabled"] = False
 
2569
                    elif client["last_checker_status"] != 0:
 
2570
                        logger.warning(
 
2571
                            "disabling client {0} - Client "
 
2572
                            "last checker failed with error code {1}"
 
2573
                            .format(client_name,
 
2574
                                    client["last_checker_status"]))
 
2575
                        client["enabled"] = False
 
2576
                    else:
 
2577
                        client["expires"] = (datetime.datetime
 
2578
                                             .utcnow()
 
2579
                                             + client["timeout"])
 
2580
                        logger.debug("Last checker succeeded,"
 
2581
                                     " keeping {0} enabled"
 
2582
                                     .format(client_name))
1922
2583
            try:
1923
 
                yield (name, special_settings[name]())
1924
 
            except KeyError:
1925
 
                yield (name, value)
1926
 
    
1927
 
    tcp_server.clients.update(set(
1928
 
            client_class(name = section,
1929
 
                         config= dict(client_config_items(
1930
 
                        client_config, section)))
1931
 
            for section in client_config.sections()))
 
2584
                client["secret"] = (
 
2585
                    pgp.decrypt(client["encrypted_secret"],
 
2586
                                client_settings[client_name]
 
2587
                                ["secret"]))
 
2588
            except PGPError:
 
2589
                # If decryption fails, we use secret from new settings
 
2590
                logger.debug("Failed to decrypt {0} old secret"
 
2591
                             .format(client_name))
 
2592
                client["secret"] = (
 
2593
                    client_settings[client_name]["secret"])
 
2594
    
 
2595
    # Add/remove clients based on new changes made to config
 
2596
    for client_name in (set(old_client_settings)
 
2597
                        - set(client_settings)):
 
2598
        del clients_data[client_name]
 
2599
    for client_name in (set(client_settings)
 
2600
                        - set(old_client_settings)):
 
2601
        clients_data[client_name] = client_settings[client_name]
 
2602
    
 
2603
    # Create all client objects
 
2604
    for client_name, client in clients_data.iteritems():
 
2605
        tcp_server.clients[client_name] = client_class(
 
2606
            name = client_name, settings = client)
 
2607
    
1932
2608
    if not tcp_server.clients:
1933
2609
        logger.warning("No clients defined")
1934
 
        
1935
 
    if not debug:
1936
 
        try:
1937
 
            with pidfile:
1938
 
                pid = os.getpid()
1939
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
1940
 
            del pidfile
1941
 
        except IOError:
1942
 
            logger.error("Could not write to file %r with PID %d",
1943
 
                         pidfilename, pid)
1944
 
        except NameError:
1945
 
            # "pidfile" was never created
1946
 
            pass
 
2610
    
 
2611
    if not foreground:
 
2612
        if pidfile is not None:
 
2613
            try:
 
2614
                with pidfile:
 
2615
                    pid = os.getpid()
 
2616
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2617
            except IOError:
 
2618
                logger.error("Could not write to file %r with PID %d",
 
2619
                             pidfilename, pid)
 
2620
        del pidfile
1947
2621
        del pidfilename
1948
 
        
1949
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
1950
 
 
 
2622
    
1951
2623
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1952
2624
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1953
2625
    
1954
2626
    if use_dbus:
1955
 
        class MandosDBusService(dbus.service.Object):
 
2627
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2628
                                        "se.bsnet.fukt.Mandos"})
 
2629
        class MandosDBusService(DBusObjectWithProperties):
1956
2630
            """A D-Bus proxy object"""
1957
2631
            def __init__(self):
1958
2632
                dbus.service.Object.__init__(self, bus, "/")
1959
 
            _interface = "se.bsnet.fukt.Mandos"
 
2633
            _interface = "se.recompile.Mandos"
 
2634
            
 
2635
            @dbus_interface_annotations(_interface)
 
2636
            def _foo(self):
 
2637
                return { "org.freedesktop.DBus.Property"
 
2638
                         ".EmitsChangedSignal":
 
2639
                             "false"}
1960
2640
            
1961
2641
            @dbus.service.signal(_interface, signature="o")
1962
2642
            def ClientAdded(self, objpath):
1977
2657
            def GetAllClients(self):
1978
2658
                "D-Bus method"
1979
2659
                return dbus.Array(c.dbus_object_path
1980
 
                                  for c in tcp_server.clients)
 
2660
                                  for c in
 
2661
                                  tcp_server.clients.itervalues())
1981
2662
            
1982
2663
            @dbus.service.method(_interface,
1983
2664
                                 out_signature="a{oa{sv}}")
1985
2666
                "D-Bus method"
1986
2667
                return dbus.Dictionary(
1987
2668
                    ((c.dbus_object_path, c.GetAll(""))
1988
 
                     for c in tcp_server.clients),
 
2669
                     for c in tcp_server.clients.itervalues()),
1989
2670
                    signature="oa{sv}")
1990
2671
            
1991
2672
            @dbus.service.method(_interface, in_signature="o")
1992
2673
            def RemoveClient(self, object_path):
1993
2674
                "D-Bus method"
1994
 
                for c in tcp_server.clients:
 
2675
                for c in tcp_server.clients.itervalues():
1995
2676
                    if c.dbus_object_path == object_path:
1996
 
                        tcp_server.clients.remove(c)
 
2677
                        del tcp_server.clients[c.name]
1997
2678
                        c.remove_from_connection()
1998
2679
                        # Don't signal anything except ClientRemoved
1999
2680
                        c.disable(quiet=True)
2010
2691
        "Cleanup function; run on exit"
2011
2692
        service.cleanup()
2012
2693
        
 
2694
        multiprocessing.active_children()
 
2695
        if not (tcp_server.clients or client_settings):
 
2696
            return
 
2697
        
 
2698
        # Store client before exiting. Secrets are encrypted with key
 
2699
        # based on what config file has. If config file is
 
2700
        # removed/edited, old secret will thus be unrecovable.
 
2701
        clients = {}
 
2702
        with PGPEngine() as pgp:
 
2703
            for client in tcp_server.clients.itervalues():
 
2704
                key = client_settings[client.name]["secret"]
 
2705
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2706
                                                      key)
 
2707
                client_dict = {}
 
2708
                
 
2709
                # A list of attributes that can not be pickled
 
2710
                # + secret.
 
2711
                exclude = set(("bus", "changedstate", "secret",
 
2712
                               "checker"))
 
2713
                for name, typ in (inspect.getmembers
 
2714
                                  (dbus.service.Object)):
 
2715
                    exclude.add(name)
 
2716
                
 
2717
                client_dict["encrypted_secret"] = (client
 
2718
                                                   .encrypted_secret)
 
2719
                for attr in client.client_structure:
 
2720
                    if attr not in exclude:
 
2721
                        client_dict[attr] = getattr(client, attr)
 
2722
                
 
2723
                clients[client.name] = client_dict
 
2724
                del client_settings[client.name]["secret"]
 
2725
        
 
2726
        try:
 
2727
            with (tempfile.NamedTemporaryFile
 
2728
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2729
                   dir=os.path.dirname(stored_state_path),
 
2730
                   delete=False)) as stored_state:
 
2731
                pickle.dump((clients, client_settings), stored_state)
 
2732
                tempname=stored_state.name
 
2733
            os.rename(tempname, stored_state_path)
 
2734
        except (IOError, OSError) as e:
 
2735
            if not debug:
 
2736
                try:
 
2737
                    os.remove(tempname)
 
2738
                except NameError:
 
2739
                    pass
 
2740
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2741
                logger.warning("Could not save persistent state: {0}"
 
2742
                               .format(os.strerror(e.errno)))
 
2743
            else:
 
2744
                logger.warning("Could not save persistent state:",
 
2745
                               exc_info=e)
 
2746
                raise e
 
2747
        
 
2748
        # Delete all clients, and settings from config
2013
2749
        while tcp_server.clients:
2014
 
            client = tcp_server.clients.pop()
 
2750
            name, client = tcp_server.clients.popitem()
2015
2751
            if use_dbus:
2016
2752
                client.remove_from_connection()
2017
 
            client.disable_hook = None
2018
2753
            # Don't signal anything except ClientRemoved
2019
2754
            client.disable(quiet=True)
2020
2755
            if use_dbus:
2021
2756
                # Emit D-Bus signal
2022
 
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
 
2757
                mandos_dbus_service.ClientRemoved(client
 
2758
                                                  .dbus_object_path,
2023
2759
                                                  client.name)
 
2760
        client_settings.clear()
2024
2761
    
2025
2762
    atexit.register(cleanup)
2026
2763
    
2027
 
    for client in tcp_server.clients:
 
2764
    for client in tcp_server.clients.itervalues():
2028
2765
        if use_dbus:
2029
2766
            # Emit D-Bus signal
2030
2767
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2031
 
        client.enable()
 
2768
        # Need to initiate checking of clients
 
2769
        if client.enabled:
 
2770
            client.init_checker()
2032
2771
    
2033
2772
    tcp_server.enable()
2034
2773
    tcp_server.server_activate()
2037
2776
    service.port = tcp_server.socket.getsockname()[1]
2038
2777
    if use_ipv6:
2039
2778
        logger.info("Now listening on address %r, port %d,"
2040
 
                    " flowinfo %d, scope_id %d"
2041
 
                    % tcp_server.socket.getsockname())
 
2779
                    " flowinfo %d, scope_id %d",
 
2780
                    *tcp_server.socket.getsockname())
2042
2781
    else:                       # IPv4
2043
 
        logger.info("Now listening on address %r, port %d"
2044
 
                    % tcp_server.socket.getsockname())
 
2782
        logger.info("Now listening on address %r, port %d",
 
2783
                    *tcp_server.socket.getsockname())
2045
2784
    
2046
2785
    #service.interface = tcp_server.socket.getsockname()[3]
2047
2786
    
2050
2789
        try:
2051
2790
            service.activate()
2052
2791
        except dbus.exceptions.DBusException as error:
2053
 
            logger.critical("DBusException: %s", error)
 
2792
            logger.critical("D-Bus Exception", exc_info=error)
2054
2793
            cleanup()
2055
2794
            sys.exit(1)
2056
2795
        # End of Avahi example code
2063
2802
        logger.debug("Starting main loop")
2064
2803
        main_loop.run()
2065
2804
    except AvahiError as error:
2066
 
        logger.critical("AvahiError: %s", error)
 
2805
        logger.critical("Avahi Error", exc_info=error)
2067
2806
        cleanup()
2068
2807
        sys.exit(1)
2069
2808
    except KeyboardInterrupt: