/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

  • Committer: Teddy Hogeborn
  • Date: 2012-06-24 03:45:55 UTC
  • mto: (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 303.
  • Revision ID: teddy@recompile.se-20120624034555-7p0dtbpsz0dgsn4d
* mandos (Client.start_checker): Add comment.  Break long line.

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
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
65
67
import types
66
68
import binascii
67
69
import tempfile
 
70
import itertools
 
71
import collections
68
72
 
69
73
import dbus
70
74
import dbus.service
85
89
    except ImportError:
86
90
        SO_BINDTODEVICE = None
87
91
 
88
 
 
89
 
version = "1.4.1"
 
92
version = "1.6.0"
90
93
stored_state_file = "clients.pickle"
91
94
 
92
95
logger = logging.getLogger()
111
114
        return interface_index
112
115
 
113
116
 
114
 
def initlogger(level=logging.WARNING):
 
117
def initlogger(debug, level=logging.WARNING):
115
118
    """init logger and add loglevel"""
116
119
    
117
120
    syslogger.setFormatter(logging.Formatter
119
122
                            ' %(message)s'))
120
123
    logger.addHandler(syslogger)
121
124
    
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)
 
125
    if debug:
 
126
        console = logging.StreamHandler()
 
127
        console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
 
128
                                               ' [%(process)d]:'
 
129
                                               ' %(levelname)s:'
 
130
                                               ' %(message)s'))
 
131
        logger.addHandler(console)
128
132
    logger.setLevel(level)
129
133
 
130
134
 
142
146
        self.gnupg.options.meta_interactive = False
143
147
        self.gnupg.options.homedir = self.tempdir
144
148
        self.gnupg.options.extra_args.extend(['--force-mdc',
145
 
                                              '--quiet'])
 
149
                                              '--quiet',
 
150
                                              '--no-use-agent'])
146
151
    
147
152
    def __enter__(self):
148
153
        return self
149
154
    
150
 
    def __exit__ (self, exc_type, exc_value, traceback):
 
155
    def __exit__(self, exc_type, exc_value, traceback):
151
156
        self._cleanup()
152
157
        return False
153
158
    
174
179
    
175
180
    def encrypt(self, data, password):
176
181
        self.gnupg.passphrase = self.password_encode(password)
177
 
        with open(os.devnull) as devnull:
 
182
        with open(os.devnull, "w") as devnull:
178
183
            try:
179
184
                proc = self.gnupg.run(['--symmetric'],
180
185
                                      create_fhs=['stdin', 'stdout'],
191
196
    
192
197
    def decrypt(self, data, password):
193
198
        self.gnupg.passphrase = self.password_encode(password)
194
 
        with open(os.devnull) as devnull:
 
199
        with open(os.devnull, "w") as devnull:
195
200
            try:
196
201
                proc = self.gnupg.run(['--decrypt'],
197
202
                                      create_fhs=['stdin', 'stdout'],
198
203
                                      attach_fhs={'stderr': devnull})
199
 
                with contextlib.closing(proc.handles['stdin'] ) as f:
 
204
                with contextlib.closing(proc.handles['stdin']) as f:
200
205
                    f.write(data)
201
206
                with contextlib.closing(proc.handles['stdout']) as f:
202
207
                    decrypted_plaintext = f.read()
207
212
        return decrypted_plaintext
208
213
 
209
214
 
210
 
 
211
215
class AvahiError(Exception):
212
216
    def __init__(self, value, *args, **kwargs):
213
217
        self.value = value
242
246
    server: D-Bus Server
243
247
    bus: dbus.SystemBus()
244
248
    """
 
249
    
245
250
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
246
251
                 servicetype = None, port = None, TXT = None,
247
252
                 domain = "", host = "", max_renames = 32768,
260
265
        self.server = None
261
266
        self.bus = bus
262
267
        self.entry_group_state_changed_match = None
 
268
    
263
269
    def rename(self):
264
270
        """Derived from the Avahi example code"""
265
271
        if self.rename_count >= self.max_renames:
275
281
        try:
276
282
            self.add()
277
283
        except dbus.exceptions.DBusException as error:
278
 
            logger.critical("DBusException: %s", error)
 
284
            logger.critical("D-Bus Exception", exc_info=error)
279
285
            self.cleanup()
280
286
            os._exit(1)
281
287
        self.rename_count += 1
 
288
    
282
289
    def remove(self):
283
290
        """Derived from the Avahi example code"""
284
291
        if self.entry_group_state_changed_match is not None:
286
293
            self.entry_group_state_changed_match = None
287
294
        if self.group is not None:
288
295
            self.group.Reset()
 
296
    
289
297
    def add(self):
290
298
        """Derived from the Avahi example code"""
291
299
        self.remove()
308
316
            dbus.UInt16(self.port),
309
317
            avahi.string_array_to_txt_array(self.TXT))
310
318
        self.group.Commit()
 
319
    
311
320
    def entry_group_state_changed(self, state, error):
312
321
        """Derived from the Avahi example code"""
313
322
        logger.debug("Avahi entry group state change: %i", state)
320
329
        elif state == avahi.ENTRY_GROUP_FAILURE:
321
330
            logger.critical("Avahi: Error in group state changed %s",
322
331
                            unicode(error))
323
 
            raise AvahiGroupError("State changed: %s"
324
 
                                  % unicode(error))
 
332
            raise AvahiGroupError("State changed: {0!s}"
 
333
                                  .format(error))
 
334
    
325
335
    def cleanup(self):
326
336
        """Derived from the Avahi example code"""
327
337
        if self.group is not None:
332
342
                pass
333
343
            self.group = None
334
344
        self.remove()
 
345
    
335
346
    def server_state_changed(self, state, error=None):
336
347
        """Derived from the Avahi example code"""
337
348
        logger.debug("Avahi server state change: %i", state)
356
367
                logger.debug("Unknown state: %r", state)
357
368
            else:
358
369
                logger.debug("Unknown state: %r: %r", state, error)
 
370
    
359
371
    def activate(self):
360
372
        """Derived from the Avahi example code"""
361
373
        if self.server is None:
368
380
                                 self.server_state_changed)
369
381
        self.server_state_changed(self.server.GetState())
370
382
 
 
383
 
371
384
class AvahiServiceToSyslog(AvahiService):
372
385
    def rename(self):
373
386
        """Add the new name to the syslog messages"""
374
387
        ret = AvahiService.rename(self)
375
388
        syslogger.setFormatter(logging.Formatter
376
 
                               ('Mandos (%s) [%%(process)d]:'
377
 
                                ' %%(levelname)s: %%(message)s'
378
 
                                % self.name))
 
389
                               ('Mandos ({0}) [%(process)d]:'
 
390
                                ' %(levelname)s: %(message)s'
 
391
                                .format(self.name)))
379
392
        return ret
380
393
 
381
 
def _timedelta_to_milliseconds(td):
 
394
 
 
395
def timedelta_to_milliseconds(td):
382
396
    "Convert a datetime.timedelta() to milliseconds"
383
397
    return ((td.days * 24 * 60 * 60 * 1000)
384
398
            + (td.seconds * 1000)
385
399
            + (td.microseconds // 1000))
386
 
        
 
400
 
 
401
 
387
402
class Client(object):
388
403
    """A representation of a client host served by this server.
389
404
    
390
405
    Attributes:
391
 
    _approved:   bool(); 'None' if not yet approved/disapproved
 
406
    approved:   bool(); 'None' if not yet approved/disapproved
392
407
    approval_delay: datetime.timedelta(); Time to wait for approval
393
408
    approval_duration: datetime.timedelta(); Duration of one approval
394
409
    checker:    subprocess.Popen(); a running checker process used
412
427
    interval:   datetime.timedelta(); How often to start a new checker
413
428
    last_approval_request: datetime.datetime(); (UTC) or None
414
429
    last_checked_ok: datetime.datetime(); (UTC) or None
415
 
 
416
430
    last_checker_status: integer between 0 and 255 reflecting exit
417
431
                         status of last checker. -1 reflects crashed
418
 
                         checker, or None.
 
432
                         checker, -2 means no checker completed yet.
419
433
    last_enabled: datetime.datetime(); (UTC) or None
420
434
    name:       string; from the config file, used in log messages and
421
435
                        D-Bus identifiers
422
436
    secret:     bytestring; sent verbatim (over TLS) to client
423
437
    timeout:    datetime.timedelta(); How long from last_checked_ok
424
438
                                      until this client is disabled
425
 
    extended_timeout:   extra long timeout when password has been sent
 
439
    extended_timeout:   extra long timeout when secret has been sent
426
440
    runtime_expansions: Allowed attributes for runtime expansion.
427
441
    expires:    datetime.datetime(); time (UTC) when a client will be
428
442
                disabled, or None
429
443
    """
430
444
    
431
445
    runtime_expansions = ("approval_delay", "approval_duration",
432
 
                          "created", "enabled", "fingerprint",
433
 
                          "host", "interval", "last_checked_ok",
 
446
                          "created", "enabled", "expires",
 
447
                          "fingerprint", "host", "interval",
 
448
                          "last_approval_request", "last_checked_ok",
434
449
                          "last_enabled", "name", "timeout")
 
450
    client_defaults = { "timeout": "PT5M",
 
451
                        "extended_timeout": "PT15M",
 
452
                        "interval": "PT2M",
 
453
                        "checker": "fping -q -- %%(host)s",
 
454
                        "host": "",
 
455
                        "approval_delay": "PT0S",
 
456
                        "approval_duration": "PT1S",
 
457
                        "approved_by_default": "True",
 
458
                        "enabled": "True",
 
459
                        }
435
460
    
436
461
    def timeout_milliseconds(self):
437
462
        "Return the 'timeout' attribute in milliseconds"
438
 
        return _timedelta_to_milliseconds(self.timeout)
 
463
        return timedelta_to_milliseconds(self.timeout)
439
464
    
440
465
    def extended_timeout_milliseconds(self):
441
466
        "Return the 'extended_timeout' attribute in milliseconds"
442
 
        return _timedelta_to_milliseconds(self.extended_timeout)
 
467
        return timedelta_to_milliseconds(self.extended_timeout)
443
468
    
444
469
    def interval_milliseconds(self):
445
470
        "Return the 'interval' attribute in milliseconds"
446
 
        return _timedelta_to_milliseconds(self.interval)
 
471
        return timedelta_to_milliseconds(self.interval)
447
472
    
448
473
    def approval_delay_milliseconds(self):
449
 
        return _timedelta_to_milliseconds(self.approval_delay)
450
 
    
451
 
    def __init__(self, name = None, config=None):
452
 
        """Note: the 'checker' key in 'config' sets the
453
 
        'checker_command' attribute and *not* the 'checker'
454
 
        attribute."""
 
474
        return timedelta_to_milliseconds(self.approval_delay)
 
475
    
 
476
    @staticmethod
 
477
    def config_parser(config):
 
478
        """Construct a new dict of client settings of this form:
 
479
        { client_name: {setting_name: value, ...}, ...}
 
480
        with exceptions for any special settings as defined above.
 
481
        NOTE: Must be a pure function. Must return the same result
 
482
        value given the same arguments.
 
483
        """
 
484
        settings = {}
 
485
        for client_name in config.sections():
 
486
            section = dict(config.items(client_name))
 
487
            client = settings[client_name] = {}
 
488
            
 
489
            client["host"] = section["host"]
 
490
            # Reformat values from string types to Python types
 
491
            client["approved_by_default"] = config.getboolean(
 
492
                client_name, "approved_by_default")
 
493
            client["enabled"] = config.getboolean(client_name,
 
494
                                                  "enabled")
 
495
            
 
496
            client["fingerprint"] = (section["fingerprint"].upper()
 
497
                                     .replace(" ", ""))
 
498
            if "secret" in section:
 
499
                client["secret"] = section["secret"].decode("base64")
 
500
            elif "secfile" in section:
 
501
                with open(os.path.expanduser(os.path.expandvars
 
502
                                             (section["secfile"])),
 
503
                          "rb") as secfile:
 
504
                    client["secret"] = secfile.read()
 
505
            else:
 
506
                raise TypeError("No secret or secfile for section {0}"
 
507
                                .format(section))
 
508
            client["timeout"] = string_to_delta(section["timeout"])
 
509
            client["extended_timeout"] = string_to_delta(
 
510
                section["extended_timeout"])
 
511
            client["interval"] = string_to_delta(section["interval"])
 
512
            client["approval_delay"] = string_to_delta(
 
513
                section["approval_delay"])
 
514
            client["approval_duration"] = string_to_delta(
 
515
                section["approval_duration"])
 
516
            client["checker_command"] = section["checker"]
 
517
            client["last_approval_request"] = None
 
518
            client["last_checked_ok"] = None
 
519
            client["last_checker_status"] = -2
 
520
        
 
521
        return settings
 
522
    
 
523
    def __init__(self, settings, name = None):
455
524
        self.name = name
456
 
        if config is None:
457
 
            config = {}
 
525
        # adding all client settings
 
526
        for setting, value in settings.iteritems():
 
527
            setattr(self, setting, value)
 
528
        
 
529
        if self.enabled:
 
530
            if not hasattr(self, "last_enabled"):
 
531
                self.last_enabled = datetime.datetime.utcnow()
 
532
            if not hasattr(self, "expires"):
 
533
                self.expires = (datetime.datetime.utcnow()
 
534
                                + self.timeout)
 
535
        else:
 
536
            self.last_enabled = None
 
537
            self.expires = None
 
538
        
458
539
        logger.debug("Creating client %r", self.name)
459
540
        # Uppercase and remove spaces from fingerprint for later
460
541
        # comparison purposes with return value from the fingerprint()
461
542
        # function
462
 
        self.fingerprint = (config["fingerprint"].upper()
463
 
                            .replace(" ", ""))
464
543
        logger.debug("  Fingerprint: %s", self.fingerprint)
465
 
        if "secret" in config:
466
 
            self.secret = config["secret"].decode("base64")
467
 
        elif "secfile" in config:
468
 
            with open(os.path.expanduser(os.path.expandvars
469
 
                                         (config["secfile"])),
470
 
                      "rb") as secfile:
471
 
                self.secret = secfile.read()
472
 
        else:
473
 
            raise TypeError("No secret or secfile for client %s"
474
 
                            % self.name)
475
 
        self.host = config.get("host", "")
476
 
        self.created = datetime.datetime.utcnow()
477
 
        self.enabled = config.get("enabled", True)
478
 
        self.last_approval_request = None
479
 
        if self.enabled:
480
 
            self.last_enabled = datetime.datetime.utcnow()
481
 
        else:
482
 
            self.last_enabled = None
483
 
        self.last_checked_ok = None
484
 
        self.last_checker_status = None
485
 
        self.timeout = string_to_delta(config["timeout"])
486
 
        self.extended_timeout = string_to_delta(config
487
 
                                                ["extended_timeout"])
488
 
        self.interval = string_to_delta(config["interval"])
 
544
        self.created = settings.get("created",
 
545
                                    datetime.datetime.utcnow())
 
546
        
 
547
        # attributes specific for this server instance
489
548
        self.checker = None
490
549
        self.checker_initiator_tag = None
491
550
        self.disable_initiator_tag = None
492
 
        if self.enabled:
493
 
            self.expires = datetime.datetime.utcnow() + self.timeout
494
 
        else:
495
 
            self.expires = None
496
551
        self.checker_callback_tag = None
497
 
        self.checker_command = config["checker"]
498
552
        self.current_checker_command = None
499
 
        self._approved = None
500
 
        self.approved_by_default = config.get("approved_by_default",
501
 
                                              True)
 
553
        self.approved = None
502
554
        self.approvals_pending = 0
503
 
        self.approval_delay = string_to_delta(
504
 
            config["approval_delay"])
505
 
        self.approval_duration = string_to_delta(
506
 
            config["approval_duration"])
507
555
        self.changedstate = (multiprocessing_manager
508
556
                             .Condition(multiprocessing_manager
509
557
                                        .Lock()))
529
577
        if getattr(self, "enabled", False):
530
578
            # Already enabled
531
579
            return
532
 
        self.send_changedstate()
533
580
        self.expires = datetime.datetime.utcnow() + self.timeout
534
581
        self.enabled = True
535
582
        self.last_enabled = datetime.datetime.utcnow()
536
583
        self.init_checker()
 
584
        self.send_changedstate()
537
585
    
538
586
    def disable(self, quiet=True):
539
587
        """Disable this client."""
540
588
        if not getattr(self, "enabled", False):
541
589
            return False
542
590
        if not quiet:
543
 
            self.send_changedstate()
544
 
        if not quiet:
545
591
            logger.info("Disabling client %s", self.name)
546
 
        if getattr(self, "disable_initiator_tag", False):
 
592
        if getattr(self, "disable_initiator_tag", None) is not None:
547
593
            gobject.source_remove(self.disable_initiator_tag)
548
594
            self.disable_initiator_tag = None
549
595
        self.expires = None
550
 
        if getattr(self, "checker_initiator_tag", False):
 
596
        if getattr(self, "checker_initiator_tag", None) is not None:
551
597
            gobject.source_remove(self.checker_initiator_tag)
552
598
            self.checker_initiator_tag = None
553
599
        self.stop_checker()
554
600
        self.enabled = False
 
601
        if not quiet:
 
602
            self.send_changedstate()
555
603
        # Do not run this again if called by a gobject.timeout_add
556
604
        return False
557
605
    
561
609
    def init_checker(self):
562
610
        # Schedule a new checker to be started an 'interval' from now,
563
611
        # and every interval from then on.
 
612
        if self.checker_initiator_tag is not None:
 
613
            gobject.source_remove(self.checker_initiator_tag)
564
614
        self.checker_initiator_tag = (gobject.timeout_add
565
615
                                      (self.interval_milliseconds(),
566
616
                                       self.start_checker))
567
617
        # Schedule a disable() when 'timeout' has passed
 
618
        if self.disable_initiator_tag is not None:
 
619
            gobject.source_remove(self.disable_initiator_tag)
568
620
        self.disable_initiator_tag = (gobject.timeout_add
569
621
                                   (self.timeout_milliseconds(),
570
622
                                    self.disable))
576
628
        self.checker_callback_tag = None
577
629
        self.checker = None
578
630
        if os.WIFEXITED(condition):
579
 
            self.last_checker_status =  os.WEXITSTATUS(condition)
 
631
            self.last_checker_status = os.WEXITSTATUS(condition)
580
632
            if self.last_checker_status == 0:
581
633
                logger.info("Checker for %(name)s succeeded",
582
634
                            vars(self))
589
641
            logger.warning("Checker for %(name)s crashed?",
590
642
                           vars(self))
591
643
    
592
 
    def checked_ok(self, timeout=None):
593
 
        """Bump up the timeout for this client.
594
 
        
595
 
        This should only be called when the client has been seen,
596
 
        alive and well.
597
 
        """
 
644
    def checked_ok(self):
 
645
        """Assert that the client has been seen, alive and well."""
 
646
        self.last_checked_ok = datetime.datetime.utcnow()
 
647
        self.last_checker_status = 0
 
648
        self.bump_timeout()
 
649
    
 
650
    def bump_timeout(self, timeout=None):
 
651
        """Bump up the timeout for this client."""
598
652
        if timeout is None:
599
653
            timeout = self.timeout
600
 
        self.last_checked_ok = datetime.datetime.utcnow()
601
654
        if self.disable_initiator_tag is not None:
602
655
            gobject.source_remove(self.disable_initiator_tag)
 
656
            self.disable_initiator_tag = None
603
657
        if getattr(self, "enabled", False):
604
658
            self.disable_initiator_tag = (gobject.timeout_add
605
 
                                          (_timedelta_to_milliseconds
 
659
                                          (timedelta_to_milliseconds
606
660
                                           (timeout), self.disable))
607
661
            self.expires = datetime.datetime.utcnow() + timeout
608
662
    
615
669
        If a checker already exists, leave it running and do
616
670
        nothing."""
617
671
        # The reason for not killing a running checker is that if we
618
 
        # did that, then if a checker (for some reason) started
619
 
        # running slowly and taking more than 'interval' time, the
620
 
        # client would inevitably timeout, since no checker would get
621
 
        # a chance to run to completion.  If we instead leave running
 
672
        # did that, and if a checker (for some reason) started running
 
673
        # slowly and taking more than 'interval' time, then the client
 
674
        # would inevitably timeout, since no checker would get a
 
675
        # chance to run to completion.  If we instead leave running
622
676
        # checkers alone, the checker would have to take more time
623
677
        # than 'timeout' for the client to be disabled, which is as it
624
678
        # should be.
638
692
                                      self.current_checker_command)
639
693
        # Start a new checker if needed
640
694
        if self.checker is None:
 
695
            # Escape attributes for the shell
 
696
            escaped_attrs = dict(
 
697
                (attr, re.escape(unicode(getattr(self, attr))))
 
698
                for attr in
 
699
                self.runtime_expansions)
641
700
            try:
642
 
                # In case checker_command has exactly one % operator
643
 
                command = self.checker_command % self.host
644
 
            except TypeError:
645
 
                # Escape attributes for the shell
646
 
                escaped_attrs = dict(
647
 
                    (attr,
648
 
                     re.escape(unicode(str(getattr(self, attr, "")),
649
 
                                       errors=
650
 
                                       'replace')))
651
 
                    for attr in
652
 
                    self.runtime_expansions)
653
 
                
654
 
                try:
655
 
                    command = self.checker_command % escaped_attrs
656
 
                except TypeError as error:
657
 
                    logger.error('Could not format string "%s":'
658
 
                                 ' %s', self.checker_command, error)
659
 
                    return True # Try again later
 
701
                command = self.checker_command % escaped_attrs
 
702
            except TypeError as error:
 
703
                logger.error('Could not format string "%s"',
 
704
                             self.checker_command, exc_info=error)
 
705
                return True # Try again later
660
706
            self.current_checker_command = command
661
707
            try:
662
708
                logger.info("Starting checker %r for %s",
668
714
                self.checker = subprocess.Popen(command,
669
715
                                                close_fds=True,
670
716
                                                shell=True, cwd="/")
671
 
                self.checker_callback_tag = (gobject.child_watch_add
672
 
                                             (self.checker.pid,
673
 
                                              self.checker_callback,
674
 
                                              data=command))
675
 
                # The checker may have completed before the gobject
676
 
                # watch was added.  Check for this.
 
717
            except OSError as error:
 
718
                logger.error("Failed to start subprocess",
 
719
                             exc_info=error)
 
720
                return True
 
721
            self.checker_callback_tag = (gobject.child_watch_add
 
722
                                         (self.checker.pid,
 
723
                                          self.checker_callback,
 
724
                                          data=command))
 
725
            # The checker may have completed before the gobject
 
726
            # watch was added.  Check for this.
 
727
            try:
677
728
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
678
 
                if pid:
679
 
                    gobject.source_remove(self.checker_callback_tag)
680
 
                    self.checker_callback(pid, status, command)
681
729
            except OSError as error:
682
 
                logger.error("Failed to start subprocess: %s",
683
 
                             error)
 
730
                if error.errno == errno.ECHILD:
 
731
                    # This should never happen
 
732
                    logger.error("Child process vanished",
 
733
                                 exc_info=error)
 
734
                    return True
 
735
                raise
 
736
            if pid:
 
737
                gobject.source_remove(self.checker_callback_tag)
 
738
                self.checker_callback(pid, status, command)
684
739
        # Re-run this periodically if run by gobject.timeout_add
685
740
        return True
686
741
    
693
748
            return
694
749
        logger.debug("Stopping checker for %(name)s", vars(self))
695
750
        try:
696
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
751
            self.checker.terminate()
697
752
            #time.sleep(0.5)
698
753
            #if self.checker.poll() is None:
699
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
754
            #    self.checker.kill()
700
755
        except OSError as error:
701
756
            if error.errno != errno.ESRCH: # No such process
702
757
                raise
719
774
    # "Set" method, so we fail early here:
720
775
    if byte_arrays and signature != "ay":
721
776
        raise ValueError("Byte arrays not supported for non-'ay'"
722
 
                         " signature %r" % signature)
 
777
                         " signature {0!r}".format(signature))
723
778
    def decorator(func):
724
779
        func._dbus_is_property = True
725
780
        func._dbus_interface = dbus_interface
733
788
    return decorator
734
789
 
735
790
 
 
791
def dbus_interface_annotations(dbus_interface):
 
792
    """Decorator for marking functions returning interface annotations
 
793
    
 
794
    Usage:
 
795
    
 
796
    @dbus_interface_annotations("org.example.Interface")
 
797
    def _foo(self):  # Function name does not matter
 
798
        return {"org.freedesktop.DBus.Deprecated": "true",
 
799
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
800
                    "false"}
 
801
    """
 
802
    def decorator(func):
 
803
        func._dbus_is_interface = True
 
804
        func._dbus_interface = dbus_interface
 
805
        func._dbus_name = dbus_interface
 
806
        return func
 
807
    return decorator
 
808
 
 
809
 
 
810
def dbus_annotations(annotations):
 
811
    """Decorator to annotate D-Bus methods, signals or properties
 
812
    Usage:
 
813
    
 
814
    @dbus_service_property("org.example.Interface", signature="b",
 
815
                           access="r")
 
816
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
 
817
                        "org.freedesktop.DBus.Property."
 
818
                        "EmitsChangedSignal": "false"})
 
819
    def Property_dbus_property(self):
 
820
        return dbus.Boolean(False)
 
821
    """
 
822
    def decorator(func):
 
823
        func._dbus_annotations = annotations
 
824
        return func
 
825
    return decorator
 
826
 
 
827
 
736
828
class DBusPropertyException(dbus.exceptions.DBusException):
737
829
    """A base class for D-Bus property-related exceptions
738
830
    """
761
853
    """
762
854
    
763
855
    @staticmethod
764
 
    def _is_dbus_property(obj):
765
 
        return getattr(obj, "_dbus_is_property", False)
 
856
    def _is_dbus_thing(thing):
 
857
        """Returns a function testing if an attribute is a D-Bus thing
 
858
        
 
859
        If called like _is_dbus_thing("method") it returns a function
 
860
        suitable for use as predicate to inspect.getmembers().
 
861
        """
 
862
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
 
863
                                   False)
766
864
    
767
 
    def _get_all_dbus_properties(self):
 
865
    def _get_all_dbus_things(self, thing):
768
866
        """Returns a generator of (name, attribute) pairs
769
867
        """
770
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
868
        return ((getattr(athing.__get__(self), "_dbus_name",
 
869
                         name),
 
870
                 athing.__get__(self))
771
871
                for cls in self.__class__.__mro__
772
 
                for name, prop in
773
 
                inspect.getmembers(cls, self._is_dbus_property))
 
872
                for name, athing in
 
873
                inspect.getmembers(cls,
 
874
                                   self._is_dbus_thing(thing)))
774
875
    
775
876
    def _get_dbus_property(self, interface_name, property_name):
776
877
        """Returns a bound method if one exists which is a D-Bus
778
879
        """
779
880
        for cls in  self.__class__.__mro__:
780
881
            for name, value in (inspect.getmembers
781
 
                                (cls, self._is_dbus_property)):
 
882
                                (cls,
 
883
                                 self._is_dbus_thing("property"))):
782
884
                if (value._dbus_name == property_name
783
885
                    and value._dbus_interface == interface_name):
784
886
                    return value.__get__(self)
813
915
            # signatures other than "ay".
814
916
            if prop._dbus_signature != "ay":
815
917
                raise ValueError
816
 
            value = dbus.ByteArray(''.join(unichr(byte)
817
 
                                           for byte in value))
 
918
            value = dbus.ByteArray(b''.join(chr(byte)
 
919
                                            for byte in value))
818
920
        prop(value)
819
921
    
820
922
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
826
928
        Note: Will not include properties with access="write".
827
929
        """
828
930
        properties = {}
829
 
        for name, prop in self._get_all_dbus_properties():
 
931
        for name, prop in self._get_all_dbus_things("property"):
830
932
            if (interface_name
831
933
                and interface_name != prop._dbus_interface):
832
934
                # Interface non-empty but did not match
847
949
                         path_keyword='object_path',
848
950
                         connection_keyword='connection')
849
951
    def Introspect(self, object_path, connection):
850
 
        """Standard D-Bus method, overloaded to insert property tags.
 
952
        """Overloading of standard D-Bus method.
 
953
        
 
954
        Inserts property tags and interface annotation tags.
851
955
        """
852
956
        xmlstring = dbus.service.Object.Introspect(self, object_path,
853
957
                                                   connection)
860
964
                e.setAttribute("access", prop._dbus_access)
861
965
                return e
862
966
            for if_tag in document.getElementsByTagName("interface"):
 
967
                # Add property tags
863
968
                for tag in (make_tag(document, name, prop)
864
969
                            for name, prop
865
 
                            in self._get_all_dbus_properties()
 
970
                            in self._get_all_dbus_things("property")
866
971
                            if prop._dbus_interface
867
972
                            == if_tag.getAttribute("name")):
868
973
                    if_tag.appendChild(tag)
 
974
                # Add annotation tags
 
975
                for typ in ("method", "signal", "property"):
 
976
                    for tag in if_tag.getElementsByTagName(typ):
 
977
                        annots = dict()
 
978
                        for name, prop in (self.
 
979
                                           _get_all_dbus_things(typ)):
 
980
                            if (name == tag.getAttribute("name")
 
981
                                and prop._dbus_interface
 
982
                                == if_tag.getAttribute("name")):
 
983
                                annots.update(getattr
 
984
                                              (prop,
 
985
                                               "_dbus_annotations",
 
986
                                               {}))
 
987
                        for name, value in annots.iteritems():
 
988
                            ann_tag = document.createElement(
 
989
                                "annotation")
 
990
                            ann_tag.setAttribute("name", name)
 
991
                            ann_tag.setAttribute("value", value)
 
992
                            tag.appendChild(ann_tag)
 
993
                # Add interface annotation tags
 
994
                for annotation, value in dict(
 
995
                    itertools.chain.from_iterable(
 
996
                        annotations().iteritems()
 
997
                        for name, annotations in
 
998
                        self._get_all_dbus_things("interface")
 
999
                        if name == if_tag.getAttribute("name")
 
1000
                        )).iteritems():
 
1001
                    ann_tag = document.createElement("annotation")
 
1002
                    ann_tag.setAttribute("name", annotation)
 
1003
                    ann_tag.setAttribute("value", value)
 
1004
                    if_tag.appendChild(ann_tag)
869
1005
                # Add the names to the return values for the
870
1006
                # "org.freedesktop.DBus.Properties" methods
871
1007
                if (if_tag.getAttribute("name")
886
1022
        except (AttributeError, xml.dom.DOMException,
887
1023
                xml.parsers.expat.ExpatError) as error:
888
1024
            logger.error("Failed to override Introspection method",
889
 
                         error)
 
1025
                         exc_info=error)
890
1026
        return xmlstring
891
1027
 
892
1028
 
893
 
def datetime_to_dbus (dt, variant_level=0):
 
1029
def datetime_to_dbus(dt, variant_level=0):
894
1030
    """Convert a UTC datetime.datetime() to a D-Bus type."""
895
1031
    if dt is None:
896
1032
        return dbus.String("", variant_level = variant_level)
898
1034
                       variant_level=variant_level)
899
1035
 
900
1036
 
901
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
902
 
                                  .__metaclass__):
903
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
904
 
    will add additional D-Bus attributes matching a certain pattern.
 
1037
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1038
    """A class decorator; applied to a subclass of
 
1039
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1040
    interface names according to the "alt_interface_names" mapping.
 
1041
    Usage:
 
1042
    
 
1043
    @alternate_dbus_interfaces({"org.example.Interface":
 
1044
                                    "net.example.AlternateInterface"})
 
1045
    class SampleDBusObject(dbus.service.Object):
 
1046
        @dbus.service.method("org.example.Interface")
 
1047
        def SampleDBusMethod():
 
1048
            pass
 
1049
    
 
1050
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1051
    reachable via two interfaces: "org.example.Interface" and
 
1052
    "net.example.AlternateInterface", the latter of which will have
 
1053
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1054
    "true", unless "deprecate" is passed with a False value.
 
1055
    
 
1056
    This works for methods and signals, and also for D-Bus properties
 
1057
    (from DBusObjectWithProperties) and interfaces (from the
 
1058
    dbus_interface_annotations decorator).
905
1059
    """
906
 
    def __new__(mcs, name, bases, attr):
907
 
        # Go through all the base classes which could have D-Bus
908
 
        # methods, signals, or properties in them
909
 
        for base in (b for b in bases
910
 
                     if issubclass(b, dbus.service.Object)):
911
 
            # Go though all attributes of the base class
912
 
            for attrname, attribute in inspect.getmembers(base):
 
1060
    def wrapper(cls):
 
1061
        for orig_interface_name, alt_interface_name in (
 
1062
            alt_interface_names.iteritems()):
 
1063
            attr = {}
 
1064
            interface_names = set()
 
1065
            # Go though all attributes of the class
 
1066
            for attrname, attribute in inspect.getmembers(cls):
913
1067
                # Ignore non-D-Bus attributes, and D-Bus attributes
914
1068
                # with the wrong interface name
915
1069
                if (not hasattr(attribute, "_dbus_interface")
916
1070
                    or not attribute._dbus_interface
917
 
                    .startswith("se.recompile.Mandos")):
 
1071
                    .startswith(orig_interface_name)):
918
1072
                    continue
919
1073
                # Create an alternate D-Bus interface name based on
920
1074
                # the current name
921
1075
                alt_interface = (attribute._dbus_interface
922
 
                                 .replace("se.recompile.Mandos",
923
 
                                          "se.bsnet.fukt.Mandos"))
 
1076
                                 .replace(orig_interface_name,
 
1077
                                          alt_interface_name))
 
1078
                interface_names.add(alt_interface)
924
1079
                # Is this a D-Bus signal?
925
1080
                if getattr(attribute, "_dbus_is_signal", False):
926
1081
                    # Extract the original non-method function by
941
1096
                                nonmethod_func.func_name,
942
1097
                                nonmethod_func.func_defaults,
943
1098
                                nonmethod_func.func_closure)))
 
1099
                    # Copy annotations, if any
 
1100
                    try:
 
1101
                        new_function._dbus_annotations = (
 
1102
                            dict(attribute._dbus_annotations))
 
1103
                    except AttributeError:
 
1104
                        pass
944
1105
                    # Define a creator of a function to call both the
945
 
                    # old and new functions, so both the old and new
946
 
                    # signals gets sent when the function is called
 
1106
                    # original and alternate functions, so both the
 
1107
                    # original and alternate signals gets sent when
 
1108
                    # the function is called
947
1109
                    def fixscope(func1, func2):
948
1110
                        """This function is a scope container to pass
949
1111
                        func1 and func2 to the "call_both" function
956
1118
                        return call_both
957
1119
                    # Create the "call_both" function and add it to
958
1120
                    # the class
959
 
                    attr[attrname] = fixscope(attribute,
960
 
                                              new_function)
 
1121
                    attr[attrname] = fixscope(attribute, new_function)
961
1122
                # Is this a D-Bus method?
962
1123
                elif getattr(attribute, "_dbus_is_method", False):
963
1124
                    # Create a new, but exactly alike, function
974
1135
                                        attribute.func_name,
975
1136
                                        attribute.func_defaults,
976
1137
                                        attribute.func_closure)))
 
1138
                    # Copy annotations, if any
 
1139
                    try:
 
1140
                        attr[attrname]._dbus_annotations = (
 
1141
                            dict(attribute._dbus_annotations))
 
1142
                    except AttributeError:
 
1143
                        pass
977
1144
                # Is this a D-Bus property?
978
1145
                elif getattr(attribute, "_dbus_is_property", False):
979
1146
                    # Create a new, but exactly alike, function
993
1160
                                        attribute.func_name,
994
1161
                                        attribute.func_defaults,
995
1162
                                        attribute.func_closure)))
996
 
        return type.__new__(mcs, name, bases, attr)
997
 
 
998
 
 
 
1163
                    # Copy annotations, if any
 
1164
                    try:
 
1165
                        attr[attrname]._dbus_annotations = (
 
1166
                            dict(attribute._dbus_annotations))
 
1167
                    except AttributeError:
 
1168
                        pass
 
1169
                # Is this a D-Bus interface?
 
1170
                elif getattr(attribute, "_dbus_is_interface", False):
 
1171
                    # Create a new, but exactly alike, function
 
1172
                    # object.  Decorate it to be a new D-Bus interface
 
1173
                    # with the alternate D-Bus interface name.  Add it
 
1174
                    # to the class.
 
1175
                    attr[attrname] = (dbus_interface_annotations
 
1176
                                      (alt_interface)
 
1177
                                      (types.FunctionType
 
1178
                                       (attribute.func_code,
 
1179
                                        attribute.func_globals,
 
1180
                                        attribute.func_name,
 
1181
                                        attribute.func_defaults,
 
1182
                                        attribute.func_closure)))
 
1183
            if deprecate:
 
1184
                # Deprecate all alternate interfaces
 
1185
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1186
                for interface_name in interface_names:
 
1187
                    @dbus_interface_annotations(interface_name)
 
1188
                    def func(self):
 
1189
                        return { "org.freedesktop.DBus.Deprecated":
 
1190
                                     "true" }
 
1191
                    # Find an unused name
 
1192
                    for aname in (iname.format(i)
 
1193
                                  for i in itertools.count()):
 
1194
                        if aname not in attr:
 
1195
                            attr[aname] = func
 
1196
                            break
 
1197
            if interface_names:
 
1198
                # Replace the class with a new subclass of it with
 
1199
                # methods, signals, etc. as created above.
 
1200
                cls = type(b"{0}Alternate".format(cls.__name__),
 
1201
                           (cls,), attr)
 
1202
        return cls
 
1203
    return wrapper
 
1204
 
 
1205
 
 
1206
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1207
                                "se.bsnet.fukt.Mandos"})
999
1208
class ClientDBus(Client, DBusObjectWithProperties):
1000
1209
    """A Client class using D-Bus
1001
1210
    
1012
1221
    def __init__(self, bus = None, *args, **kwargs):
1013
1222
        self.bus = bus
1014
1223
        Client.__init__(self, *args, **kwargs)
1015
 
        
1016
 
        self._approvals_pending = 0
1017
1224
        # Only now, when this client is initialized, can it show up on
1018
1225
        # the D-Bus
1019
1226
        client_object_name = unicode(self.name).translate(
1023
1230
                                 ("/clients/" + client_object_name))
1024
1231
        DBusObjectWithProperties.__init__(self, self.bus,
1025
1232
                                          self.dbus_object_path)
1026
 
        
 
1233
    
1027
1234
    def notifychangeproperty(transform_func,
1028
1235
                             dbus_name, type_func=lambda x: x,
1029
1236
                             variant_level=1):
1052
1259
        
1053
1260
        return property(lambda self: getattr(self, attrname), setter)
1054
1261
    
1055
 
    
1056
1262
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1057
1263
    approvals_pending = notifychangeproperty(dbus.Boolean,
1058
1264
                                             "ApprovalPending",
1065
1271
                                       checker is not None)
1066
1272
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1067
1273
                                           "LastCheckedOK")
 
1274
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1275
                                               "LastCheckerStatus")
1068
1276
    last_approval_request = notifychangeproperty(
1069
1277
        datetime_to_dbus, "LastApprovalRequest")
1070
1278
    approved_by_default = notifychangeproperty(dbus.Boolean,
1071
1279
                                               "ApprovedByDefault")
1072
 
    approval_delay = notifychangeproperty(dbus.UInt16,
 
1280
    approval_delay = notifychangeproperty(dbus.UInt64,
1073
1281
                                          "ApprovalDelay",
1074
1282
                                          type_func =
1075
 
                                          _timedelta_to_milliseconds)
 
1283
                                          timedelta_to_milliseconds)
1076
1284
    approval_duration = notifychangeproperty(
1077
 
        dbus.UInt16, "ApprovalDuration",
1078
 
        type_func = _timedelta_to_milliseconds)
 
1285
        dbus.UInt64, "ApprovalDuration",
 
1286
        type_func = timedelta_to_milliseconds)
1079
1287
    host = notifychangeproperty(dbus.String, "Host")
1080
 
    timeout = notifychangeproperty(dbus.UInt16, "Timeout",
 
1288
    timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1081
1289
                                   type_func =
1082
 
                                   _timedelta_to_milliseconds)
 
1290
                                   timedelta_to_milliseconds)
1083
1291
    extended_timeout = notifychangeproperty(
1084
 
        dbus.UInt16, "ExtendedTimeout",
1085
 
        type_func = _timedelta_to_milliseconds)
1086
 
    interval = notifychangeproperty(dbus.UInt16,
 
1292
        dbus.UInt64, "ExtendedTimeout",
 
1293
        type_func = timedelta_to_milliseconds)
 
1294
    interval = notifychangeproperty(dbus.UInt64,
1087
1295
                                    "Interval",
1088
1296
                                    type_func =
1089
 
                                    _timedelta_to_milliseconds)
 
1297
                                    timedelta_to_milliseconds)
1090
1298
    checker_command = notifychangeproperty(dbus.String, "Checker")
1091
1299
    
1092
1300
    del notifychangeproperty
1134
1342
        return r
1135
1343
    
1136
1344
    def _reset_approved(self):
1137
 
        self._approved = None
 
1345
        self.approved = None
1138
1346
        return False
1139
1347
    
1140
1348
    def approve(self, value=True):
1141
 
        self.send_changedstate()
1142
 
        self._approved = value
1143
 
        gobject.timeout_add(_timedelta_to_milliseconds
 
1349
        self.approved = value
 
1350
        gobject.timeout_add(timedelta_to_milliseconds
1144
1351
                            (self.approval_duration),
1145
1352
                            self._reset_approved)
1146
 
    
 
1353
        self.send_changedstate()
1147
1354
    
1148
1355
    ## D-Bus methods, signals & properties
1149
1356
    _interface = "se.recompile.Mandos.Client"
1150
1357
    
 
1358
    ## Interfaces
 
1359
    
 
1360
    @dbus_interface_annotations(_interface)
 
1361
    def _foo(self):
 
1362
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1363
                     "false"}
 
1364
    
1151
1365
    ## Signals
1152
1366
    
1153
1367
    # CheckerCompleted - signal
1189
1403
        "D-Bus signal"
1190
1404
        return self.need_approval()
1191
1405
    
1192
 
    # NeRwequest - signal
1193
 
    @dbus.service.signal(_interface, signature="s")
1194
 
    def NewRequest(self, ip):
1195
 
        """D-Bus signal
1196
 
        Is sent after a client request a password.
1197
 
        """
1198
 
        pass
1199
 
    
1200
1406
    ## Methods
1201
1407
    
1202
1408
    # Approve - method
1260
1466
                           access="readwrite")
1261
1467
    def ApprovalDuration_dbus_property(self, value=None):
1262
1468
        if value is None:       # get
1263
 
            return dbus.UInt64(_timedelta_to_milliseconds(
 
1469
            return dbus.UInt64(timedelta_to_milliseconds(
1264
1470
                    self.approval_duration))
1265
1471
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
1266
1472
    
1280
1486
    def Host_dbus_property(self, value=None):
1281
1487
        if value is None:       # get
1282
1488
            return dbus.String(self.host)
1283
 
        self.host = value
 
1489
        self.host = unicode(value)
1284
1490
    
1285
1491
    # Created - property
1286
1492
    @dbus_service_property(_interface, signature="s", access="read")
1312
1518
            return
1313
1519
        return datetime_to_dbus(self.last_checked_ok)
1314
1520
    
 
1521
    # LastCheckerStatus - property
 
1522
    @dbus_service_property(_interface, signature="n",
 
1523
                           access="read")
 
1524
    def LastCheckerStatus_dbus_property(self):
 
1525
        return dbus.Int16(self.last_checker_status)
 
1526
    
1315
1527
    # Expires - property
1316
1528
    @dbus_service_property(_interface, signature="s", access="read")
1317
1529
    def Expires_dbus_property(self):
1328
1540
    def Timeout_dbus_property(self, value=None):
1329
1541
        if value is None:       # get
1330
1542
            return dbus.UInt64(self.timeout_milliseconds())
 
1543
        old_timeout = self.timeout
1331
1544
        self.timeout = datetime.timedelta(0, 0, 0, value)
1332
 
        if getattr(self, "disable_initiator_tag", None) is None:
1333
 
            return
1334
 
        # Reschedule timeout
1335
 
        gobject.source_remove(self.disable_initiator_tag)
1336
 
        self.disable_initiator_tag = None
1337
 
        self.expires = None
1338
 
        time_to_die = _timedelta_to_milliseconds((self
1339
 
                                                  .last_checked_ok
1340
 
                                                  + self.timeout)
1341
 
                                                 - datetime.datetime
1342
 
                                                 .utcnow())
1343
 
        if time_to_die <= 0:
1344
 
            # The timeout has passed
1345
 
            self.disable()
1346
 
        else:
1347
 
            self.expires = (datetime.datetime.utcnow()
1348
 
                            + datetime.timedelta(milliseconds =
1349
 
                                                 time_to_die))
1350
 
            self.disable_initiator_tag = (gobject.timeout_add
1351
 
                                          (time_to_die, self.disable))
 
1545
        # Reschedule disabling
 
1546
        if self.enabled:
 
1547
            now = datetime.datetime.utcnow()
 
1548
            self.expires += self.timeout - old_timeout
 
1549
            if self.expires <= now:
 
1550
                # The timeout has passed
 
1551
                self.disable()
 
1552
            else:
 
1553
                if (getattr(self, "disable_initiator_tag", None)
 
1554
                    is None):
 
1555
                    return
 
1556
                gobject.source_remove(self.disable_initiator_tag)
 
1557
                self.disable_initiator_tag = (
 
1558
                    gobject.timeout_add(
 
1559
                        timedelta_to_milliseconds(self.expires - now),
 
1560
                        self.disable))
1352
1561
    
1353
1562
    # ExtendedTimeout - property
1354
1563
    @dbus_service_property(_interface, signature="t",
1380
1589
    def Checker_dbus_property(self, value=None):
1381
1590
        if value is None:       # get
1382
1591
            return dbus.String(self.checker_command)
1383
 
        self.checker_command = value
 
1592
        self.checker_command = unicode(value)
1384
1593
    
1385
1594
    # CheckerRunning - property
1386
1595
    @dbus_service_property(_interface, signature="b",
1415
1624
            raise KeyError()
1416
1625
    
1417
1626
    def __getattribute__(self, name):
1418
 
        if(name == '_pipe'):
 
1627
        if name == '_pipe':
1419
1628
            return super(ProxyClient, self).__getattribute__(name)
1420
1629
        self._pipe.send(('getattr', name))
1421
1630
        data = self._pipe.recv()
1428
1637
            return func
1429
1638
    
1430
1639
    def __setattr__(self, name, value):
1431
 
        if(name == '_pipe'):
 
1640
        if name == '_pipe':
1432
1641
            return super(ProxyClient, self).__setattr__(name, value)
1433
1642
        self._pipe.send(('setattr', name, value))
1434
1643
 
1435
1644
 
1436
 
class ClientDBusTransitional(ClientDBus):
1437
 
    __metaclass__ = AlternateDBusNamesMetaclass
1438
 
 
1439
 
 
1440
1645
class ClientHandler(socketserver.BaseRequestHandler, object):
1441
1646
    """A class to handle client connections.
1442
1647
    
1503
1708
                    logger.warning("Bad certificate: %s", error)
1504
1709
                    return
1505
1710
                logger.debug("Fingerprint: %s", fpr)
1506
 
                if self.server.use_dbus:
1507
 
                    # Emit D-Bus signal
1508
 
                    client.NewRequest(str(self.client_address))
1509
1711
                
1510
1712
                try:
1511
1713
                    client = ProxyClient(child_pipe, fpr,
1527
1729
                            client.Rejected("Disabled")
1528
1730
                        return
1529
1731
                    
1530
 
                    if client._approved or not client.approval_delay:
 
1732
                    if client.approved or not client.approval_delay:
1531
1733
                        #We are approved or approval is disabled
1532
1734
                        break
1533
 
                    elif client._approved is None:
 
1735
                    elif client.approved is None:
1534
1736
                        logger.info("Client %s needs approval",
1535
1737
                                    client.name)
1536
1738
                        if self.server.use_dbus:
1549
1751
                    #wait until timeout or approved
1550
1752
                    time = datetime.datetime.now()
1551
1753
                    client.changedstate.acquire()
1552
 
                    (client.changedstate.wait
1553
 
                     (float(client._timedelta_to_milliseconds(delay)
1554
 
                            / 1000)))
 
1754
                    client.changedstate.wait(
 
1755
                        float(timedelta_to_milliseconds(delay)
 
1756
                              / 1000))
1555
1757
                    client.changedstate.release()
1556
1758
                    time2 = datetime.datetime.now()
1557
1759
                    if (time2 - time) >= delay:
1573
1775
                    try:
1574
1776
                        sent = session.send(client.secret[sent_size:])
1575
1777
                    except gnutls.errors.GNUTLSError as error:
1576
 
                        logger.warning("gnutls send failed")
 
1778
                        logger.warning("gnutls send failed",
 
1779
                                       exc_info=error)
1577
1780
                        return
1578
1781
                    logger.debug("Sent: %d, remaining: %d",
1579
1782
                                 sent, len(client.secret)
1582
1785
                
1583
1786
                logger.info("Sending secret to %s", client.name)
1584
1787
                # bump the timeout using extended_timeout
1585
 
                client.checked_ok(client.extended_timeout)
 
1788
                client.bump_timeout(client.extended_timeout)
1586
1789
                if self.server.use_dbus:
1587
1790
                    # Emit D-Bus signal
1588
1791
                    client.GotSecret()
1593
1796
                try:
1594
1797
                    session.bye()
1595
1798
                except gnutls.errors.GNUTLSError as error:
1596
 
                    logger.warning("GnuTLS bye failed")
 
1799
                    logger.warning("GnuTLS bye failed",
 
1800
                                   exc_info=error)
1597
1801
    
1598
1802
    @staticmethod
1599
1803
    def peer_certificate(session):
1664
1868
    def sub_process_main(self, request, address):
1665
1869
        try:
1666
1870
            self.finish_request(request, address)
1667
 
        except:
 
1871
        except Exception:
1668
1872
            self.handle_error(request, address)
1669
1873
        self.close_request(request)
1670
1874
    
1671
1875
    def process_request(self, request, address):
1672
1876
        """Start a new process to process the request."""
1673
1877
        proc = multiprocessing.Process(target = self.sub_process_main,
1674
 
                                       args = (request,
1675
 
                                               address))
 
1878
                                       args = (request, address))
1676
1879
        proc.start()
1677
1880
        return proc
1678
1881
 
1706
1909
        use_ipv6:       Boolean; to use IPv6 or not
1707
1910
    """
1708
1911
    def __init__(self, server_address, RequestHandlerClass,
1709
 
                 interface=None, use_ipv6=True):
 
1912
                 interface=None, use_ipv6=True, socketfd=None):
 
1913
        """If socketfd is set, use that file descriptor instead of
 
1914
        creating a new one with socket.socket().
 
1915
        """
1710
1916
        self.interface = interface
1711
1917
        if use_ipv6:
1712
1918
            self.address_family = socket.AF_INET6
 
1919
        if socketfd is not None:
 
1920
            # Save the file descriptor
 
1921
            self.socketfd = socketfd
 
1922
            # Save the original socket.socket() function
 
1923
            self.socket_socket = socket.socket
 
1924
            # To implement --socket, we monkey patch socket.socket.
 
1925
            # 
 
1926
            # (When socketserver.TCPServer is a new-style class, we
 
1927
            # could make self.socket into a property instead of monkey
 
1928
            # patching socket.socket.)
 
1929
            # 
 
1930
            # Create a one-time-only replacement for socket.socket()
 
1931
            @functools.wraps(socket.socket)
 
1932
            def socket_wrapper(*args, **kwargs):
 
1933
                # Restore original function so subsequent calls are
 
1934
                # not affected.
 
1935
                socket.socket = self.socket_socket
 
1936
                del self.socket_socket
 
1937
                # This time only, return a new socket object from the
 
1938
                # saved file descriptor.
 
1939
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
1940
            # Replace socket.socket() function with wrapper
 
1941
            socket.socket = socket_wrapper
 
1942
        # The socketserver.TCPServer.__init__ will call
 
1943
        # socket.socket(), which might be our replacement,
 
1944
        # socket_wrapper(), if socketfd was set.
1713
1945
        socketserver.TCPServer.__init__(self, server_address,
1714
1946
                                        RequestHandlerClass)
 
1947
    
1715
1948
    def server_bind(self):
1716
1949
        """This overrides the normal server_bind() function
1717
1950
        to bind to an interface if one was specified, and also NOT to
1725
1958
                try:
1726
1959
                    self.socket.setsockopt(socket.SOL_SOCKET,
1727
1960
                                           SO_BINDTODEVICE,
1728
 
                                           str(self.interface
1729
 
                                               + '\0'))
 
1961
                                           str(self.interface + '\0'))
1730
1962
                except socket.error as error:
1731
 
                    if error[0] == errno.EPERM:
1732
 
                        logger.error("No permission to"
1733
 
                                     " bind to interface %s",
1734
 
                                     self.interface)
1735
 
                    elif error[0] == errno.ENOPROTOOPT:
 
1963
                    if error.errno == errno.EPERM:
 
1964
                        logger.error("No permission to bind to"
 
1965
                                     " interface %s", self.interface)
 
1966
                    elif error.errno == errno.ENOPROTOOPT:
1736
1967
                        logger.error("SO_BINDTODEVICE not available;"
1737
1968
                                     " cannot bind to interface %s",
1738
1969
                                     self.interface)
 
1970
                    elif error.errno == errno.ENODEV:
 
1971
                        logger.error("Interface %s does not exist,"
 
1972
                                     " cannot bind", self.interface)
1739
1973
                    else:
1740
1974
                        raise
1741
1975
        # Only bind(2) the socket if we really need to.
1771
2005
    """
1772
2006
    def __init__(self, server_address, RequestHandlerClass,
1773
2007
                 interface=None, use_ipv6=True, clients=None,
1774
 
                 gnutls_priority=None, use_dbus=True):
 
2008
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1775
2009
        self.enabled = False
1776
2010
        self.clients = clients
1777
2011
        if self.clients is None:
1781
2015
        IPv6_TCPServer.__init__(self, server_address,
1782
2016
                                RequestHandlerClass,
1783
2017
                                interface = interface,
1784
 
                                use_ipv6 = use_ipv6)
 
2018
                                use_ipv6 = use_ipv6,
 
2019
                                socketfd = socketfd)
1785
2020
    def server_activate(self):
1786
2021
        if self.enabled:
1787
2022
            return socketserver.TCPServer.server_activate(self)
1800
2035
    
1801
2036
    def handle_ipc(self, source, condition, parent_pipe=None,
1802
2037
                   proc = None, client_object=None):
1803
 
        condition_names = {
1804
 
            gobject.IO_IN: "IN",   # There is data to read.
1805
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1806
 
                                    # blocking).
1807
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1808
 
            gobject.IO_ERR: "ERR", # Error condition.
1809
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1810
 
                                    # broken, usually for pipes and
1811
 
                                    # sockets).
1812
 
            }
1813
 
        conditions_string = ' | '.join(name
1814
 
                                       for cond, name in
1815
 
                                       condition_names.iteritems()
1816
 
                                       if cond & condition)
1817
2038
        # error, or the other end of multiprocessing.Pipe has closed
1818
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2039
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1819
2040
            # Wait for other process to exit
1820
2041
            proc.join()
1821
2042
            return False
1879
2100
        return True
1880
2101
 
1881
2102
 
 
2103
def rfc3339_duration_to_delta(duration):
 
2104
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2105
    
 
2106
    >>> rfc3339_duration_to_delta("P7D")
 
2107
    datetime.timedelta(7)
 
2108
    >>> rfc3339_duration_to_delta("PT60S")
 
2109
    datetime.timedelta(0, 60)
 
2110
    >>> rfc3339_duration_to_delta("PT60M")
 
2111
    datetime.timedelta(0, 3600)
 
2112
    >>> rfc3339_duration_to_delta("PT24H")
 
2113
    datetime.timedelta(1)
 
2114
    >>> rfc3339_duration_to_delta("P1W")
 
2115
    datetime.timedelta(7)
 
2116
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2117
    datetime.timedelta(0, 330)
 
2118
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2119
    datetime.timedelta(1, 200)
 
2120
    """
 
2121
    
 
2122
    # Parsing an RFC 3339 duration with regular expressions is not
 
2123
    # possible - there would have to be multiple places for the same
 
2124
    # values, like seconds.  The current code, while more esoteric, is
 
2125
    # cleaner without depending on a parsing library.  If Python had a
 
2126
    # built-in library for parsing we would use it, but we'd like to
 
2127
    # avoid excessive use of external libraries.
 
2128
    
 
2129
    # New type for defining tokens, syntax, and semantics all-in-one
 
2130
    Token = collections.namedtuple("Token",
 
2131
                                   ("regexp", # To match token; if
 
2132
                                              # "value" is not None,
 
2133
                                              # must have a "group"
 
2134
                                              # containing digits
 
2135
                                    "value",  # datetime.timedelta or
 
2136
                                              # None
 
2137
                                    "followers")) # Tokens valid after
 
2138
                                                  # this token
 
2139
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2140
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2141
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2142
    token_second = Token(re.compile(r"(\d+)S"),
 
2143
                         datetime.timedelta(seconds=1),
 
2144
                         frozenset((token_end,)))
 
2145
    token_minute = Token(re.compile(r"(\d+)M"),
 
2146
                         datetime.timedelta(minutes=1),
 
2147
                         frozenset((token_second, token_end)))
 
2148
    token_hour = Token(re.compile(r"(\d+)H"),
 
2149
                       datetime.timedelta(hours=1),
 
2150
                       frozenset((token_minute, token_end)))
 
2151
    token_time = Token(re.compile(r"T"),
 
2152
                       None,
 
2153
                       frozenset((token_hour, token_minute,
 
2154
                                  token_second)))
 
2155
    token_day = Token(re.compile(r"(\d+)D"),
 
2156
                      datetime.timedelta(days=1),
 
2157
                      frozenset((token_time, token_end)))
 
2158
    token_month = Token(re.compile(r"(\d+)M"),
 
2159
                        datetime.timedelta(weeks=4),
 
2160
                        frozenset((token_day, token_end)))
 
2161
    token_year = Token(re.compile(r"(\d+)Y"),
 
2162
                       datetime.timedelta(weeks=52),
 
2163
                       frozenset((token_month, token_end)))
 
2164
    token_week = Token(re.compile(r"(\d+)W"),
 
2165
                       datetime.timedelta(weeks=1),
 
2166
                       frozenset((token_end,)))
 
2167
    token_duration = Token(re.compile(r"P"), None,
 
2168
                           frozenset((token_year, token_month,
 
2169
                                      token_day, token_time,
 
2170
                                      token_week))),
 
2171
    # Define starting values
 
2172
    value = datetime.timedelta() # Value so far
 
2173
    found_token = None
 
2174
    followers = frozenset(token_duration,) # Following valid tokens
 
2175
    s = duration                # String left to parse
 
2176
    # Loop until end token is found
 
2177
    while found_token is not token_end:
 
2178
        # Search for any currently valid tokens
 
2179
        for token in followers:
 
2180
            match = token.regexp.match(s)
 
2181
            if match is not None:
 
2182
                # Token found
 
2183
                if token.value is not None:
 
2184
                    # Value found, parse digits
 
2185
                    factor = int(match.group(1), 10)
 
2186
                    # Add to value so far
 
2187
                    value += factor * token.value
 
2188
                # Strip token from string
 
2189
                s = token.regexp.sub("", s, 1)
 
2190
                # Go to found token
 
2191
                found_token = token
 
2192
                # Set valid next tokens
 
2193
                followers = found_token.followers
 
2194
                break
 
2195
        else:
 
2196
            # No currently valid tokens were found
 
2197
            raise ValueError("Invalid RFC 3339 duration")
 
2198
    # End token found
 
2199
    return value
 
2200
 
 
2201
 
1882
2202
def string_to_delta(interval):
1883
2203
    """Parse a string and return a datetime.timedelta
1884
2204
    
1895
2215
    >>> string_to_delta('5m 30s')
1896
2216
    datetime.timedelta(0, 330)
1897
2217
    """
 
2218
    
 
2219
    try:
 
2220
        return rfc3339_duration_to_delta(interval)
 
2221
    except ValueError:
 
2222
        pass
 
2223
    
1898
2224
    timevalue = datetime.timedelta(0)
1899
2225
    for s in interval.split():
1900
2226
        try:
1911
2237
            elif suffix == "w":
1912
2238
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1913
2239
            else:
1914
 
                raise ValueError("Unknown suffix %r" % suffix)
 
2240
                raise ValueError("Unknown suffix {0!r}"
 
2241
                                 .format(suffix))
1915
2242
        except (ValueError, IndexError) as e:
1916
2243
            raise ValueError(*(e.args))
1917
2244
        timevalue += delta
1931
2258
        sys.exit()
1932
2259
    if not noclose:
1933
2260
        # Close all standard open file descriptors
1934
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2261
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1935
2262
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1936
2263
            raise OSError(errno.ENODEV,
1937
 
                          "%s not a character device"
1938
 
                          % os.path.devnull)
 
2264
                          "{0} not a character device"
 
2265
                          .format(os.devnull))
1939
2266
        os.dup2(null, sys.stdin.fileno())
1940
2267
        os.dup2(null, sys.stdout.fileno())
1941
2268
        os.dup2(null, sys.stderr.fileno())
1950
2277
    
1951
2278
    parser = argparse.ArgumentParser()
1952
2279
    parser.add_argument("-v", "--version", action="version",
1953
 
                        version = "%%(prog)s %s" % version,
 
2280
                        version = "%(prog)s {0}".format(version),
1954
2281
                        help="show version number and exit")
1955
2282
    parser.add_argument("-i", "--interface", metavar="IF",
1956
2283
                        help="Bind to interface IF")
1981
2308
    parser.add_argument("--no-restore", action="store_false",
1982
2309
                        dest="restore", help="Do not restore stored"
1983
2310
                        " state")
 
2311
    parser.add_argument("--socket", type=int,
 
2312
                        help="Specify a file descriptor to a network"
 
2313
                        " socket to use instead of creating one")
1984
2314
    parser.add_argument("--statedir", metavar="DIR",
1985
2315
                        help="Directory to save/restore state in")
 
2316
    parser.add_argument("--foreground", action="store_true",
 
2317
                        help="Run in foreground")
1986
2318
    
1987
2319
    options = parser.parse_args()
1988
2320
    
2003
2335
                        "use_ipv6": "True",
2004
2336
                        "debuglevel": "",
2005
2337
                        "restore": "True",
2006
 
                        "statedir": "/var/lib/mandos"
 
2338
                        "socket": "",
 
2339
                        "statedir": "/var/lib/mandos",
 
2340
                        "foreground": "False",
2007
2341
                        }
2008
2342
    
2009
2343
    # Parse config file for server-global settings
2014
2348
    # Convert the SafeConfigParser object to a dict
2015
2349
    server_settings = server_config.defaults()
2016
2350
    # Use the appropriate methods on the non-string config options
2017
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2351
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2018
2352
        server_settings[option] = server_config.getboolean("DEFAULT",
2019
2353
                                                           option)
2020
2354
    if server_settings["port"]:
2021
2355
        server_settings["port"] = server_config.getint("DEFAULT",
2022
2356
                                                       "port")
 
2357
    if server_settings["socket"]:
 
2358
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2359
                                                         "socket")
 
2360
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2361
        # over with an opened os.devnull.  But we don't want this to
 
2362
        # happen with a supplied network socket.
 
2363
        if 0 <= server_settings["socket"] <= 2:
 
2364
            server_settings["socket"] = os.dup(server_settings
 
2365
                                               ["socket"])
2023
2366
    del server_config
2024
2367
    
2025
2368
    # Override the settings from the config file with command line
2027
2370
    for option in ("interface", "address", "port", "debug",
2028
2371
                   "priority", "servicename", "configdir",
2029
2372
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2030
 
                   "statedir"):
 
2373
                   "statedir", "socket", "foreground"):
2031
2374
        value = getattr(options, option)
2032
2375
        if value is not None:
2033
2376
            server_settings[option] = value
2036
2379
    for option in server_settings.keys():
2037
2380
        if type(server_settings[option]) is str:
2038
2381
            server_settings[option] = unicode(server_settings[option])
 
2382
    # Debug implies foreground
 
2383
    if server_settings["debug"]:
 
2384
        server_settings["foreground"] = True
2039
2385
    # Now we have our good server settings in "server_settings"
2040
2386
    
2041
2387
    ##################################################################
2047
2393
    use_ipv6 = server_settings["use_ipv6"]
2048
2394
    stored_state_path = os.path.join(server_settings["statedir"],
2049
2395
                                     stored_state_file)
 
2396
    foreground = server_settings["foreground"]
2050
2397
    
2051
2398
    if debug:
2052
 
        initlogger(logging.DEBUG)
 
2399
        initlogger(debug, logging.DEBUG)
2053
2400
    else:
2054
2401
        if not debuglevel:
2055
 
            initlogger()
 
2402
            initlogger(debug)
2056
2403
        else:
2057
2404
            level = getattr(logging, debuglevel.upper())
2058
 
            initlogger(level)
 
2405
            initlogger(debug, level)
2059
2406
    
2060
2407
    if server_settings["servicename"] != "Mandos":
2061
2408
        syslogger.setFormatter(logging.Formatter
2062
 
                               ('Mandos (%s) [%%(process)d]:'
2063
 
                                ' %%(levelname)s: %%(message)s'
2064
 
                                % server_settings["servicename"]))
 
2409
                               ('Mandos ({0}) [%(process)d]:'
 
2410
                                ' %(levelname)s: %(message)s'
 
2411
                                .format(server_settings
 
2412
                                        ["servicename"])))
2065
2413
    
2066
2414
    # Parse config file with clients
2067
 
    client_defaults = { "timeout": "5m",
2068
 
                        "extended_timeout": "15m",
2069
 
                        "interval": "2m",
2070
 
                        "checker": "fping -q -- %%(host)s",
2071
 
                        "host": "",
2072
 
                        "approval_delay": "0s",
2073
 
                        "approval_duration": "1s",
2074
 
                        }
2075
 
    client_config = configparser.SafeConfigParser(client_defaults)
 
2415
    client_config = configparser.SafeConfigParser(Client
 
2416
                                                  .client_defaults)
2076
2417
    client_config.read(os.path.join(server_settings["configdir"],
2077
2418
                                    "clients.conf"))
2078
2419
    
2087
2428
                              use_ipv6=use_ipv6,
2088
2429
                              gnutls_priority=
2089
2430
                              server_settings["priority"],
2090
 
                              use_dbus=use_dbus)
2091
 
    if not debug:
 
2431
                              use_dbus=use_dbus,
 
2432
                              socketfd=(server_settings["socket"]
 
2433
                                        or None))
 
2434
    if not foreground:
2092
2435
        pidfilename = "/var/run/mandos.pid"
 
2436
        pidfile = None
2093
2437
        try:
2094
2438
            pidfile = open(pidfilename, "w")
2095
 
        except IOError:
2096
 
            logger.error("Could not open file %r", pidfilename)
 
2439
        except IOError as e:
 
2440
            logger.error("Could not open file %r", pidfilename,
 
2441
                         exc_info=e)
2097
2442
    
2098
 
    try:
2099
 
        uid = pwd.getpwnam("_mandos").pw_uid
2100
 
        gid = pwd.getpwnam("_mandos").pw_gid
2101
 
    except KeyError:
 
2443
    for name in ("_mandos", "mandos", "nobody"):
2102
2444
        try:
2103
 
            uid = pwd.getpwnam("mandos").pw_uid
2104
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2445
            uid = pwd.getpwnam(name).pw_uid
 
2446
            gid = pwd.getpwnam(name).pw_gid
 
2447
            break
2105
2448
        except KeyError:
2106
 
            try:
2107
 
                uid = pwd.getpwnam("nobody").pw_uid
2108
 
                gid = pwd.getpwnam("nobody").pw_gid
2109
 
            except KeyError:
2110
 
                uid = 65534
2111
 
                gid = 65534
 
2449
            continue
 
2450
    else:
 
2451
        uid = 65534
 
2452
        gid = 65534
2112
2453
    try:
2113
2454
        os.setgid(gid)
2114
2455
        os.setuid(uid)
2115
2456
    except OSError as error:
2116
 
        if error[0] != errno.EPERM:
 
2457
        if error.errno != errno.EPERM:
2117
2458
            raise error
2118
2459
    
2119
2460
    if debug:
2131
2472
         .gnutls_global_set_log_function(debug_gnutls))
2132
2473
        
2133
2474
        # Redirect stdin so all checkers get /dev/null
2134
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2475
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2135
2476
        os.dup2(null, sys.stdin.fileno())
2136
2477
        if null > 2:
2137
2478
            os.close(null)
2138
 
    else:
2139
 
        # No console logging
2140
 
        logger.removeHandler(console)
2141
2479
    
2142
2480
    # Need to fork before connecting to D-Bus
2143
 
    if not debug:
 
2481
    if not foreground:
2144
2482
        # Close all input and output, do double fork, etc.
2145
2483
        daemon()
2146
2484
    
 
2485
    # multiprocessing will use threads, so before we use gobject we
 
2486
    # need to inform gobject that threads will be used.
 
2487
    gobject.threads_init()
 
2488
    
2147
2489
    global main_loop
2148
2490
    # From the Avahi example code
2149
 
    DBusGMainLoop(set_as_default=True )
 
2491
    DBusGMainLoop(set_as_default=True)
2150
2492
    main_loop = gobject.MainLoop()
2151
2493
    bus = dbus.SystemBus()
2152
2494
    # End of Avahi example code
2158
2500
                            ("se.bsnet.fukt.Mandos", bus,
2159
2501
                             do_not_queue=True))
2160
2502
        except dbus.exceptions.NameExistsException as e:
2161
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2503
            logger.error("Disabling D-Bus:", exc_info=e)
2162
2504
            use_dbus = False
2163
2505
            server_settings["use_dbus"] = False
2164
2506
            tcp_server.use_dbus = False
2176
2518
    
2177
2519
    client_class = Client
2178
2520
    if use_dbus:
2179
 
        client_class = functools.partial(ClientDBusTransitional,
2180
 
                                         bus = bus)
2181
 
    
2182
 
    special_settings = {
2183
 
        # Some settings need to be accessd by special methods;
2184
 
        # booleans need .getboolean(), etc.  Here is a list of them:
2185
 
        "approved_by_default":
2186
 
            lambda section:
2187
 
            client_config.getboolean(section, "approved_by_default"),
2188
 
        "enabled":
2189
 
            lambda section:
2190
 
            client_config.getboolean(section, "enabled"),
2191
 
        }
2192
 
    # Construct a new dict of client settings of this form:
2193
 
    # { client_name: {setting_name: value, ...}, ...}
2194
 
    # with exceptions for any special settings as defined above
2195
 
    client_settings = dict((clientname,
2196
 
                           dict((setting,
2197
 
                                 (value
2198
 
                                  if setting not in special_settings
2199
 
                                  else special_settings[setting]
2200
 
                                  (clientname)))
2201
 
                                for setting, value in
2202
 
                                client_config.items(clientname)))
2203
 
                          for clientname in client_config.sections())
2204
 
    
 
2521
        client_class = functools.partial(ClientDBus, bus = bus)
 
2522
    
 
2523
    client_settings = Client.config_parser(client_config)
2205
2524
    old_client_settings = {}
2206
 
    clients_data = []
 
2525
    clients_data = {}
2207
2526
    
2208
2527
    # Get client data and settings from last running state.
2209
2528
    if server_settings["restore"]:
2213
2532
                                                     (stored_state))
2214
2533
            os.remove(stored_state_path)
2215
2534
        except IOError as e:
2216
 
            logger.warning("Could not load persistent state: {0}"
2217
 
                           .format(e))
2218
 
            if e.errno != errno.ENOENT:
 
2535
            if e.errno == errno.ENOENT:
 
2536
                logger.warning("Could not load persistent state: {0}"
 
2537
                                .format(os.strerror(e.errno)))
 
2538
            else:
 
2539
                logger.critical("Could not load persistent state:",
 
2540
                                exc_info=e)
2219
2541
                raise
 
2542
        except EOFError as e:
 
2543
            logger.warning("Could not load persistent state: "
 
2544
                           "EOFError:", exc_info=e)
2220
2545
    
2221
2546
    with PGPEngine() as pgp:
2222
 
        for client in clients_data:
2223
 
            client_name = client["name"]
2224
 
            
 
2547
        for client_name, client in clients_data.iteritems():
2225
2548
            # Decide which value to use after restoring saved state.
2226
2549
            # We have three different values: Old config file,
2227
2550
            # new config file, and saved state.
2235
2558
                    if (name != "secret" and
2236
2559
                        value != old_client_settings[client_name]
2237
2560
                        [name]):
2238
 
                        setattr(client, name, value)
 
2561
                        client[name] = value
2239
2562
                except KeyError:
2240
2563
                    pass
2241
2564
            
2242
2565
            # Clients who has passed its expire date can still be
2243
 
            # enabled if its last checker was sucessful.  Clients
2244
 
            # whose checker failed before we stored its state is
2245
 
            # assumed to have failed all checkers during downtime.
2246
 
            if client["enabled"] and client["last_checked_ok"]:
2247
 
                if ((datetime.datetime.utcnow()
2248
 
                     - client["last_checked_ok"])
2249
 
                    > client["interval"]):
2250
 
                    if client["last_checker_status"] != 0:
 
2566
            # enabled if its last checker was successful.  Clients
 
2567
            # whose checker succeeded before we stored its state is
 
2568
            # assumed to have successfully run all checkers during
 
2569
            # downtime.
 
2570
            if client["enabled"]:
 
2571
                if datetime.datetime.utcnow() >= client["expires"]:
 
2572
                    if not client["last_checked_ok"]:
 
2573
                        logger.warning(
 
2574
                            "disabling client {0} - Client never "
 
2575
                            "performed a successful checker"
 
2576
                            .format(client_name))
 
2577
                        client["enabled"] = False
 
2578
                    elif client["last_checker_status"] != 0:
 
2579
                        logger.warning(
 
2580
                            "disabling client {0} - Client "
 
2581
                            "last checker failed with error code {1}"
 
2582
                            .format(client_name,
 
2583
                                    client["last_checker_status"]))
2251
2584
                        client["enabled"] = False
2252
2585
                    else:
2253
2586
                        client["expires"] = (datetime.datetime
2254
2587
                                             .utcnow()
2255
2588
                                             + client["timeout"])
2256
 
            
2257
 
            client["changedstate"] = (multiprocessing_manager
2258
 
                                      .Condition
2259
 
                                      (multiprocessing_manager
2260
 
                                       .Lock()))
2261
 
            if use_dbus:
2262
 
                new_client = (ClientDBusTransitional.__new__
2263
 
                              (ClientDBusTransitional))
2264
 
                tcp_server.clients[client_name] = new_client
2265
 
                new_client.bus = bus
2266
 
                for name, value in client.iteritems():
2267
 
                    setattr(new_client, name, value)
2268
 
                client_object_name = unicode(client_name).translate(
2269
 
                    {ord("."): ord("_"),
2270
 
                     ord("-"): ord("_")})
2271
 
                new_client.dbus_object_path = (dbus.ObjectPath
2272
 
                                               ("/clients/"
2273
 
                                                + client_object_name))
2274
 
                DBusObjectWithProperties.__init__(new_client,
2275
 
                                                  new_client.bus,
2276
 
                                                  new_client
2277
 
                                                  .dbus_object_path)
2278
 
            else:
2279
 
                tcp_server.clients[client_name] = (Client.__new__
2280
 
                                                   (Client))
2281
 
                for name, value in client.iteritems():
2282
 
                    setattr(tcp_server.clients[client_name],
2283
 
                            name, value)
2284
 
            
 
2589
                        logger.debug("Last checker succeeded,"
 
2590
                                     " keeping {0} enabled"
 
2591
                                     .format(client_name))
2285
2592
            try:
2286
 
                tcp_server.clients[client_name].secret = (
2287
 
                    pgp.decrypt(tcp_server.clients[client_name]
2288
 
                                .encrypted_secret,
 
2593
                client["secret"] = (
 
2594
                    pgp.decrypt(client["encrypted_secret"],
2289
2595
                                client_settings[client_name]
2290
2596
                                ["secret"]))
2291
2597
            except PGPError:
2292
2598
                # If decryption fails, we use secret from new settings
2293
 
                tcp_server.clients[client_name].secret = (
 
2599
                logger.debug("Failed to decrypt {0} old secret"
 
2600
                             .format(client_name))
 
2601
                client["secret"] = (
2294
2602
                    client_settings[client_name]["secret"])
2295
2603
    
2296
 
    # Create/remove clients based on new changes made to config
2297
 
    for clientname in set(old_client_settings) - set(client_settings):
2298
 
        del tcp_server.clients[clientname]
2299
 
    for clientname in set(client_settings) - set(old_client_settings):
2300
 
        tcp_server.clients[clientname] = (client_class(name
2301
 
                                                       = clientname,
2302
 
                                                       config =
2303
 
                                                       client_settings
2304
 
                                                       [clientname]))
 
2604
    # Add/remove clients based on new changes made to config
 
2605
    for client_name in (set(old_client_settings)
 
2606
                        - set(client_settings)):
 
2607
        del clients_data[client_name]
 
2608
    for client_name in (set(client_settings)
 
2609
                        - set(old_client_settings)):
 
2610
        clients_data[client_name] = client_settings[client_name]
 
2611
    
 
2612
    # Create all client objects
 
2613
    for client_name, client in clients_data.iteritems():
 
2614
        tcp_server.clients[client_name] = client_class(
 
2615
            name = client_name, settings = client)
2305
2616
    
2306
2617
    if not tcp_server.clients:
2307
2618
        logger.warning("No clients defined")
2308
 
        
2309
 
    if not debug:
2310
 
        try:
2311
 
            with pidfile:
2312
 
                pid = os.getpid()
2313
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2314
 
            del pidfile
2315
 
        except IOError:
2316
 
            logger.error("Could not write to file %r with PID %d",
2317
 
                         pidfilename, pid)
2318
 
        except NameError:
2319
 
            # "pidfile" was never created
2320
 
            pass
 
2619
    
 
2620
    if not foreground:
 
2621
        if pidfile is not None:
 
2622
            try:
 
2623
                with pidfile:
 
2624
                    pid = os.getpid()
 
2625
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2626
            except IOError:
 
2627
                logger.error("Could not write to file %r with PID %d",
 
2628
                             pidfilename, pid)
 
2629
        del pidfile
2321
2630
        del pidfilename
2322
 
        
2323
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2324
2631
    
2325
2632
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2326
2633
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2327
2634
    
2328
2635
    if use_dbus:
2329
 
        class MandosDBusService(dbus.service.Object):
 
2636
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2637
                                        "se.bsnet.fukt.Mandos"})
 
2638
        class MandosDBusService(DBusObjectWithProperties):
2330
2639
            """A D-Bus proxy object"""
2331
2640
            def __init__(self):
2332
2641
                dbus.service.Object.__init__(self, bus, "/")
2333
2642
            _interface = "se.recompile.Mandos"
2334
2643
            
 
2644
            @dbus_interface_annotations(_interface)
 
2645
            def _foo(self):
 
2646
                return { "org.freedesktop.DBus.Property"
 
2647
                         ".EmitsChangedSignal":
 
2648
                             "false"}
 
2649
            
2335
2650
            @dbus.service.signal(_interface, signature="o")
2336
2651
            def ClientAdded(self, objpath):
2337
2652
                "D-Bus signal"
2379
2694
            
2380
2695
            del _interface
2381
2696
        
2382
 
        class MandosDBusServiceTransitional(MandosDBusService):
2383
 
            __metaclass__ = AlternateDBusNamesMetaclass
2384
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2697
        mandos_dbus_service = MandosDBusService()
2385
2698
    
2386
2699
    def cleanup():
2387
2700
        "Cleanup function; run on exit"
2394
2707
        # Store client before exiting. Secrets are encrypted with key
2395
2708
        # based on what config file has. If config file is
2396
2709
        # removed/edited, old secret will thus be unrecovable.
2397
 
        clients = []
 
2710
        clients = {}
2398
2711
        with PGPEngine() as pgp:
2399
2712
            for client in tcp_server.clients.itervalues():
2400
2713
                key = client_settings[client.name]["secret"]
2402
2715
                                                      key)
2403
2716
                client_dict = {}
2404
2717
                
2405
 
                # A list of attributes that will not be stored when
2406
 
                # shutting down.
2407
 
                exclude = set(("bus", "changedstate", "secret"))
 
2718
                # A list of attributes that can not be pickled
 
2719
                # + secret.
 
2720
                exclude = set(("bus", "changedstate", "secret",
 
2721
                               "checker"))
2408
2722
                for name, typ in (inspect.getmembers
2409
2723
                                  (dbus.service.Object)):
2410
2724
                    exclude.add(name)
2415
2729
                    if attr not in exclude:
2416
2730
                        client_dict[attr] = getattr(client, attr)
2417
2731
                
2418
 
                clients.append(client_dict)
 
2732
                clients[client.name] = client_dict
2419
2733
                del client_settings[client.name]["secret"]
2420
2734
        
2421
2735
        try:
2422
 
            with os.fdopen(os.open(stored_state_path,
2423
 
                                   os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2424
 
                                   0600), "wb") as stored_state:
 
2736
            with (tempfile.NamedTemporaryFile
 
2737
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2738
                   dir=os.path.dirname(stored_state_path),
 
2739
                   delete=False)) as stored_state:
2425
2740
                pickle.dump((clients, client_settings), stored_state)
 
2741
                tempname=stored_state.name
 
2742
            os.rename(tempname, stored_state_path)
2426
2743
        except (IOError, OSError) as e:
2427
 
            logger.warning("Could not save persistent state: {0}"
2428
 
                           .format(e))
2429
 
            if e.errno not in (errno.ENOENT, errno.EACCES):
2430
 
                raise
 
2744
            if not debug:
 
2745
                try:
 
2746
                    os.remove(tempname)
 
2747
                except NameError:
 
2748
                    pass
 
2749
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2750
                logger.warning("Could not save persistent state: {0}"
 
2751
                               .format(os.strerror(e.errno)))
 
2752
            else:
 
2753
                logger.warning("Could not save persistent state:",
 
2754
                               exc_info=e)
 
2755
                raise e
2431
2756
        
2432
2757
        # Delete all clients, and settings from config
2433
2758
        while tcp_server.clients:
2460
2785
    service.port = tcp_server.socket.getsockname()[1]
2461
2786
    if use_ipv6:
2462
2787
        logger.info("Now listening on address %r, port %d,"
2463
 
                    " flowinfo %d, scope_id %d"
2464
 
                    % tcp_server.socket.getsockname())
 
2788
                    " flowinfo %d, scope_id %d",
 
2789
                    *tcp_server.socket.getsockname())
2465
2790
    else:                       # IPv4
2466
 
        logger.info("Now listening on address %r, port %d"
2467
 
                    % tcp_server.socket.getsockname())
 
2791
        logger.info("Now listening on address %r, port %d",
 
2792
                    *tcp_server.socket.getsockname())
2468
2793
    
2469
2794
    #service.interface = tcp_server.socket.getsockname()[3]
2470
2795
    
2473
2798
        try:
2474
2799
            service.activate()
2475
2800
        except dbus.exceptions.DBusException as error:
2476
 
            logger.critical("DBusException: %s", error)
 
2801
            logger.critical("D-Bus Exception", exc_info=error)
2477
2802
            cleanup()
2478
2803
            sys.exit(1)
2479
2804
        # End of Avahi example code
2486
2811
        logger.debug("Starting main loop")
2487
2812
        main_loop.run()
2488
2813
    except AvahiError as error:
2489
 
        logger.critical("AvahiError: %s", error)
 
2814
        logger.critical("Avahi Error", exc_info=error)
2490
2815
        cleanup()
2491
2816
        sys.exit(1)
2492
2817
    except KeyboardInterrupt:
2497
2822
    # Must run before the D-Bus bus name gets deregistered
2498
2823
    cleanup()
2499
2824
 
2500
 
 
2501
2825
if __name__ == '__main__':
2502
2826
    main()