/mandos/release

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

« back to all changes in this revision

Viewing changes to mandos

* mandos: Use all new builtins.
* mandos-ctl: - '' -
* mandos-monitor: - '' -

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
63
65
import cPickle as pickle
64
66
import multiprocessing
65
67
import types
 
68
import binascii
 
69
import tempfile
 
70
import itertools
66
71
 
67
72
import dbus
68
73
import dbus.service
73
78
import ctypes.util
74
79
import xml.dom.minidom
75
80
import inspect
 
81
import GnuPGInterface
76
82
 
77
83
try:
78
84
    SO_BINDTODEVICE = socket.SO_BINDTODEVICE
82
88
    except ImportError:
83
89
        SO_BINDTODEVICE = None
84
90
 
85
 
 
86
 
version = "1.3.1"
87
 
 
88
 
#logger = logging.getLogger('mandos')
89
 
logger = logging.Logger('mandos')
 
91
version = "1.5.3"
 
92
stored_state_file = "clients.pickle"
 
93
 
 
94
logger = logging.getLogger()
90
95
syslogger = (logging.handlers.SysLogHandler
91
96
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
92
97
              address = str("/dev/log")))
93
 
syslogger.setFormatter(logging.Formatter
94
 
                       ('Mandos [%(process)d]: %(levelname)s:'
95
 
                        ' %(message)s'))
96
 
logger.addHandler(syslogger)
97
 
 
98
 
console = logging.StreamHandler()
99
 
console.setFormatter(logging.Formatter('%(name)s [%(process)d]:'
100
 
                                       ' %(levelname)s:'
101
 
                                       ' %(message)s'))
102
 
logger.addHandler(console)
 
98
 
 
99
try:
 
100
    if_nametoindex = (ctypes.cdll.LoadLibrary
 
101
                      (ctypes.util.find_library("c"))
 
102
                      .if_nametoindex)
 
103
except (OSError, AttributeError):
 
104
    def if_nametoindex(interface):
 
105
        "Get an interface index the hard way, i.e. using fcntl()"
 
106
        SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
 
107
        with contextlib.closing(socket.socket()) as s:
 
108
            ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
 
109
                                struct.pack(str("16s16x"),
 
110
                                            interface))
 
111
        interface_index = struct.unpack(str("I"),
 
112
                                        ifreq[16:20])[0]
 
113
        return interface_index
 
114
 
 
115
 
 
116
def initlogger(debug, level=logging.WARNING):
 
117
    """init logger and add loglevel"""
 
118
    
 
119
    syslogger.setFormatter(logging.Formatter
 
120
                           ('Mandos [%(process)d]: %(levelname)s:'
 
121
                            ' %(message)s'))
 
122
    logger.addHandler(syslogger)
 
123
    
 
124
    if debug:
 
125
        console = logging.StreamHandler()
 
126
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
127
                                               ' [%(process)d]:'
 
128
                                               ' %(levelname)s:'
 
129
                                               ' %(message)s'))
 
130
        logger.addHandler(console)
 
131
    logger.setLevel(level)
 
132
 
 
133
 
 
134
class PGPError(Exception):
 
135
    """Exception if encryption/decryption fails"""
 
136
    pass
 
137
 
 
138
 
 
139
class PGPEngine(object):
 
140
    """A simple class for OpenPGP symmetric encryption & decryption"""
 
141
    def __init__(self):
 
142
        self.gnupg = GnuPGInterface.GnuPG()
 
143
        self.tempdir = tempfile.mkdtemp(prefix="mandos-")
 
144
        self.gnupg = GnuPGInterface.GnuPG()
 
145
        self.gnupg.options.meta_interactive = False
 
146
        self.gnupg.options.homedir = self.tempdir
 
147
        self.gnupg.options.extra_args.extend(['--force-mdc',
 
148
                                              '--quiet',
 
149
                                              '--no-use-agent'])
 
150
    
 
151
    def __enter__(self):
 
152
        return self
 
153
    
 
154
    def __exit__ (self, exc_type, exc_value, traceback):
 
155
        self._cleanup()
 
156
        return False
 
157
    
 
158
    def __del__(self):
 
159
        self._cleanup()
 
160
    
 
161
    def _cleanup(self):
 
162
        if self.tempdir is not None:
 
163
            # Delete contents of tempdir
 
164
            for root, dirs, files in os.walk(self.tempdir,
 
165
                                             topdown = False):
 
166
                for filename in files:
 
167
                    os.remove(os.path.join(root, filename))
 
168
                for dirname in dirs:
 
169
                    os.rmdir(os.path.join(root, dirname))
 
170
            # Remove tempdir
 
171
            os.rmdir(self.tempdir)
 
172
            self.tempdir = None
 
173
    
 
174
    def password_encode(self, password):
 
175
        # Passphrase can not be empty and can not contain newlines or
 
176
        # NUL bytes.  So we prefix it and hex encode it.
 
177
        return b"mandos" + binascii.hexlify(password)
 
178
    
 
179
    def encrypt(self, data, password):
 
180
        self.gnupg.passphrase = self.password_encode(password)
 
181
        with open(os.devnull, "w") as devnull:
 
182
            try:
 
183
                proc = self.gnupg.run(['--symmetric'],
 
184
                                      create_fhs=['stdin', 'stdout'],
 
185
                                      attach_fhs={'stderr': devnull})
 
186
                with contextlib.closing(proc.handles['stdin']) as f:
 
187
                    f.write(data)
 
188
                with contextlib.closing(proc.handles['stdout']) as f:
 
189
                    ciphertext = f.read()
 
190
                proc.wait()
 
191
            except IOError as e:
 
192
                raise PGPError(e)
 
193
        self.gnupg.passphrase = None
 
194
        return ciphertext
 
195
    
 
196
    def decrypt(self, data, password):
 
197
        self.gnupg.passphrase = self.password_encode(password)
 
198
        with open(os.devnull, "w") as devnull:
 
199
            try:
 
200
                proc = self.gnupg.run(['--decrypt'],
 
201
                                      create_fhs=['stdin', 'stdout'],
 
202
                                      attach_fhs={'stderr': devnull})
 
203
                with contextlib.closing(proc.handles['stdin']) as f:
 
204
                    f.write(data)
 
205
                with contextlib.closing(proc.handles['stdout']) as f:
 
206
                    decrypted_plaintext = f.read()
 
207
                proc.wait()
 
208
            except IOError as e:
 
209
                raise PGPError(e)
 
210
        self.gnupg.passphrase = None
 
211
        return decrypted_plaintext
 
212
 
103
213
 
104
214
class AvahiError(Exception):
105
215
    def __init__(self, value, *args, **kwargs):
135
245
    server: D-Bus Server
136
246
    bus: dbus.SystemBus()
137
247
    """
 
248
    
138
249
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
139
250
                 servicetype = None, port = None, TXT = None,
140
251
                 domain = "", host = "", max_renames = 32768,
153
264
        self.server = None
154
265
        self.bus = bus
155
266
        self.entry_group_state_changed_match = None
 
267
    
156
268
    def rename(self):
157
269
        """Derived from the Avahi example code"""
158
270
        if self.rename_count >= self.max_renames:
160
272
                            " after %i retries, exiting.",
161
273
                            self.rename_count)
162
274
            raise AvahiServiceError("Too many renames")
163
 
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
 
275
        self.name = unicode(self.server
 
276
                            .GetAlternativeServiceName(self.name))
164
277
        logger.info("Changing Zeroconf service name to %r ...",
165
278
                    self.name)
166
 
        syslogger.setFormatter(logging.Formatter
167
 
                               ('Mandos (%s) [%%(process)d]:'
168
 
                                ' %%(levelname)s: %%(message)s'
169
 
                                % self.name))
170
279
        self.remove()
171
280
        try:
172
281
            self.add()
173
282
        except dbus.exceptions.DBusException as error:
174
 
            logger.critical("DBusException: %s", error)
 
283
            logger.critical("D-Bus Exception", exc_info=error)
175
284
            self.cleanup()
176
285
            os._exit(1)
177
286
        self.rename_count += 1
 
287
    
178
288
    def remove(self):
179
289
        """Derived from the Avahi example code"""
180
290
        if self.entry_group_state_changed_match is not None:
182
292
            self.entry_group_state_changed_match = None
183
293
        if self.group is not None:
184
294
            self.group.Reset()
 
295
    
185
296
    def add(self):
186
297
        """Derived from the Avahi example code"""
187
298
        self.remove()
192
303
                avahi.DBUS_INTERFACE_ENTRY_GROUP)
193
304
        self.entry_group_state_changed_match = (
194
305
            self.group.connect_to_signal(
195
 
                'StateChanged', self .entry_group_state_changed))
 
306
                'StateChanged', self.entry_group_state_changed))
196
307
        logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
197
308
                     self.name, self.type)
198
309
        self.group.AddService(
204
315
            dbus.UInt16(self.port),
205
316
            avahi.string_array_to_txt_array(self.TXT))
206
317
        self.group.Commit()
 
318
    
207
319
    def entry_group_state_changed(self, state, error):
208
320
        """Derived from the Avahi example code"""
209
321
        logger.debug("Avahi entry group state change: %i", state)
216
328
        elif state == avahi.ENTRY_GROUP_FAILURE:
217
329
            logger.critical("Avahi: Error in group state changed %s",
218
330
                            unicode(error))
219
 
            raise AvahiGroupError("State changed: %s"
220
 
                                  % unicode(error))
 
331
            raise AvahiGroupError("State changed: {0!s}"
 
332
                                  .format(error))
 
333
    
221
334
    def cleanup(self):
222
335
        """Derived from the Avahi example code"""
223
336
        if self.group is not None:
224
337
            try:
225
338
                self.group.Free()
226
339
            except (dbus.exceptions.UnknownMethodException,
227
 
                    dbus.exceptions.DBusException) as e:
 
340
                    dbus.exceptions.DBusException):
228
341
                pass
229
342
            self.group = None
230
343
        self.remove()
 
344
    
231
345
    def server_state_changed(self, state, error=None):
232
346
        """Derived from the Avahi example code"""
233
347
        logger.debug("Avahi server state change: %i", state)
252
366
                logger.debug("Unknown state: %r", state)
253
367
            else:
254
368
                logger.debug("Unknown state: %r: %r", state, error)
 
369
    
255
370
    def activate(self):
256
371
        """Derived from the Avahi example code"""
257
372
        if self.server is None:
264
379
                                 self.server_state_changed)
265
380
        self.server_state_changed(self.server.GetState())
266
381
 
 
382
class AvahiServiceToSyslog(AvahiService):
 
383
    def rename(self):
 
384
        """Add the new name to the syslog messages"""
 
385
        ret = AvahiService.rename(self)
 
386
        syslogger.setFormatter(logging.Formatter
 
387
                               ('Mandos ({0}) [%(process)d]:'
 
388
                                ' %(levelname)s: %(message)s'
 
389
                                .format(self.name)))
 
390
        return ret
267
391
 
268
 
def _timedelta_to_milliseconds(td):
 
392
def timedelta_to_milliseconds(td):
269
393
    "Convert a datetime.timedelta() to milliseconds"
270
394
    return ((td.days * 24 * 60 * 60 * 1000)
271
395
            + (td.seconds * 1000)
272
396
            + (td.microseconds // 1000))
273
 
        
 
397
 
274
398
class Client(object):
275
399
    """A representation of a client host served by this server.
276
400
    
277
401
    Attributes:
278
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
402
    approved:   bool(); 'None' if not yet approved/disapproved
