/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:
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.5.1"
 
91
version = "1.5.5"
89
92
stored_state_file = "clients.pickle"
90
93
 
91
94
logger = logging.getLogger()
148
151
    def __enter__(self):
149
152
        return self
150
153
    
151
 
    def __exit__ (self, exc_type, exc_value, traceback):
 
154
    def __exit__(self, exc_type, exc_value, traceback):
152
155
        self._cleanup()
153
156
        return False
154
157
    
175
178
    
176
179
    def encrypt(self, data, password):
177
180
        self.gnupg.passphrase = self.password_encode(password)
178
 
        with open(os.devnull) as devnull:
 
181
        with open(os.devnull, "w") as devnull:
179
182
            try:
180
183
                proc = self.gnupg.run(['--symmetric'],
181
184
                                      create_fhs=['stdin', 'stdout'],
192
195
    
193
196
    def decrypt(self, data, password):
194
197
        self.gnupg.passphrase = self.password_encode(password)
195
 
        with open(os.devnull) as devnull:
 
198
        with open(os.devnull, "w") as devnull:
196
199
            try:
197
200
                proc = self.gnupg.run(['--decrypt'],
198
201
                                      create_fhs=['stdin', 'stdout'],
199
202
                                      attach_fhs={'stderr': devnull})
200
 
                with contextlib.closing(proc.handles['stdin'] ) as f:
 
203
                with contextlib.closing(proc.handles['stdin']) as f:
201
204
                    f.write(data)
202
205
                with contextlib.closing(proc.handles['stdout']) as f:
203
206
                    decrypted_plaintext = f.read()
208
211
        return decrypted_plaintext
209
212
 
210
213
 
211
 
 
212
214
class AvahiError(Exception):
213
215
    def __init__(self, value, *args, **kwargs):
214
216
        self.value = value
243
245
    server: D-Bus Server
244
246
    bus: dbus.SystemBus()
245
247
    """
 
248
    
246
249
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
247
250
                 servicetype = None, port = None, TXT = None,
248
251
                 domain = "", host = "", max_renames = 32768,
261
264
        self.server = None
262
265
        self.bus = bus
263
266
        self.entry_group_state_changed_match = None
 
267
    
264
268
    def rename(self):
265
269
        """Derived from the Avahi example code"""
266
270
        if self.rename_count >= self.max_renames:
276
280
        try:
277
281
            self.add()
278
282
        except dbus.exceptions.DBusException as error:
279
 
            logger.critical("DBusException: %s", error)
 
283
            logger.critical("D-Bus Exception", exc_info=error)
280
284
            self.cleanup()
281
285
            os._exit(1)
282
286
        self.rename_count += 1
 
287
    
283
288
    def remove(self):
284
289
        """Derived from the Avahi example code"""
285
290
        if self.entry_group_state_changed_match is not None:
287
292
            self.entry_group_state_changed_match = None
288
293
        if self.group is not None:
289
294
            self.group.Reset()
 
295
    
290
296
    def add(self):
291
297
        """Derived from the Avahi example code"""
292
298
        self.remove()
309
315
            dbus.UInt16(self.port),
310
316
            avahi.string_array_to_txt_array(self.TXT))
311
317
        self.group.Commit()
 
318
    
312
319
    def entry_group_state_changed(self, state, error):
313
320
        """Derived from the Avahi example code"""
314
321
        logger.debug("Avahi entry group state change: %i", state)
321
328
        elif state == avahi.ENTRY_GROUP_FAILURE:
322
329
            logger.critical("Avahi: Error in group state changed %s",
323
330
                            unicode(error))
324
 
            raise AvahiGroupError("State changed: %s"
325
 
                                  % unicode(error))
 
331
            raise AvahiGroupError("State changed: {0!s}"
 
332
                                  .format(error))
 
333
    
326
334
    def cleanup(self):
327
335
        """Derived from the Avahi example code"""
328
336
        if self.group is not None:
333
341
                pass
334
342
            self.group = None
335
343
        self.remove()
 
344
    
336
345
    def server_state_changed(self, state, error=None):
337
346
        """Derived from the Avahi example code"""
338
347
        logger.debug("Avahi server state change: %i", state)
357
366
                logger.debug("Unknown state: %r", state)
358
367
            else:
359
368
                logger.debug("Unknown state: %r: %r", state, error)
 
369
    
360
370
    def activate(self):
361
371
        """Derived from the Avahi example code"""
362
372
        if self.server is None:
369
379
                                 self.server_state_changed)
370
380
        self.server_state_changed(self.server.GetState())
371
381
 
 
382
 
372
383
class AvahiServiceToSyslog(AvahiService):
373
384
    def rename(self):
374
385
        """Add the new name to the syslog messages"""
375
386
        ret = AvahiService.rename(self)
376
387
        syslogger.setFormatter(logging.Formatter
377
 
                               ('Mandos (%s) [%%(process)d]:'
378
 
                                ' %%(levelname)s: %%(message)s'
379
 
                                % self.name))
 
388
                               ('Mandos ({0}) [%(process)d]:'
 
389
                                ' %(levelname)s: %(message)s'
 
390
                                .format(self.name)))
380
391
        return ret
381
392
 
 
393
 
382
394
def timedelta_to_milliseconds(td):
383
395
    "Convert a datetime.timedelta() to milliseconds"
384
396
    return ((td.days * 24 * 60 * 60 * 1000)
385
397
            + (td.seconds * 1000)
386
398
            + (td.microseconds // 1000))
387
 
        
 
399
 
 
400
 
388
401
class Client(object):
389
402
    """A representation of a client host served by this server.
390
403
    
415
428
    last_checked_ok: datetime.datetime(); (UTC) or None
416
429
    last_checker_status: integer between 0 and 255 reflecting exit
417
430
                         status of last checker. -1 reflects crashed
418
 
                         checker, or None.
 
431
                         checker, -2 means no checker completed yet.
419
432
    last_enabled: datetime.datetime(); (UTC) or None
420
433
    name:       string; from the config file, used in log messages and
421
434
                        D-Bus identifiers
422
435
    secret:     bytestring; sent verbatim (over TLS) to client
423
436
    timeout:    datetime.timedelta(); How long from last_checked_ok
424
437
                                      until this client is disabled
425
 
    extended_timeout:   extra long timeout when password has been sent
 
438
    extended_timeout:   extra long timeout when secret has been sent
426
439
    runtime_expansions: Allowed attributes for runtime expansion.
427
440
    expires:    datetime.datetime(); time (UTC) when a client will be
428
441
                disabled, or None
429
442
    """
430
443
    
431
444
    runtime_expansions = ("approval_delay", "approval_duration",
432
 
                          "created", "enabled", "fingerprint",
433
 
                          "host", "interval", "last_checked_ok",
 
445
                          "created", "enabled", "expires",
 
446
                          "fingerprint", "host", "interval",
 
447
                          "last_approval_request", "last_checked_ok",
434
448
                          "last_enabled", "name", "timeout")
435
449
    client_defaults = { "timeout": "5m",
436
450
                        "extended_timeout": "15m",
457
471
    
458
472
    def approval_delay_milliseconds(self):
459
473
        return timedelta_to_milliseconds(self.approval_delay)
460
 
 
 
474
    
461
475
    @staticmethod
462
476
    def config_parser(config):
463
477
        """Construct a new dict of client settings of this form:
488
502
                          "rb") as secfile:
489
503
                    client["secret"] = secfile.read()
490
504
            else:
491
 
                raise TypeError("No secret or secfile for section %s"
492
 
                                % section)
 
505
                raise TypeError("No secret or secfile for section {0}"
 
506
                                .format(section))
493
507
            client["timeout"] = string_to_delta(section["timeout"])
494
508
            client["extended_timeout"] = string_to_delta(
495
509
                section["extended_timeout"])
501
515
            client["checker_command"] = section["checker"]
502
516
            client["last_approval_request"] = None
503
517
            client["last_checked_ok"] = None
504
 
            client["last_checker_status"] = None
 
518
            client["last_checker_status"] = -2
505
519
        
506
520
        return settings
507
 
        
508
 
        
 
521
    
509
522
    def __init__(self, settings, name = None):
510
 
        """Note: the 'checker' key in 'config' sets the
511
 
        'checker_command' attribute and *not* the 'checker'
512
 
        attribute."""
513
523
        self.name = name
514
524
        # adding all client settings
515
525
        for setting, value in settings.iteritems():
524
534
        else:
525
535
            self.last_enabled = None
526
536
            self.expires = None
527
 
       
 
537
        
528
538
        logger.debug("Creating client %r", self.name)
529
539
        # Uppercase and remove spaces from fingerprint for later
530
540
        # comparison purposes with return value from the fingerprint()
532
542
        logger.debug("  Fingerprint: %s", self.fingerprint)
533
543
        self.created = settings.get("created",
534
544
                                    datetime.datetime.utcnow())
535
 
 
 
545
        
536
546
        # attributes specific for this server instance
537
547
        self.checker = None
538
548
        self.checker_initiator_tag = None
566
576
        if getattr(self, "enabled", False):
567
577
            # Already enabled
568
578
            return
569
 
        self.send_changedstate()
570
579
        self.expires = datetime.datetime.utcnow() + self.timeout
571
580
        self.enabled = True
572
581
        self.last_enabled = datetime.datetime.utcnow()
573
582
        self.init_checker()
 
583
        self.send_changedstate()
574
584
    
575
585
    def disable(self, quiet=True):
576
586
        """Disable this client."""
577
587
        if not getattr(self, "enabled", False):
578
588
            return False
579
589
        if not quiet:
580
 
            self.send_changedstate()
581
 
        if not quiet:
582
590
            logger.info("Disabling client %s", self.name)
583
 
        if getattr(self, "disable_initiator_tag", False):
 
591
        if getattr(self, "disable_initiator_tag", None) is not None:
584
592
            gobject.source_remove(self.disable_initiator_tag)
585
593
            self.disable_initiator_tag = None
586
594
        self.expires = None
587
 
        if getattr(self, "checker_initiator_tag", False):
 
595
        if getattr(self, "checker_initiator_tag", None) is not None:
588
596
            gobject.source_remove(self.checker_initiator_tag)
589
597
            self.checker_initiator_tag = None
590
598
        self.stop_checker()
591
599
        self.enabled = False
 
600
        if not quiet:
 
601
            self.send_changedstate()
592
602
        # Do not run this again if called by a gobject.timeout_add
593
603
        return False
594
604
    
598
608
    def init_checker(self):
599
609
        # Schedule a new checker to be started an 'interval' from now,
600
610
        # and every interval from then on.
 
611
        if self.checker_initiator_tag is not None:
 
612
            gobject.source_remove(self.checker_initiator_tag)
601
613
        self.checker_initiator_tag = (gobject.timeout_add
602
614
                                      (self.interval_milliseconds(),
603
615
                                       self.start_checker))
604
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)
605
619
        self.disable_initiator_tag = (gobject.timeout_add
606
620
                                   (self.timeout_milliseconds(),
607
621
                                    self.disable))
626
640
            logger.warning("Checker for %(name)s crashed?",
627
641
                           vars(self))
628
642
    
629
 
    def checked_ok(self, timeout=None):
630
 
        """Bump up the timeout for this client.
631
 
        
632
 
        This should only be called when the client has been seen,
633
 
        alive and well.
634
 
        """
 
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."""
635
651
        if timeout is None:
636
652
            timeout = self.timeout
637
 
        self.last_checked_ok = datetime.datetime.utcnow()
638
653
        if self.disable_initiator_tag is not None:
639
654
            gobject.source_remove(self.disable_initiator_tag)
 
655
            self.disable_initiator_tag = None
640
656
        if getattr(self, "enabled", False):
641
657
            self.disable_initiator_tag = (gobject.timeout_add
642
658
                                          (timedelta_to_milliseconds
652
668
        If a checker already exists, leave it running and do
653
669
        nothing."""
654
670
        # The reason for not killing a running checker is that if we
655
 
        # did that, then if a checker (for some reason) started
656
 
        # running slowly and taking more than 'interval' time, the
657
 
        # client would inevitably timeout, since no checker would get
658
 
        # 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
659
675
        # checkers alone, the checker would have to take more time
660
676
        # than 'timeout' for the client to be disabled, which is as it
661
677
        # should be.
675
691
                                      self.current_checker_command)
676
692
        # Start a new checker if needed
677
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)
678
699
            try:
679
 
                # In case checker_command has exactly one % operator
680
 
                command = self.checker_command % self.host
681
 
            except TypeError:
682
 
                # Escape attributes for the shell
683
 
                escaped_attrs = dict(
684
 
                    (attr,
685
 
                     re.escape(unicode(str(getattr(self, attr, "")),
686
 
                                       errors=
687
 
                                       'replace')))
688
 
                    for attr in
689
 
                    self.runtime_expansions)
690
 
                
691
 
                try:
692
 
                    command = self.checker_command % escaped_attrs
693
 
                except TypeError as error:
694
 
                    logger.error('Could not format string "%s":'
695
 
                                 ' %s', self.checker_command, error)
696
 
                    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
697
705
            self.current_checker_command = command
698
706
            try:
699
707
                logger.info("Starting checker %r for %s",
705
713
                self.checker = subprocess.Popen(command,
706
714
                                                close_fds=True,
707
715
                                                shell=True, cwd="/")
708
 
                self.checker_callback_tag = (gobject.child_watch_add
709
 
                                             (self.checker.pid,
710
 
                                              self.checker_callback,
711
 
                                              data=command))
712
 
                # The checker may have completed before the gobject
713
 
                # watch was added.  Check for this.
714
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
715
 
                if pid:
716
 
                    gobject.source_remove(self.checker_callback_tag)
717
 
                    self.checker_callback(pid, status, command)
718
716
            except OSError as error:
719
 
                logger.error("Failed to start subprocess: %s",
720
 
                             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)
721
729
        # Re-run this periodically if run by gobject.timeout_add
722
730
        return True
723
731
    
730
738
            return
731
739
        logger.debug("Stopping checker for %(name)s", vars(self))
732
740
        try:
733
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
741
            self.checker.terminate()
734
742
            #time.sleep(0.5)
735
743
            #if self.checker.poll() is None:
736
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
744
            #    self.checker.kill()
737
745
        except OSError as error:
738
746
            if error.errno != errno.ESRCH: # No such process
739
747
                raise
756
764
    # "Set" method, so we fail early here:
757
765
    if byte_arrays and signature != "ay":
758
766
        raise ValueError("Byte arrays not supported for non-'ay'"
759
 
                         " signature %r" % signature)
 
767
                         " signature {0!r}".format(signature))
760
768
    def decorator(func):
761
769
        func._dbus_is_property = True
762
770
        func._dbus_interface = dbus_interface
770
778
    return decorator
771
779
 
772
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
 
773
818
class DBusPropertyException(dbus.exceptions.DBusException):
774
819
    """A base class for D-Bus property-related exceptions
775
820
    """
798
843
    """
799
844
    
800
845
    @staticmethod
801
 
    def _is_dbus_property(obj):
802
 
        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)
803
854
    
804
 
    def _get_all_dbus_properties(self):
 
855
    def _get_all_dbus_things(self, thing):
805
856
        """Returns a generator of (name, attribute) pairs
806
857
        """
807
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
858
        return ((getattr(athing.__get__(self), "_dbus_name",
 
859
                         name),
 
860
                 athing.__get__(self))
808
861
                for cls in self.__class__.__mro__
809
 
                for name, prop in
810
 
                inspect.getmembers(cls, self._is_dbus_property))
 
862
                for name, athing in
 
863
                inspect.getmembers(cls,
 
864
                                   self._is_dbus_thing(thing)))
811
865
    
812
866
    def _get_dbus_property(self, interface_name, property_name):
813
867
        """Returns a bound method if one exists which is a D-Bus
815
869
        """
816
870
        for cls in  self.__class__.__mro__:
817
871
            for name, value in (inspect.getmembers
818
 
                                (cls, self._is_dbus_property)):
 
872
                                (cls,
 
873
                                 self._is_dbus_thing("property"))):
819
874
                if (value._dbus_name == property_name
820
875
                    and value._dbus_interface == interface_name):
821
876
                    return value.__get__(self)
863
918
        Note: Will not include properties with access="write".
864
919
        """
865
920
        properties = {}
866
 
        for name, prop in self._get_all_dbus_properties():
 
921
        for name, prop in self._get_all_dbus_things("property"):
867
922
            if (interface_name
868
923
                and interface_name != prop._dbus_interface):
869
924
                # Interface non-empty but did not match
884
939
                         path_keyword='object_path',
885
940
                         connection_keyword='connection')
886
941
    def Introspect(self, object_path, connection):
887
 
        """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.
888
945
        """
889
946
        xmlstring = dbus.service.Object.Introspect(self, object_path,
890
947
                                                   connection)
897
954
                e.setAttribute("access", prop._dbus_access)
898
955
                return e
899
956
            for if_tag in document.getElementsByTagName("interface"):
 
957
                # Add property tags
900
958
                for tag in (make_tag(document, name, prop)
901
959
                            for name, prop
902
 
                            in self._get_all_dbus_properties()
 
960
                            in self._get_all_dbus_things("property")
903
961
                            if prop._dbus_interface
904
962
                            == if_tag.getAttribute("name")):
905
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)
906
995
                # Add the names to the return values for the
907
996
                # "org.freedesktop.DBus.Properties" methods
908
997
                if (if_tag.getAttribute("name")
923
1012
        except (AttributeError, xml.dom.DOMException,
924
1013
                xml.parsers.expat.ExpatError) as error:
925
1014
            logger.error("Failed to override Introspection method",
926
 
                         error)
 
1015
                         exc_info=error)
927
1016
        return xmlstring
928
1017
 
929
1018
 
930
 
def datetime_to_dbus (dt, variant_level=0):
 
1019
def datetime_to_dbus(dt, variant_level=0):
931
1020
    """Convert a UTC datetime.datetime() to a D-Bus type."""
932
1021
    if dt is None:
933
1022
        return dbus.String("", variant_level = variant_level)
935
1024
                       variant_level=variant_level)
936
1025
 
937
1026
 
938
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
939
 
                                  .__metaclass__):
940
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
941
 
    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).
942
1049
    """
943
 
    def __new__(mcs, name, bases, attr):
944
 
        # Go through all the base classes which could have D-Bus
945
 
        # methods, signals, or properties in them
946
 
        for base in (b for b in bases
947
 
                     if issubclass(b, dbus.service.Object)):
948
 
            # Go though all attributes of the base class
949
 
            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):
950
1057
                # Ignore non-D-Bus attributes, and D-Bus attributes
951
1058
                # with the wrong interface name
952
1059
                if (not hasattr(attribute, "_dbus_interface")
953
1060
                    or not attribute._dbus_interface
954
 
                    .startswith("se.recompile.Mandos")):
 
1061
                    .startswith(orig_interface_name)):
955
1062
                    continue
956
1063
                # Create an alternate D-Bus interface name based on
957
1064
                # the current name
958
1065
                alt_interface = (attribute._dbus_interface
959
 
                                 .replace("se.recompile.Mandos",
960
 
                                          "se.bsnet.fukt.Mandos"))
 
1066
                                 .replace(orig_interface_name,
 
1067
                                          alt_interface_name))
 
1068
                interface_names.add(alt_interface)
961
1069
                # Is this a D-Bus signal?
962
1070
                if getattr(attribute, "_dbus_is_signal", False):
963
1071
                    # Extract the original non-method function by
978
1086
                                nonmethod_func.func_name,
979
1087
                                nonmethod_func.func_defaults,
980
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
981
1095
                    # Define a creator of a function to call both the
982
 
                    # old and new functions, so both the old and new
983
 
                    # 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
984
1099
                    def fixscope(func1, func2):
985
1100
                        """This function is a scope container to pass
986
1101
                        func1 and func2 to the "call_both" function
993
1108
                        return call_both
994
1109
                    # Create the "call_both" function and add it to
995
1110
                    # the class
996
 
                    attr[attrname] = fixscope(attribute,
997
 
                                              new_function)
 
1111
                    attr[attrname] = fixscope(attribute, new_function)
998
1112
                # Is this a D-Bus method?
999
1113
                elif getattr(attribute, "_dbus_is_method", False):
1000
1114
                    # Create a new, but exactly alike, function
1011
1125
                                        attribute.func_name,
1012
1126
                                        attribute.func_defaults,
1013
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
1014
1134
                # Is this a D-Bus property?
1015
1135
                elif getattr(attribute, "_dbus_is_property", False):
1016
1136
                    # Create a new, but exactly alike, function
1030
1150
                                        attribute.func_name,
1031
1151
                                        attribute.func_defaults,
1032
1152
                                        attribute.func_closure)))
1033
 
        return type.__new__(mcs, name, bases, attr)
1034
 
 
1035
 
 
 
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"})
1036
1198
class ClientDBus(Client, DBusObjectWithProperties):
1037
1199
    """A Client class using D-Bus
1038
1200
    
1049
1211
    def __init__(self, bus = None, *args, **kwargs):
1050
1212
        self.bus = bus
1051
1213
        Client.__init__(self, *args, **kwargs)
1052
 
        self._approvals_pending = 0
1053
 
        
1054
 
        self._approvals_pending = 0
1055
1214
        # Only now, when this client is initialized, can it show up on
1056
1215
        # the D-Bus
1057
1216
        client_object_name = unicode(self.name).translate(
1061
1220
                                 ("/clients/" + client_object_name))
1062
1221
        DBusObjectWithProperties.__init__(self, self.bus,
1063
1222
                                          self.dbus_object_path)
1064
 
        
 
1223
    
1065
1224
    def notifychangeproperty(transform_func,
1066
1225
                             dbus_name, type_func=lambda x: x,
1067
1226
                             variant_level=1):
1090
1249
        
1091
1250
        return property(lambda self: getattr(self, attrname), setter)
1092
1251
    
1093
 
    
1094
1252
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1095
1253
    approvals_pending = notifychangeproperty(dbus.Boolean,
1096
1254
                                             "ApprovalPending",
1103
1261
                                       checker is not None)
1104
1262
    last_checked_ok = notifychangeproperty(datetime_to_dbus,
1105
1263
                                           "LastCheckedOK")
 
1264
    last_checker_status = notifychangeproperty(dbus.Int16,
 
1265
                                               "LastCheckerStatus")
1106
1266
    last_approval_request = notifychangeproperty(
1107
1267
        datetime_to_dbus, "LastApprovalRequest")
1108
1268
    approved_by_default = notifychangeproperty(dbus.Boolean,
1176
1336
        return False
1177
1337
    
1178
1338
    def approve(self, value=True):
1179
 
        self.send_changedstate()
1180
1339
        self.approved = value
1181
1340
        gobject.timeout_add(timedelta_to_milliseconds
1182
1341
                            (self.approval_duration),
1183
1342
                            self._reset_approved)
1184
 
    
 
1343
        self.send_changedstate()
1185
1344
    
1186
1345
    ## D-Bus methods, signals & properties
1187
1346
    _interface = "se.recompile.Mandos.Client"
1188
1347
    
 
1348
    ## Interfaces
 
1349
    
 
1350
    @dbus_interface_annotations(_interface)
 
1351
    def _foo(self):
 
1352
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1353
                     "false"}
 
1354
    
1189
1355
    ## Signals
1190
1356
    
1191
1357
    # CheckerCompleted - signal
1227
1393
        "D-Bus signal"
1228
1394
        return self.need_approval()
1229
1395
    
1230
 
    # NeRwequest - signal
1231
 
    @dbus.service.signal(_interface, signature="s")
1232
 
    def NewRequest(self, ip):
1233
 
        """D-Bus signal
1234
 
        Is sent after a client request a password.
1235
 
        """
1236
 
        pass
1237
 
    
1238
1396
    ## Methods
1239
1397
    
1240
1398
    # Approve - method
1350
1508
            return
1351
1509
        return datetime_to_dbus(self.last_checked_ok)
1352
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
    
1353
1517
    # Expires - property
1354
1518
    @dbus_service_property(_interface, signature="s", access="read")
1355
1519
    def Expires_dbus_property(self):
1366
1530
    def Timeout_dbus_property(self, value=None):
1367
1531
        if value is None:       # get
1368
1532
            return dbus.UInt64(self.timeout_milliseconds())
 
1533
        old_timeout = self.timeout
1369
1534
        self.timeout = datetime.timedelta(0, 0, 0, value)
1370
 
        # Reschedule timeout
 
1535
        # Reschedule disabling
1371
1536
        if self.enabled:
1372
1537
            now = datetime.datetime.utcnow()
1373
 
            time_to_die = timedelta_to_milliseconds(
1374
 
                (self.last_checked_ok + self.timeout) - now)
1375
 
            if time_to_die <= 0:
 
1538
            self.expires += self.timeout - old_timeout
 
1539
            if self.expires <= now:
1376
1540
                # The timeout has passed
1377
1541
                self.disable()
1378
1542
            else:
1379
 
                self.expires = (now +
1380
 
                                datetime.timedelta(milliseconds =
1381
 
                                                   time_to_die))
1382
1543
                if (getattr(self, "disable_initiator_tag", None)
1383
1544
                    is None):
1384
1545
                    return
1385
1546
                gobject.source_remove(self.disable_initiator_tag)
1386
 
                self.disable_initiator_tag = (gobject.timeout_add
1387
 
                                              (time_to_die,
1388
 
                                               self.disable))
 
1547
                self.disable_initiator_tag = (
 
1548
                    gobject.timeout_add(
 
1549
                        timedelta_to_milliseconds(self.expires - now),
 
1550
                        self.disable))
1389
1551
    
1390
1552
    # ExtendedTimeout - property
1391
1553
    @dbus_service_property(_interface, signature="t",
1470
1632
        self._pipe.send(('setattr', name, value))
1471
1633
 
1472
1634
 
1473
 
class ClientDBusTransitional(ClientDBus):
1474
 
    __metaclass__ = AlternateDBusNamesMetaclass
1475
 
 
1476
 
 
1477
1635
class ClientHandler(socketserver.BaseRequestHandler, object):
1478
1636
    """A class to handle client connections.
1479
1637
    
1547
1705
                except KeyError:
1548
1706
                    return
1549
1707
                
1550
 
                if self.server.use_dbus:
1551
 
                    # Emit D-Bus signal
1552
 
                    client.NewRequest(str(self.client_address))
1553
 
                
1554
1708
                if client.approval_delay:
1555
1709
                    delay = client.approval_delay
1556
1710
                    client.approvals_pending += 1
1587
1741
                    #wait until timeout or approved
1588
1742
                    time = datetime.datetime.now()
1589
1743
                    client.changedstate.acquire()
1590
 
                    (client.changedstate.wait
1591
 
                     (float(client.timedelta_to_milliseconds(delay)
1592
 
                            / 1000)))
 
1744
                    client.changedstate.wait(
 
1745
                        float(timedelta_to_milliseconds(delay)
 
1746
                              / 1000))
1593
1747
                    client.changedstate.release()
1594
1748
                    time2 = datetime.datetime.now()
1595
1749
                    if (time2 - time) >= delay:
1611
1765
                    try:
1612
1766
                        sent = session.send(client.secret[sent_size:])
1613
1767
                    except gnutls.errors.GNUTLSError as error:
1614
 
                        logger.warning("gnutls send failed")
 
1768
                        logger.warning("gnutls send failed",
 
1769
                                       exc_info=error)
1615
1770
                        return
1616
1771
                    logger.debug("Sent: %d, remaining: %d",
1617
1772
                                 sent, len(client.secret)
1620
1775
                
1621
1776
                logger.info("Sending secret to %s", client.name)
1622
1777
                # bump the timeout using extended_timeout
1623
 
                client.checked_ok(client.extended_timeout)
 
1778
                client.bump_timeout(client.extended_timeout)
1624
1779
                if self.server.use_dbus:
1625
1780
                    # Emit D-Bus signal
1626
1781
                    client.GotSecret()
1631
1786
                try:
1632
1787
                    session.bye()
1633
1788
                except gnutls.errors.GNUTLSError as error:
1634
 
                    logger.warning("GnuTLS bye failed")
 
1789
                    logger.warning("GnuTLS bye failed",
 
1790
                                   exc_info=error)
1635
1791
    
1636
1792
    @staticmethod
1637
1793
    def peer_certificate(session):
1709
1865
    def process_request(self, request, address):
1710
1866
        """Start a new process to process the request."""
1711
1867
        proc = multiprocessing.Process(target = self.sub_process_main,
1712
 
                                       args = (request,
1713
 
                                               address))
 
1868
                                       args = (request, address))
1714
1869
        proc.start()
1715
1870
        return proc
1716
1871
 
1744
1899
        use_ipv6:       Boolean; to use IPv6 or not
1745
1900
    """
1746
1901
    def __init__(self, server_address, RequestHandlerClass,
1747
 
                 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
        """
1748
1906
        self.interface = interface
1749
1907
        if use_ipv6:
1750
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.
1751
1935
        socketserver.TCPServer.__init__(self, server_address,
1752
1936
                                        RequestHandlerClass)
 
1937
    
1753
1938
    def server_bind(self):
1754
1939
        """This overrides the normal server_bind() function
1755
1940
        to bind to an interface if one was specified, and also NOT to
1763
1948
                try:
1764
1949
                    self.socket.setsockopt(socket.SOL_SOCKET,
1765
1950
                                           SO_BINDTODEVICE,
1766
 
                                           str(self.interface
1767
 
                                               + '\0'))
 
1951
                                           str(self.interface + '\0'))
1768
1952
                except socket.error as error:
1769
 
                    if error[0] == errno.EPERM:
1770
 
                        logger.error("No permission to"
1771
 
                                     " bind to interface %s",
1772
 
                                     self.interface)
1773
 
                    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:
1774
1957
                        logger.error("SO_BINDTODEVICE not available;"
1775
1958
                                     " cannot bind to interface %s",
1776
1959
                                     self.interface)
 
1960
                    elif error.errno == errno.ENODEV:
 
1961
                        logger.error("Interface %s does not exist,"
 
1962
                                     " cannot bind", self.interface)
1777
1963
                    else:
1778
1964
                        raise
1779
1965
        # Only bind(2) the socket if we really need to.
1809
1995
    """
1810
1996
    def __init__(self, server_address, RequestHandlerClass,
1811
1997
                 interface=None, use_ipv6=True, clients=None,
1812
 
                 gnutls_priority=None, use_dbus=True):
 
1998
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1813
1999
        self.enabled = False
1814
2000
        self.clients = clients
1815
2001
        if self.clients is None:
1819
2005
        IPv6_TCPServer.__init__(self, server_address,
1820
2006
                                RequestHandlerClass,
1821
2007
                                interface = interface,
1822
 
                                use_ipv6 = use_ipv6)
 
2008
                                use_ipv6 = use_ipv6,
 
2009
                                socketfd = socketfd)
1823
2010
    def server_activate(self):
1824
2011
        if self.enabled:
1825
2012
            return socketserver.TCPServer.server_activate(self)
1838
2025
    
1839
2026
    def handle_ipc(self, source, condition, parent_pipe=None,
1840
2027
                   proc = None, client_object=None):
1841
 
        condition_names = {
1842
 
            gobject.IO_IN: "IN",   # There is data to read.
1843
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1844
 
                                    # blocking).
1845
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1846
 
            gobject.IO_ERR: "ERR", # Error condition.
1847
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1848
 
                                    # broken, usually for pipes and
1849
 
                                    # sockets).
1850
 
            }
1851
 
        conditions_string = ' | '.join(name
1852
 
                                       for cond, name in
1853
 
                                       condition_names.iteritems()
1854
 
                                       if cond & condition)
1855
2028
        # error, or the other end of multiprocessing.Pipe has closed
1856
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2029
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1857
2030
            # Wait for other process to exit
1858
2031
            proc.join()
1859
2032
            return False
1949
2122
            elif suffix == "w":
1950
2123
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1951
2124
            else:
1952
 
                raise ValueError("Unknown suffix %r" % suffix)
 
2125
                raise ValueError("Unknown suffix {0!r}"
 
2126
                                 .format(suffix))
1953
2127
        except (ValueError, IndexError) as e:
1954
2128
            raise ValueError(*(e.args))
1955
2129
        timevalue += delta
1969
2143
        sys.exit()
1970
2144
    if not noclose:
1971
2145
        # Close all standard open file descriptors
1972
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2146
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1973
2147
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1974
2148
            raise OSError(errno.ENODEV,
1975
 
                          "%s not a character device"
1976
 
                          % os.path.devnull)
 
2149
                          "{0} not a character device"
 
2150
                          .format(os.devnull))
1977
2151
        os.dup2(null, sys.stdin.fileno())
1978
2152
        os.dup2(null, sys.stdout.fileno())
1979
2153
        os.dup2(null, sys.stderr.fileno())
1988
2162
    
1989
2163
    parser = argparse.ArgumentParser()
1990
2164
    parser.add_argument("-v", "--version", action="version",
1991
 
                        version = "%%(prog)s %s" % version,
 
2165
                        version = "%(prog)s {0}".format(version),
1992
2166
                        help="show version number and exit")
1993
2167
    parser.add_argument("-i", "--interface", metavar="IF",
1994
2168
                        help="Bind to interface IF")
2019
2193
    parser.add_argument("--no-restore", action="store_false",
2020
2194
                        dest="restore", help="Do not restore stored"
2021
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")
2022
2199
    parser.add_argument("--statedir", metavar="DIR",
2023
2200
                        help="Directory to save/restore state in")
 
2201
    parser.add_argument("--foreground", action="store_true",
 
2202
                        help="Run in foreground")
2024
2203
    
2025
2204
    options = parser.parse_args()
2026
2205
    
2041
2220
                        "use_ipv6": "True",
2042
2221
                        "debuglevel": "",
2043
2222
                        "restore": "True",
2044
 
                        "statedir": "/var/lib/mandos"
 
2223
                        "socket": "",
 
2224
                        "statedir": "/var/lib/mandos",
 
2225
                        "foreground": "False",
2045
2226
                        }
2046
2227
    
2047
2228
    # Parse config file for server-global settings
2052
2233
    # Convert the SafeConfigParser object to a dict
2053
2234
    server_settings = server_config.defaults()
2054
2235
    # Use the appropriate methods on the non-string config options
2055
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2236
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2056
2237
        server_settings[option] = server_config.getboolean("DEFAULT",
2057
2238
                                                           option)
2058
2239
    if server_settings["port"]:
2059
2240
        server_settings["port"] = server_config.getint("DEFAULT",
2060
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"])
2061
2251
    del server_config
2062
2252
    
2063
2253
    # Override the settings from the config file with command line
2065
2255
    for option in ("interface", "address", "port", "debug",
2066
2256
                   "priority", "servicename", "configdir",
2067
2257
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2068
 
                   "statedir"):
 
2258
                   "statedir", "socket", "foreground"):
2069
2259
        value = getattr(options, option)
2070
2260
        if value is not None:
2071
2261
            server_settings[option] = value
2074
2264
    for option in server_settings.keys():
2075
2265
        if type(server_settings[option]) is str:
2076
2266
            server_settings[option] = unicode(server_settings[option])
 
2267
    # Debug implies foreground
 
2268
    if server_settings["debug"]:
 
2269
        server_settings["foreground"] = True
2077
2270
    # Now we have our good server settings in "server_settings"
2078
2271
    
2079
2272
    ##################################################################
2085
2278
    use_ipv6 = server_settings["use_ipv6"]
2086
2279
    stored_state_path = os.path.join(server_settings["statedir"],
2087
2280
                                     stored_state_file)
 
2281
    foreground = server_settings["foreground"]
2088
2282
    
2089
2283
    if debug:
2090
2284
        initlogger(debug, logging.DEBUG)
2097
2291
    
2098
2292
    if server_settings["servicename"] != "Mandos":
2099
2293
        syslogger.setFormatter(logging.Formatter
2100
 
                               ('Mandos (%s) [%%(process)d]:'
2101
 
                                ' %%(levelname)s: %%(message)s'
2102
 
                                % server_settings["servicename"]))
 
2294
                               ('Mandos ({0}) [%(process)d]:'
 
2295
                                ' %(levelname)s: %(message)s'
 
2296
                                .format(server_settings
 
2297
                                        ["servicename"])))
2103
2298
    
2104
2299
    # Parse config file with clients
2105
2300
    client_config = configparser.SafeConfigParser(Client
2118
2313
                              use_ipv6=use_ipv6,
2119
2314
                              gnutls_priority=
2120
2315
                              server_settings["priority"],
2121
 
                              use_dbus=use_dbus)
2122
 
    if not debug:
 
2316
                              use_dbus=use_dbus,
 
2317
                              socketfd=(server_settings["socket"]
 
2318
                                        or None))
 
2319
    if not foreground:
2123
2320
        pidfilename = "/var/run/mandos.pid"
 
2321
        pidfile = None
2124
2322
        try:
2125
2323
            pidfile = open(pidfilename, "w")
2126
 
        except IOError:
2127
 
            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)
2128
2327
    
2129
 
    try:
2130
 
        uid = pwd.getpwnam("_mandos").pw_uid
2131
 
        gid = pwd.getpwnam("_mandos").pw_gid
2132
 
    except KeyError:
 
2328
    for name in ("_mandos", "mandos", "nobody"):
2133
2329
        try:
2134
 
            uid = pwd.getpwnam("mandos").pw_uid
2135
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2330
            uid = pwd.getpwnam(name).pw_uid
 
2331
            gid = pwd.getpwnam(name).pw_gid
 
2332
            break
2136
2333
        except KeyError:
2137
 
            try:
2138
 
                uid = pwd.getpwnam("nobody").pw_uid
2139
 
                gid = pwd.getpwnam("nobody").pw_gid
2140
 
            except KeyError:
2141
 
                uid = 65534
2142
 
                gid = 65534
 
2334
            continue
 
2335
    else:
 
2336
        uid = 65534
 
2337
        gid = 65534
2143
2338
    try:
2144
2339
        os.setgid(gid)
2145
2340
        os.setuid(uid)
2146
2341
    except OSError as error:
2147
 
        if error[0] != errno.EPERM:
 
2342
        if error.errno != errno.EPERM:
2148
2343
            raise error
2149
2344
    
2150
2345
    if debug:
2162
2357
         .gnutls_global_set_log_function(debug_gnutls))
2163
2358
        
2164
2359
        # Redirect stdin so all checkers get /dev/null
2165
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2360
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2166
2361
        os.dup2(null, sys.stdin.fileno())
2167
2362
        if null > 2:
2168
2363
            os.close(null)
2169
2364
    
2170
2365
    # Need to fork before connecting to D-Bus
2171
 
    if not debug:
 
2366
    if not foreground:
2172
2367
        # Close all input and output, do double fork, etc.
2173
2368
        daemon()
2174
2369
    
 
2370
    # multiprocessing will use threads, so before we use gobject we
 
2371
    # need to inform gobject that threads will be used.
2175
2372
    gobject.threads_init()
2176
2373
    
2177
2374
    global main_loop
2178
2375
    # From the Avahi example code
2179
 
    DBusGMainLoop(set_as_default=True )
 
2376
    DBusGMainLoop(set_as_default=True)
2180
2377
    main_loop = gobject.MainLoop()
2181
2378
    bus = dbus.SystemBus()
2182
2379
    # End of Avahi example code
2188
2385
                            ("se.bsnet.fukt.Mandos", bus,
2189
2386
                             do_not_queue=True))
2190
2387
        except dbus.exceptions.NameExistsException as e:
2191
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2388
            logger.error("Disabling D-Bus:", exc_info=e)
2192
2389
            use_dbus = False
2193
2390
            server_settings["use_dbus"] = False
2194
2391
            tcp_server.use_dbus = False
2206
2403
    
2207
2404
    client_class = Client
2208
2405
    if use_dbus:
2209
 
        client_class = functools.partial(ClientDBusTransitional,
2210
 
                                         bus = bus)
 
2406
        client_class = functools.partial(ClientDBus, bus = bus)
2211
2407
    
2212
2408
    client_settings = Client.config_parser(client_config)
2213
2409
    old_client_settings = {}
2221
2417
                                                     (stored_state))
2222
2418
            os.remove(stored_state_path)
2223
2419
        except IOError as e:
2224
 
            logger.warning("Could not load persistent state: {0}"
2225
 
                           .format(e))
2226
 
            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)
2227
2426
                raise
2228
2427
        except EOFError as e:
2229
2428
            logger.warning("Could not load persistent state: "
2230
 
                           "EOFError: {0}".format(e))
 
2429
                           "EOFError:", exc_info=e)
2231
2430
    
2232
2431
    with PGPEngine() as pgp:
2233
2432
        for client_name, client in clients_data.iteritems():
2250
2449
            
2251
2450
            # Clients who has passed its expire date can still be
2252
2451
            # enabled if its last checker was successful.  Clients
2253
 
            # whose checker failed before we stored its state is
2254
 
            # 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.
2255
2455
            if client["enabled"]:
2256
2456
                if datetime.datetime.utcnow() >= client["expires"]:
2257
2457
                    if not client["last_checked_ok"]:
2258
2458
                        logger.warning(
2259
2459
                            "disabling client {0} - Client never "
2260
 
                            "performed a successfull checker"
2261
 
                            .format(client["name"]))
 
2460
                            "performed a successful checker"
 
2461
                            .format(client_name))
2262
2462
                        client["enabled"] = False
2263
2463
                    elif client["last_checker_status"] != 0:
2264
2464
                        logger.warning(
2265
2465
                            "disabling client {0} - Client "
2266
2466
                            "last checker failed with error code {1}"
2267
 
                            .format(client["name"],
 
2467
                            .format(client_name,
2268
2468
                                    client["last_checker_status"]))
2269
2469
                        client["enabled"] = False
2270
2470
                    else:
2273
2473
                                             + client["timeout"])
2274
2474
                        logger.debug("Last checker succeeded,"
2275
2475
                                     " keeping {0} enabled"
2276
 
                                     .format(client["name"]))
 
2476
                                     .format(client_name))
2277
2477
            try:
2278
2478
                client["secret"] = (
2279
2479
                    pgp.decrypt(client["encrypted_secret"],
2285
2485
                             .format(client_name))
2286
2486
                client["secret"] = (
2287
2487
                    client_settings[client_name]["secret"])
2288
 
 
2289
2488
    
2290
2489
    # Add/remove clients based on new changes made to config
2291
2490
    for client_name in (set(old_client_settings)
2294
2493
    for client_name in (set(client_settings)
2295
2494
                        - set(old_client_settings)):
2296
2495
        clients_data[client_name] = client_settings[client_name]
2297
 
 
2298
 
    # Create clients all clients
 
2496
    
 
2497
    # Create all client objects
2299
2498
    for client_name, client in clients_data.iteritems():
2300
2499
        tcp_server.clients[client_name] = client_class(
2301
2500
            name = client_name, settings = client)
2302
2501
    
2303
2502
    if not tcp_server.clients:
2304
2503
        logger.warning("No clients defined")
2305
 
        
2306
 
    if not debug:
2307
 
        try:
2308
 
            with pidfile:
2309
 
                pid = os.getpid()
2310
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2311
 
            del pidfile
2312
 
        except IOError:
2313
 
            logger.error("Could not write to file %r with PID %d",
2314
 
                         pidfilename, pid)
2315
 
        except NameError:
2316
 
            # "pidfile" was never created
2317
 
            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
2318
2515
        del pidfilename
2319
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2320
2516
    
2321
2517
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2322
2518
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2323
2519
    
2324
2520
    if use_dbus:
2325
 
        class MandosDBusService(dbus.service.Object):
 
2521
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2522
                                        "se.bsnet.fukt.Mandos"})
 
2523
        class MandosDBusService(DBusObjectWithProperties):
2326
2524
            """A D-Bus proxy object"""
2327
2525
            def __init__(self):
2328
2526
                dbus.service.Object.__init__(self, bus, "/")
2329
2527
            _interface = "se.recompile.Mandos"
2330
2528
            
 
2529
            @dbus_interface_annotations(_interface)
 
2530
            def _foo(self):
 
2531
                return { "org.freedesktop.DBus.Property"
 
2532
                         ".EmitsChangedSignal":
 
2533
                             "false"}
 
2534
            
2331
2535
            @dbus.service.signal(_interface, signature="o")
2332
2536
            def ClientAdded(self, objpath):
2333
2537
                "D-Bus signal"
2375
2579
            
2376
2580
            del _interface
2377
2581
        
2378
 
        class MandosDBusServiceTransitional(MandosDBusService):
2379
 
            __metaclass__ = AlternateDBusNamesMetaclass
2380
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2582
        mandos_dbus_service = MandosDBusService()
2381
2583
    
2382
2584
    def cleanup():
2383
2585
        "Cleanup function; run on exit"
2416
2618
                del client_settings[client.name]["secret"]
2417
2619
        
2418
2620
        try:
2419
 
            tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2420
 
                                                prefix="clients-",
2421
 
                                                dir=os.path.dirname
2422
 
                                                (stored_state_path))
2423
 
            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:
2424
2625
                pickle.dump((clients, client_settings), stored_state)
 
2626
                tempname=stored_state.name
2425
2627
            os.rename(tempname, stored_state_path)
2426
2628
        except (IOError, OSError) as e:
2427
 
            logger.warning("Could not save persistent state: {0}"
2428
 
                           .format(e))
2429
2629
            if not debug:
2430
2630
                try:
2431
2631
                    os.remove(tempname)
2432
2632
                except NameError:
2433
2633
                    pass
2434
 
            if e.errno not in set((errno.ENOENT, errno.EACCES,
2435
 
                                   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)
2436
2640
                raise e
2437
2641
        
2438
2642
        # Delete all clients, and settings from config
2466
2670
    service.port = tcp_server.socket.getsockname()[1]
2467
2671
    if use_ipv6:
2468
2672
        logger.info("Now listening on address %r, port %d,"
2469
 
                    " flowinfo %d, scope_id %d"
2470
 
                    % tcp_server.socket.getsockname())
 
2673
                    " flowinfo %d, scope_id %d",
 
2674
                    *tcp_server.socket.getsockname())
2471
2675
    else:                       # IPv4
2472
 
        logger.info("Now listening on address %r, port %d"
2473
 
                    % tcp_server.socket.getsockname())
 
2676
        logger.info("Now listening on address %r, port %d",
 
2677
                    *tcp_server.socket.getsockname())
2474
2678
    
2475
2679
    #service.interface = tcp_server.socket.getsockname()[3]
2476
2680
    
2479
2683
        try:
2480
2684
            service.activate()
2481
2685
        except dbus.exceptions.DBusException as error:
2482
 
            logger.critical("DBusException: %s", error)
 
2686
            logger.critical("D-Bus Exception", exc_info=error)
2483
2687
            cleanup()
2484
2688
            sys.exit(1)
2485
2689
        # End of Avahi example code
2492
2696
        logger.debug("Starting main loop")
2493
2697
        main_loop.run()
2494
2698
    except AvahiError as error:
2495
 
        logger.critical("AvahiError: %s", error)
 
2699
        logger.critical("Avahi Error", exc_info=error)
2496
2700
        cleanup()
2497
2701
        sys.exit(1)
2498
2702
    except KeyboardInterrupt: