/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-17 14:55:31 UTC
  • mto: (301.1.1 release) (237.7.272 trunk)
  • mto: This revision was merged to the branch mainline in revision 302.
  • Revision ID: teddy@recompile.se-20120617145531-o24z982oerm6xb6s
* mandos: New "--foreground" option.

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
68
71
 
69
72
import dbus
70
73
import dbus.service
85
88
    except ImportError:
86
89
        SO_BINDTODEVICE = None
87
90
 
88
 
version = "1.4.1"
 
91
version = "1.5.5"
89
92
stored_state_file = "clients.pickle"
90
93
 
91
94
logger = logging.getLogger()
142
145
        self.gnupg.options.meta_interactive = False
143
146
        self.gnupg.options.homedir = self.tempdir
144
147
        self.gnupg.options.extra_args.extend(['--force-mdc',
145
 
                                              '--quiet'])
 
148
                                              '--quiet',
 
149
                                              '--no-use-agent'])
146
150
    
147
151
    def __enter__(self):
148
152
        return self
149
153
    
150
 
    def __exit__ (self, exc_type, exc_value, traceback):
 
154
    def __exit__(self, exc_type, exc_value, traceback):
151
155
        self._cleanup()
152
156
        return False
153
157
    
174
178
    
175
179
    def encrypt(self, data, password):
176
180
        self.gnupg.passphrase = self.password_encode(password)
177
 
        with open(os.devnull) as devnull:
 
181
        with open(os.devnull, "w") as devnull:
178
182
            try:
179
183
                proc = self.gnupg.run(['--symmetric'],
180
184
                                      create_fhs=['stdin', 'stdout'],
191
195
    
192
196
    def decrypt(self, data, password):
193
197
        self.gnupg.passphrase = self.password_encode(password)
194
 
        with open(os.devnull) as devnull:
 
198
        with open(os.devnull, "w") as devnull:
195
199
            try:
196
200
                proc = self.gnupg.run(['--decrypt'],
197
201
                                      create_fhs=['stdin', 'stdout'],
198
202
                                      attach_fhs={'stderr': devnull})
199
 
                with contextlib.closing(proc.handles['stdin'] ) as f:
 
203
                with contextlib.closing(proc.handles['stdin']) as f:
200
204
                    f.write(data)
201
205
                with contextlib.closing(proc.handles['stdout']) as f:
202
206
                    decrypted_plaintext = f.read()
207
211
        return decrypted_plaintext
208
212
 
209
213
 
210
 
 
211
214
class AvahiError(Exception):
212
215
    def __init__(self, value, *args, **kwargs):
213
216
        self.value = value
242
245
    server: D-Bus Server
243
246
    bus: dbus.SystemBus()
244
247
    """
 
248
    
245
249
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
246
250
                 servicetype = None, port = None, TXT = None,
247
251
                 domain = "", host = "", max_renames = 32768,
260
264
        self.server = None
261
265
        self.bus = bus
262
266
        self.entry_group_state_changed_match = None
 
267
    
263
268
    def rename(self):
264
269
        """Derived from the Avahi example code"""
265
270
        if self.rename_count >= self.max_renames:
275
280
        try:
276
281
            self.add()
277
282
        except dbus.exceptions.DBusException as error:
278
 
            logger.critical("DBusException: %s", error)
 
283
            logger.critical("D-Bus Exception", exc_info=error)
279
284
            self.cleanup()
280
285
            os._exit(1)
281
286
        self.rename_count += 1
 
287
    
282
288
    def remove(self):
283
289
        """Derived from the Avahi example code"""
284
290
        if self.entry_group_state_changed_match is not None:
286
292
            self.entry_group_state_changed_match = None
287
293
        if self.group is not None:
288
294
            self.group.Reset()
 
295
    
289
296
    def add(self):
290
297
        """Derived from the Avahi example code"""
291
298
        self.remove()
308
315
            dbus.UInt16(self.port),
309
316
            avahi.string_array_to_txt_array(self.TXT))
310
317
        self.group.Commit()
 
318
    
311
319
    def entry_group_state_changed(self, state, error):
312
320
        """Derived from the Avahi example code"""
313
321
        logger.debug("Avahi entry group state change: %i", state)
320
328
        elif state == avahi.ENTRY_GROUP_FAILURE:
321
329
            logger.critical("Avahi: Error in group state changed %s",
322
330
                            unicode(error))
323
 
            raise AvahiGroupError("State changed: %s"
324
 
                                  % unicode(error))
 
331
            raise AvahiGroupError("State changed: {0!s}"
 
332
                                  .format(error))
 
333
    
325
334
    def cleanup(self):
326
335
        """Derived from the Avahi example code"""
327
336
        if self.group is not None:
332
341
                pass
333
342
            self.group = None
334
343
        self.remove()
 
344
    
335
345
    def server_state_changed(self, state, error=None):
336
346
        """Derived from the Avahi example code"""
337
347
        logger.debug("Avahi server state change: %i", state)
356
366
                logger.debug("Unknown state: %r", state)
357
367
            else:
358
368
                logger.debug("Unknown state: %r: %r", state, error)
 
369
    
359
370
    def activate(self):
360
371
        """Derived from the Avahi example code"""
361
372
        if self.server is None:
368
379
                                 self.server_state_changed)
369
380
        self.server_state_changed(self.server.GetState())
370
381
 
 
382
 
371
383
class AvahiServiceToSyslog(AvahiService):
372
384
    def rename(self):
373
385
        """Add the new name to the syslog messages"""
374
386
        ret = AvahiService.rename(self)
375
387
        syslogger.setFormatter(logging.Formatter
376
 
                               ('Mandos (%s) [%%(process)d]:'
377
 
                                ' %%(levelname)s: %%(message)s'
378
 
                                % self.name))
 
388
                               ('Mandos ({0}) [%(process)d]:'
 
389
                                ' %(levelname)s: %(message)s'
 
390
                                .format(self.name)))
379
391
        return ret
380
392
 
 
393
 
381
394
def timedelta_to_milliseconds(td):
382
395
    "Convert a datetime.timedelta() to milliseconds"
383
396
    return ((td.days * 24 * 60 * 60 * 1000)
384
397
            + (td.seconds * 1000)
385
398
            + (td.microseconds // 1000))
386
 
        
 
399
 
 
400
 
387
401
class Client(object):
388
402
    """A representation of a client host served by this server.
389
403
    
414
428
    last_checked_ok: datetime.datetime(); (UTC) or None
415
429
    last_checker_status: integer between 0 and 255 reflecting exit
416
430
                         status of last checker. -1 reflects crashed
417
 
                         checker, or None.
 
431
                         checker, -2 means no checker completed yet.
418
432
    last_enabled: datetime.datetime(); (UTC) or None
419
433
    name:       string; from the config file, used in log messages and
420
434
                        D-Bus identifiers
421
435
    secret:     bytestring; sent verbatim (over TLS) to client
422
436
    timeout:    datetime.timedelta(); How long from last_checked_ok
423
437
                                      until this client is disabled
424
 
    extended_timeout:   extra long timeout when password has been sent
 
438
    extended_timeout:   extra long timeout when secret has been sent
425
439
    runtime_expansions: Allowed attributes for runtime expansion.
426
440
    expires:    datetime.datetime(); time (UTC) when a client will be
427
441
                disabled, or None
428
442
    """
429
443
    
430
444
    runtime_expansions = ("approval_delay", "approval_duration",
431
 
                          "created", "enabled", "fingerprint",
432
 
                          "host", "interval", "last_checked_ok",
 
445
                          "created", "enabled", "expires",
 
446
                          "fingerprint", "host", "interval",
 
447
                          "last_approval_request", "last_checked_ok",
433
448
                          "last_enabled", "name", "timeout")
434
449
    client_defaults = { "timeout": "5m",
435
450
                        "extended_timeout": "15m",
456
471
    
457
472
    def approval_delay_milliseconds(self):
458
473
        return timedelta_to_milliseconds(self.approval_delay)
459
 
 
 
474
    
460
475
    @staticmethod
461
476
    def config_parser(config):
462
 
        """ Construct a new dict of client settings of this form:
 
477
        """Construct a new dict of client settings of this form:
463
478
        { client_name: {setting_name: value, ...}, ...}
464
 
        with exceptions for any special settings as defined above"""
 
479
        with exceptions for any special settings as defined above.
 
480
        NOTE: Must be a pure function. Must return the same result
 
481
        value given the same arguments.
 
482
        """
465
483
        settings = {}
466
484
        for client_name in config.sections():
467
485
            section = dict(config.items(client_name))
471
489
            # Reformat values from string types to Python types
472
490
            client["approved_by_default"] = config.getboolean(
473
491
                client_name, "approved_by_default")
474
 
            client["enabled"] = config.getboolean(client_name, "enabled")
 
492
            client["enabled"] = config.getboolean(client_name,
 
493
                                                  "enabled")
475
494
            
476
495
            client["fingerprint"] = (section["fingerprint"].upper()
477
496
                                     .replace(" ", ""))
483
502
                          "rb") as secfile:
484
503
                    client["secret"] = secfile.read()
485
504
            else:
486
 
                raise TypeError("No secret or secfile for section %s"
487
 
                                % section)
 
505
                raise TypeError("No secret or secfile for section {0}"
 
506
                                .format(section))
488
507
            client["timeout"] = string_to_delta(section["timeout"])
489
508
            client["extended_timeout"] = string_to_delta(
490
509
                section["extended_timeout"])
496
515
            client["checker_command"] = section["checker"]
497
516
            client["last_approval_request"] = None
498
517
            client["last_checked_ok"] = None
499
 
            client["last_checker_status"] = None
500
 
            if client["enabled"]:
501
 
                client["last_enabled"] = datetime.datetime.utcnow()
502
 
                client["expires"] = (datetime.datetime.utcnow()
503
 
                                     + client["timeout"])
504
 
            else:
505
 
                client["last_enabled"] = None
506
 
                client["expires"] = None
507
 
 
 
518
            client["last_checker_status"] = -2
 
519
        
508
520
        return settings
509
 
        
510
 
        
 
521
    
511
522
    def __init__(self, settings, name = None):
512
 
        """Note: the 'checker' key in 'config' sets the
513
 
        'checker_command' attribute and *not* the 'checker'
514
 
        attribute."""
515
523
        self.name = name
516
524
        # adding all client settings
517
525
        for setting, value in settings.iteritems():
518
526
            setattr(self, setting, value)
519
527
        
 
528
        if self.enabled:
 
529
            if not hasattr(self, "last_enabled"):
 
530
                self.last_enabled = datetime.datetime.utcnow()
 
531
            if not hasattr(self, "expires"):
 
532
                self.expires = (datetime.datetime.utcnow()
 
533
                                + self.timeout)
 
534
        else:
 
535
            self.last_enabled = None
 
536
            self.expires = None
 
537
        
520
538
        logger.debug("Creating client %r", self.name)
521
539
        # Uppercase and remove spaces from fingerprint for later
522
540
        # comparison purposes with return value from the fingerprint()
523
541
        # function
524
542
        logger.debug("  Fingerprint: %s", self.fingerprint)
525
 
        self.created = settings.get("created", datetime.datetime.utcnow())
526
 
 
 
543
        self.created = settings.get("created",
 
544
                                    datetime.datetime.utcnow())
 
545
        
527
546
        # attributes specific for this server instance
528
547
        self.checker = None
529
548
        self.checker_initiator_tag = None
557
576
        if getattr(self, "enabled", False):
558
577
            # Already enabled
559
578
            return
560
 
        self.send_changedstate()
561
579
        self.expires = datetime.datetime.utcnow() + self.timeout
562
580
        self.enabled = True
563
581
        self.last_enabled = datetime.datetime.utcnow()
564
582
        self.init_checker()
 
583
        self.send_changedstate()
565
584
    
566
585
    def disable(self, quiet=True):
567
586
        """Disable this client."""
568
587
        if not getattr(self, "enabled", False):
569
588
            return False
570
589
        if not quiet:
571
 
            self.send_changedstate()
572
 
        if not quiet:
573
590
            logger.info("Disabling client %s", self.name)
574
 
        if getattr(self, "disable_initiator_tag", False):
 
591
        if getattr(self, "disable_initiator_tag", None) is not None:
575
592
            gobject.source_remove(self.disable_initiator_tag)
576
593
            self.disable_initiator_tag = None
577
594
        self.expires = None
578
 
        if getattr(self, "checker_initiator_tag", False):
 
595
        if getattr(self, "checker_initiator_tag", None) is not None:
579
596
            gobject.source_remove(self.checker_initiator_tag)
580
597
            self.checker_initiator_tag = None
581
598
        self.stop_checker()
582
599
        self.enabled = False
 
600
        if not quiet:
 
601
            self.send_changedstate()
583
602
        # Do not run this again if called by a gobject.timeout_add
584
603
        return False
585
604
    
589
608
    def init_checker(self):
590
609
        # Schedule a new checker to be started an 'interval' from now,
591
610
        # and every interval from then on.
 
611
        if self.checker_initiator_tag is not None:
 
612
            gobject.source_remove(self.checker_initiator_tag)
592
613
        self.checker_initiator_tag = (gobject.timeout_add
593
614
                                      (self.interval_milliseconds(),
594
615
                                       self.start_checker))
595
616
        # Schedule a disable() when 'timeout' has passed
 
617
        if self.disable_initiator_tag is not None:
 
618
            gobject.source_remove(self.disable_initiator_tag)
596
619
        self.disable_initiator_tag = (gobject.timeout_add
597
620
                                   (self.timeout_milliseconds(),
598
621
                                    self.disable))
617
640
            logger.warning("Checker for %(name)s crashed?",
618
641
                           vars(self))
619
642
    
620
 
    def checked_ok(self, timeout=None):
621
 
        """Bump up the timeout for this client.
622
 
        
623
 
        This should only be called when the client has been seen,
624
 
        alive and well.
625
 
        """
 
643
    def checked_ok(self):
 
644
        """Assert that the client has been seen, alive and well."""
 
645
        self.last_checked_ok = datetime.datetime.utcnow()
 
646
        self.last_checker_status = 0
 
647
        self.bump_timeout()
 
648
    
 
649
    def bump_timeout(self, timeout=None):
 
650
        """Bump up the timeout for this client."""
626
651
        if timeout is None:
627
652
            timeout = self.timeout
628
 
        self.last_checked_ok = datetime.datetime.utcnow()
629
653
        if self.disable_initiator_tag is not None:
630
654
            gobject.source_remove(self.disable_initiator_tag)
 
655
            self.disable_initiator_tag = None
631
656
        if getattr(self, "enabled", False):
632
657
            self.disable_initiator_tag = (gobject.timeout_add
633
658
                                          (timedelta_to_milliseconds
643
668
        If a checker already exists, leave it running and do
644
669
        nothing."""
645
670
        # The reason for not killing a running checker is that if we
646
 
        # did that, then if a checker (for some reason) started
647
 
        # running slowly and taking more than 'interval' time, the
648
 
        # client would inevitably timeout, since no checker would get
649
 
        # a chance to run to completion.  If we instead leave running
 
671
        # did that, and if a checker (for some reason) started running
 
672
        # slowly and taking more than 'interval' time, then the client
 
673
        # would inevitably timeout, since no checker would get a
 
674
        # chance to run to completion.  If we instead leave running
650
675
        # checkers alone, the checker would have to take more time
651
676
        # than 'timeout' for the client to be disabled, which is as it
652
677
        # should be.
666
691
                                      self.current_checker_command)
667
692
        # Start a new checker if needed
668
693
        if self.checker is None:
 
694
            # Escape attributes for the shell
 
695
            escaped_attrs = dict(
 
696
                (attr, re.escape(unicode(getattr(self, attr))))
 
697
                for attr in
 
698
                self.runtime_expansions)
669
699
            try:
670
 
                # In case checker_command has exactly one % operator
671
 
                command = self.checker_command % self.host
672
 
            except TypeError:
673
 
                # Escape attributes for the shell
674
 
                escaped_attrs = dict(
675
 
                    (attr,
676
 
                     re.escape(unicode(str(getattr(self, attr, "")),
677
 
                                       errors=
678
 
                                       'replace')))
679
 
                    for attr in
680
 
                    self.runtime_expansions)
681
 
                
682
 
                try:
683
 
                    command = self.checker_command % escaped_attrs
684
 
                except TypeError as error:
685
 
                    logger.error('Could not format string "%s":'
686
 
                                 ' %s', self.checker_command, error)
687
 
                    return True # Try again later
 
700
                command = self.checker_command % escaped_attrs
 
701
            except TypeError as error:
 
702
                logger.error('Could not format string "%s"',
 
703
                             self.checker_command, exc_info=error)
 
704
                return True # Try again later
688
705
            self.current_checker_command = command
689
706
            try:
690
707
                logger.info("Starting checker %r for %s",
696
713
                self.checker = subprocess.Popen(command,
697
714
                                                close_fds=True,
698
715
                                                shell=True, cwd="/")
699
 
                self.checker_callback_tag = (gobject.child_watch_add
700
 
                                             (self.checker.pid,
701
 
                                              self.checker_callback,
702
 
                                              data=command))
703
 
                # The checker may have completed before the gobject
704
 
                # watch was added.  Check for this.
705
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
706
 
                if pid:
707
 
                    gobject.source_remove(self.checker_callback_tag)
708
 
                    self.checker_callback(pid, status, command)
709
716
            except OSError as error:
710
 
                logger.error("Failed to start subprocess: %s",
711
 
                             error)
 
717
                logger.error("Failed to start subprocess",
 
718
                             exc_info=error)
 
719
            self.checker_callback_tag = (gobject.child_watch_add
 
720
                                         (self.checker.pid,
 
721
                                          self.checker_callback,
 
722
                                          data=command))
 
723
            # The checker may have completed before the gobject
 
724
            # watch was added.  Check for this.
 
725
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
726
            if pid:
 
727
                gobject.source_remove(self.checker_callback_tag)
 
728
                self.checker_callback(pid, status, command)
712
729
        # Re-run this periodically if run by gobject.timeout_add
713
730
        return True
714
731
    
721
738
            return
722
739
        logger.debug("Stopping checker for %(name)s", vars(self))
723
740
        try:
724
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
741
            self.checker.terminate()
725
742
            #time.sleep(0.5)
726
743
            #if self.checker.poll() is None:
727
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
744
            #    self.checker.kill()
728
745
        except OSError as error:
729
746
            if error.errno != errno.ESRCH: # No such process
730
747
                raise
747
764
    # "Set" method, so we fail early here:
748
765
    if byte_arrays and signature != "ay":
749
766
        raise ValueError("Byte arrays not supported for non-'ay'"
750
 
                         " signature %r" % signature)
 
767
                         " signature {0!r}".format(signature))
751
768
    def decorator(func):
752
769
        func._dbus_is_property = True
753
770
        func._dbus_interface = dbus_interface
761
778
    return decorator
762
779
 
763
780
 
 
781
def dbus_interface_annotations(dbus_interface):
 
782
    """Decorator for marking functions returning interface annotations
 
783
    
 
784
    Usage:
 
785
    
 
786
    @dbus_interface_annotations("org.example.Interface")
 
787
    def _foo(self):  # Function name does not matter
 
788
        return {"org.freedesktop.DBus.Deprecated": "true",
 
789
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
790
                    "false"}
 
791
    """
 
792
    def decorator(func):
 
793
        func._dbus_is_interface = True
 
794
        func._dbus_interface = dbus_interface
 
795
        func._dbus_name = dbus_interface
 
796
        return func
 
797
    return decorator
 
798
 
 
799
 
 
800
def dbus_annotations(annotations):
 
801
    """Decorator to annotate D-Bus methods, signals or properties
 
802
    Usage:
 
803
    
 
804
    @dbus_service_property("org.example.Interface", signature="b",
 
805
                           access="r")
 
806
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
 
807
                        "org.freedesktop.DBus.Property."
 
808
                        "EmitsChangedSignal": "false"})
 
809
    def Property_dbus_property(self):
 
810
        return dbus.Boolean(False)
 
811
    """
 
812
    def decorator(func):
 
813
        func._dbus_annotations = annotations
 
814
        return func
 
815
    return decorator
 
816
 
 
817
 
764
818
class DBusPropertyException(dbus.exceptions.DBusException):
765
819
    """A base class for D-Bus property-related exceptions
766
820
    """
789
843
    """
790
844
    
791
845
    @staticmethod
792
 
    def _is_dbus_property(obj):
793
 
        return getattr(obj, "_dbus_is_property", False)
 
846
    def _is_dbus_thing(thing):
 
847
        """Returns a function testing if an attribute is a D-Bus thing
 
848
        
 
849
        If called like _is_dbus_thing("method") it returns a function
 
850
        suitable for use as predicate to inspect.getmembers().
 
851
        """
 
852
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
 
853
                                   False)
794
854
    
795
 
    def _get_all_dbus_properties(self):
 
855
    def _get_all_dbus_things(self, thing):
796
856
        """Returns a generator of (name, attribute) pairs
797
857
        """
798
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
858
        return ((getattr(athing.__get__(self), "_dbus_name",
 
859
                         name),
 
860
                 athing.__get__(self))
799
861
                for cls in self.__class__.__mro__
800
 
                for name, prop in
801
 
                inspect.getmembers(cls, self._is_dbus_property))
 
862
                for name, athing in
 
863
                inspect.getmembers(cls,
 
864
                                   self._is_dbus_thing(thing)))
802
865
    
803
866
    def _get_dbus_property(self, interface_name, property_name):
804
867
        """Returns a bound method if one exists which is a D-Bus
806
869
        """
807
870
        for cls in  self.__class__.__mro__:
808
871
            for name, value in (inspect.getmembers
809
 
                                (cls, self._is_dbus_property)):
 
872
                                (cls,
 
873
                                 self._is_dbus_thing("property"))):
810
874
                if (value._dbus_name == property_name
811
875
                    and value._dbus_interface == interface_name):
812
876
                    return value.__get__(self)
841
905
            # signatures other than "ay".
842
906
            if prop._dbus_signature != "ay":
843
907
                raise ValueError
844
 
            value = dbus.ByteArray(''.join(unichr(byte)
845
 
                                           for byte in value))
 
908
            value = dbus.ByteArray(b''.join(chr(byte)
 
909
                                            for byte in value))
846
910
        prop(value)
847
911
    
848
912
    @dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
854
918
        Note: Will not include properties with access="write".
855
919
        """
856
920
        properties = {}
857
 
        for name, prop in self._get_all_dbus_properties():
 
921
        for name, prop in self._get_all_dbus_things("property"):
858
922
            if (interface_name
859
923
                and interface_name != prop._dbus_interface):
860
924
                # Interface non-empty but did not match
875
939
                         path_keyword='object_path',
876
940
                         connection_keyword='connection')
877
941
    def Introspect(self, object_path, connection):
878
 
        """Standard D-Bus method, overloaded to insert property tags.
 
942
        """Overloading of standard D-Bus method.
 
943
        
 
944
        Inserts property tags and interface annotation tags.
879
945
        """
880
946
        xmlstring = dbus.service.Object.Introspect(self, object_path,
881
947
                                                   connection)
888
954
                e.setAttribute("access", prop._dbus_access)
889
955
                return e
890
956
            for if_tag in document.getElementsByTagName("interface"):
 
957
                # Add property tags
891
958
                for tag in (make_tag(document, name, prop)
892
959
                            for name, prop
893
 
                            in self._get_all_dbus_properties()
 
960
                            in self._get_all_dbus_things("property")
894
961
                            if prop._dbus_interface
895
962
                            == if_tag.getAttribute("name")):
896
963
                    if_tag.appendChild(tag)
 
964
                # Add annotation tags
 
965
                for typ in ("method", "signal", "property"):
 
966
                    for tag in if_tag.getElementsByTagName(typ):
 
967
                        annots = dict()
 
968
                        for name, prop in (self.
 
969
                                           _get_all_dbus_things(typ)):
 
970
                            if (name == tag.getAttribute("name")
 
971
                                and prop._dbus_interface
 
972
                                == if_tag.getAttribute("name")):
 
973
                                annots.update(getattr
 
974
                                              (prop,
 
975
                                               "_dbus_annotations",
 
976
                                               {}))
 
977
                        for name, value in annots.iteritems():
 
978
                            ann_tag = document.createElement(
 
979
                                "annotation")
 
980
                            ann_tag.setAttribute("name", name)
 
981
                            ann_tag.setAttribute("value", value)
 
982
                            tag.appendChild(ann_tag)
 
983
                # Add interface annotation tags
 
984
                for annotation, value in dict(
 
985
                    itertools.chain.from_iterable(
 
986
                        annotations().iteritems()
 
987
                        for name, annotations in
 
988
                        self._get_all_dbus_things("interface")
 
989
                        if name == if_tag.getAttribute("name")
 
990
                        )).iteritems():
 
991
                    ann_tag = document.createElement("annotation")
 
992
                    ann_tag.setAttribute("name", annotation)
 
993
                    ann_tag.setAttribute("value", value)
 
994
                    if_tag.appendChild(ann_tag)
897
995
                # Add the names to the return values for the
898
996
                # "org.freedesktop.DBus.Properties" methods
899
997
                if (if_tag.getAttribute("name")
914
1012
        except (AttributeError, xml.dom.DOMException,
915
1013
                xml.parsers.expat.ExpatError) as error:
916
1014
            logger.error("Failed to override Introspection method",
917
 
                         error)
 
1015
                         exc_info=error)
918
1016
        return xmlstring
919
1017
 
920
1018
 
921
 
def datetime_to_dbus (dt, variant_level=0):
 
1019
def datetime_to_dbus(dt, variant_level=0):
922
1020
    """Convert a UTC datetime.datetime() to a D-Bus type."""
923
1021
    if dt is None:
924
1022
        return dbus.String("", variant_level = variant_level)
926
1024
                       variant_level=variant_level)
927
1025
 
928
1026
 
929
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
930
 
                                  .__metaclass__):
931
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
932
 
    will add additional D-Bus attributes matching a certain pattern.
 
1027
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1028
    """A class decorator; applied to a subclass of
 
1029
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1030
    interface names according to the "alt_interface_names" mapping.
 
1031
    Usage:
 
1032
    
 
1033
    @alternate_dbus_interfaces({"org.example.Interface":
 
1034
                                    "net.example.AlternateInterface"})
 
1035
    class SampleDBusObject(dbus.service.Object):
 
1036
        @dbus.service.method("org.example.Interface")
 
1037
        def SampleDBusMethod():
 
1038
            pass
 
1039
    
 
1040
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1041
    reachable via two interfaces: "org.example.Interface" and
 
1042
    "net.example.AlternateInterface", the latter of which will have
 
1043
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1044
    "true", unless "deprecate" is passed with a False value.
 
1045
    
 
1046
    This works for methods and signals, and also for D-Bus properties
 
1047
    (from DBusObjectWithProperties) and interfaces (from the
 
1048
    dbus_interface_annotations decorator).
933
1049
    """
934
 
    def __new__(mcs, name, bases, attr):
935
 
        # Go through all the base classes which could have D-Bus
936
 
        # methods, signals, or properties in them
937
 
        for base in (b for b in bases
938
 
                     if issubclass(b, dbus.service.Object)):
939
 
            # Go though all attributes of the base class
940
 
            for attrname, attribute in inspect.getmembers(base):
 
1050
    def wrapper(cls):
 
1051
        for orig_interface_name, alt_interface_name in (
 
1052
            alt_interface_names.iteritems()):
 
1053
            attr = {}
 
1054
            interface_names = set()
 
1055
            # Go though all attributes of the class
 
1056
            for attrname, attribute in inspect.getmembers(cls):
941
1057
                # Ignore non-D-Bus attributes, and D-Bus attributes
942
1058
                # with the wrong interface name
943
1059
                if (not hasattr(attribute, "_dbus_interface")
944
1060
                    or not attribute._dbus_interface
945
 
                    .startswith("se.recompile.Mandos")):
 
1061
                    .startswith(orig_interface_name)):
946
1062
                    continue
947
1063
                # Create an alternate D-Bus interface name based on
948
1064
                # the current name
949
1065
                alt_interface = (attribute._dbus_interface
950
 
                                 .replace("se.recompile.Mandos",
951
 
                                          "se.bsnet.fukt.Mandos"))
 
1066
                                 .replace(orig_interface_name,
 
1067
                                          alt_interface_name))
 
1068
                interface_names.add(alt_interface)
952
1069
                # Is this a D-Bus signal?
953
1070
                if getattr(attribute, "_dbus_is_signal", False):
954
1071
                    # Extract the original non-method function by
969
1086
                                nonmethod_func.func_name,
970
1087
                                nonmethod_func.func_defaults,
971
1088
                                nonmethod_func.func_closure)))
 
1089
                    # Copy annotations, if any
 
1090
                    try:
 
1091
                        new_function._dbus_annotations = (
 
1092
                            dict(attribute._dbus_annotations))
 
1093
                    except AttributeError:
 
1094
                        pass
972
1095
                    # Define a creator of a function to call both the
973
 
                    # old and new functions, so both the old and new
974
 
                    # signals gets sent when the function is called
 
1096
                    # original and alternate functions, so both the
 
1097
                    # original and alternate signals gets sent when
 
1098
                    # the function is called
975
1099
                    def fixscope(func1, func2):
976
1100
                        """This function is a scope container to pass
977
1101
                        func1 and func2 to the "call_both" function
984
1108
                        return call_both
985
1109
                    # Create the "call_both" function and add it to
986
1110
                    # the class
987
 
                    attr[attrname] = fixscope(attribute,
988
 
                                              new_function)
 
1111
                    attr[attrname] = fixscope(attribute, new_function)
989
1112
                # Is this a D-Bus method?
990
1113
                elif getattr(attribute, "_dbus_is_method", False):
991
1114
                    # Create a new, but exactly alike, function
1002
1125
                                        attribute.func_name,
1003
1126
                                        attribute.func_defaults,
1004
1127
                                        attribute.func_closure)))
 
1128
                    # Copy annotations, if any
 
1129
                    try:
 
1130
                        attr[attrname]._dbus_annotations = (
 
1131
                            dict(attribute._dbus_annotations))
 
1132
                    except AttributeError:
 
1133
                        pass
1005
1134
                # Is this a D-Bus property?
1006
1135
                elif getattr(attribute, "_dbus_is_property", False):
1007
1136
                    # Create a new, but exactly alike, function
1021
1150
                                        attribute.func_name,
1022
1151
                                        attribute.func_defaults,
1023
1152
                                        attribute.func_closure)))
1024
 
        return type.__new__(mcs, name, bases, attr)
1025
 
 
1026
 
 
 
1153
                    # Copy annotations, if any
 
1154
                    try:
 
1155
                        attr[attrname]._dbus_annotations = (
 
1156
                            dict(attribute._dbus_annotations))
 
1157
                    except AttributeError:
 
1158
                        pass
 
1159
                # Is this a D-Bus interface?
 
1160
                elif getattr(attribute, "_dbus_is_interface", False):
 
1161
                    # Create a new, but exactly alike, function
 
1162
                    # object.  Decorate it to be a new D-Bus interface
 
1163
                    # with the alternate D-Bus interface name.  Add it
 
1164
                    # to the class.
 
1165
                    attr[attrname] = (dbus_interface_annotations
 
1166
                                      (alt_interface)
 
1167
                                      (types.FunctionType
 
1168
                                       (attribute.func_code,
 
1169
                                        attribute.func_globals,
 
1170
                                        attribute.func_name,
 
1171
                                        attribute.func_defaults,
 
1172
                                        attribute.func_closure)))
 
1173
            if deprecate:
 
1174
                # Deprecate all alternate interfaces
 
1175
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1176
                for interface_name in interface_names:
 
1177
                    @dbus_interface_annotations(interface_name)
 
1178
                    def func(self):
 
1179
                        return { "org.freedesktop.DBus.Deprecated":
 
1180
                                     "true" }
 
1181
                    # Find an unused name
 
1182
                    for aname in (iname.format(i)
 
1183
                                  for i in itertools.count()):
 
1184
                        if aname not in attr:
 
1185
                            attr[aname] = func
 
1186
                            break
 
1187
            if interface_names:
 
1188
                # Replace the class with a new subclass of it with
 
1189
                # methods, signals, etc. as created above.
 
1190
                cls = type(b"{0}Alternate".format(cls.__name__),
 
1191
                           (cls,), attr)
 
1192
        return cls
 
1193
    return wrapper
 
1194
 
 
1195
 
 
1196
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1197
                                "se.bsnet.fukt.Mandos"})
1027
1198
class ClientDBus(Client, DBusObjectWithProperties):
1028
1199
    """A Client class using D-Bus
1029
1200
    
1040
1211
    def __init__(self, bus = None, *args, **kwargs):
1041
1212
        self.bus = bus
1042
1213
        Client.__init__(self, *args, **kwargs)
1043
 
        self._approvals_pending = 0
1044
 
        
1045
 
        self._approvals_pending = 0
1046
1214
        # Only now, when this client is initialized, can it show up on
1047
1215
        # the D-Bus
1048
1216
        client_object_name = unicode(self.name).translate(
1052
1220
                                 ("/clients/" + client_object_name))
1053
1221
        DBusObjectWithProperties.__init__(self, self.bus,
1054
1222
                                          self.dbus_object_path)
1055
 
        
 
1223
    
1056
1224
    def notifychangeproperty(transform_func,
1057
1225
                             dbus_name, type_func=lambda x: x,
1058
1226
                             variant_level=1):
1081
1249
        
1082
1250
        return property(lambda self: getattr(self, attrname), setter)
1083
1251
    
1084
 
    
1085
1252
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1086
1253
    approvals_pending = notifychangeproperty(dbus.Boolean,
1087
1254
                                             "ApprovalPending",
1094
1261
                                       checker is not None)
1095
1262
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1096
1263
                                           "LastCheckedOK")
 
1264
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1265
                                               "LastCheckerStatus")
1097
1266
    last_approval_request = notifychangeproperty(
1098
1267
        datetime_to_dbus, "LastApprovalRequest")
1099
1268
    approved_by_default = notifychangeproperty(dbus.Boolean,
1167
1336
        return False
1168
1337
    
1169
1338
    def approve(self, value=True):
1170
 
        self.send_changedstate()
1171
1339
        self.approved = value
1172
1340
        gobject.timeout_add(timedelta_to_milliseconds
1173
1341
                            (self.approval_duration),
1174
1342
                            self._reset_approved)
1175
 
    
 
1343
        self.send_changedstate()
1176
1344
    
1177
1345
    ## D-Bus methods, signals & properties
1178
1346
    _interface = "se.recompile.Mandos.Client"
1179
1347
    
 
1348
    ## Interfaces
 
1349
    
 
1350
    @dbus_interface_annotations(_interface)
 
1351
    def _foo(self):
 
1352
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1353
                     "false"}
 
1354
    
1180
1355
    ## Signals
1181
1356
    
1182
1357
    # CheckerCompleted - signal
1218
1393
        "D-Bus signal"
1219
1394
        return self.need_approval()
1220
1395
    
1221
 
    # NeRwequest - signal
1222
 
    @dbus.service.signal(_interface, signature="s")
1223
 
    def NewRequest(self, ip):
1224
 
        """D-Bus signal
1225
 
        Is sent after a client request a password.
1226
 
        """
1227
 
        pass
1228
 
    
1229
1396
    ## Methods
1230
1397
    
1231
1398
    # Approve - method
1341
1508
            return
1342
1509
        return datetime_to_dbus(self.last_checked_ok)
1343
1510
    
 
1511
    # LastCheckerStatus - property
 
1512
    @dbus_service_property(_interface, signature="n",
 
1513
                           access="read")
 
1514
    def LastCheckerStatus_dbus_property(self):
 
1515
        return dbus.Int16(self.last_checker_status)
 
1516
    
1344
1517
    # Expires - property
1345
1518
    @dbus_service_property(_interface, signature="s", access="read")
1346
1519
    def Expires_dbus_property(self):
1357
1530
    def Timeout_dbus_property(self, value=None):
1358
1531
        if value is None:       # get
1359
1532
            return dbus.UInt64(self.timeout_milliseconds())
 
1533
        old_timeout = self.timeout
1360
1534
        self.timeout = datetime.timedelta(0, 0, 0, value)
1361
 
        if getattr(self, "disable_initiator_tag", None) is None:
1362
 
            return
1363
 
        # Reschedule timeout
1364
 
        gobject.source_remove(self.disable_initiator_tag)
1365
 
        self.disable_initiator_tag = None
1366
 
        self.expires = None
1367
 
        time_to_die = timedelta_to_milliseconds((self
1368
 
                                                 .last_checked_ok
1369
 
                                                 + self.timeout)
1370
 
                                                - datetime.datetime
1371
 
                                                .utcnow())
1372
 
        if time_to_die <= 0:
1373
 
            # The timeout has passed
1374
 
            self.disable()
1375
 
        else:
1376
 
            self.expires = (datetime.datetime.utcnow()
1377
 
                            + datetime.timedelta(milliseconds =
1378
 
                                                 time_to_die))
1379
 
            self.disable_initiator_tag = (gobject.timeout_add
1380
 
                                          (time_to_die, self.disable))
 
1535
        # Reschedule disabling
 
1536
        if self.enabled:
 
1537
            now = datetime.datetime.utcnow()
 
1538
            self.expires += self.timeout - old_timeout
 
1539
            if self.expires <= now:
 
1540
                # The timeout has passed
 
1541
                self.disable()
 
1542
            else:
 
1543
                if (getattr(self, "disable_initiator_tag", None)
 
1544
                    is None):
 
1545
                    return
 
1546
                gobject.source_remove(self.disable_initiator_tag)
 
1547
                self.disable_initiator_tag = (
 
1548
                    gobject.timeout_add(
 
1549
                        timedelta_to_milliseconds(self.expires - now),
 
1550
                        self.disable))
1381
1551
    
1382
1552
    # ExtendedTimeout - property
1383
1553
    @dbus_service_property(_interface, signature="t",
1462
1632
        self._pipe.send(('setattr', name, value))
1463
1633
 
1464
1634
 
1465
 
class ClientDBusTransitional(ClientDBus):
1466
 
    __metaclass__ = AlternateDBusNamesMetaclass
1467
 
 
1468
 
 
1469
1635
class ClientHandler(socketserver.BaseRequestHandler, object):
1470
1636
    """A class to handle client connections.
1471
1637
    
1539
1705
                except KeyError:
1540
1706
                    return
1541
1707
                
1542
 
                if self.server.use_dbus:
1543
 
                    # Emit D-Bus signal
1544
 
                    client.NewRequest(str(self.client_address))
1545
 
                
1546
1708
                if client.approval_delay:
1547
1709
                    delay = client.approval_delay
1548
1710
                    client.approvals_pending += 1
1579
1741
                    #wait until timeout or approved
1580
1742
                    time = datetime.datetime.now()
1581
1743
                    client.changedstate.acquire()
1582
 
                    (client.changedstate.wait
1583
 
                     (float(client.timedelta_to_milliseconds(delay)
1584
 
                            / 1000)))
 
1744
                    client.changedstate.wait(
 
1745
                        float(timedelta_to_milliseconds(delay)
 
1746
                              / 1000))
1585
1747
                    client.changedstate.release()
1586
1748
                    time2 = datetime.datetime.now()
1587
1749
                    if (time2 - time) >= delay:
1603
1765
                    try:
1604
1766
                        sent = session.send(client.secret[sent_size:])
1605
1767
                    except gnutls.errors.GNUTLSError as error:
1606
 
                        logger.warning("gnutls send failed")
 
1768
                        logger.warning("gnutls send failed",
 
1769
                                       exc_info=error)
1607
1770
                        return
1608
1771
                    logger.debug("Sent: %d, remaining: %d",
1609
1772
                                 sent, len(client.secret)
1612
1775
                
1613
1776
                logger.info("Sending secret to %s", client.name)
1614
1777
                # bump the timeout using extended_timeout
1615
 
                client.checked_ok(client.extended_timeout)
 
1778
                client.bump_timeout(client.extended_timeout)
1616
1779
                if self.server.use_dbus:
1617
1780
                    # Emit D-Bus signal
1618
1781
                    client.GotSecret()
1623
1786
                try:
1624
1787
                    session.bye()
1625
1788
                except gnutls.errors.GNUTLSError as error:
1626
 
                    logger.warning("GnuTLS bye failed")
 
1789
                    logger.warning("GnuTLS bye failed",
 
1790
                                   exc_info=error)
1627
1791
    
1628
1792
    @staticmethod
1629
1793
    def peer_certificate(session):
1701
1865
    def process_request(self, request, address):
1702
1866
        """Start a new process to process the request."""
1703
1867
        proc = multiprocessing.Process(target = self.sub_process_main,
1704
 
                                       args = (request,
1705
 
                                               address))
 
1868
                                       args = (request, address))
1706
1869
        proc.start()
1707
1870
        return proc
1708
1871
 
1736
1899
        use_ipv6:       Boolean; to use IPv6 or not
1737
1900
    """
1738
1901
    def __init__(self, server_address, RequestHandlerClass,
1739
 
                 interface=None, use_ipv6=True):
 
1902
                 interface=None, use_ipv6=True, socketfd=None):
 
1903
        """If socketfd is set, use that file descriptor instead of
 
1904
        creating a new one with socket.socket().
 
1905
        """
1740
1906
        self.interface = interface
1741
1907
        if use_ipv6:
1742
1908
            self.address_family = socket.AF_INET6
 
1909
        if socketfd is not None:
 
1910
            # Save the file descriptor
 
1911
            self.socketfd = socketfd
 
1912
            # Save the original socket.socket() function
 
1913
            self.socket_socket = socket.socket
 
1914
            # To implement --socket, we monkey patch socket.socket.
 
1915
            # 
 
1916
            # (When socketserver.TCPServer is a new-style class, we
 
1917
            # could make self.socket into a property instead of monkey
 
1918
            # patching socket.socket.)
 
1919
            # 
 
1920
            # Create a one-time-only replacement for socket.socket()
 
1921
            @functools.wraps(socket.socket)
 
1922
            def socket_wrapper(*args, **kwargs):
 
1923
                # Restore original function so subsequent calls are
 
1924
                # not affected.
 
1925
                socket.socket = self.socket_socket
 
1926
                del self.socket_socket
 
1927
                # This time only, return a new socket object from the
 
1928
                # saved file descriptor.
 
1929
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
1930
            # Replace socket.socket() function with wrapper
 
1931
            socket.socket = socket_wrapper
 
1932
        # The socketserver.TCPServer.__init__ will call
 
1933
        # socket.socket(), which might be our replacement,
 
1934
        # socket_wrapper(), if socketfd was set.
1743
1935
        socketserver.TCPServer.__init__(self, server_address,
1744
1936
                                        RequestHandlerClass)
 
1937
    
1745
1938
    def server_bind(self):
1746
1939
        """This overrides the normal server_bind() function
1747
1940
        to bind to an interface if one was specified, and also NOT to
1755
1948
                try:
1756
1949
                    self.socket.setsockopt(socket.SOL_SOCKET,
1757
1950
                                           SO_BINDTODEVICE,
1758
 
                                           str(self.interface
1759
 
                                               + '\0'))
 
1951
                                           str(self.interface + '\0'))
1760
1952
                except socket.error as error:
1761
 
                    if error[0] == errno.EPERM:
1762
 
                        logger.error("No permission to"
1763
 
                                     " bind to interface %s",
1764
 
                                     self.interface)
1765
 
                    elif error[0] == errno.ENOPROTOOPT:
 
1953
                    if error.errno == errno.EPERM:
 
1954
                        logger.error("No permission to bind to"
 
1955
                                     " interface %s", self.interface)
 
1956
                    elif error.errno == errno.ENOPROTOOPT:
1766
1957
                        logger.error("SO_BINDTODEVICE not available;"
1767
1958
                                     " cannot bind to interface %s",
1768
1959
                                     self.interface)
 
1960
                    elif error.errno == errno.ENODEV:
 
1961
                        logger.error("Interface %s does not exist,"
 
1962
                                     " cannot bind", self.interface)
1769
1963
                    else:
1770
1964
                        raise
1771
1965
        # Only bind(2) the socket if we really need to.
1801
1995
    """
1802
1996
    def __init__(self, server_address, RequestHandlerClass,
1803
1997
                 interface=None, use_ipv6=True, clients=None,
1804
 
                 gnutls_priority=None, use_dbus=True):
 
1998
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1805
1999
        self.enabled = False
1806
2000
        self.clients = clients
1807
2001
        if self.clients is None:
1811
2005
        IPv6_TCPServer.__init__(self, server_address,
1812
2006
                                RequestHandlerClass,
1813
2007
                                interface = interface,
1814
 
                                use_ipv6 = use_ipv6)
 
2008
                                use_ipv6 = use_ipv6,
 
2009
                                socketfd = socketfd)
1815
2010
    def server_activate(self):
1816
2011
        if self.enabled:
1817
2012
            return socketserver.TCPServer.server_activate(self)
1830
2025
    
1831
2026
    def handle_ipc(self, source, condition, parent_pipe=None,
1832
2027
                   proc = None, client_object=None):
1833
 
        condition_names = {
1834
 
            gobject.IO_IN: "IN",   # There is data to read.
1835
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1836
 
                                    # blocking).
1837
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1838
 
            gobject.IO_ERR: "ERR", # Error condition.
1839
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1840
 
                                    # broken, usually for pipes and
1841
 
                                    # sockets).
1842
 
            }
1843
 
        conditions_string = ' | '.join(name
1844
 
                                       for cond, name in
1845
 
                                       condition_names.iteritems()
1846
 
                                       if cond & condition)
1847
2028
        # error, or the other end of multiprocessing.Pipe has closed
1848
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2029
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1849
2030
            # Wait for other process to exit
1850
2031
            proc.join()
1851
2032
            return False
1941
2122
            elif suffix == "w":
1942
2123
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1943
2124
            else:
1944
 
                raise ValueError("Unknown suffix %r" % suffix)
 
2125
                raise ValueError("Unknown suffix {0!r}"
 
2126
                                 .format(suffix))
1945
2127
        except (ValueError, IndexError) as e:
1946
2128
            raise ValueError(*(e.args))
1947
2129
        timevalue += delta
1961
2143
        sys.exit()
1962
2144
    if not noclose:
1963
2145
        # Close all standard open file descriptors
1964
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2146
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1965
2147
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1966
2148
            raise OSError(errno.ENODEV,
1967
 
                          "%s not a character device"
1968
 
                          % os.path.devnull)
 
2149
                          "{0} not a character device"
 
2150
                          .format(os.devnull))
1969
2151
        os.dup2(null, sys.stdin.fileno())
1970
2152
        os.dup2(null, sys.stdout.fileno())
1971
2153
        os.dup2(null, sys.stderr.fileno())
1980
2162
    
1981
2163
    parser = argparse.ArgumentParser()
1982
2164
    parser.add_argument("-v", "--version", action="version",
1983
 
                        version = "%%(prog)s %s" % version,
 
2165
                        version = "%(prog)s {0}".format(version),
1984
2166
                        help="show version number and exit")
1985
2167
    parser.add_argument("-i", "--interface", metavar="IF",
1986
2168
                        help="Bind to interface IF")
2011
2193
    parser.add_argument("--no-restore", action="store_false",
2012
2194
                        dest="restore", help="Do not restore stored"
2013
2195
                        " state")
 
2196
    parser.add_argument("--socket", type=int,
 
2197
                        help="Specify a file descriptor to a network"
 
2198
                        " socket to use instead of creating one")
2014
2199
    parser.add_argument("--statedir", metavar="DIR",
2015
2200
                        help="Directory to save/restore state in")
 
2201
    parser.add_argument("--foreground", action="store_true",
 
2202
                        help="Run in foreground")
2016
2203
    
2017
2204
    options = parser.parse_args()
2018
2205
    
2033
2220
                        "use_ipv6": "True",
2034
2221
                        "debuglevel": "",
2035
2222
                        "restore": "True",
2036
 
                        "statedir": "/var/lib/mandos"
 
2223
                        "socket": "",
 
2224
                        "statedir": "/var/lib/mandos",
 
2225
                        "foreground": "False",
2037
2226
                        }
2038
2227
    
2039
2228
    # Parse config file for server-global settings
2044
2233
    # Convert the SafeConfigParser object to a dict
2045
2234
    server_settings = server_config.defaults()
2046
2235
    # Use the appropriate methods on the non-string config options
2047
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2236
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2048
2237
        server_settings[option] = server_config.getboolean("DEFAULT",
2049
2238
                                                           option)
2050
2239
    if server_settings["port"]:
2051
2240
        server_settings["port"] = server_config.getint("DEFAULT",
2052
2241
                                                       "port")
 
2242
    if server_settings["socket"]:
 
2243
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2244
                                                         "socket")
 
2245
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2246
        # over with an opened os.devnull.  But we don't want this to
 
2247
        # happen with a supplied network socket.
 
2248
        if 0 <= server_settings["socket"] <= 2:
 
2249
            server_settings["socket"] = os.dup(server_settings
 
2250
                                               ["socket"])
2053
2251
    del server_config
2054
2252
    
2055
2253
    # Override the settings from the config file with command line
2057
2255
    for option in ("interface", "address", "port", "debug",
2058
2256
                   "priority", "servicename", "configdir",
2059
2257
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2060
 
                   "statedir"):
 
2258
                   "statedir", "socket", "foreground"):
2061
2259
        value = getattr(options, option)
2062
2260
        if value is not None:
2063
2261
            server_settings[option] = value
2066
2264
    for option in server_settings.keys():
2067
2265
        if type(server_settings[option]) is str:
2068
2266
            server_settings[option] = unicode(server_settings[option])
 
2267
    # Debug implies foreground
 
2268
    if server_settings["debug"]:
 
2269
        server_settings["foreground"] = True
2069
2270
    # Now we have our good server settings in "server_settings"
2070
2271
    
2071
2272
    ##################################################################
2077
2278
    use_ipv6 = server_settings["use_ipv6"]
2078
2279
    stored_state_path = os.path.join(server_settings["statedir"],
2079
2280
                                     stored_state_file)
 
2281
    foreground = server_settings["foreground"]
2080
2282
    
2081
2283
    if debug:
2082
2284
        initlogger(debug, logging.DEBUG)
2089
2291
    
2090
2292
    if server_settings["servicename"] != "Mandos":
2091
2293
        syslogger.setFormatter(logging.Formatter
2092
 
                               ('Mandos (%s) [%%(process)d]:'
2093
 
                                ' %%(levelname)s: %%(message)s'
2094
 
                                % server_settings["servicename"]))
 
2294
                               ('Mandos ({0}) [%(process)d]:'
 
2295
                                ' %(levelname)s: %(message)s'
 
2296
                                .format(server_settings
 
2297
                                        ["servicename"])))
2095
2298
    
2096
2299
    # Parse config file with clients
2097
 
    client_config = configparser.SafeConfigParser(Client.client_defaults)
 
2300
    client_config = configparser.SafeConfigParser(Client
 
2301
                                                  .client_defaults)
2098
2302
    client_config.read(os.path.join(server_settings["configdir"],
2099
2303
                                    "clients.conf"))
2100
2304
    
2109
2313
                              use_ipv6=use_ipv6,
2110
2314
                              gnutls_priority=
2111
2315
                              server_settings["priority"],
2112
 
                              use_dbus=use_dbus)
2113
 
    if not debug:
 
2316
                              use_dbus=use_dbus,
 
2317
                              socketfd=(server_settings["socket"]
 
2318
                                        or None))
 
2319
    if not foreground:
2114
2320
        pidfilename = "/var/run/mandos.pid"
 
2321
        pidfile = None
2115
2322
        try:
2116
2323
            pidfile = open(pidfilename, "w")
2117
 
        except IOError:
2118
 
            logger.error("Could not open file %r", pidfilename)
 
2324
        except IOError as e:
 
2325
            logger.error("Could not open file %r", pidfilename,
 
2326
                         exc_info=e)
2119
2327
    
2120
 
    try:
2121
 
        uid = pwd.getpwnam("_mandos").pw_uid
2122
 
        gid = pwd.getpwnam("_mandos").pw_gid
2123
 
    except KeyError:
 
2328
    for name in ("_mandos", "mandos", "nobody"):
2124
2329
        try:
2125
 
            uid = pwd.getpwnam("mandos").pw_uid
2126
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2330
            uid = pwd.getpwnam(name).pw_uid
 
2331
            gid = pwd.getpwnam(name).pw_gid
 
2332
            break
2127
2333
        except KeyError:
2128
 
            try:
2129
 
                uid = pwd.getpwnam("nobody").pw_uid
2130
 
                gid = pwd.getpwnam("nobody").pw_gid
2131
 
            except KeyError:
2132
 
                uid = 65534
2133
 
                gid = 65534
 
2334
            continue
 
2335
    else:
 
2336
        uid = 65534
 
2337
        gid = 65534
2134
2338
    try:
2135
2339
        os.setgid(gid)
2136
2340
        os.setuid(uid)
2137
2341
    except OSError as error:
2138
 
        if error[0] != errno.EPERM:
 
2342
        if error.errno != errno.EPERM:
2139
2343
            raise error
2140
2344
    
2141
2345
    if debug:
2153
2357
         .gnutls_global_set_log_function(debug_gnutls))
2154
2358
        
2155
2359
        # Redirect stdin so all checkers get /dev/null
2156
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2360
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2157
2361
        os.dup2(null, sys.stdin.fileno())
2158
2362
        if null > 2:
2159
2363
            os.close(null)
2160
2364
    
2161
2365
    # Need to fork before connecting to D-Bus
2162
 
    if not debug:
 
2366
    if not foreground:
2163
2367
        # Close all input and output, do double fork, etc.
2164
2368
        daemon()
2165
2369
    
 
2370
    # multiprocessing will use threads, so before we use gobject we
 
2371
    # need to inform gobject that threads will be used.
2166
2372
    gobject.threads_init()
2167
2373
    
2168
2374
    global main_loop
2169
2375
    # From the Avahi example code
2170
 
    DBusGMainLoop(set_as_default=True )
 
2376
    DBusGMainLoop(set_as_default=True)
2171
2377
    main_loop = gobject.MainLoop()
2172
2378
    bus = dbus.SystemBus()
2173
2379
    # End of Avahi example code
2179
2385
                            ("se.bsnet.fukt.Mandos", bus,
2180
2386
                             do_not_queue=True))
2181
2387
        except dbus.exceptions.NameExistsException as e:
2182
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2388
            logger.error("Disabling D-Bus:", exc_info=e)
2183
2389
            use_dbus = False
2184
2390
            server_settings["use_dbus"] = False
2185
2391
            tcp_server.use_dbus = False
2197
2403
    
2198
2404
    client_class = Client
2199
2405
    if use_dbus:
2200
 
        client_class = functools.partial(ClientDBusTransitional,
2201
 
                                         bus = bus)
 
2406
        client_class = functools.partial(ClientDBus, bus = bus)
2202
2407
    
2203
2408
    client_settings = Client.config_parser(client_config)
2204
2409
    old_client_settings = {}
2212
2417
                                                     (stored_state))
2213
2418
            os.remove(stored_state_path)
2214
2419
        except IOError as e:
2215
 
            logger.warning("Could not load persistent state: {0}"
2216
 
                           .format(e))
2217
 
            if e.errno != errno.ENOENT:
 
2420
            if e.errno == errno.ENOENT:
 
2421
                logger.warning("Could not load persistent state: {0}"
 
2422
                                .format(os.strerror(e.errno)))
 
2423
            else:
 
2424
                logger.critical("Could not load persistent state:",
 
2425
                                exc_info=e)
2218
2426
                raise
2219
2427
        except EOFError as e:
2220
2428
            logger.warning("Could not load persistent state: "
2221
 
                           "EOFError: {0}".format(e))
 
2429
                           "EOFError:", exc_info=e)
2222
2430
    
2223
2431
    with PGPEngine() as pgp:
2224
2432
        for client_name, client in clients_data.iteritems():
2241
2449
            
2242
2450
            # Clients who has passed its expire date can still be
2243
2451
            # enabled if its last checker was successful.  Clients
2244
 
            # whose checker failed before we stored its state is
2245
 
            # assumed to have failed all checkers during downtime.
 
2452
            # whose checker succeeded before we stored its state is
 
2453
            # assumed to have successfully run all checkers during
 
2454
            # downtime.
2246
2455
            if client["enabled"]:
2247
2456
                if datetime.datetime.utcnow() >= client["expires"]:
2248
2457
                    if not client["last_checked_ok"]:
2249
2458
                        logger.warning(
2250
2459
                            "disabling client {0} - Client never "
2251
 
                            "performed a successfull checker"
2252
 
                            .format(client["name"]))
 
2460
                            "performed a successful checker"
 
2461
                            .format(client_name))
2253
2462
                        client["enabled"] = False
2254
2463
                    elif client["last_checker_status"] != 0:
2255
2464
                        logger.warning(
2256
2465
                            "disabling client {0} - Client "
2257
2466
                            "last checker failed with error code {1}"
2258
 
                            .format(client["name"],
 
2467
                            .format(client_name,
2259
2468
                                    client["last_checker_status"]))
2260
2469
                        client["enabled"] = False
2261
2470
                    else:
2262
2471
                        client["expires"] = (datetime.datetime
2263
2472
                                             .utcnow()
2264
2473
                                             + client["timeout"])
2265
 
                    
 
2474
                        logger.debug("Last checker succeeded,"
 
2475
                                     " keeping {0} enabled"
 
2476
                                     .format(client_name))
2266
2477
            try:
2267
2478
                client["secret"] = (
2268
2479
                    pgp.decrypt(client["encrypted_secret"],
2274
2485
                             .format(client_name))
2275
2486
                client["secret"] = (
2276
2487
                    client_settings[client_name]["secret"])
2277
 
 
2278
2488
    
2279
2489
    # Add/remove clients based on new changes made to config
2280
 
    for client_name in set(old_client_settings) - set(client_settings):
 
2490
    for client_name in (set(old_client_settings)
 
2491
                        - set(client_settings)):
2281
2492
        del clients_data[client_name]
2282
 
    for client_name in set(client_settings) - set(old_client_settings):
 
2493
    for client_name in (set(client_settings)
 
2494
                        - set(old_client_settings)):
2283
2495
        clients_data[client_name] = client_settings[client_name]
2284
 
 
2285
 
    # Create clients all clients
 
2496
    
 
2497
    # Create all client objects
2286
2498
    for client_name, client in clients_data.iteritems():
2287
2499
        tcp_server.clients[client_name] = client_class(
2288
2500
            name = client_name, settings = client)
2289
2501
    
2290
2502
    if not tcp_server.clients:
2291
2503
        logger.warning("No clients defined")
2292
 
        
2293
 
    if not debug:
2294
 
        try:
2295
 
            with pidfile:
2296
 
                pid = os.getpid()
2297
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2298
 
            del pidfile
2299
 
        except IOError:
2300
 
            logger.error("Could not write to file %r with PID %d",
2301
 
                         pidfilename, pid)
2302
 
        except NameError:
2303
 
            # "pidfile" was never created
2304
 
            pass
 
2504
    
 
2505
    if not foreground:
 
2506
        if pidfile is not None:
 
2507
            try:
 
2508
                with pidfile:
 
2509
                    pid = os.getpid()
 
2510
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2511
            except IOError:
 
2512
                logger.error("Could not write to file %r with PID %d",
 
2513
                             pidfilename, pid)
 
2514
        del pidfile
2305
2515
        del pidfilename
2306
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2307
2516
    
2308
2517
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2309
2518
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2310
2519
    
2311
2520
    if use_dbus:
2312
 
        class MandosDBusService(dbus.service.Object):
 
2521
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2522
                                        "se.bsnet.fukt.Mandos"})
 
2523
        class MandosDBusService(DBusObjectWithProperties):
2313
2524
            """A D-Bus proxy object"""
2314
2525
            def __init__(self):
2315
2526
                dbus.service.Object.__init__(self, bus, "/")
2316
2527
            _interface = "se.recompile.Mandos"
2317
2528
            
 
2529
            @dbus_interface_annotations(_interface)
 
2530
            def _foo(self):
 
2531
                return { "org.freedesktop.DBus.Property"
 
2532
                         ".EmitsChangedSignal":
 
2533
                             "false"}
 
2534
            
2318
2535
            @dbus.service.signal(_interface, signature="o")
2319
2536
            def ClientAdded(self, objpath):
2320
2537
                "D-Bus signal"
2362
2579
            
2363
2580
            del _interface
2364
2581
        
2365
 
        class MandosDBusServiceTransitional(MandosDBusService):
2366
 
            __metaclass__ = AlternateDBusNamesMetaclass
2367
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2582
        mandos_dbus_service = MandosDBusService()
2368
2583
    
2369
2584
    def cleanup():
2370
2585
        "Cleanup function; run on exit"
2403
2618
                del client_settings[client.name]["secret"]
2404
2619
        
2405
2620
        try:
2406
 
            tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2407
 
                                                prefix="clients-",
2408
 
                                                dir=os.path.dirname
2409
 
                                                (stored_state_path))
2410
 
            with os.fdopen(tempfd, "wb") as stored_state:
 
2621
            with (tempfile.NamedTemporaryFile
 
2622
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2623
                   dir=os.path.dirname(stored_state_path),
 
2624
                   delete=False)) as stored_state:
2411
2625
                pickle.dump((clients, client_settings), stored_state)
 
2626
                tempname=stored_state.name
2412
2627
            os.rename(tempname, stored_state_path)
2413
2628
        except (IOError, OSError) as e:
2414
 
            logger.warning("Could not save persistent state: {0}"
2415
 
                           .format(e))
2416
2629
            if not debug:
2417
2630
                try:
2418
2631
                    os.remove(tempname)
2419
2632
                except NameError:
2420
2633
                    pass
2421
 
            if e.errno not in set((errno.ENOENT, errno.EACCES,
2422
 
                                   errno.EEXIST)):
 
2634
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2635
                logger.warning("Could not save persistent state: {0}"
 
2636
                               .format(os.strerror(e.errno)))
 
2637
            else:
 
2638
                logger.warning("Could not save persistent state:",
 
2639
                               exc_info=e)
2423
2640
                raise e
2424
2641
        
2425
2642
        # Delete all clients, and settings from config
2453
2670
    service.port = tcp_server.socket.getsockname()[1]
2454
2671
    if use_ipv6:
2455
2672
        logger.info("Now listening on address %r, port %d,"
2456
 
                    " flowinfo %d, scope_id %d"
2457
 
                    % tcp_server.socket.getsockname())
 
2673
                    " flowinfo %d, scope_id %d",
 
2674
                    *tcp_server.socket.getsockname())
2458
2675
    else:                       # IPv4
2459
 
        logger.info("Now listening on address %r, port %d"
2460
 
                    % tcp_server.socket.getsockname())
 
2676
        logger.info("Now listening on address %r, port %d",
 
2677
                    *tcp_server.socket.getsockname())
2461
2678
    
2462
2679
    #service.interface = tcp_server.socket.getsockname()[3]
2463
2680
    
2466
2683
        try:
2467
2684
            service.activate()
2468
2685
        except dbus.exceptions.DBusException as error:
2469
 
            logger.critical("DBusException: %s", error)
 
2686
            logger.critical("D-Bus Exception", exc_info=error)
2470
2687
            cleanup()
2471
2688
            sys.exit(1)
2472
2689
        # End of Avahi example code
2479
2696
        logger.debug("Starting main loop")
2480
2697
        main_loop.run()
2481
2698
    except AvahiError as error:
2482
 
        logger.critical("AvahiError: %s", error)
 
2699
        logger.critical("Avahi Error", exc_info=error)
2483
2700
        cleanup()
2484
2701
        sys.exit(1)
2485
2702
    except KeyboardInterrupt: