/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2011-11-26 23:08:17 UTC
  • mto: (518.1.8 mandos-persistent)
  • mto: This revision was merged to the branch mainline in revision 524.
  • Revision ID: teddy@recompile.se-20111126230817-tv08v831s2yltbkd
Make "enabled" a client config option.

* DBUS-API: Fix wording on "Expires" option.
* clients.conf (enabled): New.
* mandos (Client): "last_enabled" can now be None.
  (Client.__init__): Get "enabled" from config.  Only set
                     "last_enabled" and "expires" if enabled.
  (ClientDBus.Created_dbus_property): Removed redundant dbus.String().
  (ClientDBus.Interval_dbus_property): If changed, only reschedule
                                       checker if enabled.
  (main/special_settings): Added "enabled".
* mandos-clients.conf (OPTIONS): Added "enabled".

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
# "AvahiService" class, and some lines in "main".
12
12
13
13
# Everything else is
14
 
# Copyright © 2008-2012 Teddy Hogeborn
15
 
# Copyright © 2008-2012 Björn Påhlsson
 
14
# Copyright © 2008-2011 Teddy Hogeborn
 
15
# Copyright © 2008-2011 Björn Påhlsson
16
16
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
34
34
from __future__ import (division, absolute_import, print_function,
35
35
                        unicode_literals)
36
36
 
37
 
from future_builtins import *
38
 
 
39
37
import SocketServer as socketserver
40
38
import socket
41
39
import argparse
67
65
import types
68
66
import binascii
69
67
import tempfile
70
 
import itertools
71
68
 
72
69
import dbus
73
70
import dbus.service
88
85
    except ImportError:
89
86
        SO_BINDTODEVICE = None
90
87
 
91
 
version = "1.5.3"
 
88
 
 
89
version = "1.4.1"
92
90
stored_state_file = "clients.pickle"
93
91
 
94
92
logger = logging.getLogger()
113
111
        return interface_index
114
112
 
115
113
 
116
 
def initlogger(debug, level=logging.WARNING):
 
114
def initlogger(level=logging.WARNING):
117
115
    """init logger and add loglevel"""
118
116
    
119
117
    syslogger.setFormatter(logging.Formatter
121
119
                            ' %(message)s'))
122
120
    logger.addHandler(syslogger)
123
121
    
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)
 
122
    console = logging.StreamHandler()
 
123
    console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
124
                                           ' [%(process)d]:'
 
125
                                           ' %(levelname)s:'
 
126
                                           ' %(message)s'))
 
127
    logger.addHandler(console)
131
128
    logger.setLevel(level)
132
129
 
133
130
 
134
 
class PGPError(Exception):
135
 
    """Exception if encryption/decryption fails"""
 
131
class CryptoError(Exception):
136
132
    pass
137
133
 
138
134
 
139
 
class PGPEngine(object):
 
135
class Crypto(object):
140
136
    """A simple class for OpenPGP symmetric encryption & decryption"""
141
137
    def __init__(self):
142
138
        self.gnupg = GnuPGInterface.GnuPG()
145
141
        self.gnupg.options.meta_interactive = False
146
142
        self.gnupg.options.homedir = self.tempdir
147
143
        self.gnupg.options.extra_args.extend(['--force-mdc',
148
 
                                              '--quiet',
149
 
                                              '--no-use-agent'])
 
144
                                              '--quiet'])
150
145
    
151
146
    def __enter__(self):
152
147
        return self
178
173
    
179
174
    def encrypt(self, data, password):
180
175
        self.gnupg.passphrase = self.password_encode(password)
181
 
        with open(os.devnull, "w") as devnull:
 
176
        with open(os.devnull) as devnull:
182
177
            try:
183
178
                proc = self.gnupg.run(['--symmetric'],
184
179
                                      create_fhs=['stdin', 'stdout'],
189
184
                    ciphertext = f.read()
190
185
                proc.wait()
191
186
            except IOError as e:
192
 
                raise PGPError(e)
 
187
                raise CryptoError(e)
193
188
        self.gnupg.passphrase = None
194
189
        return ciphertext
195
190
    
196
191
    def decrypt(self, data, password):
197
192
        self.gnupg.passphrase = self.password_encode(password)
198
 
        with open(os.devnull, "w") as devnull:
 
193
        with open(os.devnull) as devnull:
199
194
            try:
200
195
                proc = self.gnupg.run(['--decrypt'],
201
196
                                      create_fhs=['stdin', 'stdout'],
202
197
                                      attach_fhs={'stderr': devnull})
203
 
                with contextlib.closing(proc.handles['stdin']) as f:
 
198
                with contextlib.closing(proc.handles['stdin'] ) as f:
204
199
                    f.write(data)
205
200
                with contextlib.closing(proc.handles['stdout']) as f:
206
201
                    decrypted_plaintext = f.read()
207
202
                proc.wait()
208
203
            except IOError as e:
209
 
                raise PGPError(e)
 
204
                raise CryptoError(e)
210
205
        self.gnupg.passphrase = None
211
206
        return decrypted_plaintext
212
207
 
213
208
 
 
209
 
214
210
class AvahiError(Exception):
215
211
    def __init__(self, value, *args, **kwargs):
216
212
        self.value = value
245
241
    server: D-Bus Server
246
242
    bus: dbus.SystemBus()
247
243
    """
248
 
    
249
244
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
250
245
                 servicetype = None, port = None, TXT = None,
251
246
                 domain = "", host = "", max_renames = 32768,
264
259
        self.server = None
265
260
        self.bus = bus
266
261
        self.entry_group_state_changed_match = None
267
 
    
268
262
    def rename(self):
269
263
        """Derived from the Avahi example code"""
270
264
        if self.rename_count >= self.max_renames:
280
274
        try:
281
275
            self.add()
282
276
        except dbus.exceptions.DBusException as error:
283
 
            logger.critical("D-Bus Exception", exc_info=error)
 
277
            logger.critical("DBusException: %s", error)
284
278
            self.cleanup()
285
279
            os._exit(1)
286
280
        self.rename_count += 1
287
 
    
288
281
    def remove(self):
289
282
        """Derived from the Avahi example code"""
290
283
        if self.entry_group_state_changed_match is not None:
292
285
            self.entry_group_state_changed_match = None
293
286
        if self.group is not None:
294
287
            self.group.Reset()
295
 
    
296
288
    def add(self):
297
289
        """Derived from the Avahi example code"""
298
290
        self.remove()
315
307
            dbus.UInt16(self.port),
316
308
            avahi.string_array_to_txt_array(self.TXT))
317
309
        self.group.Commit()
318
 
    
319
310
    def entry_group_state_changed(self, state, error):
320
311
        """Derived from the Avahi example code"""
321
312
        logger.debug("Avahi entry group state change: %i", state)
328
319
        elif state == avahi.ENTRY_GROUP_FAILURE:
329
320
            logger.critical("Avahi: Error in group state changed %s",
330
321
                            unicode(error))
331
 
            raise AvahiGroupError("State changed: {0!s}"
332
 
                                  .format(error))
333
 
    
 
322
            raise AvahiGroupError("State changed: %s"
 
323
                                  % unicode(error))
334
324
    def cleanup(self):
335
325
        """Derived from the Avahi example code"""
336
326
        if self.group is not None:
341
331
                pass
342
332
            self.group = None
343
333
        self.remove()
344
 
    
345
334
    def server_state_changed(self, state, error=None):
346
335
        """Derived from the Avahi example code"""
347
336
        logger.debug("Avahi server state change: %i", state)
366
355
                logger.debug("Unknown state: %r", state)
367
356
            else:
368
357
                logger.debug("Unknown state: %r: %r", state, error)
369
 
    
370
358
    def activate(self):
371
359
        """Derived from the Avahi example code"""
372
360
        if self.server is None:
384
372
        """Add the new name to the syslog messages"""
385
373
        ret = AvahiService.rename(self)
386
374
        syslogger.setFormatter(logging.Formatter
387
 
                               ('Mandos ({0}) [%(process)d]:'
388
 
                                ' %(levelname)s: %(message)s'
389
 
                                .format(self.name)))
 
375
                               ('Mandos (%s) [%%(process)d]:'
 
376
                                ' %%(levelname)s: %%(message)s'
 
377
                                % self.name))
390
378
        return ret
391
379
 
392
 
def timedelta_to_milliseconds(td):
 
380
def _timedelta_to_milliseconds(td):
393
381
    "Convert a datetime.timedelta() to milliseconds"
394
382
    return ((td.days * 24 * 60 * 60 * 1000)
395
383
            + (td.seconds * 1000)
396
384
            + (td.microseconds // 1000))
397
 
 
 
385
        
398
386
class Client(object):
399
387
    """A representation of a client host served by this server.
400
388
    
401
389
    Attributes:
402
 
    approved:   bool(); 'None' if not yet approved/disapproved
 
390
    _approved:   bool(); 'None' if not yet approved/disapproved
403
391
    approval_delay: datetime.timedelta(); Time to wait for approval
404
392
    approval_duration: datetime.timedelta(); Duration of one approval
405
393
    checker:    subprocess.Popen(); a running checker process used
423
411
    interval:   datetime.timedelta(); How often to start a new checker
424
412
    last_approval_request: datetime.datetime(); (UTC) or None
425
413
    last_checked_ok: datetime.datetime(); (UTC) or None
 
414
 
426
415
    last_checker_status: integer between 0 and 255 reflecting exit
427
416
                         status of last checker. -1 reflects crashed
428
 
                         checker, -2 means no checker completed yet.
 
417
                         checker, or None.
429
418
    last_enabled: datetime.datetime(); (UTC) or None
430
419
    name:       string; from the config file, used in log messages and
431
420
                        D-Bus identifiers
432
421
    secret:     bytestring; sent verbatim (over TLS) to client
433
422
    timeout:    datetime.timedelta(); How long from last_checked_ok
434
423
                                      until this client is disabled
435
 
    extended_timeout:   extra long timeout when secret has been sent
 
424
    extended_timeout:   extra long timeout when password has been sent
436
425
    runtime_expansions: Allowed attributes for runtime expansion.
437
426
    expires:    datetime.datetime(); time (UTC) when a client will be
438
427
                disabled, or None
442
431
                          "created", "enabled", "fingerprint",
443
432
                          "host", "interval", "last_checked_ok",
444
433
                          "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
 
                        }
455
434
    
456
435
    def timeout_milliseconds(self):
457
436
        "Return the 'timeout' attribute in milliseconds"
458
 
        return timedelta_to_milliseconds(self.timeout)
 
437
        return _timedelta_to_milliseconds(self.timeout)
459
438
    
460
439
    def extended_timeout_milliseconds(self):
461
440
        "Return the 'extended_timeout' attribute in milliseconds"
462
 
        return timedelta_to_milliseconds(self.extended_timeout)
 
441
        return _timedelta_to_milliseconds(self.extended_timeout)
463
442
    
464
443
    def interval_milliseconds(self):
465
444
        "Return the 'interval' attribute in milliseconds"
466
 
        return timedelta_to_milliseconds(self.interval)
 
445
        return _timedelta_to_milliseconds(self.interval)
467
446
    
468
447
    def approval_delay_milliseconds(self):
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):
 
448
        return _timedelta_to_milliseconds(self.approval_delay)
 
449
    
 
450
    def __init__(self, name = None, config=None):
 
451
        """Note: the 'checker' key in 'config' sets the
 
452
        'checker_command' attribute and *not* the 'checker'
 
453
        attribute."""
519
454
        self.name = name
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
 
        
 
455
        if config is None:
 
456
            config = {}
534
457
        logger.debug("Creating client %r", self.name)
535
458
        # Uppercase and remove spaces from fingerprint for later
536
459
        # comparison purposes with return value from the fingerprint()
537
460
        # function
 
461
        self.fingerprint = (config["fingerprint"].upper()
 
462
                            .replace(" ", ""))
538
463
        logger.debug("  Fingerprint: %s", self.fingerprint)
539
 
        self.created = settings.get("created",
540
 
                                    datetime.datetime.utcnow())
541
 
        
542
 
        # attributes specific for this server instance
 
464
        if "secret" in config:
 
465
            self.secret = config["secret"].decode("base64")
 
466
        elif "secfile" in config:
 
467
            with open(os.path.expanduser(os.path.expandvars
 
468
                                         (config["secfile"])),
 
469
                      "rb") as secfile:
 
470
                self.secret = secfile.read()
 
471
        else:
 
472
            raise TypeError("No secret or secfile for client %s"
 
473
                            % self.name)
 
474
        self.host = config.get("host", "")
 
475
        self.created = datetime.datetime.utcnow()
 
476
        self.enabled = config.get("enabled", True)
 
477
        self.last_approval_request = None
 
478
        if self.enabled:
 
479
            self.last_enabled = datetime.datetime.utcnow()
 
480
        else:
 
481
            self.last_enabled = None
 
482
        self.last_checked_ok = None
 
483
        self.last_checker_status = None
 
484
        self.timeout = string_to_delta(config["timeout"])
 
485
        self.extended_timeout = string_to_delta(config
 
486
                                                ["extended_timeout"])
 
487
        self.interval = string_to_delta(config["interval"])
543
488
        self.checker = None
544
489
        self.checker_initiator_tag = None
545
490
        self.disable_initiator_tag = None
 
491
        if self.enabled:
 
492
            self.expires = datetime.datetime.utcnow() + self.timeout
 
493
        else:
 
494
            self.expires = None
546
495
        self.checker_callback_tag = None
 
496
        self.checker_command = config["checker"]
547
497
        self.current_checker_command = None
548
 
        self.approved = None
 
498
        self._approved = None
 
499
        self.approved_by_default = config.get("approved_by_default",
 
500
                                              True)
549
501
        self.approvals_pending = 0
 
502
        self.approval_delay = string_to_delta(
 
503
            config["approval_delay"])
 
504
        self.approval_duration = string_to_delta(
 
505
            config["approval_duration"])
550
506
        self.changedstate = (multiprocessing_manager
551
507
                             .Condition(multiprocessing_manager
552
508
                                        .Lock()))
572
528
        if getattr(self, "enabled", False):
573
529
            # Already enabled
574
530
            return
 
531
        self.send_changedstate()
575
532
        self.expires = datetime.datetime.utcnow() + self.timeout
576
533
        self.enabled = True
577
534
        self.last_enabled = datetime.datetime.utcnow()
578
535
        self.init_checker()
579
 
        self.send_changedstate()
580
536
    
581
537
    def disable(self, quiet=True):
582
538
        """Disable this client."""
583
539
        if not getattr(self, "enabled", False):
584
540
            return False
585
541
        if not quiet:
 
542
            self.send_changedstate()
 
543
        if not quiet:
586
544
            logger.info("Disabling client %s", self.name)
587
 
        if getattr(self, "disable_initiator_tag", None) is not None:
 
545
        if getattr(self, "disable_initiator_tag", False):
588
546
            gobject.source_remove(self.disable_initiator_tag)
589
547
            self.disable_initiator_tag = None
590
548
        self.expires = None
591
 
        if getattr(self, "checker_initiator_tag", None) is not None:
 
549
        if getattr(self, "checker_initiator_tag", False):
592
550
            gobject.source_remove(self.checker_initiator_tag)
593
551
            self.checker_initiator_tag = None
594
552
        self.stop_checker()
595
553
        self.enabled = False
596
 
        if not quiet:
597
 
            self.send_changedstate()
598
554
        # Do not run this again if called by a gobject.timeout_add
599
555
        return False
600
556
    
604
560
    def init_checker(self):
605
561
        # Schedule a new checker to be started an 'interval' from now,
606
562
        # and every interval from then on.
607
 
        if self.checker_initiator_tag is not None:
608
 
            gobject.source_remove(self.checker_initiator_tag)
609
563
        self.checker_initiator_tag = (gobject.timeout_add
610
564
                                      (self.interval_milliseconds(),
611
565
                                       self.start_checker))
612
566
        # Schedule a disable() when 'timeout' has passed
613
 
        if self.disable_initiator_tag is not None:
614
 
            gobject.source_remove(self.disable_initiator_tag)
615
567
        self.disable_initiator_tag = (gobject.timeout_add
616
568
                                   (self.timeout_milliseconds(),
617
569
                                    self.disable))
623
575
        self.checker_callback_tag = None
624
576
        self.checker = None
625
577
        if os.WIFEXITED(condition):
626
 
            self.last_checker_status = os.WEXITSTATUS(condition)
 
578
            self.last_checker_status =  os.WEXITSTATUS(condition)
627
579
            if self.last_checker_status == 0:
628
580
                logger.info("Checker for %(name)s succeeded",
629
581
                            vars(self))
636
588
            logger.warning("Checker for %(name)s crashed?",
637
589
                           vars(self))
638
590
    
639
 
    def checked_ok(self):
640
 
        """Assert that the client has been seen, alive and well."""
641
 
        self.last_checked_ok = datetime.datetime.utcnow()
642
 
        self.last_checker_status = 0
643
 
        self.bump_timeout()
644
 
    
645
 
    def bump_timeout(self, timeout=None):
646
 
        """Bump up the timeout for this client."""
 
591
    def checked_ok(self, timeout=None):
 
592
        """Bump up the timeout for this client.
 
593
        
 
594
        This should only be called when the client has been seen,
 
595
        alive and well.
 
596
        """