279
403
    approval_delay: datetime.timedelta(); Time to wait for approval
280
404
    approval_duration: datetime.timedelta(); Duration of one approval
281
405
    checker:    subprocess.Popen(); a running checker process used
288
412
                     instance %(name)s can be used in the command.
289
413
    checker_initiator_tag: a gobject event source tag, or None
290
414
    created:    datetime.datetime(); (UTC) object creation
 
415
    client_structure: Object describing what attributes a client has
 
416
                      and is used for storing the client at exit
291
417
    current_checker_command: string; current running checker_command
292
 
    disable_hook:  If set, called by disable() as disable_hook(self)
293
418
    disable_initiator_tag: a gobject event source tag, or None
294
419
    enabled:    bool()
295
420
    fingerprint: string (40 or 32 hexadecimal digits); used to
298
423
    interval:   datetime.timedelta(); How often to start a new checker
299
424
    last_approval_request: datetime.datetime(); (UTC) or None
300
425
    last_checked_ok: datetime.datetime(); (UTC) or None
301
 
    last_enabled: datetime.datetime(); (UTC)
 
426
    last_checker_status: integer between 0 and 255 reflecting exit
 
427
                         status of last checker. -1 reflects crashed
 
428
                         checker, -2 means no checker completed yet.
 
429
    last_enabled: datetime.datetime(); (UTC) or None
302
430
    name:       string; from the config file, used in log messages and
303
431
                        D-Bus identifiers
304
432
    secret:     bytestring; sent verbatim (over TLS) to client
305
433
    timeout:    datetime.timedelta(); How long from last_checked_ok
306
434
                                      until this client is disabled
307
 
    extended_timeout:   extra long timeout when password has been sent
 
435
    extended_timeout:   extra long timeout when secret has been sent
308
436
    runtime_expansions: Allowed attributes for runtime expansion.
309
437
    expires:    datetime.datetime(); time (UTC) when a client will be
310
438
                disabled, or None
314
442
                          "created", "enabled", "fingerprint",
315
443
                          "host", "interval", "last_checked_ok",
316
444
                          "last_enabled", "name", "timeout")
 
445
    client_defaults = { "timeout": "5m",
 
446
                        "extended_timeout": "15m",
 
447
                        "interval": "2m",
 
448
                        "checker": "fping -q -- %%(host)s",
 
449
                        "host": "",
 
450
                        "approval_delay": "0s",
 
451
                        "approval_duration": "1s",
 
452
                        "approved_by_default": "True",
 
453
                        "enabled": "True",
 
454
                        }
317
455
    
318
456
    def timeout_milliseconds(self):
319
457
        "Return the 'timeout' attribute in milliseconds"
320
 
        return _timedelta_to_milliseconds(self.timeout)
 
458
        return timedelta_to_milliseconds(self.timeout)
321
459
    
322
460
    def extended_timeout_milliseconds(self):
323
461
        "Return the 'extended_timeout' attribute in milliseconds"
324
 
        return _timedelta_to_milliseconds(self.extended_timeout)    
 
462
        return timedelta_to_milliseconds(self.extended_timeout)
325
463
    
326
464
    def interval_milliseconds(self):
327
465
        "Return the 'interval' attribute in milliseconds"
328
 
        return _timedelta_to_milliseconds(self.interval)
 
466
        return timedelta_to_milliseconds(self.interval)
329
467
    
330
468
    def approval_delay_milliseconds(self):
331
 
        return _timedelta_to_milliseconds(self.approval_delay)
332
 
    
333
 
    def __init__(self, name = None, disable_hook=None, config=None):
334
 
        """Note: the 'checker' key in 'config' sets the
335
 
        'checker_command' attribute and *not* the 'checker'
336
 
        attribute."""
 
469
        return timedelta_to_milliseconds(self.approval_delay)
 
470
    
 
471
    @staticmethod
 
472
    def config_parser(config):
 
473
        """Construct a new dict of client settings of this form:
 
474
        { client_name: {setting_name: value, ...}, ...}
 
475
        with exceptions for any special settings as defined above.
 
476
        NOTE: Must be a pure function. Must return the same result
 
477
        value given the same arguments.
 
478
        """
 
479
        settings = {}
 
480
        for client_name in config.sections():
 
481
            section = dict(config.items(client_name))
 
482
            client = settings[client_name] = {}
 
483
            
 
484
            client["host"] = section["host"]
 
485
            # Reformat values from string types to Python types
 
486
            client["approved_by_default"] = config.getboolean(
 
487
                client_name, "approved_by_default")
 
488
            client["enabled"] = config.getboolean(client_name,
 
489
                                                  "enabled")
 
490
            
 
491
            client["fingerprint"] = (section["fingerprint"].upper()
 
492
                                     .replace(" ", ""))
 
493
            if "secret" in section:
 
494
                client["secret"] = section["secret"].decode("base64")
 
495
            elif "secfile" in section:
 
496
                with open(os.path.expanduser(os.path.expandvars
 
497
                                             (section["secfile"])),
 
498
                          "rb") as secfile:
 
499
                    client["secret"] = secfile.read()
 
500
            else:
 
501
                raise TypeError("No secret or secfile for section {0}"
 
502
                                .format(section))
 
503
            client["timeout"] = string_to_delta(section["timeout"])
 
504
            client["extended_timeout"] = string_to_delta(
 
505
                section["extended_timeout"])
 
506
            client["interval"] = string_to_delta(section["interval"])
 
507
            client["approval_delay"] = string_to_delta(
 
508
                section["approval_delay"])
 
509
            client["approval_duration"] = string_to_delta(
 
510
                section["approval_duration"])
 
511
            client["checker_command"] = section["checker"]
 
512
            client["last_approval_request"] = None
 
513
            client["last_checked_ok"] = None
 
514
            client["last_checker_status"] = -2
 
515
        
 
516
        return settings
 
517
    
 
518
    def __init__(self, settings, name = None):
337
519
        self.name = name
338
 
        if config is None:
339
 
            config = {}
 
520
        # adding all client settings
 
521
        for setting, value in settings.iteritems():
 
522
            setattr(self, setting, value)
 
523
        
 
524
        if self.enabled:
 
525
            if not hasattr(self, "last_enabled"):
 
526
                self.last_enabled = datetime.datetime.utcnow()
 
527
            if not hasattr(self, "expires"):
 
528
                self.expires = (datetime.datetime.utcnow()
 
529
                                + self.timeout)
 
530
        else:
 
531
            self.last_enabled = None
 
532
            self.expires = None
 
533
        
340
534
        logger.debug("Creating client %r", self.name)
341
535
        # Uppercase and remove spaces from fingerprint for later
342
536
        # comparison purposes with return value from the fingerprint()
343
537
        # function
344
 
        self.fingerprint = (config["fingerprint"].upper()
345
 
                            .replace(" ", ""))
346
538
        logger.debug("  Fingerprint: %s", self.fingerprint)
347
 
        if "secret" in config:
348
 
            self.secret = config["secret"].decode("base64")
349
 
        elif "secfile" in config:
350
 
            with open(os.path.expanduser(os.path.expandvars
351
 
                                         (config["secfile"])),
352
 
                      "rb") as secfile:
353
 
                self.secret = secfile.read()
354
 
        else:
355
 
            raise TypeError("No secret or secfile for client %s"
356
 
                            % self.name)
357
 
        self.host = config.get("host", "")
358
 
        self.created = datetime.datetime.utcnow()
359
 
        self.enabled = False
360
 
        self.last_approval_request = None
361
 
        self.last_enabled = None
362
 
        self.last_checked_ok = None
363
 
        self.timeout = string_to_delta(config["timeout"])
364
 
        self.extended_timeout = string_to_delta(config["extended_timeout"])
365
 
        self.interval = string_to_delta(config["interval"])
366
 
        self.disable_hook = disable_hook
 
539
        self.created = settings.get("created",
 
540
                                    datetime.datetime.utcnow())
 
541
        
 
542
        # attributes specific for this server instance
367
543
        self.checker = None
368
544
        self.checker_initiator_tag = None
369
545
        self.disable_initiator_tag = None
370
 
        self.expires = None
371
546
        self.checker_callback_tag = None
372
 
        self.checker_command = config["checker"]
373
547
        self.current_checker_command = None
374
 
        self.last_connect = None
375
 
        self._approved = None
376
 
        self.approved_by_default = config.get("approved_by_default",
377
 
                                              True)
 
548
        self.approved = None
378
549
        self.approvals_pending = 0
379
 
        self.approval_delay = string_to_delta(
380
 
            config["approval_delay"])
381
 
        self.approval_duration = string_to_delta(
382
 
            config["approval_duration"])
383
 
        self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
 
550
        self.changedstate = (multiprocessing_manager
 
551
                             .Condition(multiprocessing_manager
 
552
                                        .Lock()))
 
553
        self.client_structure = [attr for attr in
 
554
                                 self.__dict__.iterkeys()
 
555
                                 if not attr.startswith("_")]
 
556
        self.client_structure.append("client_structure")
 
557
        
 
558
        for name, t in inspect.getmembers(type(self),
 
559
                                          lambda obj:
 
560
                                              isinstance(obj,
 
561
                                                         property)):
 
562
            if not name.startswith("_"):
 
563
                self.client_structure.append(name)
384
564
    
 
565
    # Send notice to process children that client state has changed
385
566
    def send_changedstate(self):
386
 
        self.changedstate.acquire()
387
 
        self.changedstate.notify_all()
388
 
        self.changedstate.release()
389
 
        
 
567
        with self.changedstate:
 
568
            self.changedstate.notify_all()
 
569
    
390
570
    def enable(self):
391
571
        """Start this client's checker and timeout hooks"""
392
572
        if getattr(self, "enabled", False):
393
573
            # Already enabled
394
574
            return
395
575
        self.send_changedstate()
396
 
        # Schedule a new checker to be started an 'interval' from now,
397
 
        # and every interval from then on.
398
 
        self.checker_initiator_tag = (gobject.timeout_add
399
 
                                      (self.interval_milliseconds(),
400
 
                                       self.start_checker))
401
 
        # Schedule a disable() when 'timeout' has passed
402
576
        self.expires = datetime.datetime.utcnow() + self.timeout
403
 
        self.disable_initiator_tag = (gobject.timeout_add
404
 
                                   (self.timeout_milliseconds(),
405
 
                                    self.disable))
406
577
        self.enabled = True
407
578
        self.last_enabled = datetime.datetime.utcnow()
408
 
        # Also start a new checker *right now*.
409
 
        self.start_checker()
 
579
        self.init_checker()
410
580
    
411
581
    def disable(self, quiet=True):
412
582
        """Disable this client."""
424
594
            gobject.source_remove(self.checker_initiator_tag)
425
595
            self.checker_initiator_tag = None
426
596
        self.stop_checker()
427
 
        if self.disable_hook:
428
 
            self.disable_hook(self)
429
597
        self.enabled = False
430
598
        # Do not run this again if called by a gobject.timeout_add
431
599
        return False
432
600
    
433
601
    def __del__(self):
434
 
        self.disable_hook = None
435
602
        self.disable()
436
603
    
 
604
    def init_checker(self):
 
605
        # Schedule a new checker to be started an 'interval' from now,
 
606
        # and every interval from then on.
 
607
        self.checker_initiator_tag = (gobject.timeout_add
 
608
                                      (self.interval_milliseconds(),
 
609
                                       self.start_checker))
 
610
        # Schedule a disable() when 'timeout' has passed
 
611
        self.disable_initiator_tag = (gobject.timeout_add
 
612
                                   (self.timeout_milliseconds(),
 
613
                                    self.disable))
 
614
        # Also start a new checker *right now*.
 
615
        self.start_checker()
 
616
    
437
617
    def checker_callback(self, pid, condition, command):
438
618
        """The checker has completed, so take appropriate actions."""
439
619
        self.checker_callback_tag = None
440
620
        self.checker = None
441
621
        if os.WIFEXITED(condition):
442
 
            exitstatus = os.WEXITSTATUS(condition)
443
 
            if exitstatus == 0:
 
622
            self.last_checker_status = os.WEXITSTATUS(condition)
 
623
            if self.last_checker_status == 0:
444
624
                logger.info("Checker for %(name)s succeeded",
445
625
                            vars(self))
446
626
                self.checked_ok()
448
628
                logger.info("Checker for %(name)s failed",
449
629
                            vars(self))
450
630
        else:
 
631
            self.last_checker_status = -1
451
632
            logger.warning("Checker for %(name)s crashed?",
452
633
                           vars(self))
453
634
    
454
 
    def checked_ok(self, timeout=None):
455
 
        """Bump up the timeout for this client.
456
 
        
457
 
        This should only be called when the client has been seen,
458
 
        alive and well.
459
 
        """
 
635
    def checked_ok(self):
 
636
        """Assert that the client has been seen, alive and well."""
 
637
        self.last_checked_ok = datetime.datetime.utcnow()
 
638
        self.last_checker_status = 0
 
639
        self.bump_timeout()
 
640
    
 
641
    def bump_timeout(self, timeout=None):
 
642
        """Bump up the timeout for this client."""
460
643
        if timeout is None:
461
644
            timeout = self.timeout
462
 
        self.last_checked_ok = datetime.datetime.utcnow()
463
 
        gobject.source_remove(self.disable_initiator_tag)
464
 
        self.expires = datetime.datetime.utcnow() + timeout
465
 
        self.disable_initiator_tag = (gobject.timeout_add
466
 
                                      (_timedelta_to_milliseconds(timeout),
467
 
                                       self.disable))
 
645
        if self.disable_initiator_tag is not None:
 
646
            gobject.source_remove(self.disable_initiator_tag)
 
647
        if getattr(self, "enabled", False):
 
648
            self.disable_initiator_tag = (gobject.timeout_add
 
649
                                          (timedelta_to_milliseconds
 
650
                                           (timeout), self.disable))
 
651
            self.expires = datetime.datetime.utcnow() + timeout
468
652
    
469
653
    def need_approval(self):
470
654
        self.last_approval_request = datetime.datetime.utcnow()
475
659
        If a checker already exists, leave it running and do
476
660
        nothing."""
477
661
        # The reason for not killing a running checker is that if we
478
 
        # did that, then if a checker (for some reason) started
479
 
        # running slowly and taking more than 'interval' time, the
480
 
        # client would inevitably timeout, since no checker would get
481
 
        # a chance to run to completion.  If we instead leave running
 
662
        # did that, and if a checker (for some reason) started running
 
663
        # slowly and taking more than 'interval' time, then the client
 
664
        # would inevitably timeout, since no checker would get a
 
665
        # chance to run to completion.  If we instead leave running
482
666
        # checkers alone, the checker would have to take more time
483
667
        # than 'timeout' for the client to be disabled, which is as it
484
668
        # should be.
514
698
                try:
515
699
                    command = self.checker_command % escaped_attrs
516
700
                except TypeError as error:
517
 
                    logger.error('Could not format string "%s":'
518
 
                                 ' %s', self.checker_command, error)
 
701
                    logger.error('Could not format string "%s"',
 
702
                                 self.checker_command, exc_info=error)
519
703
                    return True # Try again later
520
704
            self.current_checker_command = command
521
705
            try:
539
723
                    gobject.source_remove(self.checker_callback_tag)
540
724
                    self.checker_callback(pid, status, command)
541
725
            except OSError as error:
542
 
                logger.error("Failed to start subprocess: %s",
543
 
                             error)
 
726
                logger.error("Failed to start subprocess",
 
727
                             exc_info=error)
544
728
        # Re-run this periodically if run by gobject.timeout_add
545
729
        return True
546
730
    
553
737
            return
554
738
        logger.debug("Stopping checker for %(name)s", vars(self))
555
739
        try:
556
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
740
            self.checker.terminate()
557
741
            #time.sleep(0.5)
558
742
            #if self.checker.poll() is None:
559
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
743
            #    self.checker.kill()
560
744
        except OSError as error:
561
745
            if error.errno != errno.ESRCH: # No such process
562
746
                raise
579
763
    # "Set" method, so we fail early here:
580
764
    if byte_arrays and signature != "ay":
581
765
        raise ValueError("Byte arrays not supported for non-'ay'"
582
 
                         " signature %r" % signature)
 
766
                         " signature {0!r}".format(signature))
583
767
    def decorator(func):
584
768
        func._dbus_is_property = True
585
769
        func._dbus_interface = dbus_interface
593
777
    return decorator
594
778
 
595
779
 
 
780
def dbus_interface_annotations(dbus_interface):
 
781
    """Decorator for marking functions returning interface annotations
 
782
    
 
783
    Usage:
 
784
    
 
785
    @dbus_interface_annotations("org.example.Interface")
 
786
    def _foo(self):  # Function name does not matter
 
787
        return {"org.freedesktop.DBus.Deprecated": "true",
 
788
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
789
                    "false"}
 
790
    """
 
791
    def decorator(func):
 
792
        func._dbus_is_interface = True
 
793
        func._dbus_interface = dbus_interface
 
794
        func._dbus_name = dbus_interface
 
795
        return func
 
796
    return decorator
 
797
 
 
798
 
 
799
def dbus_annotations(annotations):
 
800
    """Decorator to annotate D-Bus methods, signals or properties
 
801
    Usage:
 
802
    
 
803
    @dbus_service_property("org.example.Interface", signature="b",
 
804
                           access="r")
 
805
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
 
806
                        "org.freedesktop.DBus.Property."
 
807
                        "EmitsChangedSignal": "false"})
 
808
    def Property_dbus_property(self):
 
809
        return dbus.Boolean(False)
 
810
    """
 
811
    def decorator(func):
 
812
        func._dbus_annotations = annotations
 
813
        return func
 
814
    return decorator
 
815
 
 
816
 
596
817
class DBusPropertyException(dbus.exceptions.DBusException):
597
818
    """A base class for D-Bus property-related exceptions
598
819
    """
621
842
    """
622
843
    
623
844
    @staticmethod
624
 
    def _is_dbus_property(obj):
625
 
        return getattr(obj, "_dbus_is_property", False)
 
845
    def _is_dbus_thing(thing):
 
846
        """Returns a function testing if an attribute is a D-Bus thing
 
847
        
 
848
        If called like _is_dbus_thing("method") it returns a function
 
849
        suitable for use as predicate to inspect.getmembers().
 
850
        """
 
851
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
 
852
                                   False)
626
853
    
627
 
    def _get_all_dbus_properties(self):
 
854
    def _get_all_dbus_things(self, thing):
628
855
        """Returns a generator of (name, attribute) pairs
629
856
        """
630
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
857
        return ((getattr(athing.__get__(self), "_dbus_name",
 
858
                         name),
 
859
                 athing.__get__(self))
631
860
                for cls in self.__class__.__mro__
632
 
                for name, prop in inspect.getmembers(cls, self._is_dbus_property))
 
861
                for name, athing in
 
862
                inspect.getmembers(cls,
 
863
                                   self._is_dbus_thing(thing)))
633
864
    
634
865
    def _get_dbus_property(self, interface_name, property_name):
635
866
        """Returns a bound method if one exists which is a D-Bus
636
867
        property with the specified name and interface.
637
868
        """
638
869
        for cls in  self.__class__.__mro__:
639
 
            for name, value in inspect.getmembers(cls, self._is_dbus_property):
640
 
                if value._dbus_name == property_name and value._dbus_interface == interface_name:
 
870
            for name, value in (inspect.getmembers
 
871
                                (cls,
 
872
                                 self._is_dbus_thing("property"))):
 
873
                if (value._dbus_name == property_name
 
874
                    and value._dbus_interface == interface_name):
641
875
                    return value.__get__(self)
642
876
        
643
877
        # No such property
644
878
        raise DBusPropertyNotFound(self.dbus_object_path + ":"
645
879
                                   + interface_name + "."
646
880
                                   + property_name)
647
 
 
648
881
    
649
882
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
650
883
                         out_signature="v")
671
904
            # signatures other than "ay".
672
905
            if prop._dbus_signature != "ay":
673
906
                raise ValueError
674
 
            value = dbus.ByteArray(''.join(unichr(byte)
675
 
                                           for byte in value))
 
907
            value = dbus.ByteArray(b''.join(chr(byte)
 
908
                                            for byte in value))
676
909
        prop(value)
677
910
    
678
911
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
683
916
        
684
917
        Note: Will not include properties with access="write".
685
918
        """
686
 
        all = {}
687
 
        for name, prop in self._get_all_dbus_properties():
 
919
        properties = {}
 
920
        for name, prop in self._get_all_dbus_things("property"):
688
921
            if (interface_name
689
922
                and interface_name != prop._dbus_interface):
690
923
                # Interface non-empty but did not match
694
927
                continue
695
928
            value = prop()
696
929
            if not hasattr(value, "variant_level"):
697
 
                all[name] = value
 
930
                properties[name] = value
698
931
                continue
699
 
            all[name] = type(value)(value, variant_level=
700
 
                                    value.variant_level+1)
701
 
        return dbus.Dictionary(all, signature="sv")
 
932
            properties[name] = type(value)(value, variant_level=
 
933
                                           value.variant_level+1)
 
934
        return dbus.Dictionary(properties, signature="sv")
702
935
    
703
936
    @dbus.service.method(dbus.INTROSPECTABLE_IFACE,
704
937
                         out_signature="s",
705
938
                         path_keyword='object_path',
706
939
                         connection_keyword='connection')
707
940
    def Introspect(self, object_path, connection):
708
 
        """Standard D-Bus method, overloaded to insert property tags.
 
941
        """Overloading of standard D-Bus method.
 
942
        
 
943
        Inserts property tags and interface annotation tags.
709
944
        """
710
945
        xmlstring = dbus.service.Object.Introspect(self, object_path,
711
946
                                                   connection)
718
953
                e.setAttribute("access", prop._dbus_access)
719
954
                return e
720
955
            for if_tag in document.getElementsByTagName("interface"):
 
956
                # Add property tags
721
957
                for tag in (make_tag(document, name, prop)
722
958
                            for name, prop
723
 
                            in self._get_all_dbus_properties()
 
959
                            in self._get_all_dbus_things("property")
724
960
                            if prop._dbus_interface
725
961
                            == if_tag.getAttribute("name")):
726
962
                    if_tag.appendChild(tag)
 
963
                # Add annotation tags
 
964
                for typ in ("method", "signal", "property"):
 
965
                    for tag in if_tag.getElementsByTagName(typ):
 
966
                        annots = dict()
 
967
                        for name, prop in (self.
 
968
                                           _get_all_dbus_things(typ)):
 
969
                            if (name == tag.getAttribute("name")
 
970
                                and prop._dbus_interface
 
971
                                == if_tag.getAttribute("name")):
 
972
                                annots.update(getattr
 
973
                                              (prop,
 
974
                                               "_dbus_annotations",
 
975
                                               {}))
 
976
                        for name, value in annots.iteritems():
 
977
                            ann_tag = document.createElement(
 
978
                                "annotation")
 
979
                            ann_tag.setAttribute("name", name)
 
980
                            ann_tag.setAttribute("value", value)
 
981
                            tag.appendChild(ann_tag)
 
982
                # Add interface annotation tags
 
983
                for annotation, value in dict(
 
984
                    itertools.chain.from_iterable(
 
985
                        annotations().iteritems()
 
986
                        for name, annotations in
 
987
                        self._get_all_dbus_things("interface")
 
988
                        if name == if_tag.getAttribute("name")
 
989
                        )).iteritems():
 
990
                    ann_tag = document.createElement("annotation")
 
991
                    ann_tag.setAttribute("name", annotation)
 
992
                    ann_tag.setAttribute("value", value)
 
993
                    if_tag.appendChild(ann_tag)
727
994
                # Add the names to the return values for the
728
995
                # "org.freedesktop.DBus.Properties" methods
729
996
                if (if_tag.getAttribute("name")
744
1011
        except (AttributeError, xml.dom.DOMException,
745
1012
                xml.parsers.expat.ExpatError) as error:
746
1013
            logger.error("Failed to override Introspection method",
747
 
                         error)
 
1014
                         exc_info=error)
748
1015
        return xmlstring
749
1016
 
750
1017
 
755
1022
    return dbus.String(dt.isoformat(),
756
1023
                       variant_level=variant_level)
757
1024
 
758
 
class transitional_dbus_metaclass(DBusObjectWithProperties.__metaclass__):
759
 
    def __new__(mcs, name, bases, attr):
760
 
        for attrname, old_dbusobj in inspect.getmembers(bases[0]):
761
 
            new_interface = getattr(old_dbusobj, "_dbus_interface", "").replace("se.bsnet.fukt.", "se.recompile.")
762
 
            if (getattr(old_dbusobj, "_dbus_is_signal", False)
763
 
                and old_dbusobj._dbus_interface.startswith("se.bsnet.fukt.Mandos")):
764
 
                unwrappedfunc = dict(zip(old_dbusobj.func_code.co_freevars,
765
 
                                    old_dbusobj.__closure__))["func"].cell_contents
766
 
                newfunc = types.FunctionType(unwrappedfunc.func_code,
767
 
                                             unwrappedfunc.func_globals,
768
 
                                             unwrappedfunc.func_name,
769
 
                                             unwrappedfunc.func_defaults,
770
 
                                             unwrappedfunc.func_closure)
771
 
                new_dbusfunc = dbus.service.signal(
772
 
                    new_interface, old_dbusobj._dbus_signature)(newfunc)            
773
 
                attr["_transitional_" + attrname] = new_dbusfunc
774
 
 
775
 
                def fixscope(func1, func2):
776
 
                    def newcall(*args, **kwargs):
777
 
                        func1(*args, **kwargs)
778
 
                        func2(*args, **kwargs)
779
 
                    return newcall
780
 
 
781
 
                attr[attrname] = fixscope(old_dbusobj, new_dbusfunc)
782
 
            
783
 
            elif (getattr(old_dbusobj, "_dbus_is_method", False)
784
 
                and old_dbusobj._dbus_interface.startswith("se.bsnet.fukt.Mandos")):
785
 
                new_dbusfunc = (dbus.service.method
786
 
                                (new_interface,
787
 
                                 old_dbusobj._dbus_in_signature,
788
 
                                 old_dbusobj._dbus_out_signature)
789
 
                                (types.FunctionType
790
 
                                 (old_dbusobj.func_code,
791
 
                                  old_dbusobj.func_globals,
792
 
                                  old_dbusobj.func_name,
793
 
                                  old_dbusobj.func_defaults,
794
 
                                  old_dbusobj.func_closure)))
795
 
 
796
 
                attr[attrname] = new_dbusfunc
797
 
            elif (getattr(old_dbusobj, "_dbus_is_property", False)
798
 
                  and old_dbusobj._dbus_interface.startswith("se.bsnet.fukt.Mandos")):
799
 
                new_dbusfunc = (dbus_service_property
800
 
                                (new_interface,
801
 
                                 old_dbusobj._dbus_signature,
802
 
                                 old_dbusobj._dbus_access,
803
 
                                 old_dbusobj._dbus_get_args_options["byte_arrays"])
804
 
                                (types.FunctionType
805
 
                                 (old_dbusobj.func_code,
806
 
                                  old_dbusobj.func_globals,
807
 
                                  old_dbusobj.func_name,
808
 
                                  old_dbusobj.func_defaults,
809
 
                                  old_dbusobj.func_closure)))
810
 
 
811
 
                attr[attrname] = new_dbusfunc
812
 
        return type.__new__(mcs, name, bases, attr)
813
 
 
 
1025
 
 
1026
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1027
    """A class decorator; applied to a subclass of
 
1028
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1029
    interface names according to the "alt_interface_names" mapping.
 
1030
    Usage:
 
1031
    
 
1032
    @alternate_dbus_names({"org.example.Interface":
 
1033
                               "net.example.AlternateInterface"})
 
1034
    class SampleDBusObject(dbus.service.Object):
 
1035
        @dbus.service.method("org.example.Interface")
 
1036
        def SampleDBusMethod():
 
1037
            pass
 
1038
    
 
1039
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1040
    reachable via two interfaces: "org.example.Interface" and
 
1041
    "net.example.AlternateInterface", the latter of which will have
 
1042
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1043
    "true", unless "deprecate" is passed with a False value.
 
1044
    
 
1045
    This works for methods and signals, and also for D-Bus properties
 
1046
    (from DBusObjectWithProperties) and interfaces (from the
 
1047
    dbus_interface_annotations decorator).
 
1048
    """
 
1049
    def wrapper(cls):
 
1050
        for orig_interface_name, alt_interface_name in (
 
1051
            alt_interface_names.iteritems()):
 
1052
            attr = {}
 
1053
            interface_names = set()
 
1054
            # Go though all attributes of the class
 
1055
            for attrname, attribute in inspect.getmembers(cls):
 
1056
                # Ignore non-D-Bus attributes, and D-Bus attributes
 
1057
                # with the wrong interface name
 
1058
                if (not hasattr(attribute, "_dbus_interface")
 
1059
                    or not attribute._dbus_interface
 
1060
                    .startswith(orig_interface_name)):
 
1061
                    continue
 
1062
                # Create an alternate D-Bus interface name based on
 
1063
                # the current name
 
1064
                alt_interface = (attribute._dbus_interface
 
1065
                                 .replace(orig_interface_name,
 
1066
                                          alt_interface_name))
 
1067
                interface_names.add(alt_interface)
 
1068
                # Is this a D-Bus signal?
 
1069
                if getattr(attribute, "_dbus_is_signal", False):
 
1070
                    # Extract the original non-method function by
 
1071
                    # black magic
 
1072
                    nonmethod_func = (dict(
 
1073
                            zip(attribute.func_code.co_freevars,
 
1074
                                attribute.__closure__))["func"]
 
1075
                                      .cell_contents)
 
1076
                    # Create a new, but exactly alike, function
 
1077
                    # object, and decorate it to be a new D-Bus signal
 
1078
                    # with the alternate D-Bus interface name
 
1079
                    new_function = (dbus.service.signal
 
1080
                                    (alt_interface,
 
1081
                                     attribute._dbus_signature)
 
1082
                                    (types.FunctionType(
 
1083
                                nonmethod_func.func_code,
 
1084
                                nonmethod_func.func_globals,
 
1085
                                nonmethod_func.func_name,
 
1086
                                nonmethod_func.func_defaults,
 
1087
                                nonmethod_func.func_closure)))
 
1088
                    # Copy annotations, if any
 
1089
                    try:
 
1090
                        new_function._dbus_annotations = (
 
1091
                            dict(attribute._dbus_annotations))
 
1092
                    except AttributeError:
 
1093
                        pass
 
1094
                    # Define a creator of a function to call both the
 
1095
                    # original and alternate functions, so both the
 
1096
                    # original and alternate signals gets sent when
 
1097
                    # the function is called
 
1098
                    def fixscope(func1, func2):
 
1099
                        """This function is a scope container to pass
 
1100
                        func1 and func2 to the "call_both" function
 
1101
                        outside of its arguments"""
 
1102
                        def call_both(*args, **kwargs):
 
1103
                            """This function will emit two D-Bus
 
1104
                            signals by calling func1 and func2"""
 
1105
                            func1(*args, **kwargs)
 
1106
                            func2(*args, **kwargs)
 
1107
                        return call_both
 
1108
                    # Create the "call_both" function and add it to
 
1109
                    # the class
 
1110
                    attr[attrname] = fixscope(attribute, new_function)
 
1111
                # Is this a D-Bus method?
 
1112
                elif getattr(attribute, "_dbus_is_method", False):
 
1113
                    # Create a new, but exactly alike, function
 
1114
                    # object.  Decorate it to be a new D-Bus method
 
1115
                    # with the alternate D-Bus interface name.  Add it
 
1116
                    # to the class.
 
1117
                    attr[attrname] = (dbus.service.method
 
1118
                                      (alt_interface,
 
1119
                                       attribute._dbus_in_signature,
 
1120
                                       attribute._dbus_out_signature)
 
1121
                                      (types.FunctionType
 
1122
                                       (attribute.func_code,
 
1123
                                        attribute.func_globals,
 
1124
                                        attribute.func_name,
 
1125
                                        attribute.func_defaults,
 
1126
                                        attribute.func_closure)))
 
1127
                    # Copy annotations, if any
 
1128
                    try:
 
1129
                        attr[attrname]._dbus_annotations = (
 
1130
                            dict(attribute._dbus_annotations))
 
1131
                    except AttributeError:
 
1132
                        pass
 
1133
                # Is this a D-Bus property?
 
1134
                elif getattr(attribute, "_dbus_is_property", False):
 
1135
                    # Create a new, but exactly alike, function
 
1136
                    # object, and decorate it to be a new D-Bus
 
1137
                    # property with the alternate D-Bus interface
 
1138
                    # name.  Add it to the class.
 
1139
                    attr[attrname] = (dbus_service_property
 
1140
                                      (alt_interface,
 
1141
                                       attribute._dbus_signature,
 
1142
                                       attribute._dbus_access,
 
1143
                                       attribute
 
1144
                                       ._dbus_get_args_options
 
1145
                                       ["byte_arrays"])
 
1146
                                      (types.FunctionType
 
1147
                                       (attribute.func_code,
 
1148
                                        attribute.func_globals,
 
1149
                                        attribute.func_name,
 
1150
                                        attribute.func_defaults,
 
1151
                                        attribute.func_closure)))
 
1152
                    # Copy annotations, if any
 
1153
                    try:
 
1154
                        attr[attrname]._dbus_annotations = (
 
1155
                            dict(attribute._dbus_annotations))
 
1156
                    except AttributeError:
 
1157
                        pass
 
1158
                # Is this a D-Bus interface?
 
1159
                elif getattr(attribute, "_dbus_is_interface", False):
 
1160
                    # Create a new, but exactly alike, function
 
1161
                    # object.  Decorate it to be a new D-Bus interface
 
1162
                    # with the alternate D-Bus interface name.  Add it
 
1163
                    # to the class.
 
1164
                    attr[attrname] = (dbus_interface_annotations
 
1165
                                      (alt_interface)
 
1166
                                      (types.FunctionType
 
1167
                                       (attribute.func_code,
 
1168
                                        attribute.func_globals,
 
1169
                                        attribute.func_name,
 
1170
                                        attribute.func_defaults,
 
1171
                                        attribute.func_closure)))
 
1172
            if deprecate:
 
1173
                # Deprecate all alternate interfaces
 
1174
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1175
                for interface_name in interface_names:
 
1176
                    @dbus_interface_annotations(interface_name)
 
1177
                    def func(self):
 
1178
                        return { "org.freedesktop.DBus.Deprecated":
 
1179
                                     "true" }
 
1180
                    # Find an unused name
 
1181
                    for aname in (iname.format(i)
 
1182
                                  for i in itertools.count()):
 
1183
                        if aname not in attr:
 
1184
                            attr[aname] = func
 
1185
                            break
 
1186
            if interface_names:
 
1187
                # Replace the class with a new subclass of it with
 
1188
                # methods, signals, etc. as created above.
 
1189
                cls = type(b"{0}Alternate".format(cls.__name__),
 
1190
                           (cls,), attr)
 
1191
        return cls
 
1192
    return wrapper
 
1193
 
 
1194
 
 
1195
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1196
                                "se.bsnet.fukt.Mandos"})
814
1197
class ClientDBus(Client, DBusObjectWithProperties):
815
1198
    """A Client class using D-Bus
816
1199
    
825
1208
    # dbus.service.Object doesn't use super(), so we can't either.
826
1209
    
827
1210
    def __init__(self, bus = None, *args, **kwargs):
828
 
        self._approvals_pending = 0
829
1211
        self.bus = bus
830
1212
        Client.__init__(self, *args, **kwargs)
831
1213
        # Only now, when this client is initialized, can it show up on
837
1219
                                 ("/clients/" + client_object_name))
838
1220
        DBusObjectWithProperties.__init__(self, self.bus,
839
1221
                                          self.dbus_object_path)
840
 
        
 
1222
    
841
1223
    def notifychangeproperty(transform_func,
842
1224
                             dbus_name, type_func=lambda x: x,
843
1225
                             variant_level=1):
844
 
        """ Modify a variable so that its a property that announce its
845
 
        changes to DBus.
846
 
        transform_fun: Function that takes a value and transform it to
847
 
                       DBus type.
848
 
        dbus_name: DBus name of the variable
 
1226
        """ Modify a variable so that it's a property which announces
 
1227
        its changes to DBus.
 
1228
        
 
1229
        transform_fun: Function that takes a value and a variant_level
 
1230
                       and transforms it to a D-Bus type.
 
1231
        dbus_name: D-Bus name of the variable
849
1232
        type_func: Function that transform the value before sending it
850
 
                   to DBus
851
 
        variant_level: DBus variant level. default: 1
 
1233
                   to the D-Bus.  Default: no transform
 
1234
        variant_level: D-Bus variant level.  Default: 1
852
1235
        """
853
 
        real_value = [None,]
 
1236
        attrname = "_{0}".format(dbus_name)
854
1237
        def setter(self, value):
855
 
            old_value = real_value[0]
856
 
            real_value[0] = value
857
1238
            if hasattr(self, "dbus_object_path"):
858
 
                if type_func(old_value) != type_func(real_value[0]):
859
 
                    dbus_value = transform_func(type_func(real_value[0]),
860
 
                                                variant_level)
 
1239
                if (not hasattr(self, attrname) or
 
1240
                    type_func(getattr(self, attrname, None))
 
1241
                    != type_func(value)):
 
1242
                    dbus_value = transform_func(type_func(value),
 
1243
                                                variant_level
 
1244
                                                =variant_level)
861
1245
                    self.PropertyChanged(dbus.String(dbus_name),
862
1246
                                         dbus_value)
 
1247
            setattr(self, attrname, value)
863
1248
        
864
 
        return property(lambda self: real_value[0], setter)
865
 
    
 
1249
        return property(lambda self: getattr(self, attrname), setter)
866
1250
    
867
1251
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
868
1252
    approvals_pending = notifychangeproperty(dbus.Boolean,
872
1256
    last_enabled = notifychangeproperty(datetime_to_dbus,
873
1257
                                        "LastEnabled")
874
1258
    checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
875
 
                                   type_func = lambda checker: checker is not None)
 
1259
                                   type_func = lambda checker:
 
1260
                                       checker is not None)
876
1261
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
877
1262
                                           "LastCheckedOK")
878
 
    last_approval_request = notifychangeproperty(datetime_to_dbus,
879
 
                                                 "LastApprovalRequest")
 
1263
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1264
                                               "LastCheckerStatus")
 
1265
    last_approval_request = notifychangeproperty(
 
1266
        datetime_to_dbus, "LastApprovalRequest")
880
1267
    approved_by_default = notifychangeproperty(dbus.Boolean,
881
1268
                                               "ApprovedByDefault")
882
 
    approval_delay = notifychangeproperty(dbus.UInt16, "ApprovalDelay",
883
 
                                          type_func = _timedelta_to_milliseconds)
884
 
    approval_duration = notifychangeproperty(dbus.UInt16, "ApprovalDuration",
885
 
                                             type_func = _timedelta_to_milliseconds)
 
1269
    approval_delay = notifychangeproperty(dbus.UInt64,
 
1270
                                          "ApprovalDelay",
 
1271
                                          type_func =
 
1272
                                          timedelta_to_milliseconds)
 
1273
    approval_duration = notifychangeproperty(
 
1274
        dbus.UInt64, "ApprovalDuration",
 
1275
        type_func = timedelta_to_milliseconds)
886
1276
    host = notifychangeproperty(dbus.String, "Host")
887
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
888
 
                                   type_func = _timedelta_to_milliseconds)
889
 
    extended_timeout = notifychangeproperty(dbus.UInt16, "ExtendedTimeout",
890
 
                                            type_func = _timedelta_to_milliseconds)
891
 
    interval = notifychangeproperty(dbus.UInt16, "Interval",
892
 
                                    type_func = _timedelta_to_milliseconds)
 
1277
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
1278
                                   type_func =
 
1279
                                   timedelta_to_milliseconds)
 
1280
    extended_timeout = notifychangeproperty(
 
1281
        dbus.UInt64, "ExtendedTimeout",
 
1282
        type_func = timedelta_to_milliseconds)
 
1283
    interval = notifychangeproperty(dbus.UInt64,
 
1284
                                    "Interval",
 
1285
                                    type_func =
 
1286
                                    timedelta_to_milliseconds)
893
1287
    checker_command = notifychangeproperty(dbus.String, "Checker")
894
1288
    
895
1289
    del notifychangeproperty
937
1331
        return r
938
1332
    
939
1333
    def _reset_approved(self):
940
 
        self._approved = None
 
1334
        self.approved = None
941
1335
        return False
942
1336
    
943
1337
    def approve(self, value=True):
944
1338
        self.send_changedstate()
945
 
        self._approved = value
946
 
        gobject.timeout_add(_timedelta_to_milliseconds
 
1339
        self.approved = value
 
1340
        gobject.timeout_add(timedelta_to_milliseconds
947
1341
                            (self.approval_duration),
948
1342
                            self._reset_approved)
949
1343
    
950
 
    
951
1344
    ## D-Bus methods, signals & properties
952
 
    _interface = "se.bsnet.fukt.Mandos.Client"
953
 
 
 
1345
    _interface = "se.recompile.Mandos.Client"
 
1346
    
 
1347
    ## Interfaces
 
1348
    
 
1349
    @dbus_interface_annotations(_interface)
 
1350
    def _foo(self):
 
1351
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1352
                     "false"}
 
1353
    
954
1354
    ## Signals
955
1355
    
956
1356
    # CheckerCompleted - signal
1055
1455
                           access="readwrite")
1056
1456
    def ApprovalDuration_dbus_property(self, value=None):
1057
1457
        if value is None:       # get
1058
 
            return dbus.UInt64(_timedelta_to_milliseconds(
 
1458
            return dbus.UInt64(timedelta_to_milliseconds(
1059
1459
                    self.approval_duration))
1060
1460
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1061
1461
    
1075
1475
    def Host_dbus_property(self, value=None):
1076
1476
        if value is None:       # get
1077
1477
            return dbus.String(self.host)
1078
 
        self.host = value
 
1478
        self.host = unicode(value)
1079
1479
    
1080
1480
    # Created - property
1081
1481
    @dbus_service_property(_interface, signature="s", access="read")
1082
1482
    def Created_dbus_property(self):
1083
 
        return dbus.String(datetime_to_dbus(self.created))
 
1483
        return datetime_to_dbus(self.created)
1084
1484
    
1085
1485
    # LastEnabled - property
1086
1486
    @dbus_service_property(_interface, signature="s", access="read")
1107
1507
            return
1108
1508
        return datetime_to_dbus(self.last_checked_ok)
1109
1509
    
 
1510
    # LastCheckerStatus - property
 
1511
    @dbus_service_property(_interface, signature="n",
 
1512
                           access="read")
 
1513
    def LastCheckerStatus_dbus_property(self):
 
1514
        return dbus.Int16(self.last_checker_status)
 
1515
    
1110
1516
    # Expires - property
1111
1517
    @dbus_service_property(_interface, signature="s", access="read")
1112
1518
    def Expires_dbus_property(self):
1124
1530
        if value is None:       # get
1125
1531
            return dbus.UInt64(self.timeout_milliseconds())
1126
1532
        self.timeout = datetime.timedelta(0, 0, 0, value)
1127
 
        if getattr(self, "disable_initiator_tag", None) is None:
1128
 
            return
1129
1533
        # Reschedule timeout
1130
 
        gobject.source_remove(self.disable_initiator_tag)
1131
 
        self.disable_initiator_tag = None
1132
 
        self.expires = None
1133
 
        time_to_die = (self.
1134
 
                       _timedelta_to_milliseconds((self
1135
 
                                                   .last_checked_ok
1136
 
                                                   + self.timeout)
1137
 
                                                  - datetime.datetime
1138
 
                                                  .utcnow()))
1139
 
        if time_to_die <= 0:
1140
 
            # The timeout has passed
1141
 
            self.disable()
1142
 
        else:
1143
 
            self.expires = (datetime.datetime.utcnow()
1144
 
                            + datetime.timedelta(milliseconds = time_to_die))
1145
 
            self.disable_initiator_tag = (gobject.timeout_add
1146
 
                                          (time_to_die, self.disable))
 
1534
        if self.enabled:
 
1535
            now = datetime.datetime.utcnow()
 
1536
            time_to_die = timedelta_to_milliseconds(
 
1537
                (self.last_checked_ok + self.timeout) - now)
 
1538
            if time_to_die <= 0:
 
1539
                # The timeout has passed
 
1540
                self.disable()
 
1541
            else:
 
1542
                self.expires = (now +
 
1543
                                datetime.timedelta(milliseconds =
 
1544
                                                   time_to_die))
 
1545
                if (getattr(self, "disable_initiator_tag", None)
 
1546
                    is None):
 
1547
                    return
 
1548
                gobject.source_remove(self.disable_initiator_tag)
 
1549
                self.disable_initiator_tag = (gobject.timeout_add
 
1550
                                              (time_to_die,
 
1551
                                               self.disable))
1147
1552
    
1148
1553
    # ExtendedTimeout - property
1149
1554
    @dbus_service_property(_interface, signature="t",
1162
1567
        self.interval = datetime.timedelta(0, 0, 0, value)
1163
1568
        if getattr(self, "checker_initiator_tag", None) is None:
1164
1569
            return
1165
 
        # Reschedule checker run
1166
 
        gobject.source_remove(self.checker_initiator_tag)
1167
 
        self.checker_initiator_tag = (gobject.timeout_add
1168
 
                                      (value, self.start_checker))
1169
 
        self.start_checker()    # Start one now, too
 
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
1170
1576
    
1171
1577
    # Checker - property
1172
1578
    @dbus_service_property(_interface, signature="s",
1174
1580
    def Checker_dbus_property(self, value=None):
1175
1581
        if value is None:       # get
1176
1582
            return dbus.String(self.checker_command)
1177
 
        self.checker_command = value
 
1583
        self.checker_command = unicode(value)
1178
1584
    
1179
1585
    # CheckerRunning - property
1180
1586
    @dbus_service_property(_interface, signature="b",
1209
1615
            raise KeyError()
1210
1616
    
1211
1617
    def __getattribute__(self, name):
1212
 
        if(name == '_pipe'):
 
1618
        if name == '_pipe':
1213
1619
            return super(ProxyClient, self).__getattribute__(name)
1214
1620
        self._pipe.send(('getattr', name))
1215
1621
        data = self._pipe.recv()
1222
1628
            return func
1223
1629
    
1224
1630
    def __setattr__(self, name, value):
1225
 
        if(name == '_pipe'):
 
1631
        if name == '_pipe':
1226
1632
            return super(ProxyClient, self).__setattr__(name, value)
1227
1633
        self._pipe.send(('setattr', name, value))
1228
1634
 
1229
 
class ClientDBusTransitional(ClientDBus):
1230
 
    __metaclass__ = transitional_dbus_metaclass
1231
1635
 
1232
1636
class ClientHandler(socketserver.BaseRequestHandler, object):
1233
1637
    """A class to handle client connections.
1313
1717
                                       client.name)
1314
1718
                        if self.server.use_dbus:
1315
1719
                            # Emit D-Bus signal
1316
 
                            client.Rejected("Disabled")                    
 
1720
                            client.Rejected("Disabled")
1317
1721
                        return
1318
1722
                    
1319
 
                    if client._approved or not client.approval_delay:
 
1723
                    if client.approved or not client.approval_delay:
1320
1724
                        #We are approved or approval is disabled
1321
1725
                        break
1322
 
                    elif client._approved is None:
 
1726
                    elif client.approved is None:
1323
1727
                        logger.info("Client %s needs approval",
1324
1728
                                    client.name)
1325
1729
                        if self.server.use_dbus:
1336
1740
                        return
1337
1741
                    
1338
1742
                    #wait until timeout or approved
1339
 
                    #x = float(client._timedelta_to_milliseconds(delay))
1340
1743
                    time = datetime.datetime.now()
1341
1744
                    client.changedstate.acquire()
1342
 
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
 
1745
                    (client.changedstate.wait
 
1746
                     (float(client.timedelta_to_milliseconds(delay)
 
1747
                            / 1000)))
1343
1748
                    client.changedstate.release()
1344
1749
                    time2 = datetime.datetime.now()
1345
1750
                    if (time2 - time) >= delay:
1361
1766
                    try:
1362
1767
                        sent = session.send(client.secret[sent_size:])
1363
1768
                    except gnutls.errors.GNUTLSError as error:
1364
 
                        logger.warning("gnutls send failed")
 
1769
                        logger.warning("gnutls send failed",
 
1770
                                       exc_info=error)
1365
1771
                        return
1366
1772
                    logger.debug("Sent: %d, remaining: %d",
1367
1773
                                 sent, len(client.secret)
1369
1775
                    sent_size += sent
1370
1776
                
1371
1777
                logger.info("Sending secret to %s", client.name)
1372
 
                # bump the timeout as if seen
1373
 
                client.checked_ok(client.extended_timeout)
 
1778
                # bump the timeout using extended_timeout
 
1779
                client.bump_timeout(client.extended_timeout)
1374
1780
                if self.server.use_dbus:
1375
1781
                    # Emit D-Bus signal
1376
1782
                    client.GotSecret()
1381
1787
                try:
1382
1788
                    session.bye()
1383
1789
                except gnutls.errors.GNUTLSError as error:
1384
 
                    logger.warning("GnuTLS bye failed")
 
1790
                    logger.warning("GnuTLS bye failed",
 
1791
                                   exc_info=error)
1385
1792
    
1386
1793
    @staticmethod
1387
1794
    def peer_certificate(session):
1443
1850
        # Convert the buffer to a Python bytestring
1444
1851
        fpr = ctypes.string_at(buf, buf_len.value)
1445
1852
        # Convert the bytestring to hexadecimal notation
1446
 
        hex_fpr = ''.join("%02X" % ord(char) for char in fpr)
 
1853
        hex_fpr = binascii.hexlify(fpr).upper()
1447
1854
        return hex_fpr
1448
1855
 
1449
1856
 
1452
1859
    def sub_process_main(self, request, address):
1453
1860
        try:
1454
1861
            self.finish_request(request, address)
1455
 
        except:
 
1862
        except Exception:
1456
1863
            self.handle_error(request, address)
1457
1864
        self.close_request(request)
1458
 
            
 
1865
    
1459
1866
    def process_request(self, request, address):
1460
1867
        """Start a new process to process the request."""
1461
 
        multiprocessing.Process(target = self.sub_process_main,
1462
 
                                args = (request, address)).start()
 
1868
        proc = multiprocessing.Process(target = self.sub_process_main,
 
1869
                                       args = (request, address))
 
1870
        proc.start()
 
1871
        return proc
1463
1872
 
1464
1873
 
1465
1874
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1471
1880
        """
1472
1881
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
1473
1882
        
1474
 
        super(MultiprocessingMixInWithPipe,
1475
 
              self).process_request(request, client_address)
 
1883
        proc = MultiprocessingMixIn.process_request(self, request,
 
1884
                                                    client_address)
1476
1885
        self.child_pipe.close()
1477
 
        self.add_pipe(parent_pipe)
 
1886
        self.add_pipe(parent_pipe, proc)
1478
1887
    
1479
 
    def add_pipe(self, parent_pipe):
 
1888
    def add_pipe(self, parent_pipe, proc):
1480
1889
        """Dummy function; override as necessary"""
1481
1890
        raise NotImplementedError
1482
1891
 
1560
1969
        self.enabled = False
1561
1970
        self.clients = clients
1562
1971
        if self.clients is None:
1563
 
            self.clients = set()
 
1972
            self.clients = {}
1564
1973
        self.use_dbus = use_dbus
1565
1974
        self.gnutls_priority = gnutls_priority
1566
1975
        IPv6_TCPServer.__init__(self, server_address,
1570
1979
    def server_activate(self):
1571
1980
        if self.enabled:
1572
1981
            return socketserver.TCPServer.server_activate(self)
 
1982
    
1573
1983
    def enable(self):
1574
1984
        self.enabled = True
1575
 
    def add_pipe(self, parent_pipe):
 
1985
    
 
1986
    def add_pipe(self, parent_pipe, proc):
1576
1987
        # Call "handle_ipc" for both data and EOF events
1577
1988
        gobject.io_add_watch(parent_pipe.fileno(),
1578
1989
                             gobject.IO_IN | gobject.IO_HUP,
1579
1990
                             functools.partial(self.handle_ipc,
1580
 
                                               parent_pipe = parent_pipe))
1581
 
        
 
1991
                                               parent_pipe =
 
1992
                                               parent_pipe,
 
1993
                                               proc = proc))
 
1994
    
1582
1995
    def handle_ipc(self, source, condition, parent_pipe=None,
1583
 
                   client_object=None):
1584
 
        condition_names = {
1585
 
            gobject.IO_IN: "IN",   # There is data to read.
1586
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1587
 
                                    # blocking).
1588
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1589
 
            gobject.IO_ERR: "ERR", # Error condition.
1590
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1591
 
                                    # broken, usually for pipes and
1592
 
                                    # sockets).
1593
 
            }
1594
 
        conditions_string = ' | '.join(name
1595
 
                                       for cond, name in
1596
 
                                       condition_names.iteritems()
1597
 
                                       if cond & condition)
1598
 
        # error or the other end of multiprocessing.Pipe has closed
1599
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
1996
                   proc = None, client_object=None):
 
1997
        # error, or the other end of multiprocessing.Pipe has closed
 
1998
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
1999
            # Wait for other process to exit
 
2000
            proc.join()
1600
2001
            return False
1601
2002
        
1602
2003
        # Read a request from the child
1607
2008
            fpr = request[1]
1608
2009
            address = request[2]
1609
2010
            
1610
 
            for c in self.clients:
 
2011
            for c in self.clients.itervalues():
1611
2012
                if c.fingerprint == fpr:
1612
2013
                    client = c
1613
2014
                    break
1616
2017
                            "dress: %s", fpr, address)
1617
2018
                if self.use_dbus:
1618
2019
                    # Emit D-Bus signal
1619
 
                    mandos_dbus_service.ClientNotFound(fpr, address[0])
 
2020
                    mandos_dbus_service.ClientNotFound(fpr,
 
2021
                                                       address[0])
1620
2022
                parent_pipe.send(False)
1621
2023
                return False
1622
2024
            
1623
2025
            gobject.io_add_watch(parent_pipe.fileno(),
1624
2026
                                 gobject.IO_IN | gobject.IO_HUP,
1625
2027
                                 functools.partial(self.handle_ipc,
1626
 
                                                   parent_pipe = parent_pipe,
1627
 
                                                   client_object = client))
 
2028
                                                   parent_pipe =
 
2029
                                                   parent_pipe,
 
2030
                                                   proc = proc,
 
2031
                                                   client_object =
 
2032
                                                   client))
1628
2033
            parent_pipe.send(True)
1629
 
            # remove the old hook in favor of the new above hook on same fileno
 
2034
            # remove the old hook in favor of the new above hook on
 
2035
            # same fileno
1630
2036
            return False
1631
2037
        if command == 'funcall':
1632
2038
            funcname = request[1]
1633
2039
            args = request[2]
1634
2040
            kwargs = request[3]
1635
2041
            
1636
 
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
 
2042
            parent_pipe.send(('data', getattr(client_object,
 
2043
                                              funcname)(*args,
 
2044
                                                         **kwargs)))
1637
2045
        
1638
2046
        if command == 'getattr':
1639
2047
            attrname = request[1]
1640
2048
            if callable(client_object.__getattribute__(attrname)):
1641
2049
                parent_pipe.send(('function',))
1642
2050
            else:
1643
 
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
 
2051
                parent_pipe.send(('data', client_object
 
2052
                                  .__getattribute__(attrname)))
1644
2053
        
1645
2054
        if command == 'setattr':
1646
2055
            attrname = request[1]
1682
2091
            elif suffix == "w":
1683
2092
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1684
2093
            else:
1685
 
                raise ValueError("Unknown suffix %r" % suffix)
 
2094
                raise ValueError("Unknown suffix {0!r}"
 
2095
                                 .format(suffix))
1686
2096
        except (ValueError, IndexError) as e:
1687
2097
            raise ValueError(*(e.args))
1688
2098
        timevalue += delta
1689
2099
    return timevalue
1690
2100
 
1691
2101
 
1692
 
def if_nametoindex(interface):
1693
 
    """Call the C function if_nametoindex(), or equivalent
1694
 
    
1695
 
    Note: This function cannot accept a unicode string."""
1696
 
    global if_nametoindex
1697
 
    try:
1698
 
        if_nametoindex = (ctypes.cdll.LoadLibrary
1699
 
                          (ctypes.util.find_library("c"))
1700
 
                          .if_nametoindex)
1701
 
    except (OSError, AttributeError):
1702
 
        logger.warning("Doing if_nametoindex the hard way")
1703
 
        def if_nametoindex(interface):
1704
 
            "Get an interface index the hard way, i.e. using fcntl()"
1705
 
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1706
 
            with contextlib.closing(socket.socket()) as s:
1707
 
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1708
 
                                    struct.pack(str("16s16x"),
1709
 
                                                interface))
1710
 
            interface_index = struct.unpack(str("I"),
1711
 
                                            ifreq[16:20])[0]
1712
 
            return interface_index
1713
 
    return if_nametoindex(interface)
1714
 
 
1715
 
 
1716
2102
def daemon(nochdir = False, noclose = False):
1717
2103
    """See daemon(3).  Standard BSD Unix function.
1718
2104
    
1726
2112
        sys.exit()
1727
2113
    if not noclose:
1728
2114
        # Close all standard open file descriptors
1729
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2115
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1730
2116
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1731
2117
            raise OSError(errno.ENODEV,
1732
 
                          "%s not a character device"
1733
 
                          % os.path.devnull)
 
2118
                          "{0} not a character device"
 
2119
                          .format(os.devnull))
1734
2120
        os.dup2(null, sys.stdin.fileno())
1735
2121
        os.dup2(null, sys.stdout.fileno())
1736
2122
        os.dup2(null, sys.stderr.fileno())
1745
2131
    
1746
2132
    parser = argparse.ArgumentParser()
1747
2133
    parser.add_argument("-v", "--version", action="version",
1748
 
                        version = "%%(prog)s %s" % version,
 
2134
                        version = "%(prog)s {0}".format(version),
1749
2135
                        help="show version number and exit")
1750
2136
    parser.add_argument("-i", "--interface", metavar="IF",
1751
2137
                        help="Bind to interface IF")
1773
2159
                        " system bus interface")
1774
2160
    parser.add_argument("--no-ipv6", action="store_false",
1775
2161
                        dest="use_ipv6", help="Do not use IPv6")
 
2162
    parser.add_argument("--no-restore", action="store_false",
 
2163
                        dest="restore", help="Do not restore stored"
 
2164
                        " state")
 
2165
    parser.add_argument("--statedir", metavar="DIR",
 
2166
                        help="Directory to save/restore state in")
 
2167
    
1776
2168
    options = parser.parse_args()
1777
2169
    
1778
2170
    if options.check:
1791
2183
                        "use_dbus": "True",
1792
2184
                        "use_ipv6": "True",
1793
2185
                        "debuglevel": "",
 
2186
                        "restore": "True",
 
2187
                        "statedir": "/var/lib/mandos"
1794
2188
                        }
1795
2189
    
1796
2190
    # Parse config file for server-global settings
1813
2207
    # options, if set.
1814
2208
    for option in ("interface", "address", "port", "debug",
1815
2209
                   "priority", "servicename", "configdir",
1816
 
                   "use_dbus", "use_ipv6", "debuglevel"):
 
2210
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
 
2211
                   "statedir"):
1817
2212
        value = getattr(options, option)
1818
2213
        if value is not None:
1819
2214
            server_settings[option] = value
1831
2226
    debuglevel = server_settings["debuglevel"]
1832
2227
    use_dbus = server_settings["use_dbus"]
1833
2228
    use_ipv6 = server_settings["use_ipv6"]
 
2229
    stored_state_path = os.path.join(server_settings["statedir"],
 
2230
                                     stored_state_file)
 
2231
    
 
2232
    if debug:
 
2233
        initlogger(debug, logging.DEBUG)
 
2234
    else:
 
2235
        if not debuglevel:
 
2236
            initlogger(debug)
 
2237
        else:
 
2238
            level = getattr(logging, debuglevel.upper())
 
2239
            initlogger(debug, level)
1834
2240
    
1835
2241
    if server_settings["servicename"] != "Mandos":
1836
2242
        syslogger.setFormatter(logging.Formatter
1837
 
                               ('Mandos (%s) [%%(process)d]:'
1838
 
                                ' %%(levelname)s: %%(message)s'
1839
 
                                % server_settings["servicename"]))
 
2243
                               ('Mandos ({0}) [%(process)d]:'
 
2244
                                ' %(levelname)s: %(message)s'
 
2245
                                .format(server_settings
 
2246
                                        ["servicename"])))
1840
2247
    
1841
2248
    # Parse config file with clients
1842
 
    client_defaults = { "timeout": "5m",
1843
 
                        "extended_timeout": "15m",
1844
 
                        "interval": "2m",
1845
 
                        "checker": "fping -q -- %%(host)s",
1846
 
                        "host": "",
1847
 
                        "approval_delay": "0s",
1848
 
                        "approval_duration": "1s",
1849
 
                        }
1850
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2249
    client_config = configparser.SafeConfigParser(Client
 
2250
                                                  .client_defaults)
1851
2251
    client_config.read(os.path.join(server_settings["configdir"],
1852
2252
                                    "clients.conf"))
1853
2253
    
1867
2267
        pidfilename = "/var/run/mandos.pid"
1868
2268
        try:
1869
2269
            pidfile = open(pidfilename, "w")
1870
 
        except IOError:
1871
 
            logger.error("Could not open file %r", pidfilename)
 
2270
        except IOError as e:
 
2271
            logger.error("Could not open file %r", pidfilename,
 
2272
                         exc_info=e)
1872
2273
    
1873
 
    try:
1874
 
        uid = pwd.getpwnam("_mandos").pw_uid
1875
 
        gid = pwd.getpwnam("_mandos").pw_gid
1876
 
    except KeyError:
 
2274
    for name in ("_mandos", "mandos", "nobody"):
1877
2275
        try:
1878
 
            uid = pwd.getpwnam("mandos").pw_uid
1879
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2276
            uid = pwd.getpwnam(name).pw_uid
 
2277
            gid = pwd.getpwnam(name).pw_gid
 
2278
            break
1880
2279
        except KeyError:
1881
 
            try:
1882
 
                uid = pwd.getpwnam("nobody").pw_uid
1883
 
                gid = pwd.getpwnam("nobody").pw_gid
1884
 
            except KeyError:
1885
 
                uid = 65534
1886
 
                gid = 65534
 
2280
            continue
 
2281
    else:
 
2282
        uid = 65534
 
2283
        gid = 65534
1887
2284
    try:
1888
2285
        os.setgid(gid)
1889
2286
        os.setuid(uid)
1891
2288
        if error[0] != errno.EPERM:
1892
2289
            raise error
1893
2290
    
1894
 
    if not debug and not debuglevel:
1895
 
        syslogger.setLevel(logging.WARNING)
1896
 
        console.setLevel(logging.WARNING)
1897
 
    if debuglevel:
1898
 
        level = getattr(logging, debuglevel.upper())
1899
 
        syslogger.setLevel(level)
1900
 
        console.setLevel(level)
1901
 
    
1902
2291
    if debug:
1903
2292
        # Enable all possible GnuTLS debugging
1904
2293
        
1914
2303
         .gnutls_global_set_log_function(debug_gnutls))
1915
2304
        
1916
2305
        # Redirect stdin so all checkers get /dev/null
1917
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2306
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1918
2307
        os.dup2(null, sys.stdin.fileno())
1919
2308
        if null > 2:
1920
2309
            os.close(null)
1921
 
    else:
1922
 
        # No console logging
1923
 
        logger.removeHandler(console)
1924
2310
    
1925
2311
    # Need to fork before connecting to D-Bus
1926
2312
    if not debug:
1927
2313
        # Close all input and output, do double fork, etc.
1928
2314
        daemon()
1929
2315
    
 
2316
    gobject.threads_init()
 
2317
    
1930
2318
    global main_loop
1931
2319
    # From the Avahi example code
1932
 
    DBusGMainLoop(set_as_default=True )
 
2320
    DBusGMainLoop(set_as_default=True)
1933
2321
    main_loop = gobject.MainLoop()
1934
2322
    bus = dbus.SystemBus()
1935
2323
    # End of Avahi example code
1936
2324
    if use_dbus:
1937
2325
        try:
1938
 
            bus_name = dbus.service.BusName("se.bsnet.fukt.Mandos",
1939
 
                                            bus, do_not_queue=True)
1940
 
            bus_name2 = dbus.service.BusName("se.recompile.Mandos",
1941
 
                                            bus, do_not_queue=True)
 
2326
            bus_name = dbus.service.BusName("se.recompile.Mandos",
 
2327
                                            bus, do_not_queue=True)
 
2328
            old_bus_name = (dbus.service.BusName
 
2329
                            ("se.bsnet.fukt.Mandos", bus,
 
2330
                             do_not_queue=True))
1942
2331
        except dbus.exceptions.NameExistsException as e:
1943
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2332
            logger.error("Disabling D-Bus:", exc_info=e)
1944
2333
            use_dbus = False
1945
2334
            server_settings["use_dbus"] = False
1946
2335
            tcp_server.use_dbus = False
1947
2336
    protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1948
 
    service = AvahiService(name = server_settings["servicename"],
1949
 
                           servicetype = "_mandos._tcp",
1950
 
                           protocol = protocol, bus = bus)
 
2337
    service = AvahiServiceToSyslog(name =
 
2338
                                   server_settings["servicename"],
 
2339
                                   servicetype = "_mandos._tcp",
 
2340
                                   protocol = protocol, bus = bus)
1951
2341
    if server_settings["interface"]:
1952
2342
        service.interface = (if_nametoindex
1953
2343
                             (str(server_settings["interface"])))
1957
2347
    
1958
2348
    client_class = Client
1959
2349
    if use_dbus:
1960
 
        client_class = functools.partial(ClientDBusTransitional, bus = bus)        
1961
 
    def client_config_items(config, section):
1962
 
        special_settings = {
1963
 
            "approved_by_default":
1964
 
                lambda: config.getboolean(section,
1965
 
                                          "approved_by_default"),
1966
 
            }
1967
 
        for name, value in config.items(section):
 
2350
        client_class = functools.partial(ClientDBus, bus = bus)
 
2351
    
 
2352
    client_settings = Client.config_parser(client_config)
 
2353
    old_client_settings = {}
 
2354
    clients_data = {}
 
2355
    
 
2356
    # Get client data and settings from last running state.
 
2357
    if server_settings["restore"]:
 
2358
        try:
 
2359
            with open(stored_state_path, "rb") as stored_state:
 
2360
                clients_data, old_client_settings = (pickle.load
 
2361
                                                     (stored_state))
 
2362
            os.remove(stored_state_path)
 
2363
        except IOError as e:
 
2364
            if e.errno == errno.ENOENT:
 
2365
                logger.warning("Could not load persistent state: {0}"
 
2366
                                .format(os.strerror(e.errno)))
 
2367
            else:
 
2368
                logger.critical("Could not load persistent state:",
 
2369
                                exc_info=e)
 
2370
                raise
 
2371
        except EOFError as e:
 
2372
            logger.warning("Could not load persistent state: "
 
2373
                           "EOFError:", exc_info=e)
 
2374
    
 
2375
    with PGPEngine() as pgp:
 
2376
        for client_name, client in clients_data.iteritems():
 
2377
            # Decide which value to use after restoring saved state.
 
2378
            # We have three different values: Old config file,
 
2379
            # new config file, and saved state.
 
2380
            # New config value takes precedence if it differs from old
 
2381
            # config value, otherwise use saved state.
 
2382
            for name, value in client_settings[client_name].items():
 
2383
                try:
 
2384
                    # For each value in new config, check if it
 
2385
                    # differs from the old config value (Except for
 
2386
                    # the "secret" attribute)
 
2387
                    if (name != "secret" and
 
2388
                        value != old_client_settings[client_name]
 
2389
                        [name]):
 
2390
                        client[name] = value
 
2391
                except KeyError:
 
2392
                    pass
 
2393
            
 
2394
            # Clients who has passed its expire date can still be
 
2395
            # enabled if its last checker was successful.  Clients
 
2396
            # whose checker succeeded before we stored its state is
 
2397
            # assumed to have successfully run all checkers during
 
2398
            # downtime.
 
2399
            if client["enabled"]:
 
2400
                if datetime.datetime.utcnow() >= client["expires"]:
 
2401
                    if not client["last_checked_ok"]:
 
2402
                        logger.warning(
 
2403
                            "disabling client {0} - Client never "
 
2404
                            "performed a successful checker"
 
2405
                            .format(client_name))
 
2406
                        client["enabled"] = False
 
2407
                    elif client["last_checker_status"] != 0:
 
2408
                        logger.warning(
 
2409
                            "disabling client {0} - Client "
 
2410
                            "last checker failed with error code {1}"
 
2411
                            .format(client_name,
 
2412
                                    client["last_checker_status"]))
 
2413
                        client["enabled"] = False
 
2414
                    else:
 
2415
                        client["expires"] = (datetime.datetime
 
2416
                                             .utcnow()
 
2417
                                             + client["timeout"])
 
2418
                        logger.debug("Last checker succeeded,"
 
2419
                                     " keeping {0} enabled"
 
2420
                                     .format(client_name))
1968
2421
            try:
1969
 
                yield (name, special_settings[name]())
1970
 
            except KeyError:
1971
 
                yield (name, value)
1972
 
    
1973
 
    tcp_server.clients.update(set(
1974
 
            client_class(name = section,
1975
 
                         config= dict(client_config_items(
1976
 
                        client_config, section)))
1977
 
            for section in client_config.sections()))
 
2422
                client["secret"] = (
 
2423
                    pgp.decrypt(client["encrypted_secret"],
 
2424
                                client_settings[client_name]
 
2425
                                ["secret"]))
 
2426
            except PGPError:
 
2427
                # If decryption fails, we use secret from new settings
 
2428
                logger.debug("Failed to decrypt {0} old secret"
 
2429
                             .format(client_name))
 
2430
                client["secret"] = (
 
2431
                    client_settings[client_name]["secret"])
 
2432
    
 
2433
    # Add/remove clients based on new changes made to config
 
2434
    for client_name in (set(old_client_settings)
 
2435
                        - set(client_settings)):
 
2436
        del clients_data[client_name]
 
2437
    for client_name in (set(client_settings)
 
2438
                        - set(old_client_settings)):
 
2439
        clients_data[client_name] = client_settings[client_name]
 
2440
    
 
2441
    # Create all client objects
 
2442
    for client_name, client in clients_data.iteritems():
 
2443
        tcp_server.clients[client_name] = client_class(
 
2444
            name = client_name, settings = client)
 
2445
    
1978
2446
    if not tcp_server.clients:
1979
2447
        logger.warning("No clients defined")
1980
 
        
 
2448
    
1981
2449
    if not debug:
1982
2450
        try:
1983
2451
            with pidfile:
1991
2459
            # "pidfile" was never created
1992
2460
            pass
1993
2461
        del pidfilename
1994
 
        
1995
2462
        signal.signal(signal.SIGINT, signal.SIG_IGN)
1996
2463
    
1997
2464
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1998
2465
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1999
2466
    
2000
2467
    if use_dbus:
2001
 
        class MandosDBusService(dbus.service.Object):
 
2468
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2469
                                        "se.bsnet.fukt.Mandos"})
 
2470
        class MandosDBusService(DBusObjectWithProperties):
2002
2471
            """A D-Bus proxy object"""
2003
2472
            def __init__(self):
2004
2473
                dbus.service.Object.__init__(self, bus, "/")
2005
 
            _interface = "se.bsnet.fukt.Mandos"
 
2474
            _interface = "se.recompile.Mandos"
 
2475
            
 
2476
            @dbus_interface_annotations(_interface)
 
2477
            def _foo(self):
 
2478
                return { "org.freedesktop.DBus.Property"
 
2479
                         ".EmitsChangedSignal":
 
2480
                             "false"}
2006
2481
            
2007
2482
            @dbus.service.signal(_interface, signature="o")
2008
2483
            def ClientAdded(self, objpath):
2023
2498
            def GetAllClients(self):
2024
2499
                "D-Bus method"
2025
2500
                return dbus.Array(c.dbus_object_path
2026
 
                                  for c in tcp_server.clients)
 
2501
                                  for c in
 
2502
                                  tcp_server.clients.itervalues())
2027
2503
            
2028
2504
            @dbus.service.method(_interface,
2029
2505
                                 out_signature="a{oa{sv}}")
2031
2507
                "D-Bus method"
2032
2508
                return dbus.Dictionary(
2033
2509
                    ((c.dbus_object_path, c.GetAll(""))
2034
 
                     for c in tcp_server.clients),
 
2510
                     for c in tcp_server.clients.itervalues()),
2035
2511
                    signature="oa{sv}")
2036
2512
            
2037
2513
            @dbus.service.method(_interface, in_signature="o")
2038
2514
            def RemoveClient(self, object_path):
2039
2515
                "D-Bus method"
2040
 
                for c in tcp_server.clients:
 
2516
                for c in tcp_server.clients.itervalues():
2041
2517
                    if c.dbus_object_path == object_path:
2042
 
                        tcp_server.clients.remove(c)
 
2518
                        del tcp_server.clients[c.name]
2043
2519
                        c.remove_from_connection()
2044
2520
                        # Don't signal anything except ClientRemoved
2045
2521
                        c.disable(quiet=True)
2050
2526
            
2051
2527
            del _interface
2052
2528
        
2053
 
        class MandosDBusServiceTransitional(MandosDBusService):
2054
 
            __metaclass__ = transitional_dbus_metaclass
2055
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2529
        mandos_dbus_service = MandosDBusService()
2056
2530
    
2057
2531
    def cleanup():
2058
2532
        "Cleanup function; run on exit"
2059
2533
        service.cleanup()
2060
2534
        
 
2535
        multiprocessing.active_children()
 
2536
        if not (tcp_server.clients or client_settings):
 
2537
            return
 
2538
        
 
2539
        # Store client before exiting. Secrets are encrypted with key
 
2540
        # based on what config file has. If config file is
 
2541
        # removed/edited, old secret will thus be unrecovable.
 
2542
        clients = {}
 
2543
        with PGPEngine() as pgp:
 
2544
            for client in tcp_server.clients.itervalues():
 
2545
                key = client_settings[client.name]["secret"]
 
2546
                client.encrypted_secret = pgp.encrypt(client.secret,
 
2547
                                                      key)
 
2548
                client_dict = {}
 
2549
                
 
2550
                # A list of attributes that can not be pickled
 
2551
                # + secret.
 
2552
                exclude = set(("bus", "changedstate", "secret",
 
2553
                               "checker"))
 
2554
                for name, typ in (inspect.getmembers
 
2555
                                  (dbus.service.Object)):
 
2556
                    exclude.add(name)
 
2557
                
 
2558
                client_dict["encrypted_secret"] = (client
 
2559
                                                   .encrypted_secret)
 
2560
                for attr in client.client_structure:
 
2561
                    if attr not in exclude:
 
2562
                        client_dict[attr] = getattr(client, attr)
 
2563
                
 
2564
                clients[client.name] = client_dict
 
2565
                del client_settings[client.name]["secret"]
 
2566
        
 
2567
        try:
 
2568
            with (tempfile.NamedTemporaryFile
 
2569
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2570
                   dir=os.path.dirname(stored_state_path),
 
2571
                   delete=False)) as stored_state:
 
2572
                pickle.dump((clients, client_settings), stored_state)
 
2573
                tempname=stored_state.name
 
2574
            os.rename(tempname, stored_state_path)
 
2575
        except (IOError, OSError) as e:
 
2576
            if not debug:
 
2577
                try:
 
2578
                    os.remove(tempname)
 
2579
                except NameError:
 
2580
                    pass
 
2581
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2582
                logger.warning("Could not save persistent state: {0}"
 
2583
                               .format(os.strerror(e.errno)))
 
2584
            else:
 
2585
                logger.warning("Could not save persistent state:",
 
2586
                               exc_info=e)
 
2587
                raise e
 
2588
        
 
2589
        # Delete all clients, and settings from config
2061
2590
        while tcp_server.clients:
2062
 
            client = tcp_server.clients.pop()
 
2591
            name, client = tcp_server.clients.popitem()
2063
2592
            if use_dbus:
2064
2593
                client.remove_from_connection()
2065
 
            client.disable_hook = None
2066
2594
            # Don't signal anything except ClientRemoved
2067
2595
            client.disable(quiet=True)
2068
2596
            if use_dbus:
2069
2597
                # Emit D-Bus signal
2070
 
                mandos_dbus_service.ClientRemoved(client.dbus_object_path,
 
2598
                mandos_dbus_service.ClientRemoved(client
 
2599
                                                  .dbus_object_path,
2071
2600
                                                  client.name)
 
2601
        client_settings.clear()
2072
2602
    
2073
2603
    atexit.register(cleanup)
2074
2604
    
2075
 
    for client in tcp_server.clients:
 
2605
    for client in tcp_server.clients.itervalues():
2076
2606
        if use_dbus:
2077
2607
            # Emit D-Bus signal
2078
2608
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
2079
 
        client.enable()
 
2609
        # Need to initiate checking of clients
 
2610
        if client.enabled:
 
2611
            client.init_checker()
2080
2612
    
2081
2613
    tcp_server.enable()
2082
2614
    tcp_server.server_activate()
2085
2617
    service.port = tcp_server.socket.getsockname()[1]
2086
2618
    if use_ipv6:
2087
2619
        logger.info("Now listening on address %r, port %d,"
2088
 
                    " flowinfo %d, scope_id %d"
2089
 
                    % tcp_server.socket.getsockname())
 
2620
                    " flowinfo %d, scope_id %d",
 
2621
                    *tcp_server.socket.getsockname())
2090
2622
    else:                       # IPv4
2091
 
        logger.info("Now listening on address %r, port %d"
2092
 
                    % tcp_server.socket.getsockname())
 
2623
        logger.info("Now listening on address %r, port %d",
 
2624
                    *tcp_server.socket.getsockname())
2093
2625
    
2094
2626
    #service.interface = tcp_server.socket.getsockname()[3]
2095
2627
    
2098
2630
        try:
2099
2631
            service.activate()
2100
2632
        except dbus.exceptions.DBusException as error:
2101
 
            logger.critical("DBusException: %s", error)
 
2633
            logger.critical("D-Bus Exception", exc_info=error)
2102
2634
            cleanup()
2103
2635
            sys.exit(1)
2104
2636
        # End of Avahi example code
2111
2643
        logger.debug("Starting main loop")
2112
2644
        main_loop.run()
2113
2645
    except AvahiError as error:
2114
 
        logger.critical("AvahiError: %s", error)
 
2646
        logger.critical("Avahi Error", exc_info=error)
2115
2647
        cleanup()
2116
2648
        sys.exit(1)
2117
2649
    except KeyboardInterrupt:
2122
2654
    # Must run before the D-Bus bus name gets deregistered
2123
2655
    cleanup()
2124
2656
 
2125
 
 
2126
2657
if __name__ == '__main__':
2127
2658
    main()