/mandos/trunk

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

« back to all changes in this revision

Viewing changes to mandos

  • Committer: Teddy Hogeborn
  • Date: 2012-06-23 00:58:49 UTC
  • Revision ID: teddy@recompile.se-20120623005849-02wj82cng433rt2k
* clients.conf: Convert all time intervals to new RFC 3339 syntax.
* mandos: All client options for time intervals now take an RFC 3339
          duration.
  (rfc3339_duration_to_delta): New function.
  (string_to_delta): Try rfc3339_duration_to_delta first.
* mandos-clients.conf.xml (OPTIONS/timeout): Document new format.
  (EXAMPLE): Update to new interval format.
  (SEE ALSO): Reference RFC 3339.

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
 
71
import collections
68
72
 
69
73
import dbus
70
74
import dbus.service
85
89
    except ImportError:
86
90
        SO_BINDTODEVICE = None
87
91
 
88
 
version = "1.5.3"
 
92
version = "1.6.0"
89
93
stored_state_file = "clients.pickle"
90
94
 
91
95
logger = logging.getLogger()
148
152
    def __enter__(self):
149
153
        return self
150
154
    
151
 
    def __exit__ (self, exc_type, exc_value, traceback):
 
155
    def __exit__(self, exc_type, exc_value, traceback):
152
156
        self._cleanup()
153
157
        return False
154
158
    
175
179
    
176
180
    def encrypt(self, data, password):
177
181
        self.gnupg.passphrase = self.password_encode(password)
178
 
        with open(os.devnull) as devnull:
 
182
        with open(os.devnull, "w") as devnull:
179
183
            try:
180
184
                proc = self.gnupg.run(['--symmetric'],
181
185
                                      create_fhs=['stdin', 'stdout'],
192
196
    
193
197
    def decrypt(self, data, password):
194
198
        self.gnupg.passphrase = self.password_encode(password)
195
 
        with open(os.devnull) as devnull:
 
199
        with open(os.devnull, "w") as devnull:
196
200
            try:
197
201
                proc = self.gnupg.run(['--decrypt'],
198
202
                                      create_fhs=['stdin', 'stdout'],
199
203
                                      attach_fhs={'stderr': devnull})
200
 
                with contextlib.closing(proc.handles['stdin'] ) as f:
 
204
                with contextlib.closing(proc.handles['stdin']) as f:
201
205
                    f.write(data)
202
206
                with contextlib.closing(proc.handles['stdout']) as f:
203
207
                    decrypted_plaintext = f.read()
208
212
        return decrypted_plaintext
209
213
 
210
214
 
211
 
 
212
215
class AvahiError(Exception):
213
216
    def __init__(self, value, *args, **kwargs):
214
217
        self.value = value
243
246
    server: D-Bus Server
244
247
    bus: dbus.SystemBus()
245
248
    """
 
249
    
246
250
    def __init__(self, interface = avahi.IF_UNSPEC, name = None,
247
251
                 servicetype = None, port = None, TXT = None,
248
252
                 domain = "", host = "", max_renames = 32768,
261
265
        self.server = None
262
266
        self.bus = bus
263
267
        self.entry_group_state_changed_match = None
 
268
    
264
269
    def rename(self):
265
270
        """Derived from the Avahi example code"""
266
271
        if self.rename_count >= self.max_renames:
276
281
        try:
277
282
            self.add()
278
283
        except dbus.exceptions.DBusException as error:
279
 
            logger.critical("DBusException: %s", error)
 
284
            logger.critical("D-Bus Exception", exc_info=error)
280
285
            self.cleanup()
281
286
            os._exit(1)
282
287
        self.rename_count += 1
 
288
    
283
289
    def remove(self):
284
290
        """Derived from the Avahi example code"""
285
291
        if self.entry_group_state_changed_match is not None:
287
293
            self.entry_group_state_changed_match = None
288
294
        if self.group is not None:
289
295
            self.group.Reset()
 
296
    
290
297
    def add(self):
291
298
        """Derived from the Avahi example code"""
292
299
        self.remove()
309
316
            dbus.UInt16(self.port),
310
317
            avahi.string_array_to_txt_array(self.TXT))
311
318
        self.group.Commit()
 
319
    
312
320
    def entry_group_state_changed(self, state, error):
313
321
        """Derived from the Avahi example code"""
314
322
        logger.debug("Avahi entry group state change: %i", state)
321
329
        elif state == avahi.ENTRY_GROUP_FAILURE:
322
330
            logger.critical("Avahi: Error in group state changed %s",
323
331
                            unicode(error))
324
 
            raise AvahiGroupError("State changed: %s"
325
 
                                  % unicode(error))
 
332
            raise AvahiGroupError("State changed: {0!s}"
 
333
                                  .format(error))
 
334
    
326
335
    def cleanup(self):
327
336
        """Derived from the Avahi example code"""
328
337
        if self.group is not None:
333
342
                pass
334
343
            self.group = None
335
344
        self.remove()
 
345
    
336
346
    def server_state_changed(self, state, error=None):
337
347
        """Derived from the Avahi example code"""
338
348
        logger.debug("Avahi server state change: %i", state)
357
367
                logger.debug("Unknown state: %r", state)
358
368
            else:
359
369
                logger.debug("Unknown state: %r: %r", state, error)
 
370
    
360
371
    def activate(self):
361
372
        """Derived from the Avahi example code"""
362
373
        if self.server is None:
369
380
                                 self.server_state_changed)
370
381
        self.server_state_changed(self.server.GetState())
371
382
 
 
383
 
372
384
class AvahiServiceToSyslog(AvahiService):
373
385
    def rename(self):
374
386
        """Add the new name to the syslog messages"""
375
387
        ret = AvahiService.rename(self)
376
388
        syslogger.setFormatter(logging.Formatter
377
 
                               ('Mandos (%s) [%%(process)d]:'
378
 
                                ' %%(levelname)s: %%(message)s'
379
 
                                % self.name))
 
389
                               ('Mandos ({0}) [%(process)d]:'
 
390
                                ' %(levelname)s: %(message)s'
 
391
                                .format(self.name)))
380
392
        return ret
381
393
 
 
394
 
382
395
def timedelta_to_milliseconds(td):
383
396
    "Convert a datetime.timedelta() to milliseconds"
384
397
    return ((td.days * 24 * 60 * 60 * 1000)
385
398
            + (td.seconds * 1000)
386
399
            + (td.microseconds // 1000))
387
 
        
 
400
 
 
401
 
388
402
class Client(object):
389
403
    """A representation of a client host served by this server.
390
404
    
429
443
    """
430
444
    
431
445
    runtime_expansions = ("approval_delay", "approval_duration",
432
 
                          "created", "enabled", "fingerprint",
433
 
                          "host", "interval", "last_checked_ok",
 
446
                          "created", "enabled", "expires",
 
447
                          "fingerprint", "host", "interval",
 
448
                          "last_approval_request", "last_checked_ok",
434
449
                          "last_enabled", "name", "timeout")
435
 
    client_defaults = { "timeout": "5m",
436
 
                        "extended_timeout": "15m",
437
 
                        "interval": "2m",
 
450
    client_defaults = { "timeout": "PT5M",
 
451
                        "extended_timeout": "PT15M",
 
452
                        "interval": "PT2M",
438
453
                        "checker": "fping -q -- %%(host)s",
439
454
                        "host": "",
440
 
                        "approval_delay": "0s",
441
 
                        "approval_duration": "1s",
 
455
                        "approval_delay": "PT0S",
 
456
                        "approval_duration": "PT1S",
442
457
                        "approved_by_default": "True",
443
458
                        "enabled": "True",
444
459
                        }
457
472
    
458
473
    def approval_delay_milliseconds(self):
459
474
        return timedelta_to_milliseconds(self.approval_delay)
460
 
 
 
475
    
461
476
    @staticmethod
462
477
    def config_parser(config):
463
478
        """Construct a new dict of client settings of this form:
488
503
                          "rb") as secfile:
489
504
                    client["secret"] = secfile.read()
490
505
            else:
491
 
                raise TypeError("No secret or secfile for section %s"
492
 
                                % section)
 
506
                raise TypeError("No secret or secfile for section {0}"
 
507
                                .format(section))
493
508
            client["timeout"] = string_to_delta(section["timeout"])
494
509
            client["extended_timeout"] = string_to_delta(
495
510
                section["extended_timeout"])
504
519
            client["last_checker_status"] = -2
505
520
        
506
521
        return settings
507
 
        
508
 
        
 
522
    
509
523
    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
524
        self.name = name
514
525
        # adding all client settings
515
526
        for setting, value in settings.iteritems():
524
535
        else:
525
536
            self.last_enabled = None
526
537
            self.expires = None
527
 
       
 
538
        
528
539
        logger.debug("Creating client %r", self.name)
529
540
        # Uppercase and remove spaces from fingerprint for later
530
541
        # comparison purposes with return value from the fingerprint()
532
543
        logger.debug("  Fingerprint: %s", self.fingerprint)
533
544
        self.created = settings.get("created",
534
545
                                    datetime.datetime.utcnow())
535
 
 
 
546
        
536
547
        # attributes specific for this server instance
537
548
        self.checker = None
538
549
        self.checker_initiator_tag = None
566
577
        if getattr(self, "enabled", False):
567
578
            # Already enabled
568
579
            return
569
 
        self.send_changedstate()
570
580
        self.expires = datetime.datetime.utcnow() + self.timeout
571
581
        self.enabled = True
572
582
        self.last_enabled = datetime.datetime.utcnow()
573
583
        self.init_checker()
 
584
        self.send_changedstate()
574
585
    
575
586
    def disable(self, quiet=True):
576
587
        """Disable this client."""
577
588
        if not getattr(self, "enabled", False):
578
589
            return False
579
590
        if not quiet:
580
 
            self.send_changedstate()
581
 
        if not quiet:
582
591
            logger.info("Disabling client %s", self.name)
583
 
        if getattr(self, "disable_initiator_tag", False):
 
592
        if getattr(self, "disable_initiator_tag", None) is not None:
584
593
            gobject.source_remove(self.disable_initiator_tag)
585
594
            self.disable_initiator_tag = None
586
595
        self.expires = None
587
 
        if getattr(self, "checker_initiator_tag", False):
 
596
        if getattr(self, "checker_initiator_tag", None) is not None:
588
597
            gobject.source_remove(self.checker_initiator_tag)
589
598
            self.checker_initiator_tag = None
590
599
        self.stop_checker()
591
600
        self.enabled = False
 
601
        if not quiet:
 
602
            self.send_changedstate()
592
603
        # Do not run this again if called by a gobject.timeout_add
593
604
        return False
594
605
    
598
609
    def init_checker(self):
599
610
        # Schedule a new checker to be started an 'interval' from now,
600
611
        # and every interval from then on.
 
612
        if self.checker_initiator_tag is not None:
 
613
            gobject.source_remove(self.checker_initiator_tag)
601
614
        self.checker_initiator_tag = (gobject.timeout_add
602
615
                                      (self.interval_milliseconds(),
603
616
                                       self.start_checker))
604
617
        # Schedule a disable() when 'timeout' has passed
 
618
        if self.disable_initiator_tag is not None:
 
619
            gobject.source_remove(self.disable_initiator_tag)
605
620
        self.disable_initiator_tag = (gobject.timeout_add
606
621
                                   (self.timeout_milliseconds(),
607
622
                                    self.disable))
638
653
            timeout = self.timeout
639
654
        if self.disable_initiator_tag is not None:
640
655
            gobject.source_remove(self.disable_initiator_tag)
 
656
            self.disable_initiator_tag = None
641
657
        if getattr(self, "enabled", False):
642
658
            self.disable_initiator_tag = (gobject.timeout_add
643
659
                                          (timedelta_to_milliseconds
653
669
        If a checker already exists, leave it running and do
654
670
        nothing."""
655
671
        # The reason for not killing a running checker is that if we
656
 
        # did that, then if a checker (for some reason) started
657
 
        # running slowly and taking more than 'interval' time, the
658
 
        # client would inevitably timeout, since no checker would get
659
 
        # a chance to run to completion.  If we instead leave running
 
672
        # did that, and if a checker (for some reason) started running
 
673
        # slowly and taking more than 'interval' time, then the client
 
674
        # would inevitably timeout, since no checker would get a
 
675
        # chance to run to completion.  If we instead leave running
660
676
        # checkers alone, the checker would have to take more time
661
677
        # than 'timeout' for the client to be disabled, which is as it
662
678
        # should be.
676
692
                                      self.current_checker_command)
677
693
        # Start a new checker if needed
678
694
        if self.checker is None:
 
695
            # Escape attributes for the shell
 
696
            escaped_attrs = dict(
 
697
                (attr, re.escape(unicode(getattr(self, attr))))
 
698
                for attr in
 
699
                self.runtime_expansions)
679
700
            try:
680
 
                # In case checker_command has exactly one % operator
681
 
                command = self.checker_command % self.host
682
 
            except TypeError:
683
 
                # Escape attributes for the shell
684
 
                escaped_attrs = dict(
685
 
                    (attr,
686
 
                     re.escape(unicode(str(getattr(self, attr, "")),
687
 
                                       errors=
688
 
                                       'replace')))
689
 
                    for attr in
690
 
                    self.runtime_expansions)
691
 
                
692
 
                try:
693
 
                    command = self.checker_command % escaped_attrs
694
 
                except TypeError as error:
695
 
                    logger.error('Could not format string "%s":'
696
 
                                 ' %s', self.checker_command, error)
697
 
                    return True # Try again later
 
701
                command = self.checker_command % escaped_attrs
 
702
            except TypeError as error:
 
703
                logger.error('Could not format string "%s"',
 
704
                             self.checker_command, exc_info=error)
 
705
                return True # Try again later
698
706
            self.current_checker_command = command
699
707
            try:
700
708
                logger.info("Starting checker %r for %s",
706
714
                self.checker = subprocess.Popen(command,
707
715
                                                close_fds=True,
708
716
                                                shell=True, cwd="/")
709
 
                self.checker_callback_tag = (gobject.child_watch_add
710
 
                                             (self.checker.pid,
711
 
                                              self.checker_callback,
712
 
                                              data=command))
713
 
                # The checker may have completed before the gobject
714
 
                # watch was added.  Check for this.
715
 
                pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
716
 
                if pid:
717
 
                    gobject.source_remove(self.checker_callback_tag)
718
 
                    self.checker_callback(pid, status, command)
719
717
            except OSError as error:
720
 
                logger.error("Failed to start subprocess: %s",
721
 
                             error)
 
718
                logger.error("Failed to start subprocess",
 
719
                             exc_info=error)
 
720
            self.checker_callback_tag = (gobject.child_watch_add
 
721
                                         (self.checker.pid,
 
722
                                          self.checker_callback,
 
723
                                          data=command))
 
724
            # The checker may have completed before the gobject
 
725
            # watch was added.  Check for this.
 
726
            pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
 
727
            if pid:
 
728
                gobject.source_remove(self.checker_callback_tag)
 
729
                self.checker_callback(pid, status, command)
722
730
        # Re-run this periodically if run by gobject.timeout_add
723
731
        return True
724
732
    
731
739
            return
732
740
        logger.debug("Stopping checker for %(name)s", vars(self))
733
741
        try:
734
 
            os.kill(self.checker.pid, signal.SIGTERM)
 
742
            self.checker.terminate()
735
743
            #time.sleep(0.5)
736
744
            #if self.checker.poll() is None:
737
 
            #    os.kill(self.checker.pid, signal.SIGKILL)
 
745
            #    self.checker.kill()
738
746
        except OSError as error:
739
747
            if error.errno != errno.ESRCH: # No such process
740
748
                raise
757
765
    # "Set" method, so we fail early here:
758
766
    if byte_arrays and signature != "ay":
759
767
        raise ValueError("Byte arrays not supported for non-'ay'"
760
 
                         " signature %r" % signature)
 
768
                         " signature {0!r}".format(signature))
761
769
    def decorator(func):
762
770
        func._dbus_is_property = True
763
771
        func._dbus_interface = dbus_interface
771
779
    return decorator
772
780
 
773
781
 
 
782
def dbus_interface_annotations(dbus_interface):
 
783
    """Decorator for marking functions returning interface annotations
 
784
    
 
785
    Usage:
 
786
    
 
787
    @dbus_interface_annotations("org.example.Interface")
 
788
    def _foo(self):  # Function name does not matter
 
789
        return {"org.freedesktop.DBus.Deprecated": "true",
 
790
                "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
791
                    "false"}
 
792
    """
 
793
    def decorator(func):
 
794
        func._dbus_is_interface = True
 
795
        func._dbus_interface = dbus_interface
 
796
        func._dbus_name = dbus_interface
 
797
        return func
 
798
    return decorator
 
799
 
 
800
 
 
801
def dbus_annotations(annotations):
 
802
    """Decorator to annotate D-Bus methods, signals or properties
 
803
    Usage:
 
804
    
 
805
    @dbus_service_property("org.example.Interface", signature="b",
 
806
                           access="r")
 
807
    @dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
 
808
                        "org.freedesktop.DBus.Property."
 
809
                        "EmitsChangedSignal": "false"})
 
810
    def Property_dbus_property(self):
 
811
        return dbus.Boolean(False)
 
812
    """
 
813
    def decorator(func):
 
814
        func._dbus_annotations = annotations
 
815
        return func
 
816
    return decorator
 
817
 
 
818
 
774
819
class DBusPropertyException(dbus.exceptions.DBusException):
775
820
    """A base class for D-Bus property-related exceptions
776
821
    """
799
844
    """
800
845
    
801
846
    @staticmethod
802
 
    def _is_dbus_property(obj):
803
 
        return getattr(obj, "_dbus_is_property", False)
 
847
    def _is_dbus_thing(thing):
 
848
        """Returns a function testing if an attribute is a D-Bus thing
 
849
        
 
850
        If called like _is_dbus_thing("method") it returns a function
 
851
        suitable for use as predicate to inspect.getmembers().
 
852
        """
 
853
        return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
 
854
                                   False)
804
855
    
805
 
    def _get_all_dbus_properties(self):
 
856
    def _get_all_dbus_things(self, thing):
806
857
        """Returns a generator of (name, attribute) pairs
807
858
        """
808
 
        return ((prop.__get__(self)._dbus_name, prop.__get__(self))
 
859
        return ((getattr(athing.__get__(self), "_dbus_name",
 
860
                         name),
 
861
                 athing.__get__(self))
809
862
                for cls in self.__class__.__mro__
810
 
                for name, prop in
811
 
                inspect.getmembers(cls, self._is_dbus_property))
 
863
                for name, athing in
 
864
                inspect.getmembers(cls,
 
865
                                   self._is_dbus_thing(thing)))
812
866
    
813
867
    def _get_dbus_property(self, interface_name, property_name):
814
868
        """Returns a bound method if one exists which is a D-Bus
816
870
        """
817
871
        for cls in  self.__class__.__mro__:
818
872
            for name, value in (inspect.getmembers
819
 
                                (cls, self._is_dbus_property)):
 
873
                                (cls,
 
874
                                 self._is_dbus_thing("property"))):
820
875
                if (value._dbus_name == property_name
821
876
                    and value._dbus_interface == interface_name):
822
877
                    return value.__get__(self)
864
919
        Note: Will not include properties with access="write".
865
920
        """
866
921
        properties = {}
867
 
        for name, prop in self._get_all_dbus_properties():
 
922
        for name, prop in self._get_all_dbus_things("property"):
868
923
            if (interface_name
869
924
                and interface_name != prop._dbus_interface):
870
925
                # Interface non-empty but did not match
885
940
                         path_keyword='object_path',
886
941
                         connection_keyword='connection')
887
942
    def Introspect(self, object_path, connection):
888
 
        """Standard D-Bus method, overloaded to insert property tags.
 
943
        """Overloading of standard D-Bus method.
 
944
        
 
945
        Inserts property tags and interface annotation tags.
889
946
        """
890
947
        xmlstring = dbus.service.Object.Introspect(self, object_path,
891
948
                                                   connection)
898
955
                e.setAttribute("access", prop._dbus_access)
899
956
                return e
900
957
            for if_tag in document.getElementsByTagName("interface"):
 
958
                # Add property tags
901
959
                for tag in (make_tag(document, name, prop)
902
960
                            for name, prop
903
 
                            in self._get_all_dbus_properties()
 
961
                            in self._get_all_dbus_things("property")
904
962
                            if prop._dbus_interface
905
963
                            == if_tag.getAttribute("name")):
906
964
                    if_tag.appendChild(tag)
 
965
                # Add annotation tags
 
966
                for typ in ("method", "signal", "property"):
 
967
                    for tag in if_tag.getElementsByTagName(typ):
 
968
                        annots = dict()
 
969
                        for name, prop in (self.
 
970
                                           _get_all_dbus_things(typ)):
 
971
                            if (name == tag.getAttribute("name")
 
972
                                and prop._dbus_interface
 
973
                                == if_tag.getAttribute("name")):
 
974
                                annots.update(getattr
 
975
                                              (prop,
 
976
                                               "_dbus_annotations",
 
977
                                               {}))
 
978
                        for name, value in annots.iteritems():
 
979
                            ann_tag = document.createElement(
 
980
                                "annotation")
 
981
                            ann_tag.setAttribute("name", name)
 
982
                            ann_tag.setAttribute("value", value)
 
983
                            tag.appendChild(ann_tag)
 
984
                # Add interface annotation tags
 
985
                for annotation, value in dict(
 
986
                    itertools.chain.from_iterable(
 
987
                        annotations().iteritems()
 
988
                        for name, annotations in
 
989
                        self._get_all_dbus_things("interface")
 
990
                        if name == if_tag.getAttribute("name")
 
991
                        )).iteritems():
 
992
                    ann_tag = document.createElement("annotation")
 
993
                    ann_tag.setAttribute("name", annotation)
 
994
                    ann_tag.setAttribute("value", value)
 
995
                    if_tag.appendChild(ann_tag)
907
996
                # Add the names to the return values for the
908
997
                # "org.freedesktop.DBus.Properties" methods
909
998
                if (if_tag.getAttribute("name")
924
1013
        except (AttributeError, xml.dom.DOMException,
925
1014
                xml.parsers.expat.ExpatError) as error:
926
1015
            logger.error("Failed to override Introspection method",
927
 
                         error)
 
1016
                         exc_info=error)
928
1017
        return xmlstring
929
1018
 
930
1019
 
931
 
def datetime_to_dbus (dt, variant_level=0):
 
1020
def datetime_to_dbus(dt, variant_level=0):
932
1021
    """Convert a UTC datetime.datetime() to a D-Bus type."""
933
1022
    if dt is None:
934
1023
        return dbus.String("", variant_level = variant_level)
936
1025
                       variant_level=variant_level)
937
1026
 
938
1027
 
939
 
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
940
 
                                  .__metaclass__):
941
 
    """Applied to an empty subclass of a D-Bus object, this metaclass
942
 
    will add additional D-Bus attributes matching a certain pattern.
 
1028
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
 
1029
    """A class decorator; applied to a subclass of
 
1030
    dbus.service.Object, it will add alternate D-Bus attributes with
 
1031
    interface names according to the "alt_interface_names" mapping.
 
1032
    Usage:
 
1033
    
 
1034
    @alternate_dbus_interfaces({"org.example.Interface":
 
1035
                                    "net.example.AlternateInterface"})
 
1036
    class SampleDBusObject(dbus.service.Object):
 
1037
        @dbus.service.method("org.example.Interface")
 
1038
        def SampleDBusMethod():
 
1039
            pass
 
1040
    
 
1041
    The above "SampleDBusMethod" on "SampleDBusObject" will be
 