647
597
        if timeout is None:
648
598
            timeout = self.timeout
 
599
        self.last_checked_ok = datetime.datetime.utcnow()
649
600
        if self.disable_initiator_tag is not None:
650
601
            gobject.source_remove(self.disable_initiator_tag)
651
 
            self.disable_initiator_tag = None
652
602
        if getattr(self, "enabled", False):
653
603
            self.disable_initiator_tag = (gobject.timeout_add
654
 
                                          (timedelta_to_milliseconds
 
604
                                          (_timedelta_to_milliseconds
655
605
                                           (timeout), self.disable))
656
606
            self.expires = datetime.datetime.utcnow() + timeout
657
607
    
664
614
        If a checker already exists, leave it running and do
665
615
        nothing."""
666
616
        # The reason for not killing a running checker is that if we
667
 
        # did that, and if a checker (for some reason) started running
668
 
        # slowly and taking more than 'interval' time, then the client
669
 
        # would inevitably timeout, since no checker would get a
670
 
        # chance to run to completion.  If we instead leave running
 
617
        # did that, then if a checker (for some reason) started
 
618
        # running slowly and taking more than 'interval' time, the
 
619
        # client would inevitably timeout, since no checker would get
 
620
        # a chance to run to completion.  If we instead leave running
671
621
        # checkers alone, the checker would have to take more time
672
622
        # than 'timeout' for the client to be disabled, which is as it
673
623
        # should be.
703
653
                try:
704
654
                    command = self.checker_command % escaped_attrs
705
655
                except TypeError as error:
706
 
                    logger.error('Could not format string "%s"',
707
 
                                 self.checker_command, exc_info=error)
 
656
                    logger.error('Could not format string "%s":'
 
657
                                 ' %s', self.checker_command, error)
708
658
                    return True # Try again later
709
659
            self.current_checker_command = command
710
660
            try:
728
678
                    gobject.source_remove(self.checker_callback_tag)
729
679
                    self.checker_callback(pid, status, command)
730
680
            except OSError as error:
731
 
                logger.error("Failed to start subprocess",
732
 
                             exc_info=error)
 
681
                logger.error("Failed to start subprocess: %s",
 
682
                             error)
733
683
        # Re-run this periodically if run by gobject.timeout_add
734
684
        return True
735
685
    
742
692
            return
743
693
        logger.debug("Stopping checker for %(name)s", vars(self))
744
694
        try:
745
 
            self.checker.terminate()
 
695
            os.kill(self.checker.pid, signal.SIGTERM)
746
696
            #time.sleep(0.5)
747
697
            #if self.checker.poll() is None:
748
 
            #    self.checker.kill()
 
698
            #    os.kill(self.checker.pid, signal.SIGKILL)
749
699
        except OSError as error:
750
700
            if error.errno != errno.ESRCH: # No such process
751
701
                raise
768
718
    # "Set" method, so we fail early here:
769
719
    if byte_arrays and signature != "ay":
770
720
        raise ValueError("Byte arrays not supported for non-'ay'"
771
 
                         " signature {0!r}".format(signature))
 
721
                         " signature %r" % signature)
772
722
    def decorator(func):
773
723
        func._dbus_is_property = True
774
724
        func._dbus_interface = dbus_interface
782
732
    return decorator
783
733
 
784
734
 
785
 
def dbus_interface_annotations(dbus_interface):
786
 
    """Decorator for marking functions returning interface annotations
787
 
    
788
 
    Usage:
789
 
    
790
 
    @dbus_interface_annotations("org.example.Interface")
791
 
    def _foo(self):  # Function name does not matter
792
 
        return {"org.freedesktop.DBus.Deprecated": "true",
793
 
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
794
 
                    "false"}
795
 
    """
796
 
    def decorator(func):
797
 
        func._dbus_is_interface = True
798
 
        func._dbus_interface = dbus_interface
799
 
        func._dbus_name = dbus_interface
800
 
        return func
801
 
    return decorator
802
 
 
803
 
 
804
 
def dbus_annotations(annotations):
805
 
    """Decorator to annotate D-Bus methods, signals or properties
806
 
    Usage:
807
 
    
808
 
    @dbus_service_property("org.example.Interface", signature="b",
809
 
                           access="r")
810
 
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
811
 
                        "org.freedesktop.DBus.Property."
812
 
                        "EmitsChangedSignal": "false"})
813
 
    def Property_dbus_property(self):
814
 
        return dbus.Boolean(False)
815
 
    """
816
 
    def decorator(func):
817
 
        func._dbus_annotations = annotations
818
 
        return func
819
 
    return decorator
820
 
 
821
 
 
822
735
class DBusPropertyException(dbus.exceptions.DBusException):
823
736
    """A base class for D-Bus property-related exceptions
824
737
    """
847
760
    """
848
761
    
849
762
    @staticmethod
850
 
    def _is_dbus_thing(thing):
851
 
        """Returns a function testing if an attribute is a D-Bus thing
852
 
        
853
 
        If called like _is_dbus_thing("method") it returns a function
854
 
        suitable for use as predicate to inspect.getmembers().
855
 
        """
856
 
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
857
 
                                   False)
 
763
    def _is_dbus_property(obj):
 
764
        return getattr(obj, "_dbus_is_property", False)
858
765
    
859
 
    def _get_all_dbus_things(self, thing):
 
766
    def _get_all_dbus_properties(self):
860
767
        """Returns a generator of (name, attribute) pairs
861
768
        """
862
 
        return ((getattr(athing.__get__(self), "_dbus_name",
863
 
                         name),
864
 
                 athing.__get__(self))
 
769
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
865
770
                for cls in self.__class__.__mro__
866
 
                for name, athing in
867
 
                inspect.getmembers(cls,
868
 
                                   self._is_dbus_thing(thing)))
 
771
                for name, prop in
 
772
                inspect.getmembers(cls, self._is_dbus_property))
869
773
    
870
774
    def _get_dbus_property(self, interface_name, property_name):
871
775
        """Returns a bound method if one exists which is a D-Bus
873
777
        """
874
778
        for cls in  self.__class__.__mro__:
875
779
            for name, value in (inspect.getmembers
876
 
                                (cls,
877
 
                                 self._is_dbus_thing("property"))):
 
780
                                (cls, self._is_dbus_property)):
878
781
                if (value._dbus_name == property_name
879
782
                    and value._dbus_interface == interface_name):
880
783
                    return value.__get__(self)
909
812
            # signatures other than "ay".
910
813
            if prop._dbus_signature != "ay":
911
814
                raise ValueError
912
 
            value = dbus.ByteArray(b''.join(chr(byte)
913
 
                                            for byte in value))
 
815
            value = dbus.ByteArray(''.join(unichr(byte)
 
816
                                           for byte in value))
914
817
        prop(value)
915
818
    
916
819
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
922
825
        Note: Will not include properties with access="write".
923
826
        """
924
827
        properties = {}
925
 
        for name, prop in self._get_all_dbus_things("property"):
 
828
        for name, prop in self._get_all_dbus_properties():
926
829
            if (interface_name
927
830
                and interface_name != prop._dbus_interface):
928
831
                # Interface non-empty but did not match
943
846
                         path_keyword='object_path',
944
847
                         connection_keyword='connection')
945
848
    def Introspect(self, object_path, connection):
946
 
        """Overloading of standard D-Bus method.
947
 
        
948
 
        Inserts property tags and interface annotation tags.
 
849
        """Standard D-Bus method, overloaded to insert property tags.
949
850
        """
950
851
        xmlstring = dbus.service.Object.Introspect(self, object_path,
951
852
                                                   connection)
958
859
                e.setAttribute("access", prop._dbus_access)
959
860
                return e
960
861
            for if_tag in document.getElementsByTagName("interface"):
961
 
                # Add property tags
962
862
                for tag in (make_tag(document, name, prop)
963
863
                            for name, prop
964
 
                            in self._get_all_dbus_things("property")
 
864
                            in self._get_all_dbus_properties()
965
865
                            if prop._dbus_interface
966
866
                            == if_tag.getAttribute("name")):
967
867
                    if_tag.appendChild(tag)
968
 
                # Add annotation tags
969
 
                for typ in ("method", "signal", "property"):
970
 
                    for tag in if_tag.getElementsByTagName(typ):
971
 
                        annots = dict()
972
 
                        for name, prop in (self.
973
 
                                           _get_all_dbus_things(typ)):
974
 
                            if (name == tag.getAttribute("name")
975
 
                                and prop._dbus_interface
976
 
                                == if_tag.getAttribute("name")):
977
 
                                annots.update(getattr
978
 
                                              (prop,
979
 
                                               "_dbus_annotations",
980
 
                                               {}))
981
 
                        for name, value in annots.iteritems():
982
 
                            ann_tag = document.createElement(
983
 
                                "annotation")
984
 
                            ann_tag.setAttribute("name", name)
985
 
                            ann_tag.setAttribute("value", value)
986
 
                            tag.appendChild(ann_tag)
987
 
                # Add interface annotation tags
988
 
                for annotation, value in dict(
989
 
                    itertools.chain.from_iterable(
990
 
                        annotations().iteritems()
991
 
                        for name, annotations in
992
 
                        self._get_all_dbus_things("interface")
993
 
                        if name == if_tag.getAttribute("name")
994
 
                        )).iteritems():
995
 
                    ann_tag = document.createElement("annotation")
996
 
                    ann_tag.setAttribute("name", annotation)
997
 
                    ann_tag.setAttribute("value", value)
998
 
                    if_tag.appendChild(ann_tag)
999
868
                # Add the names to the return values for the
1000
869
                # "org.freedesktop.DBus.Properties" methods
1001
870
                if (if_tag.getAttribute("name")
1016
885
        except (AttributeError, xml.dom.DOMException,
1017
886
                xml.parsers.expat.ExpatError) as error:
1018
887
            logger.error("Failed to override Introspection method",
1019
 
                         exc_info=error)
 
888
                         error)
1020
889
        return xmlstring
1021
890
 
1022
891
 
1028
897
                       variant_level=variant_level)
1029
898
 
1030
899
 
1031
 
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1032
 
    """A class decorator; applied to a subclass of
1033
 
    dbus.service.Object, it will add alternate D-Bus attributes with
1034
 
    interface names according to the "alt_interface_names" mapping.
1035
 
    Usage:
1036
 
    
1037
 
    @alternate_dbus_names({"org.example.Interface":
1038
 
                               "net.example.AlternateInterface"})
1039
 
    class SampleDBusObject(dbus.service.Object):
1040
 
        @dbus.service.method("org.example.Interface")
1041
 
        def SampleDBusMethod():
1042
 
            pass
1043
 
    
1044
 
    The above "SampleDBusMethod" on "SampleDBusObject" will be
1045
 
    reachable via two interfaces: "org.example.Interface" and
1046
 
    "net.example.AlternateInterface", the latter of which will have
1047
 
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1048
 
    "true", unless "deprecate" is passed with a False value.
1049
 
    
1050
 
    This works for methods and signals, and also for D-Bus properties
1051
 
    (from DBusObjectWithProperties) and interfaces (from the
1052
 
    dbus_interface_annotations decorator).
 
900
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
 
901
                                  .__metaclass__):
 
902
    """Applied to an empty subclass of a D-Bus object, this metaclass
 
903
    will add additional D-Bus attributes matching a certain pattern.
1053
904
    """
1054
 
    def wrapper(cls):
1055
 
        for orig_interface_name, alt_interface_name in (
1056
 
            alt_interface_names.iteritems()):
1057
 
            attr = {}
1058
 
            interface_names = set()
1059
 
            # Go though all attributes of the class
1060
 
            for attrname, attribute in inspect.getmembers(cls):
 
905
    def __new__(mcs, name, bases, attr):
 
906
        # Go through all the base classes which could have D-Bus
 
907
        # methods, signals, or properties in them
 
908
        for base in (b for b in bases
 
909
                     if issubclass(b, dbus.service.Object)):
 
910
            # Go though all attributes of the base class
 
911
            for attrname, attribute in inspect.getmembers(base):
1061
912
                # Ignore non-D-Bus attributes, and D-Bus attributes
1062
913
                # with the wrong interface name
1063
914
                if (not hasattr(attribute, "_dbus_interface")
1064
915
                    or not attribute._dbus_interface
1065
 
                    .startswith(orig_interface_name)):
 
916
                    .startswith("se.recompile.Mandos")):
1066
917
                    continue
1067
918
                # Create an alternate D-Bus interface name based on
1068
919
                # the current name
1069
920
                alt_interface = (attribute._dbus_interface
1070
 
                                 .replace(orig_interface_name,
1071
 
                                          alt_interface_name))
1072
 
                interface_names.add(alt_interface)
 
921
                                 .replace("se.recompile.Mandos",
 
922
                                          "se.bsnet.fukt.Mandos"))
1073
923
                # Is this a D-Bus signal?
1074
924
                if getattr(attribute, "_dbus_is_signal", False):
1075
925
                    # Extract the original non-method function by
1090
940
                                nonmethod_func.func_name,
1091
941
                                nonmethod_func.func_defaults,
1092
942
                                nonmethod_func.func_closure)))
1093
 
                    # Copy annotations, if any
1094
 
                    try:
1095
 
                        new_function._dbus_annotations = (
1096
 
                            dict(attribute._dbus_annotations))
1097
 
                    except AttributeError:
1098
 
                        pass
1099
943
                    # Define a creator of a function to call both the
1100
 
                    # original and alternate functions, so both the
1101
 
                    # original and alternate signals gets sent when
1102
 
                    # the function is called
 
944
                    # old and new functions, so both the old and new
 
945
                    # signals gets sent when the function is called
1103
946
                    def fixscope(func1, func2):
1104
947
                        """This function is a scope container to pass
1105
948
                        func1 and func2 to the "call_both" function
1112
955
                        return call_both
1113
956
                    # Create the "call_both" function and add it to
1114
957
                    # the class
1115
 
                    attr[attrname] = fixscope(attribute, new_function)
 
958
                    attr[attrname] = fixscope(attribute,
 
959
                                              new_function)
1116
960
                # Is this a D-Bus method?
1117
961
                elif getattr(attribute, "_dbus_is_method", False):
1118
962
                    # Create a new, but exactly alike, function
1129
973
                                        attribute.func_name,
1130
974
                                        attribute.func_defaults,
1131
975
                                        attribute.func_closure)))
1132
 
                    # Copy annotations, if any
1133
 
                    try:
1134
 
                        attr[attrname]._dbus_annotations = (
1135
 
                            dict(attribute._dbus_annotations))
1136
 
                    except AttributeError:
1137
 
                        pass
1138
976
                # Is this a D-Bus property?
1139
977
                elif getattr(attribute, "_dbus_is_property", False):
1140
978
                    # Create a new, but exactly alike, function
1154
992
                                        attribute.func_name,
1155
993
                                        attribute.func_defaults,
1156
994
                                        attribute.func_closure)))
1157
 
                    # Copy annotations, if any
1158
 
                    try:
1159
 
                        attr[attrname]._dbus_annotations = (
1160
 
                            dict(attribute._dbus_annotations))
1161
 
                    except AttributeError:
1162
 
                        pass
1163
 
                # Is this a D-Bus interface?
1164
 
                elif getattr(attribute, "_dbus_is_interface", False):
1165
 
                    # Create a new, but exactly alike, function
1166
 
                    # object.  Decorate it to be a new D-Bus interface
1167
 
                    # with the alternate D-Bus interface name.  Add it
1168
 
                    # to the class.
1169
 
                    attr[attrname] = (dbus_interface_annotations
1170
 
                                      (alt_interface)
1171
 
                                      (types.FunctionType
1172
 
                                       (attribute.func_code,
1173
 
                                        attribute.func_globals,
1174
 
                                        attribute.func_name,
1175
 
                                        attribute.func_defaults,
1176
 
                                        attribute.func_closure)))
1177
 
            if deprecate:
1178
 
                # Deprecate all alternate interfaces
1179
 
                iname="_AlternateDBusNames_interface_annotation{0}"
1180
 
                for interface_name in interface_names:
1181
 
                    @dbus_interface_annotations(interface_name)
1182
 
                    def func(self):
1183
 
                        return { "org.freedesktop.DBus.Deprecated":
1184
 
                                     "true" }
1185
 
                    # Find an unused name
1186
 
                    for aname in (iname.format(i)
1187
 
                                  for i in itertools.count()):
1188
 
                        if aname not in attr:
1189
 
                            attr[aname] = func
1190
 
                            break
1191
 
            if interface_names:
1192
 
                # Replace the class with a new subclass of it with
1193
 
                # methods, signals, etc. as created above.
1194
 
                cls = type(b"{0}Alternate".format(cls.__name__),
1195
 
                           (cls,), attr)
1196
 
        return cls
1197
 
    return wrapper
1198
 
 
1199
 
 
1200
 
@alternate_dbus_interfaces({"se.recompile.Mandos":
1201
 
                                "se.bsnet.fukt.Mandos"})
 
995
        return type.__new__(mcs, name, bases, attr)
 
996
 
 
997
 
1202
998
class ClientDBus(Client, DBusObjectWithProperties):
1203
999
    """A Client class using D-Bus
1204
1000
    
1215
1011
    def __init__(self, bus = None, *args, **kwargs):
1216
1012
        self.bus = bus
1217
1013
        Client.__init__(self, *args, **kwargs)
 
1014
        
 
1015
        self._approvals_pending = 0
1218
1016
        # Only now, when this client is initialized, can it show up on
1219
1017
        # the D-Bus
1220
1018
        client_object_name = unicode(self.name).translate(
1224
1022
                                 ("/clients/" + client_object_name))
1225
1023
        DBusObjectWithProperties.__init__(self, self.bus,
1226
1024
                                          self.dbus_object_path)
1227
 
    
 
1025
        
1228
1026
    def notifychangeproperty(transform_func,
1229
1027
                             dbus_name, type_func=lambda x: x,
1230
1028
                             variant_level=1):
1253
1051
        
1254
1052
        return property(lambda self: getattr(self, attrname), setter)
1255
1053
    
 
1054
    
1256
1055
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1257
1056
    approvals_pending = notifychangeproperty(dbus.Boolean,
1258
1057
                                             "ApprovalPending",
1265
1064
                                       checker is not None)
1266
1065
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1267
1066
                                           "LastCheckedOK")
1268
 
    last_checker_status = notifychangeproperty(dbus.Int16,
1269
 
                                               "LastCheckerStatus")
1270
1067
    last_approval_request = notifychangeproperty(
1271
1068
        datetime_to_dbus, "LastApprovalRequest")
1272
1069
    approved_by_default = notifychangeproperty(dbus.Boolean,
1273
1070
                                               "ApprovedByDefault")
1274
 
    approval_delay = notifychangeproperty(dbus.UInt64,
 
1071
    approval_delay = notifychangeproperty(dbus.UInt16,
1275
1072
                                          "ApprovalDelay",
1276
1073
                                          type_func =
1277
 
                                          timedelta_to_milliseconds)
 
1074
                                          _timedelta_to_milliseconds)
1278
1075
    approval_duration = notifychangeproperty(
1279
 
        dbus.UInt64, "ApprovalDuration",
1280
 
        type_func = timedelta_to_milliseconds)
 
1076
        dbus.UInt16, "ApprovalDuration",
 
1077
        type_func = _timedelta_to_milliseconds)
1281
1078
    host = notifychangeproperty(dbus.String, "Host")
1282
 
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
 
1079
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1283
1080
                                   type_func =
1284
 
                                   timedelta_to_milliseconds)
 
1081
                                   _timedelta_to_milliseconds)
1285
1082
    extended_timeout = notifychangeproperty(
1286
 
        dbus.UInt64, "ExtendedTimeout",
1287
 
        type_func = timedelta_to_milliseconds)
1288
 
    interval = notifychangeproperty(dbus.UInt64,
 
1083
        dbus.UInt16, "ExtendedTimeout",
 
1084
        type_func = _timedelta_to_milliseconds)
 
1085
    interval = notifychangeproperty(dbus.UInt16,
1289
1086
                                    "Interval",
1290
1087
                                    type_func =
1291
 
                                    timedelta_to_milliseconds)
 
1088
                                    _timedelta_to_milliseconds)
1292
1089
    checker_command = notifychangeproperty(dbus.String, "Checker")
1293
1090
    
1294
1091
    del notifychangeproperty
1336
1133
        return r
1337
1134
    
1338
1135
    def _reset_approved(self):
1339
 
        self.approved = None
 
1136
        self._approved = None
1340
1137
        return False
1341
1138
    
1342
1139
    def approve(self, value=True):
1343
 
        self.approved = value
1344
 
        gobject.timeout_add(timedelta_to_milliseconds
 
1140
        self.send_changedstate()
 
1141
        self._approved = value
 
1142
        gobject.timeout_add(_timedelta_to_milliseconds
1345
1143
                            (self.approval_duration),
1346
1144
                            self._reset_approved)
1347
 
        self.send_changedstate()
 
1145
    
1348
1146
    
1349
1147
    ## D-Bus methods, signals & properties
1350
1148
    _interface = "se.recompile.Mandos.Client"
1351
1149
    
1352
 
    ## Interfaces
1353
 
    
1354
 
    @dbus_interface_annotations(_interface)
1355
 
    def _foo(self):
1356
 
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1357
 
                     "false"}
1358
 
    
1359
1150
    ## Signals
1360
1151
    
1361
1152
    # CheckerCompleted - signal
1397
1188
        "D-Bus signal"
1398
1189
        return self.need_approval()
1399
1190
    
 
1191
    # NeRwequest - signal
 
1192
    @dbus.service.signal(_interface, signature="s")
 
1193
    def NewRequest(self, ip):
 
1194
        """D-Bus signal
 
1195
        Is sent after a client request a password.
 
1196
        """
 
1197
        pass
 
1198
    
1400
1199
    ## Methods
1401
1200
    
1402
1201
    # Approve - method
1460
1259
                           access="readwrite")
1461
1260
    def ApprovalDuration_dbus_property(self, value=None):
1462
1261
        if value is None:       # get
1463
 
            return dbus.UInt64(timedelta_to_milliseconds(
 
1262
            return dbus.UInt64(_timedelta_to_milliseconds(
1464
1263
                    self.approval_duration))
1465
1264
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1466
1265
    
1480
1279
    def Host_dbus_property(self, value=None):
1481
1280
        if value is None:       # get
1482
1281
            return dbus.String(self.host)
1483
 
        self.host = unicode(value)
 
1282
        self.host = value
1484
1283
    
1485
1284
    # Created - property
1486
1285
    @dbus_service_property(_interface, signature="s", access="read")
1512
1311
            return
1513
1312
        return datetime_to_dbus(self.last_checked_ok)
1514
1313
    
1515
 
    # LastCheckerStatus - property
1516
 
    @dbus_service_property(_interface, signature="n",
1517
 
                           access="read")
1518
 
    def LastCheckerStatus_dbus_property(self):
1519
 
        return dbus.Int16(self.last_checker_status)
1520
 
    
1521
1314
    # Expires - property
1522
1315
    @dbus_service_property(_interface, signature="s", access="read")
1523
1316
    def Expires_dbus_property(self):
1534
1327
    def Timeout_dbus_property(self, value=None):
1535
1328
        if value is None:       # get
1536
1329
            return dbus.UInt64(self.timeout_milliseconds())
1537
 
        old_timeout = self.timeout
1538
1330
        self.timeout = datetime.timedelta(0, 0, 0, value)
1539
 
        # Reschedule disabling
1540
 
        if self.enabled:
1541
 
            now = datetime.datetime.utcnow()
1542
 
            self.expires += self.timeout - old_timeout
1543
 
            if self.expires <= now:
1544
 
                # The timeout has passed
1545
 
                self.disable()
1546
 
            else:
1547
 
                if (getattr(self, "disable_initiator_tag", None)
1548
 
                    is None):
1549
 
                    return
1550
 
                gobject.source_remove(self.disable_initiator_tag)
1551
 
                self.disable_initiator_tag = (
1552
 
                    gobject.timeout_add(
1553
 
                        timedelta_to_milliseconds(self.expires - now),
1554
 
                        self.disable))
 
1331
        if getattr(self, "disable_initiator_tag", None) is None:
 
1332
            return
 
1333
        # Reschedule timeout
 
1334
        gobject.source_remove(self.disable_initiator_tag)
 
1335
        self.disable_initiator_tag = None
 
1336
        self.expires = None
 
1337
        time_to_die = _timedelta_to_milliseconds((self
 
1338
                                                  .last_checked_ok
 
1339
                                                  + self.timeout)
 
1340
                                                 - datetime.datetime
 
1341
                                                 .utcnow())
 
1342
        if time_to_die <= 0:
 
1343
            # The timeout has passed
 
1344
            self.disable()
 
1345
        else:
 
1346
            self.expires = (datetime.datetime.utcnow()
 
1347
                            + datetime.timedelta(milliseconds =
 
1348
                                                 time_to_die))
 
1349
            self.disable_initiator_tag = (gobject.timeout_add
 
1350
                                          (time_to_die, self.disable))
1555
1351
    
1556
1352
    # ExtendedTimeout - property
1557
1353
    @dbus_service_property(_interface, signature="t",
1583
1379
    def Checker_dbus_property(self, value=None):
1584
1380
        if value is None:       # get
1585
1381
            return dbus.String(self.checker_command)
1586
 
        self.checker_command = unicode(value)
 
1382
        self.checker_command = value
1587
1383
    
1588
1384
    # CheckerRunning - property
1589
1385
    @dbus_service_property(_interface, signature="b",
1618
1414
            raise KeyError()
1619
1415
    
1620
1416
    def __getattribute__(self, name):
1621
 
        if name == '_pipe':
 
1417
        if(name == '_pipe'):
1622
1418
            return super(ProxyClient, self).__getattribute__(name)
1623
1419
        self._pipe.send(('getattr', name))
1624
1420
        data = self._pipe.recv()
1631
1427
            return func
1632
1428
    
1633
1429
    def __setattr__(self, name, value):
1634
 
        if name == '_pipe':
 
1430
        if(name == '_pipe'):
1635
1431
            return super(ProxyClient, self).__setattr__(name, value)
1636
1432
        self._pipe.send(('setattr', name, value))
1637
1433
 
1638
1434
 
 
1435
class ClientDBusTransitional(ClientDBus):
 
1436
    __metaclass__ = AlternateDBusNamesMetaclass
 
1437
 
 
1438
 
1639
1439
class ClientHandler(socketserver.BaseRequestHandler, object):
1640
1440
    """A class to handle client connections.
1641
1441
    
1702
1502
                    logger.warning("Bad certificate: %s", error)
1703
1503
                    return
1704
1504
                logger.debug("Fingerprint: %s", fpr)
 
1505
                if self.server.use_dbus:
 
1506
                    # Emit D-Bus signal
 
1507
                    client.NewRequest(str(self.client_address))
1705
1508
                
1706
1509
                try:
1707
1510
                    client = ProxyClient(child_pipe, fpr,
1723
1526
                            client.Rejected("Disabled")
1724
1527
                        return
1725
1528
                    
1726
 
                    if client.approved or not client.approval_delay:
 
1529
                    if client._approved or not client.approval_delay:
1727
1530
                        #We are approved or approval is disabled
1728
1531
                        break
1729
 
                    elif client.approved is None:
 
1532
                    elif client._approved is None:
1730
1533
                        logger.info("Client %s needs approval",
1731
1534
                                    client.name)
1732
1535
                        if self.server.use_dbus:
1745
1548
                    #wait until timeout or approved
1746
1549
                    time = datetime.datetime.now()
1747
1550
                    client.changedstate.acquire()
1748
 
                    client.changedstate.wait(
1749
 
                        float(timedelta_to_milliseconds(delay)
1750
 
                              / 1000))
 
1551
                    (client.changedstate.wait
 
1552
                     (float(client._timedelta_to_milliseconds(delay)
 
1553
                            / 1000)))
1751
1554
                    client.changedstate.release()
1752
1555
                    time2 = datetime.datetime.now()
1753
1556
                    if (time2 - time) >= delay:
1769
1572
                    try:
1770
1573
                        sent = session.send(client.secret[sent_size:])
1771
1574
                    except gnutls.errors.GNUTLSError as error:
1772
 
                        logger.warning("gnutls send failed",
1773
 
                                       exc_info=error)
 
1575
                        logger.warning("gnutls send failed")
1774
1576
                        return
1775
1577
                    logger.debug("Sent: %d, remaining: %d",
1776
1578
                                 sent, len(client.secret)
1779
1581
                
1780
1582
                logger.info("Sending secret to %s", client.name)
1781
1583
                # bump the timeout using extended_timeout
1782
 
                client.bump_timeout(client.extended_timeout)
 
1584
                client.checked_ok(client.extended_timeout)
1783
1585
                if self.server.use_dbus:
1784
1586
                    # Emit D-Bus signal
1785
1587
                    client.GotSecret()
1790
1592
                try:
1791
1593
                    session.bye()
1792
1594
                except gnutls.errors.GNUTLSError as error:
1793
 
                    logger.warning("GnuTLS bye failed",
1794
 
                                   exc_info=error)
 
1595
                    logger.warning("GnuTLS bye failed")
1795
1596
    
1796
1597
    @staticmethod
1797
1598
    def peer_certificate(session):
1862
1663
    def sub_process_main(self, request, address):
1863
1664
        try:
1864
1665
            self.finish_request(request, address)
1865
 
        except Exception:
 
1666
        except:
1866
1667
            self.handle_error(request, address)
1867
1668
        self.close_request(request)
1868
1669
    
1869
1670
    def process_request(self, request, address):
1870
1671
        """Start a new process to process the request."""
1871
1672
        proc = multiprocessing.Process(target = self.sub_process_main,
1872
 
                                       args = (request, address))
 
1673
                                       args = (request,
 
1674
                                               address))
1873
1675
        proc.start()
1874
1676
        return proc
1875
1677
 
1997
1799
    
1998
1800
    def handle_ipc(self, source, condition, parent_pipe=None,
1999
1801
                   proc = None, client_object=None):
 
1802
        condition_names = {
 
1803
            gobject.IO_IN: "IN",   # There is data to read.
 
1804
            gobject.IO_OUT: "OUT", # Data can be written (without
 
1805
                                    # blocking).
 
1806
            gobject.IO_PRI: "PRI", # There is urgent data to read.
 
1807
            gobject.IO_ERR: "ERR", # Error condition.
 
1808
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
 
1809
                                    # broken, usually for pipes and
 
1810
                                    # sockets).
 
1811
            }
 
1812
        conditions_string = ' | '.join(name
 
1813
                                       for cond, name in
 
1814
                                       condition_names.iteritems()
 
1815
                                       if cond & condition)
2000
1816
        # error, or the other end of multiprocessing.Pipe has closed
2001
 
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
 
1817
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2002
1818
            # Wait for other process to exit
2003
1819
            proc.join()
2004
1820
            return False
2094
1910
            elif suffix == "w":
2095
1911
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2096
1912
            else:
2097
 
                raise ValueError("Unknown suffix {0!r}"
2098
 
                                 .format(suffix))
 
1913
                raise ValueError("Unknown suffix %r" % suffix)
2099
1914
        except (ValueError, IndexError) as e:
2100
1915
            raise ValueError(*(e.args))
2101
1916
        timevalue += delta
2115
1930
        sys.exit()
2116
1931
    if not noclose:
2117
1932
        # Close all standard open file descriptors
2118
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
1933
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2119
1934
        if not stat.S_ISCHR(os.fstat(null).st_mode):
2120
1935
            raise OSError(errno.ENODEV,
2121
 
                          "{0} not a character device"
2122
 
                          .format(os.devnull))
 
1936
                          "%s not a character device"
 
1937
                          % os.path.devnull)
2123
1938
        os.dup2(null, sys.stdin.fileno())
2124
1939
        os.dup2(null, sys.stdout.fileno())
2125
1940
        os.dup2(null, sys.stderr.fileno())
2134
1949
    
2135
1950
    parser = argparse.ArgumentParser()
2136
1951
    parser.add_argument("-v", "--version", action="version",
2137
 
                        version = "%(prog)s {0}".format(version),
 
1952
                        version = "%%(prog)s %s" % version,
2138
1953
                        help="show version number and exit")
2139
1954
    parser.add_argument("-i", "--interface", metavar="IF",
2140
1955
                        help="Bind to interface IF")
2233
2048
                                     stored_state_file)
2234
2049
    
2235
2050
    if debug:
2236
 
        initlogger(debug, logging.DEBUG)
 
2051
        initlogger(logging.DEBUG)
2237
2052
    else:
2238
2053
        if not debuglevel:
2239
 
            initlogger(debug)
 
2054
            initlogger()
2240
2055
        else:
2241
2056
            level = getattr(logging, debuglevel.upper())
2242
 
            initlogger(debug, level)
 
2057
            initlogger(level)
2243
2058
    
2244
2059
    if server_settings["servicename"] != "Mandos":
2245
2060
        syslogger.setFormatter(logging.Formatter
2246
 
                               ('Mandos ({0}) [%(process)d]:'
2247
 
                                ' %(levelname)s: %(message)s'
2248
 
                                .format(server_settings
2249
 
                                        ["servicename"])))
 
2061
                               ('Mandos (%s) [%%(process)d]:'
 
2062
                                ' %%(levelname)s: %%(message)s'
 
2063
                                % server_settings["servicename"]))
2250
2064
    
2251
2065
    # Parse config file with clients
2252
 
    client_config = configparser.SafeConfigParser(Client
2253
 
                                                  .client_defaults)
 
2066
    client_defaults = { "timeout": "5m",
 
2067
                        "extended_timeout": "15m",
 
2068
                        "interval": "2m",
 
2069
                        "checker": "fping -q -- %%(host)s",
 
2070
                        "host": "",
 
2071
                        "approval_delay": "0s",
 
2072
                        "approval_duration": "1s",
 
2073
                        }
 
2074
    client_config = configparser.SafeConfigParser(client_defaults)
2254
2075
    client_config.read(os.path.join(server_settings["configdir"],
2255
2076
                                    "clients.conf"))
2256
2077
    
2270
2091
        pidfilename = "/var/run/mandos.pid"
2271
2092
        try:
2272
2093
            pidfile = open(pidfilename, "w")
2273
 
        except IOError as e:
2274
 
            logger.error("Could not open file %r", pidfilename,
2275
 
                         exc_info=e)
 
2094
        except IOError:
 
2095
            logger.error("Could not open file %r", pidfilename)
2276
2096
    
2277
 
    for name in ("_mandos", "mandos", "nobody"):
 
2097
    try:
 
2098
        uid = pwd.getpwnam("_mandos").pw_uid
 
2099
        gid = pwd.getpwnam("_mandos").pw_gid
 
2100
    except KeyError:
2278
2101
        try:
2279
 
            uid = pwd.getpwnam(name).pw_uid
2280
 
            gid = pwd.getpwnam(name).pw_gid
2281
 
            break
 
2102
            uid = pwd.getpwnam("mandos").pw_uid
 
2103
            gid = pwd.getpwnam("mandos").pw_gid
2282
2104
        except KeyError:
2283
 
            continue
2284
 
    else:
2285
 
        uid = 65534
2286
 
        gid = 65534
 
2105
            try:
 
2106
                uid = pwd.getpwnam("nobody").pw_uid
 
2107
                gid = pwd.getpwnam("nobody").pw_gid
 
2108
            except KeyError:
 
2109
                uid = 65534
 
2110
                gid = 65534
2287
2111
    try:
2288
2112
        os.setgid(gid)
2289
2113
        os.setuid(uid)
2306
2130
         .gnutls_global_set_log_function(debug_gnutls))
2307
2131
        
2308
2132
        # Redirect stdin so all checkers get /dev/null
2309
 
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
 
2133
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2310
2134
        os.dup2(null, sys.stdin.fileno())
2311
2135
        if null > 2:
2312
2136
            os.close(null)
 
2137
    else:
 
2138
        # No console logging
 
2139
        logger.removeHandler(console)
2313
2140
    
2314
2141
    # Need to fork before connecting to D-Bus
2315
2142
    if not debug:
2316
2143
        # Close all input and output, do double fork, etc.
2317
2144
        daemon()
2318
2145
    
2319
 
    gobject.threads_init()
2320
 
    
2321
2146
    global main_loop
2322
2147
    # From the Avahi example code
2323
 
    DBusGMainLoop(set_as_default=True)
 
2148
    DBusGMainLoop(set_as_default=True )
2324
2149
    main_loop = gobject.MainLoop()
2325
2150
    bus = dbus.SystemBus()
2326
2151
    # End of Avahi example code
2332
2157
                            ("se.bsnet.fukt.Mandos", bus,
2333
2158
                             do_not_queue=True))
2334
2159
        except dbus.exceptions.NameExistsException as e:
2335
 
            logger.error("Disabling D-Bus:", exc_info=e)
 
2160
            logger.error(unicode(e) + ", disabling D-Bus")
2336
2161
            use_dbus = False
2337
2162
            server_settings["use_dbus"] = False
2338
2163
            tcp_server.use_dbus = False
2350
2175
    
2351
2176
    client_class = Client
2352
2177
    if use_dbus:
2353
 
        client_class = functools.partial(ClientDBus, bus = bus)
2354
 
    
2355
 
    client_settings = Client.config_parser(client_config)
 
2178
        client_class = functools.partial(ClientDBusTransitional,
 
2179
                                         bus = bus)
 
2180
    
 
2181
    special_settings = {
 
2182
        # Some settings need to be accessd by special methods;
 
2183
        # booleans need .getboolean(), etc.  Here is a list of them:
 
2184
        "approved_by_default":
 
2185
            lambda section:
 
2186
            client_config.getboolean(section, "approved_by_default"),
 
2187
        "enabled":
 
2188
            lambda section:
 
2189
            client_config.getboolean(section, "enabled"),
 
2190
        }
 
2191
    # Construct a new dict of client settings of this form:
 
2192
    # { client_name: {setting_name: value, ...}, ...}
 
2193
    # with exceptions for any special settings as defined above
 
2194
    client_settings = dict((clientname,
 
2195
                           dict((setting,
 
2196
                                 (value
 
2197
                                  if setting not in special_settings
 
2198
                                  else special_settings[setting]
 
2199
                                  (clientname)))
 
2200
                                for setting, value in
 
2201
                                client_config.items(clientname)))
 
2202
                          for clientname in client_config.sections())
 
2203
    
2356
2204
    old_client_settings = {}
2357
 
    clients_data = {}
 
2205
    clients_data = []
2358
2206
    
2359
2207
    # Get client data and settings from last running state.
2360
2208
    if server_settings["restore"]:
2364
2212
                                                     (stored_state))
2365
2213
            os.remove(stored_state_path)
2366
2214
        except IOError as e:
2367
 
            if e.errno == errno.ENOENT:
2368
 
                logger.warning("Could not load persistent state: {0}"
2369
 
                                .format(os.strerror(e.errno)))
2370
 
            else:
2371
 
                logger.critical("Could not load persistent state:",
2372
 
                                exc_info=e)
 
2215
            logger.warning("Could not load persistent state: {0}"
 
2216
                           .format(e))
 
2217
            if e.errno != errno.ENOENT:
2373
2218
                raise
2374
 
        except EOFError as e:
2375
 
            logger.warning("Could not load persistent state: "
2376
 
                           "EOFError:", exc_info=e)
2377
2219
    
2378
 
    with PGPEngine() as pgp:
2379
 
        for client_name, client in clients_data.iteritems():
 
2220
    with Crypto() as crypt:
 
2221
        for client in clients_data:
 
2222
            client_name = client["name"]
 
2223
            
2380
2224
            # Decide which value to use after restoring saved state.
2381
2225
            # We have three different values: Old config file,
2382
2226
            # new config file, and saved state.
2390
2234
                    if (name != "secret" and
2391
2235
                        value != old_client_settings[client_name]
2392
2236
                        [name]):
2393
 
                        client[name] = value
 
2237
                        setattr(client, name, value)
2394
2238
                except KeyError:
2395
2239
                    pass
2396
2240
            
2397
2241
            # Clients who has passed its expire date can still be
2398
 
            # enabled if its last checker was successful.  Clients
2399
 
            # whose checker succeeded before we stored its state is
2400
 
            # assumed to have successfully run all checkers during
2401
 
            # downtime.
2402
 
            if client["enabled"]:
2403
 
                if datetime.datetime.utcnow() >= client["expires"]:
2404
 
                    if not client["last_checked_ok"]:
2405
 
                        logger.warning(
2406
 
                            "disabling client {0} - Client never "
2407
 
                            "performed a successful checker"
2408
 
                            .format(client_name))
2409
 
                        client["enabled"] = False
2410
 
                    elif client["last_checker_status"] != 0:
2411
 
                        logger.warning(
2412
 
                            "disabling client {0} - Client "
2413
 
                            "last checker failed with error code {1}"
2414
 
                            .format(client_name,
2415
 
                                    client["last_checker_status"]))
 
2242
            # enabled if its last checker was sucessful.  Clients
 
2243
            # whose checker failed before we stored its state is
 
2244
            # assumed to have failed all checkers during downtime.
 
2245
            if client["enabled"] and client["last_checked_ok"]:
 
2246
                if ((datetime.datetime.utcnow()
 
2247
                     - client["last_checked_ok"])
 
2248
                    > client["interval"]):
 
2249
                    if client["last_checker_status"] != 0:
2416
2250
                        client["enabled"] = False
2417
2251
                    else:
2418
2252
                        client["expires"] = (datetime.datetime
2419
2253
                                             .utcnow()
2420
2254
                                             + client["timeout"])
2421
 
                        logger.debug("Last checker succeeded,"
2422
 
                                     " keeping {0} enabled"
2423
 
                                     .format(client_name))
 
2255
            
 
2256
            client["changedstate"] = (multiprocessing_manager
 
2257
                                      .Condition
 
2258
                                      (multiprocessing_manager
 
2259
                                       .Lock()))
 
2260
            if use_dbus:
 
2261
                new_client = (ClientDBusTransitional.__new__
 
2262
                              (ClientDBusTransitional))
 
2263
                tcp_server.clients[client_name] = new_client
 
2264
                new_client.bus = bus
 
2265
                for name, value in client.iteritems():
 
2266
                    setattr(new_client, name, value)
 
2267
                client_object_name = unicode(client_name).translate(
 
2268
                    {ord("."): ord("_"),
 
2269
                     ord("-"): ord("_")})
 
2270
                new_client.dbus_object_path = (dbus.ObjectPath
 
2271
                                               ("/clients/"
 
2272
                                                + client_object_name))
 
2273
                DBusObjectWithProperties.__init__(new_client,
 
2274
                                                  new_client.bus,
 
2275
                                                  new_client
 
2276
                                                  .dbus_object_path)
 
2277
            else:
 
2278
                tcp_server.clients[client_name] = (Client.__new__
 
2279
                                                   (Client))
 
2280
                for name, value in client.iteritems():
 
2281
                    setattr(tcp_server.clients[client_name],
 
2282
                            name, value)
 
2283
            
2424
2284
            try:
2425
 
                client["secret"] = (
2426
 
                    pgp.decrypt(client["encrypted_secret"],
2427
 
                                client_settings[client_name]
2428
 
                                ["secret"]))
2429
 
            except PGPError:
 
2285
                tcp_server.clients[client_name].secret = (
 
2286
                    crypt.decrypt(tcp_server.clients[client_name]
 
2287
                                  .encrypted_secret,
 
2288
                                  client_settings[client_name]
 
2289
                                  ["secret"]))
 
2290
            except CryptoError:
2430
2291
                # If decryption fails, we use secret from new settings
2431
 
                logger.debug("Failed to decrypt {0} old secret"
2432
 
                             .format(client_name))
2433
 
                client["secret"] = (
 
2292
                tcp_server.clients[client_name].secret = (
2434
2293
                    client_settings[client_name]["secret"])
2435
2294
    
2436
 
    # Add/remove clients based on new changes made to config
2437
 
    for client_name in (set(old_client_settings)
2438
 
                        - set(client_settings)):
2439
 
        del clients_data[client_name]
2440
 
    for client_name in (set(client_settings)
2441
 
                        - set(old_client_settings)):
2442
 
        clients_data[client_name] = client_settings[client_name]
2443
 
    
2444
 
    # Create all client objects
2445
 
    for client_name, client in clients_data.iteritems():
2446
 
        tcp_server.clients[client_name] = client_class(
2447
 
            name = client_name, settings = client)
 
2295
    # Create/remove clients based on new changes made to config
 
2296
    for clientname in set(old_client_settings) - set(client_settings):
 
2297
        del tcp_server.clients[clientname]
 
2298
    for clientname in set(client_settings) - set(old_client_settings):
 
2299
        tcp_server.clients[clientname] = (client_class(name
 
2300
                                                       = clientname,
 
2301
                                                       config =
 
2302
                                                       client_settings
 
2303
                                                       [clientname]))
2448
2304
    
2449
2305
    if not tcp_server.clients:
2450
2306
        logger.warning("No clients defined")
2451
 
    
 
2307
        
2452
2308
    if not debug:
2453
2309
        try:
2454
2310
            with pidfile:
2462
2318
            # "pidfile" was never created
2463
2319
            pass
2464
2320
        del pidfilename
 
2321
        
2465
2322
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2466
2323
    
2467
2324
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2468
2325
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2469
2326
    
2470
2327
    if use_dbus:
2471
 
        @alternate_dbus_interfaces({"se.recompile.Mandos":
2472
 
                                        "se.bsnet.fukt.Mandos"})
2473
 
        class MandosDBusService(DBusObjectWithProperties):
 
2328
        class MandosDBusService(dbus.service.Object):
2474
2329
            """A D-Bus proxy object"""
2475
2330
            def __init__(self):
2476
2331
                dbus.service.Object.__init__(self, bus, "/")
2477
2332
            _interface = "se.recompile.Mandos"
2478
2333
            
2479
 
            @dbus_interface_annotations(_interface)
2480
 
            def _foo(self):
2481
 
                return { "org.freedesktop.DBus.Property"
2482
 
                         ".EmitsChangedSignal":
2483
 
                             "false"}
2484
 
            
2485
2334
            @dbus.service.signal(_interface, signature="o")
2486
2335
            def ClientAdded(self, objpath):
2487
2336
                "D-Bus signal"
2529
2378
            
2530
2379
            del _interface
2531
2380
        
2532
 
        mandos_dbus_service = MandosDBusService()
 
2381
        class MandosDBusServiceTransitional(MandosDBusService):
 
2382
            __metaclass__ = AlternateDBusNamesMetaclass
 
2383
        mandos_dbus_service = MandosDBusServiceTransitional()
2533
2384
    
2534
2385
    def cleanup():
2535
2386
        "Cleanup function; run on exit"
2542
2393
        # Store client before exiting. Secrets are encrypted with key
2543
2394
        # based on what config file has. If config file is
2544
2395
        # removed/edited, old secret will thus be unrecovable.
2545
 
        clients = {}
2546
 
        with PGPEngine() as pgp:
 
2396
        clients = []
 
2397
        with Crypto() as crypt:
2547
2398
            for client in tcp_server.clients.itervalues():
2548
2399
                key = client_settings[client.name]["secret"]
2549
 
                client.encrypted_secret = pgp.encrypt(client.secret,
2550
 
                                                      key)
 
2400
                client.encrypted_secret = crypt.encrypt(client.secret,
 
2401
                                                        key)
2551
2402
                client_dict = {}
2552
2403
                
2553
 
                # A list of attributes that can not be pickled
2554
 
                # + secret.
2555
 
                exclude = set(("bus", "changedstate", "secret",
2556
 
                               "checker"))
 
2404
                # A list of attributes that will not be stored when
 
2405
                # shutting down.
 
2406
                exclude = set(("bus", "changedstate", "secret"))
2557
2407
                for name, typ in (inspect.getmembers
2558
2408
                                  (dbus.service.Object)):
2559
2409
                    exclude.add(name)
2564
2414
                    if attr not in exclude:
2565
2415
                        client_dict[attr] = getattr(client, attr)
2566
2416
                
2567
 
                clients[client.name] = client_dict
 
2417
                clients.append(client_dict)
2568
2418
                del client_settings[client.name]["secret"]
2569
2419
        
2570
2420
        try:
2571
 
            with (tempfile.NamedTemporaryFile
2572
 
                  (mode='wb', suffix=".pickle", prefix='clients-',
2573
 
                   dir=os.path.dirname(stored_state_path),
2574
 
                   delete=False)) as stored_state:
 
2421
            with os.fdopen(os.open(stored_state_path,
 
2422
                                   os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
 
2423
                                   0600), "wb") as stored_state:
2575
2424
                pickle.dump((clients, client_settings), stored_state)
2576
 
                tempname=stored_state.name
2577
 
            os.rename(tempname, stored_state_path)
2578
2425
        except (IOError, OSError) as e:
2579
 
            if not debug:
2580
 
                try:
2581
 
                    os.remove(tempname)
2582
 
                except NameError:
2583
 
                    pass
2584
 
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2585
 
                logger.warning("Could not save persistent state: {0}"
2586
 
                               .format(os.strerror(e.errno)))
2587
 
            else:
2588
 
                logger.warning("Could not save persistent state:",
2589
 
                               exc_info=e)
2590
 
                raise e
 
2426
            logger.warning("Could not save persistent state: {0}"
 
2427
                           .format(e))
 
2428
            if e.errno not in (errno.ENOENT, errno.EACCES):
 
2429
                raise
2591
2430
        
2592
2431
        # Delete all clients, and settings from config
2593
2432
        while tcp_server.clients:
2620
2459
    service.port = tcp_server.socket.getsockname()[1]
2621
2460
    if use_ipv6:
2622
2461
        logger.info("Now listening on address %r, port %d,"
2623
 
                    " flowinfo %d, scope_id %d",
2624
 
                    *tcp_server.socket.getsockname())
 
2462
                    " flowinfo %d, scope_id %d"
 
2463
                    % tcp_server.socket.getsockname())
2625
2464
    else:                       # IPv4
2626
 
        logger.info("Now listening on address %r, port %d",
2627
 
                    *tcp_server.socket.getsockname())
 
2465
        logger.info("Now listening on address %r, port %d"
 
2466
                    % tcp_server.socket.getsockname())
2628
2467
    
2629
2468
    #service.interface = tcp_server.socket.getsockname()[3]
2630
2469
    
2633
2472
        try:
2634
2473
            service.activate()
2635
2474
        except dbus.exceptions.DBusException as error:
2636
 
            logger.critical("D-Bus Exception", exc_info=error)
 
2475
            logger.critical("DBusException: %s", error)
2637
2476
            cleanup()
2638
2477
            sys.exit(1)
2639
2478
        # End of Avahi example code
2646
2485
        logger.debug("Starting main loop")
2647
2486
        main_loop.run()
2648
2487
    except AvahiError as error:
2649
 
        logger.critical("Avahi Error", exc_info=error)
 
2488
        logger.critical("AvahiError: %s", error)
2650
2489
        cleanup()
2651
2490
        sys.exit(1)
2652
2491
    except KeyboardInterrupt:
2657
2496
    # Must run before the D-Bus bus name gets deregistered
2658
2497
    cleanup()
2659
2498
 
 
2499
 
2660
2500
if __name__ == '__main__':
2661
2501
    main()