1042
    reachable via two interfaces: "org.example.Interface" and
 
1043
    "net.example.AlternateInterface", the latter of which will have
 
1044
    its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
 
1045
    "true", unless "deprecate" is passed with a False value.
 
1046
    
 
1047
    This works for methods and signals, and also for D-Bus properties
 
1048
    (from DBusObjectWithProperties) and interfaces (from the
 
1049
    dbus_interface_annotations decorator).
943
1050
    """
944
 
    def __new__(mcs, name, bases, attr):
945
 
        # Go through all the base classes which could have D-Bus
946
 
        # methods, signals, or properties in them
947
 
        for base in (b for b in bases
948
 
                     if issubclass(b, dbus.service.Object)):
949
 
            # Go though all attributes of the base class
950
 
            for attrname, attribute in inspect.getmembers(base):
 
1051
    def wrapper(cls):
 
1052
        for orig_interface_name, alt_interface_name in (
 
1053
            alt_interface_names.iteritems()):
 
1054
            attr = {}
 
1055
            interface_names = set()
 
1056
            # Go though all attributes of the class
 
1057
            for attrname, attribute in inspect.getmembers(cls):
951
1058
                # Ignore non-D-Bus attributes, and D-Bus attributes
952
1059
                # with the wrong interface name
953
1060
                if (not hasattr(attribute, "_dbus_interface")
954
1061
                    or not attribute._dbus_interface
955
 
                    .startswith("se.recompile.Mandos")):
 
1062
                    .startswith(orig_interface_name)):
956
1063
                    continue
957
1064
                # Create an alternate D-Bus interface name based on
958
1065
                # the current name
959
1066
                alt_interface = (attribute._dbus_interface
960
 
                                 .replace("se.recompile.Mandos",
961
 
                                          "se.bsnet.fukt.Mandos"))
 
1067
                                 .replace(orig_interface_name,
 
1068
                                          alt_interface_name))
 
1069
                interface_names.add(alt_interface)
962
1070
                # Is this a D-Bus signal?
963
1071
                if getattr(attribute, "_dbus_is_signal", False):
964
1072
                    # Extract the original non-method function by
979
1087
                                nonmethod_func.func_name,
980
1088
                                nonmethod_func.func_defaults,
981
1089
                                nonmethod_func.func_closure)))
 
1090
                    # Copy annotations, if any
 
1091
                    try:
 
1092
                        new_function._dbus_annotations = (
 
1093
                            dict(attribute._dbus_annotations))
 
1094
                    except AttributeError:
 
1095
                        pass
982
1096
                    # Define a creator of a function to call both the
983
 
                    # old and new functions, so both the old and new
984
 
                    # signals gets sent when the function is called
 
1097
                    # original and alternate functions, so both the
 
1098
                    # original and alternate signals gets sent when
 
1099
                    # the function is called
985
1100
                    def fixscope(func1, func2):
986
1101
                        """This function is a scope container to pass
987
1102
                        func1 and func2 to the "call_both" function
994
1109
                        return call_both
995
1110
                    # Create the "call_both" function and add it to
996
1111
                    # the class
997
 
                    attr[attrname] = fixscope(attribute,
998
 
                                              new_function)
 
1112
                    attr[attrname] = fixscope(attribute, new_function)
999
1113
                # Is this a D-Bus method?
1000
1114
                elif getattr(attribute, "_dbus_is_method", False):
1001
1115
                    # Create a new, but exactly alike, function
1012
1126
                                        attribute.func_name,
1013
1127
                                        attribute.func_defaults,
1014
1128
                                        attribute.func_closure)))
 
1129
                    # Copy annotations, if any
 
1130
                    try:
 
1131
                        attr[attrname]._dbus_annotations = (
 
1132
                            dict(attribute._dbus_annotations))
 
1133
                    except AttributeError:
 
1134
                        pass
1015
1135
                # Is this a D-Bus property?
1016
1136
                elif getattr(attribute, "_dbus_is_property", False):
1017
1137
                    # Create a new, but exactly alike, function
1031
1151
                                        attribute.func_name,
1032
1152
                                        attribute.func_defaults,
1033
1153
                                        attribute.func_closure)))
1034
 
        return type.__new__(mcs, name, bases, attr)
1035
 
 
1036
 
 
 
1154
                    # Copy annotations, if any
 
1155
                    try:
 
1156
                        attr[attrname]._dbus_annotations = (
 
1157
                            dict(attribute._dbus_annotations))
 
1158
                    except AttributeError:
 
1159
                        pass
 
1160
                # Is this a D-Bus interface?
 
1161
                elif getattr(attribute, "_dbus_is_interface", False):
 
1162
                    # Create a new, but exactly alike, function
 
1163
                    # object.  Decorate it to be a new D-Bus interface
 
1164
                    # with the alternate D-Bus interface name.  Add it
 
1165
                    # to the class.
 
1166
                    attr[attrname] = (dbus_interface_annotations
 
1167
                                      (alt_interface)
 
1168
                                      (types.FunctionType
 
1169
                                       (attribute.func_code,
 
1170
                                        attribute.func_globals,
 
1171
                                        attribute.func_name,
 
1172
                                        attribute.func_defaults,
 
1173
                                        attribute.func_closure)))
 
1174
            if deprecate:
 
1175
                # Deprecate all alternate interfaces
 
1176
                iname="_AlternateDBusNames_interface_annotation{0}"
 
1177
                for interface_name in interface_names:
 
1178
                    @dbus_interface_annotations(interface_name)
 
1179
                    def func(self):
 
1180
                        return { "org.freedesktop.DBus.Deprecated":
 
1181
                                     "true" }
 
1182
                    # Find an unused name
 
1183
                    for aname in (iname.format(i)
 
1184
                                  for i in itertools.count()):
 
1185
                        if aname not in attr:
 
1186
                            attr[aname] = func
 
1187
                            break
 
1188
            if interface_names:
 
1189
                # Replace the class with a new subclass of it with
 
1190
                # methods, signals, etc. as created above.
 
1191
                cls = type(b"{0}Alternate".format(cls.__name__),
 
1192
                           (cls,), attr)
 
1193
        return cls
 
1194
    return wrapper
 
1195
 
 
1196
 
 
1197
@alternate_dbus_interfaces({"se.recompile.Mandos":
 
1198
                                "se.bsnet.fukt.Mandos"})
1037
1199
class ClientDBus(Client, DBusObjectWithProperties):
1038
1200
    """A Client class using D-Bus
1039
1201
    
1059
1221
                                 ("/clients/" + client_object_name))
1060
1222
        DBusObjectWithProperties.__init__(self, self.bus,
1061
1223
                                          self.dbus_object_path)
1062
 
        
 
1224
    
1063
1225
    def notifychangeproperty(transform_func,
1064
1226
                             dbus_name, type_func=lambda x: x,
1065
1227
                             variant_level=1):
1088
1250
        
1089
1251
        return property(lambda self: getattr(self, attrname), setter)
1090
1252
    
1091
 
    
1092
1253
    expires = notifychangeproperty(datetime_to_dbus, "Expires")
1093
1254
    approvals_pending = notifychangeproperty(dbus.Boolean,
1094
1255
                                             "ApprovalPending",
1176
1337
        return False
1177
1338
    
1178
1339
    def approve(self, value=True):
1179
 
        self.send_changedstate()
1180
1340
        self.approved = value
1181
1341
        gobject.timeout_add(timedelta_to_milliseconds
1182
1342
                            (self.approval_duration),
1183
1343
                            self._reset_approved)
1184
 
    
 
1344
        self.send_changedstate()
1185
1345
    
1186
1346
    ## D-Bus methods, signals & properties
1187
1347
    _interface = "se.recompile.Mandos.Client"
1188
1348
    
 
1349
    ## Interfaces
 
1350
    
 
1351
    @dbus_interface_annotations(_interface)
 
1352
    def _foo(self):
 
1353
        return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
 
1354
                     "false"}
 
1355
    
1189
1356
    ## Signals
1190
1357
    
1191
1358
    # CheckerCompleted - signal
1364
1531
    def Timeout_dbus_property(self, value=None):
1365
1532
        if value is None:       # get
1366
1533
            return dbus.UInt64(self.timeout_milliseconds())
 
1534
        old_timeout = self.timeout
1367
1535
        self.timeout = datetime.timedelta(0, 0, 0, value)
1368
 
        # Reschedule timeout
 
1536
        # Reschedule disabling
1369
1537
        if self.enabled:
1370
1538
            now = datetime.datetime.utcnow()
1371
 
            time_to_die = timedelta_to_milliseconds(
1372
 
                (self.last_checked_ok + self.timeout) - now)
1373
 
            if time_to_die <= 0:
 
1539
            self.expires += self.timeout - old_timeout
 
1540
            if self.expires <= now:
1374
1541
                # The timeout has passed
1375
1542
                self.disable()
1376
1543
            else:
1377
 
                self.expires = (now +
1378
 
                                datetime.timedelta(milliseconds =
1379
 
                                                   time_to_die))
1380
1544
                if (getattr(self, "disable_initiator_tag", None)
1381
1545
                    is None):
1382
1546
                    return
1383
1547
                gobject.source_remove(self.disable_initiator_tag)
1384
 
                self.disable_initiator_tag = (gobject.timeout_add
1385
 
                                              (time_to_die,
1386
 
                                               self.disable))
 
1548
                self.disable_initiator_tag = (
 
1549
                    gobject.timeout_add(
 
1550
                        timedelta_to_milliseconds(self.expires - now),
 
1551
                        self.disable))
1387
1552
    
1388
1553
    # ExtendedTimeout - property
1389
1554
    @dbus_service_property(_interface, signature="t",
1468
1633
        self._pipe.send(('setattr', name, value))
1469
1634
 
1470
1635
 
1471
 
class ClientDBusTransitional(ClientDBus):
1472
 
    __metaclass__ = AlternateDBusNamesMetaclass
1473
 
 
1474
 
 
1475
1636
class ClientHandler(socketserver.BaseRequestHandler, object):
1476
1637
    """A class to handle client connections.
1477
1638
    
1581
1742
                    #wait until timeout or approved
1582
1743
                    time = datetime.datetime.now()
1583
1744
                    client.changedstate.acquire()
1584
 
                    (client.changedstate.wait
1585
 
                     (float(client.timedelta_to_milliseconds(delay)
1586
 
                            / 1000)))
 
1745
                    client.changedstate.wait(
 
1746
                        float(timedelta_to_milliseconds(delay)
 
1747
                              / 1000))
1587
1748
                    client.changedstate.release()
1588
1749
                    time2 = datetime.datetime.now()
1589
1750
                    if (time2 - time) >= delay:
1605
1766
                    try:
1606
1767
                        sent = session.send(client.secret[sent_size:])
1607
1768
                    except gnutls.errors.GNUTLSError as error:
1608
 
                        logger.warning("gnutls send failed")
 
1769
                        logger.warning("gnutls send failed",
 
1770
                                       exc_info=error)
1609
1771
                        return
1610
1772
                    logger.debug("Sent: %d, remaining: %d",
1611
1773
                                 sent, len(client.secret)
1625
1787
                try:
1626
1788
                    session.bye()
1627
1789
                except gnutls.errors.GNUTLSError as error:
1628
 
                    logger.warning("GnuTLS bye failed")
 
1790
                    logger.warning("GnuTLS bye failed",
 
1791
                                   exc_info=error)
1629
1792
    
1630
1793
    @staticmethod
1631
1794
    def peer_certificate(session):
1703
1866
    def process_request(self, request, address):
1704
1867
        """Start a new process to process the request."""
1705
1868
        proc = multiprocessing.Process(target = self.sub_process_main,
1706
 
                                       args = (request,
1707
 
                                               address))
 
1869
                                       args = (request, address))
1708
1870
        proc.start()
1709
1871
        return proc
1710
1872
 
1738
1900
        use_ipv6:       Boolean; to use IPv6 or not
1739
1901
    """
1740
1902
    def __init__(self, server_address, RequestHandlerClass,
1741
 
                 interface=None, use_ipv6=True):
 
1903
                 interface=None, use_ipv6=True, socketfd=None):
 
1904
        """If socketfd is set, use that file descriptor instead of
 
1905
        creating a new one with socket.socket().
 
1906
        """
1742
1907
        self.interface = interface
1743
1908
        if use_ipv6:
1744
1909
            self.address_family = socket.AF_INET6
 
1910
        if socketfd is not None:
 
1911
            # Save the file descriptor
 
1912
            self.socketfd = socketfd
 
1913
            # Save the original socket.socket() function
 
1914
            self.socket_socket = socket.socket
 
1915
            # To implement --socket, we monkey patch socket.socket.
 
1916
            # 
 
1917
            # (When socketserver.TCPServer is a new-style class, we
 
1918
            # could make self.socket into a property instead of monkey
 
1919
            # patching socket.socket.)
 
1920
            # 
 
1921
            # Create a one-time-only replacement for socket.socket()
 
1922
            @functools.wraps(socket.socket)
 
1923
            def socket_wrapper(*args, **kwargs):
 
1924
                # Restore original function so subsequent calls are
 
1925
                # not affected.
 
1926
                socket.socket = self.socket_socket
 
1927
                del self.socket_socket
 
1928
                # This time only, return a new socket object from the
 
1929
                # saved file descriptor.
 
1930
                return socket.fromfd(self.socketfd, *args, **kwargs)
 
1931
            # Replace socket.socket() function with wrapper
 
1932
            socket.socket = socket_wrapper
 
1933
        # The socketserver.TCPServer.__init__ will call
 
1934
        # socket.socket(), which might be our replacement,
 
1935
        # socket_wrapper(), if socketfd was set.
1745
1936
        socketserver.TCPServer.__init__(self, server_address,
1746
1937
                                        RequestHandlerClass)
 
1938
    
1747
1939
    def server_bind(self):
1748
1940
        """This overrides the normal server_bind() function
1749
1941
        to bind to an interface if one was specified, and also NOT to
1757
1949
                try:
1758
1950
                    self.socket.setsockopt(socket.SOL_SOCKET,
1759
1951
                                           SO_BINDTODEVICE,
1760
 
                                           str(self.interface
1761
 
                                               + '\0'))
 
1952
                                           str(self.interface + '\0'))
1762
1953
                except socket.error as error:
1763
 
                    if error[0] == errno.EPERM:
1764
 
                        logger.error("No permission to"
1765
 
                                     " bind to interface %s",
1766
 
                                     self.interface)
1767
 
                    elif error[0] == errno.ENOPROTOOPT:
 
1954
                    if error.errno == errno.EPERM:
 
1955
                        logger.error("No permission to bind to"
 
1956
                                     " interface %s", self.interface)
 
1957
                    elif error.errno == errno.ENOPROTOOPT:
1768
1958
                        logger.error("SO_BINDTODEVICE not available;"
1769
1959
                                     " cannot bind to interface %s",
1770
1960
                                     self.interface)
 
1961
                    elif error.errno == errno.ENODEV:
 
1962
                        logger.error("Interface %s does not exist,"
 
1963
                                     " cannot bind", self.interface)
1771
1964
                    else:
1772
1965
                        raise
1773
1966
        # Only bind(2) the socket if we really need to.
1803
1996
    """
1804
1997
    def __init__(self, server_address, RequestHandlerClass,
1805
1998
                 interface=None, use_ipv6=True, clients=None,
1806
 
                 gnutls_priority=None, use_dbus=True):
 
1999
                 gnutls_priority=None, use_dbus=True, socketfd=None):
1807
2000
        self.enabled = False
1808
2001
        self.clients = clients
1809
2002
        if self.clients is None:
1813
2006
        IPv6_TCPServer.__init__(self, server_address,
1814
2007
                                RequestHandlerClass,
1815
2008
                                interface = interface,
1816
 
                                use_ipv6 = use_ipv6)
 
2009
                                use_ipv6 = use_ipv6,
 
2010
                                socketfd = socketfd)
1817
2011
    def server_activate(self):
1818
2012
        if self.enabled:
1819
2013
            return socketserver.TCPServer.server_activate(self)
1832
2026
    
1833
2027
    def handle_ipc(self, source, condition, parent_pipe=None,
1834
2028
                   proc = None, client_object=None):
1835
 
        condition_names = {
1836
 
            gobject.IO_IN: "IN",   # There is data to read.
1837
 
            gobject.IO_OUT: "OUT", # Data can be written (without
1838
 
                                    # blocking).
1839
 
            gobject.IO_PRI: "PRI", # There is urgent data to read.
1840
 
            gobject.IO_ERR: "ERR", # Error condition.
1841
 
            gobject.IO_HUP: "HUP"  # Hung up (the connection has been
1842
 
                                    # broken, usually for pipes and
1843
 
                                    # sockets).
1844
 
            }
1845
 
        conditions_string = ' | '.join(name
1846
 
                                       for cond, name in
1847
 
                                       condition_names.iteritems()
1848
 
                                       if cond & condition)
1849
2029
        # error, or the other end of multiprocessing.Pipe has closed
1850
 
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
2030
        if condition & (gobject.IO_ERR | gobject.IO_HUP):
1851
2031
            # Wait for other process to exit
1852
2032
            proc.join()
1853
2033
            return False
1911
2091
        return True
1912
2092
 
1913
2093
 
 
2094
def rfc3339_duration_to_delta(duration):
 
2095
    """Parse an RFC 3339 "duration" and return a datetime.timedelta
 
2096
    
 
2097
    >>> rfc3339_duration_to_delta("P7D")
 
2098
    datetime.timedelta(7)
 
2099
    >>> rfc3339_duration_to_delta("PT60S")
 
2100
    datetime.timedelta(0, 60)
 
2101
    >>> rfc3339_duration_to_delta("PT60M")
 
2102
    datetime.timedelta(0, 3600)
 
2103
    >>> rfc3339_duration_to_delta("PT24H")
 
2104
    datetime.timedelta(1)
 
2105
    >>> rfc3339_duration_to_delta("P1W")
 
2106
    datetime.timedelta(7)
 
2107
    >>> rfc3339_duration_to_delta("PT5M30S")
 
2108
    datetime.timedelta(0, 330)
 
2109
    >>> rfc3339_duration_to_delta("P1DT3M20S")
 
2110
    datetime.timedelta(1, 200)
 
2111
    """
 
2112
    
 
2113
    # Parsing an RFC 3339 duration with regular expressions is not
 
2114
    # possible - there would have to be multiple places for the same
 
2115
    # values, like seconds.  The current code, while more esoteric, is
 
2116
    # cleaner without depending on a parsing library.  If Python had a
 
2117
    # built-in library for parsing we would use it, but we'd like to
 
2118
    # avoid excessive use of external libraries.
 
2119
    
 
2120
    # New type for defining tokens, syntax, and semantics all-in-one
 
2121
    Token = collections.namedtuple("Token",
 
2122
                                   ("regexp", # To match token; if
 
2123
                                              # "value" is not None,
 
2124
                                              # must have a "group"
 
2125
                                              # containing digits
 
2126
                                    "value",  # datetime.timedelta or
 
2127
                                              # None
 
2128
                                    "followers")) # Tokens valid after
 
2129
                                                  # this token
 
2130
    # RFC 3339 "duration" tokens, syntax, and semantics; taken from
 
2131
    # the "duration" ABNF definition in RFC 3339, Appendix A.
 
2132
    token_end = Token(re.compile(r"$"), None, frozenset())
 
2133
    token_second = Token(re.compile(r"(\d+)S"),
 
2134
                         datetime.timedelta(seconds=1),
 
2135
                         frozenset((token_end,)))
 
2136
    token_minute = Token(re.compile(r"(\d+)M"),
 
2137
                         datetime.timedelta(minutes=1),
 
2138
                         frozenset((token_second, token_end)))
 
2139
    token_hour = Token(re.compile(r"(\d+)H"),
 
2140
                       datetime.timedelta(hours=1),
 
2141
                       frozenset((token_minute, token_end)))
 
2142
    token_time = Token(re.compile(r"T"),
 
2143
                       None,
 
2144
                       frozenset((token_hour, token_minute,
 
2145
                                  token_second)))
 
2146
    token_day = Token(re.compile(r"(\d+)D"),
 
2147
                      datetime.timedelta(days=1),
 
2148
                      frozenset((token_time, token_end)))
 
2149
    token_month = Token(re.compile(r"(\d+)M"),
 
2150
                        datetime.timedelta(weeks=4),
 
2151
                        frozenset((token_day, token_end)))
 
2152
    token_year = Token(re.compile(r"(\d+)Y"),
 
2153
                       datetime.timedelta(weeks=52),
 
2154
                       frozenset((token_month, token_end)))
 
2155
    token_week = Token(re.compile(r"(\d+)W"),
 
2156
                       datetime.timedelta(weeks=1),
 
2157
                       frozenset((token_end,)))
 
2158
    token_duration = Token(re.compile(r"P"), None,
 
2159
                           frozenset((token_year, token_month,
 
2160
                                      token_day, token_time,
 
2161
                                      token_week))),
 
2162
    # Define starting values
 
2163
    value = datetime.timedelta() # Value so far
 
2164
    found_token = None
 
2165
    followers = frozenset(token_duration,) # Following valid tokens
 
2166
    s = duration                # String left to parse
 
2167
    # Loop until end token is found
 
2168
    while found_token is not token_end:
 
2169
        # Search for any currently valid tokens
 
2170
        for token in followers:
 
2171
            match = token.regexp.match(s)
 
2172
            if match is not None:
 
2173
                # Token found
 
2174
                if token.value is not None:
 
2175
                    # Value found, parse digits
 
2176
                    factor = int(match.group(1), 10)
 
2177
                    # Add to value so far
 
2178
                    value += factor * token.value
 
2179
                # Strip token from string
 
2180
                s = token.regexp.sub("", s, 1)
 
2181
                # Go to found token
 
2182
                found_token = token
 
2183
                # Set valid next tokens
 
2184
                followers = found_token.followers
 
2185
                break
 
2186
        else:
 
2187
            # No currently valid tokens were found
 
2188
            raise ValueError("Invalid RFC 3339 duration")
 
2189
    # End token found
 
2190
    return value
 
2191
 
 
2192
 
1914
2193
def string_to_delta(interval):
1915
2194
    """Parse a string and return a datetime.timedelta
1916
2195
    
1927
2206
    >>> string_to_delta('5m 30s')
1928
2207
    datetime.timedelta(0, 330)
1929
2208
    """
 
2209
    
 
2210
    try:
 
2211
        return rfc3339_duration_to_delta(interval)
 
2212
    except ValueError:
 
2213
        pass
 
2214
    
1930
2215
    timevalue = datetime.timedelta(0)
1931
2216
    for s in interval.split():
1932
2217
        try:
1943
2228
            elif suffix == "w":
1944
2229
                delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1945
2230
            else:
1946
 
                raise ValueError("Unknown suffix %r" % suffix)
 
2231
                raise ValueError("Unknown suffix {0!r}"
 
2232
                                 .format(suffix))
1947
2233
        except (ValueError, IndexError) as e:
1948
2234
            raise ValueError(*(e.args))
1949
2235
        timevalue += delta
1963
2249
        sys.exit()
1964
2250
    if not noclose:
1965
2251
        # Close all standard open file descriptors
1966
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2252
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1967
2253
        if not stat.S_ISCHR(os.fstat(null).st_mode):
1968
2254
            raise OSError(errno.ENODEV,
1969
 
                          "%s not a character device"
1970
 
                          % os.path.devnull)
 
2255
                          "{0} not a character device"
 
2256
                          .format(os.devnull))
1971
2257
        os.dup2(null, sys.stdin.fileno())
1972
2258
        os.dup2(null, sys.stdout.fileno())
1973
2259
        os.dup2(null, sys.stderr.fileno())
1982
2268
    
1983
2269
    parser = argparse.ArgumentParser()
1984
2270
    parser.add_argument("-v", "--version", action="version",
1985
 
                        version = "%%(prog)s %s" % version,
 
2271
                        version = "%(prog)s {0}".format(version),
1986
2272
                        help="show version number and exit")
1987
2273
    parser.add_argument("-i", "--interface", metavar="IF",
1988
2274
                        help="Bind to interface IF")
2013
2299
    parser.add_argument("--no-restore", action="store_false",
2014
2300
                        dest="restore", help="Do not restore stored"
2015
2301
                        " state")
 
2302
    parser.add_argument("--socket", type=int,
 
2303
                        help="Specify a file descriptor to a network"
 
2304
                        " socket to use instead of creating one")
2016
2305
    parser.add_argument("--statedir", metavar="DIR",
2017
2306
                        help="Directory to save/restore state in")
 
2307
    parser.add_argument("--foreground", action="store_true",
 
2308
                        help="Run in foreground")
2018
2309
    
2019
2310
    options = parser.parse_args()
2020
2311
    
2035
2326
                        "use_ipv6": "True",
2036
2327
                        "debuglevel": "",
2037
2328
                        "restore": "True",
2038
 
                        "statedir": "/var/lib/mandos"
 
2329
                        "socket": "",
 
2330
                        "statedir": "/var/lib/mandos",
 
2331
                        "foreground": "False",
2039
2332
                        }
2040
2333
    
2041
2334
    # Parse config file for server-global settings
2046
2339
    # Convert the SafeConfigParser object to a dict
2047
2340
    server_settings = server_config.defaults()
2048
2341
    # Use the appropriate methods on the non-string config options
2049
 
    for option in ("debug", "use_dbus", "use_ipv6"):
 
2342
    for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2050
2343
        server_settings[option] = server_config.getboolean("DEFAULT",
2051
2344
                                                           option)
2052
2345
    if server_settings["port"]:
2053
2346
        server_settings["port"] = server_config.getint("DEFAULT",
2054
2347
                                                       "port")
 
2348
    if server_settings["socket"]:
 
2349
        server_settings["socket"] = server_config.getint("DEFAULT",
 
2350
                                                         "socket")
 
2351
        # Later, stdin will, and stdout and stderr might, be dup'ed
 
2352
        # over with an opened os.devnull.  But we don't want this to
 
2353
        # happen with a supplied network socket.
 
2354
        if 0 <= server_settings["socket"] <= 2:
 
2355
            server_settings["socket"] = os.dup(server_settings
 
2356
                                               ["socket"])
2055
2357
    del server_config
2056
2358
    
2057
2359
    # Override the settings from the config file with command line
2059
2361
    for option in ("interface", "address", "port", "debug",
2060
2362
                   "priority", "servicename", "configdir",
2061
2363
                   "use_dbus", "use_ipv6", "debuglevel", "restore",
2062
 
                   "statedir"):
 
2364
                   "statedir", "socket", "foreground"):
2063
2365
        value = getattr(options, option)
2064
2366
        if value is not None:
2065
2367
            server_settings[option] = value
2068
2370
    for option in server_settings.keys():
2069
2371
        if type(server_settings[option]) is str:
2070
2372
            server_settings[option] = unicode(server_settings[option])
 
2373
    # Debug implies foreground
 
2374
    if server_settings["debug"]:
 
2375
        server_settings["foreground"] = True
2071
2376
    # Now we have our good server settings in "server_settings"
2072
2377
    
2073
2378
    ##################################################################
2079
2384
    use_ipv6 = server_settings["use_ipv6"]
2080
2385
    stored_state_path = os.path.join(server_settings["statedir"],
2081
2386
                                     stored_state_file)
 
2387
    foreground = server_settings["foreground"]
2082
2388
    
2083
2389
    if debug:
2084
2390
        initlogger(debug, logging.DEBUG)
2091
2397
    
2092
2398
    if server_settings["servicename"] != "Mandos":
2093
2399
        syslogger.setFormatter(logging.Formatter
2094
 
                               ('Mandos (%s) [%%(process)d]:'
2095
 
                                ' %%(levelname)s: %%(message)s'
2096
 
                                % server_settings["servicename"]))
 
2400
                               ('Mandos ({0}) [%(process)d]:'
 
2401
                                ' %(levelname)s: %(message)s'
 
2402
                                .format(server_settings
 
2403
                                        ["servicename"])))
2097
2404
    
2098
2405
    # Parse config file with clients
2099
2406
    client_config = configparser.SafeConfigParser(Client
2112
2419
                              use_ipv6=use_ipv6,
2113
2420
                              gnutls_priority=
2114
2421
                              server_settings["priority"],
2115
 
                              use_dbus=use_dbus)
2116
 
    if not debug:
 
2422
                              use_dbus=use_dbus,
 
2423
                              socketfd=(server_settings["socket"]
 
2424
                                        or None))
 
2425
    if not foreground:
2117
2426
        pidfilename = "/var/run/mandos.pid"
 
2427
        pidfile = None
2118
2428
        try:
2119
2429
            pidfile = open(pidfilename, "w")
2120
 
        except IOError:
2121
 
            logger.error("Could not open file %r", pidfilename)
 
2430
        except IOError as e:
 
2431
            logger.error("Could not open file %r", pidfilename,
 
2432
                         exc_info=e)
2122
2433
    
2123
 
    try:
2124
 
        uid = pwd.getpwnam("_mandos").pw_uid
2125
 
        gid = pwd.getpwnam("_mandos").pw_gid
2126
 
    except KeyError:
 
2434
    for name in ("_mandos", "mandos", "nobody"):
2127
2435
        try:
2128
 
            uid = pwd.getpwnam("mandos").pw_uid
2129
 
            gid = pwd.getpwnam("mandos").pw_gid
 
2436
            uid = pwd.getpwnam(name).pw_uid
 
2437
            gid = pwd.getpwnam(name).pw_gid
 
2438
            break
2130
2439
        except KeyError:
2131
 
            try:
2132
 
                uid = pwd.getpwnam("nobody").pw_uid
2133
 
                gid = pwd.getpwnam("nobody").pw_gid
2134
 
            except KeyError:
2135
 
                uid = 65534
2136
 
                gid = 65534
 
2440
            continue
 
2441
    else:
 
2442
        uid = 65534
 
2443
        gid = 65534
2137
2444
    try:
2138
2445
        os.setgid(gid)
2139
2446
        os.setuid(uid)
2140
2447
    except OSError as error:
2141
 
        if error[0] != errno.EPERM:
 
2448
        if error.errno != errno.EPERM:
2142
2449
            raise error
2143
2450
    
2144
2451
    if debug:
2156
2463
         .gnutls_global_set_log_function(debug_gnutls))
2157
2464
        
2158
2465
        # Redirect stdin so all checkers get /dev/null
2159
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
2466
        null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2160
2467
        os.dup2(null, sys.stdin.fileno())
2161
2468
        if null > 2:
2162
2469
            os.close(null)
2163
2470
    
2164
2471
    # Need to fork before connecting to D-Bus
2165
 
    if not debug:
 
2472
    if not foreground:
2166
2473
        # Close all input and output, do double fork, etc.
2167
2474
        daemon()
2168
2475
    
 
2476
    # multiprocessing will use threads, so before we use gobject we
 
2477
    # need to inform gobject that threads will be used.
2169
2478
    gobject.threads_init()
2170
2479
    
2171
2480
    global main_loop
2172
2481
    # From the Avahi example code
2173
 
    DBusGMainLoop(set_as_default=True )
 
2482
    DBusGMainLoop(set_as_default=True)
2174
2483
    main_loop = gobject.MainLoop()
2175
2484
    bus = dbus.SystemBus()
2176
2485
    # End of Avahi example code
2182
2491
                            ("se.bsnet.fukt.Mandos", bus,
2183
2492
                             do_not_queue=True))
2184
2493
        except dbus.exceptions.NameExistsException as e:
2185
 
            logger.error(unicode(e) + ", disabling D-Bus")
 
2494
            logger.error("Disabling D-Bus:", exc_info=e)
2186
2495
            use_dbus = False
2187
2496
            server_settings["use_dbus"] = False
2188
2497
            tcp_server.use_dbus = False
2200
2509
    
2201
2510
    client_class = Client
2202
2511
    if use_dbus:
2203
 
        client_class = functools.partial(ClientDBusTransitional,
2204
 
                                         bus = bus)
 
2512
        client_class = functools.partial(ClientDBus, bus = bus)
2205
2513
    
2206
2514
    client_settings = Client.config_parser(client_config)
2207
2515
    old_client_settings = {}
2215
2523
                                                     (stored_state))
2216
2524
            os.remove(stored_state_path)
2217
2525
        except IOError as e:
2218
 
            logger.warning("Could not load persistent state: {0}"
2219
 
                           .format(e))
2220
 
            if e.errno != errno.ENOENT:
 
2526
            if e.errno == errno.ENOENT:
 
2527
                logger.warning("Could not load persistent state: {0}"
 
2528
                                .format(os.strerror(e.errno)))
 
2529
            else:
 
2530
                logger.critical("Could not load persistent state:",
 
2531
                                exc_info=e)
2221
2532
                raise
2222
2533
        except EOFError as e:
2223
2534
            logger.warning("Could not load persistent state: "
2224
 
                           "EOFError: {0}".format(e))
 
2535
                           "EOFError:", exc_info=e)
2225
2536
    
2226
2537
    with PGPEngine() as pgp:
2227
2538
        for client_name, client in clients_data.iteritems():
2280
2591
                             .format(client_name))
2281
2592
                client["secret"] = (
2282
2593
                    client_settings[client_name]["secret"])
2283
 
 
2284
2594
    
2285
2595
    # Add/remove clients based on new changes made to config
2286
2596
    for client_name in (set(old_client_settings)
2289
2599
    for client_name in (set(client_settings)
2290
2600
                        - set(old_client_settings)):
2291
2601
        clients_data[client_name] = client_settings[client_name]
2292
 
 
 
2602
    
2293
2603
    # Create all client objects
2294
2604
    for client_name, client in clients_data.iteritems():
2295
2605
        tcp_server.clients[client_name] = client_class(
2297
2607
    
2298
2608
    if not tcp_server.clients:
2299
2609
        logger.warning("No clients defined")
2300
 
        
2301
 
    if not debug:
2302
 
        try:
2303
 
            with pidfile:
2304
 
                pid = os.getpid()
2305
 
                pidfile.write(str(pid) + "\n".encode("utf-8"))
2306
 
            del pidfile
2307
 
        except IOError:
2308
 
            logger.error("Could not write to file %r with PID %d",
2309
 
                         pidfilename, pid)
2310
 
        except NameError:
2311
 
            # "pidfile" was never created
2312
 
            pass
 
2610
    
 
2611
    if not foreground:
 
2612
        if pidfile is not None:
 
2613
            try:
 
2614
                with pidfile:
 
2615
                    pid = os.getpid()
 
2616
                    pidfile.write(str(pid) + "\n".encode("utf-8"))
 
2617
            except IOError:
 
2618
                logger.error("Could not write to file %r with PID %d",
 
2619
                             pidfilename, pid)
 
2620
        del pidfile
2313
2621
        del pidfilename
2314
 
        signal.signal(signal.SIGINT, signal.SIG_IGN)
2315
2622
    
2316
2623
    signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2317
2624
    signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2318
2625
    
2319
2626
    if use_dbus:
2320
 
        class MandosDBusService(dbus.service.Object):
 
2627
        @alternate_dbus_interfaces({"se.recompile.Mandos":
 
2628
                                        "se.bsnet.fukt.Mandos"})
 
2629
        class MandosDBusService(DBusObjectWithProperties):
2321
2630
            """A D-Bus proxy object"""
2322
2631
            def __init__(self):
2323
2632
                dbus.service.Object.__init__(self, bus, "/")
2324
2633
            _interface = "se.recompile.Mandos"
2325
2634
            
 
2635
            @dbus_interface_annotations(_interface)
 
2636
            def _foo(self):
 
2637
                return { "org.freedesktop.DBus.Property"
 
2638
                         ".EmitsChangedSignal":
 
2639
                             "false"}
 
2640
            
2326
2641
            @dbus.service.signal(_interface, signature="o")
2327
2642
            def ClientAdded(self, objpath):
2328
2643
                "D-Bus signal"
2370
2685
            
2371
2686
            del _interface
2372
2687
        
2373
 
        class MandosDBusServiceTransitional(MandosDBusService):
2374
 
            __metaclass__ = AlternateDBusNamesMetaclass
2375
 
        mandos_dbus_service = MandosDBusServiceTransitional()
 
2688
        mandos_dbus_service = MandosDBusService()
2376
2689
    
2377
2690
    def cleanup():
2378
2691
        "Cleanup function; run on exit"
2411
2724
                del client_settings[client.name]["secret"]
2412
2725
        
2413
2726
        try:
2414
 
            tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2415
 
                                                prefix="clients-",
2416
 
                                                dir=os.path.dirname
2417
 
                                                (stored_state_path))
2418
 
            with os.fdopen(tempfd, "wb") as stored_state:
 
2727
            with (tempfile.NamedTemporaryFile
 
2728
                  (mode='wb', suffix=".pickle", prefix='clients-',
 
2729
                   dir=os.path.dirname(stored_state_path),
 
2730
                   delete=False)) as stored_state:
2419
2731
                pickle.dump((clients, client_settings), stored_state)
 
2732
                tempname=stored_state.name
2420
2733
            os.rename(tempname, stored_state_path)
2421
2734
        except (IOError, OSError) as e:
2422
 
            logger.warning("Could not save persistent state: {0}"
2423
 
                           .format(e))
2424
2735
            if not debug:
2425
2736
                try:
2426
2737
                    os.remove(tempname)
2427
2738
                except NameError:
2428
2739
                    pass
2429
 
            if e.errno not in set((errno.ENOENT, errno.EACCES,
2430
 
                                   errno.EEXIST)):
 
2740
            if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
 
2741
                logger.warning("Could not save persistent state: {0}"
 
2742
                               .format(os.strerror(e.errno)))
 
2743
            else:
 
2744
                logger.warning("Could not save persistent state:",
 
2745
                               exc_info=e)
2431
2746
                raise e
2432
2747
        
2433
2748
        # Delete all clients, and settings from config
2461
2776
    service.port = tcp_server.socket.getsockname()[1]
2462
2777
    if use_ipv6:
2463
2778
        logger.info("Now listening on address %r, port %d,"
2464
 
                    " flowinfo %d, scope_id %d"
2465
 
                    % tcp_server.socket.getsockname())
 
2779
                    " flowinfo %d, scope_id %d",
 
2780
                    *tcp_server.socket.getsockname())
2466
2781
    else:                       # IPv4
2467
 
        logger.info("Now listening on address %r, port %d"
2468
 
                    % tcp_server.socket.getsockname())
 
2782
        logger.info("Now listening on address %r, port %d",
 
2783
                    *tcp_server.socket.getsockname())
2469
2784
    
2470
2785
    #service.interface = tcp_server.socket.getsockname()[3]
2471
2786
    
2474
2789
        try:
2475
2790
            service.activate()
2476
2791
        except dbus.exceptions.DBusException as error:
2477
 
            logger.critical("DBusException: %s", error)
 
2792
            logger.critical("D-Bus Exception", exc_info=error)
2478
2793
            cleanup()
2479
2794
            sys.exit(1)
2480
2795
        # End of Avahi example code
2487
2802
        logger.debug("Starting main loop")
2488
2803
        main_loop.run()
2489
2804
    except AvahiError as error:
2490
 
        logger.critical("AvahiError: %s", error)
 
2805
        logger.critical("Avahi Error", exc_info=error)
2491
2806
        cleanup()
2492
2807
        sys.exit(1)
2493
2808
    except KeyboardInterrupt: