/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: 2010-09-12 03:00:40 UTC
  • Revision ID: teddy@fukt.bsnet.se-20100912030040-b0uopyennste9fdh
Documentation changes:

* DBUS-API: New file documenting the server D-Bus interface.

* clients.conf: Add examples of new approval settings.

* debian/mandos.docs: Added "DBUS-API".

* mandos-clients.conf.xml (OPTIONS): Added "approved_by_default",
                                     "approval_delay", and
                                     "approval_duration".
* mandos.xml (D-BUS INTERFACE): Refer to the "DBUS-API" file.
  (BUGS): Remove mention of lack of a remote query interface.

Show diffs side-by-side

added added

removed removed

Lines of Context:
55
55
import logging
56
56
import logging.handlers
57
57
import pwd
58
 
from contextlib import closing
 
58
import contextlib
59
59
import struct
60
60
import fcntl
61
61
import functools
 
62
import cPickle as pickle
 
63
import multiprocessing
62
64
 
63
65
import dbus
64
66
import dbus.service
81
83
 
82
84
version = "1.0.14"
83
85
 
 
86
#logger = logging.getLogger(u'mandos')
84
87
logger = logging.Logger(u'mandos')
85
88
syslogger = (logging.handlers.SysLogHandler
86
89
             (facility = logging.handlers.SysLogHandler.LOG_DAEMON,
154
157
                            u" after %i retries, exiting.",
155
158
                            self.rename_count)
156
159
            raise AvahiServiceError(u"Too many renames")
157
 
        self.name = self.server.GetAlternativeServiceName(self.name)
 
160
        self.name = unicode(self.server.GetAlternativeServiceName(self.name))
158
161
        logger.info(u"Changing Zeroconf service name to %r ...",
159
 
                    unicode(self.name))
 
162
                    self.name)
160
163
        syslogger.setFormatter(logging.Formatter
161
164
                               (u'Mandos (%s) [%%(process)d]:'
162
165
                                u' %%(levelname)s: %%(message)s'
163
166
                                % self.name))
164
167
        self.remove()
165
 
        self.add()
 
168
        try:
 
169
            self.add()
 
170
        except dbus.exceptions.DBusException, error:
 
171
            logger.critical(u"DBusException: %s", error)
 
172
            self.cleanup()
 
173
            os._exit(1)
166
174
        self.rename_count += 1
167
175
    def remove(self):
168
176
        """Derived from the Avahi example code"""
191
199
        self.group.Commit()
192
200
    def entry_group_state_changed(self, state, error):
193
201
        """Derived from the Avahi example code"""
194
 
        logger.debug(u"Avahi state change: %i", state)
 
202
        logger.debug(u"Avahi entry group state change: %i", state)
195
203
        
196
204
        if state == avahi.ENTRY_GROUP_ESTABLISHED:
197
205
            logger.debug(u"Zeroconf service established.")
210
218
            self.group = None
211
219
    def server_state_changed(self, state):
212
220
        """Derived from the Avahi example code"""
 
221
        logger.debug(u"Avahi server state change: %i", state)
213
222
        if state == avahi.SERVER_COLLISION:
214
223
            logger.error(u"Zeroconf server name collision")
215
224
            self.remove()
242
251
    enabled:    bool()
243
252
    last_checked_ok: datetime.datetime(); (UTC) or None
244
253
    timeout:    datetime.timedelta(); How long from last_checked_ok
245
 
                                      until this client is invalid
 
254
                                      until this client is disabled
246
255
    interval:   datetime.timedelta(); How often to start a new checker
247
256
    disable_hook:  If set, called by disable() as disable_hook(self)
248
257
    checker:    subprocess.Popen(); a running checker process used
256
265
                     runtime with vars(self) as dict, so that for
257
266
                     instance %(name)s can be used in the command.
258
267
    current_checker_command: string; current running checker_command
 
268
    approval_delay: datetime.timedelta(); Time to wait for approval
 
269
    _approved:   bool(); 'None' if not yet approved/disapproved
 
270
    approval_duration: datetime.timedelta(); Duration of one approval
259
271
    """
260
272
    
261
273
    @staticmethod
272
284
    def interval_milliseconds(self):
273
285
        "Return the 'interval' attribute in milliseconds"
274
286
        return self._timedelta_to_milliseconds(self.interval)
 
287
 
 
288
    def approval_delay_milliseconds(self):
 
289
        return self._timedelta_to_milliseconds(self.approval_delay)
275
290
    
276
291
    def __init__(self, name = None, disable_hook=None, config=None):
277
292
        """Note: the 'checker' key in 'config' sets the
290
305
        if u"secret" in config:
291
306
            self.secret = config[u"secret"].decode(u"base64")
292
307
        elif u"secfile" in config:
293
 
            with closing(open(os.path.expanduser
294
 
                              (os.path.expandvars
295
 
                               (config[u"secfile"])),
296
 
                              "rb")) as secfile:
 
308
            with open(os.path.expanduser(os.path.expandvars
 
309
                                         (config[u"secfile"])),
 
310
                      "rb") as secfile:
297
311
                self.secret = secfile.read()
298
312
        else:
299
313
            raise TypeError(u"No secret or secfile for client %s"
313
327
        self.checker_command = config[u"checker"]
314
328
        self.current_checker_command = None
315
329
        self.last_connect = None
 
330
        self._approved = None
 
331
        self.approved_by_default = config.get(u"approved_by_default",
 
332
                                              True)
 
333
        self.approvals_pending = 0
 
334
        self.approval_delay = string_to_delta(
 
335
            config[u"approval_delay"])
 
336
        self.approval_duration = string_to_delta(
 
337
            config[u"approval_duration"])
 
338
        self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
316
339
    
 
340
    def send_changedstate(self):
 
341
        self.changedstate.acquire()
 
342
        self.changedstate.notify_all()
 
343
        self.changedstate.release()
 
344
        
317
345
    def enable(self):
318
346
        """Start this client's checker and timeout hooks"""
319
347
        if getattr(self, u"enabled", False):
320
348
            # Already enabled
321
349
            return
 
350
        self.send_changedstate()
322
351
        self.last_enabled = datetime.datetime.utcnow()
323
352
        # Schedule a new checker to be started an 'interval' from now,
324
353
        # and every interval from then on.
338
367
        if not getattr(self, "enabled", False):
339
368
            return False
340
369
        if not quiet:
 
370
            self.send_changedstate()
 
371
        if not quiet:
341
372
            logger.info(u"Disabling client %s", self.name)
342
373
        if getattr(self, u"disable_initiator_tag", False):
343
374
            gobject.source_remove(self.disable_initiator_tag)
396
427
        # client would inevitably timeout, since no checker would get
397
428
        # a chance to run to completion.  If we instead leave running
398
429
        # checkers alone, the checker would have to take more time
399
 
        # than 'timeout' for the client to be declared invalid, which
400
 
        # is as it should be.
 
430
        # than 'timeout' for the client to be disabled, which is as it
 
431
        # should be.
401
432
        
402
433
        # If a checker exists, make sure it is not a zombie
403
434
        try:
475
506
            if error.errno != errno.ESRCH: # No such process
476
507
                raise
477
508
        self.checker = None
478
 
    
479
 
    def still_valid(self):
480
 
        """Has the timeout not yet passed for this client?"""
481
 
        if not getattr(self, u"enabled", False):
482
 
            return False
483
 
        now = datetime.datetime.utcnow()
484
 
        if self.last_checked_ok is None:
485
 
            return now < (self.created + self.timeout)
486
 
        else:
487
 
            return now < (self.last_checked_ok + self.timeout)
488
 
 
489
509
 
490
510
def dbus_service_property(dbus_interface, signature=u"v",
491
511
                          access=u"readwrite", byte_arrays=False):
499
519
    dbus.service.method, except there is only "signature", since the
500
520
    type from Get() and the type sent to Set() is the same.
501
521
    """
 
522
    # Encoding deeply encoded byte arrays is not supported yet by the
 
523
    # "Set" method, so we fail early here:
 
524
    if byte_arrays and signature != u"ay":
 
525
        raise ValueError(u"Byte arrays not supported for non-'ay'"
 
526
                         u" signature %r" % signature)
502
527
    def decorator(func):
503
528
        func._dbus_is_property = True
504
529
        func._dbus_interface = dbus_interface
590
615
        if prop._dbus_access == u"read":
591
616
            raise DBusPropertyAccessException(property_name)
592
617
        if prop._dbus_get_args_options[u"byte_arrays"]:
 
618
            # The byte_arrays option is not supported yet on
 
619
            # signatures other than "ay".
 
620
            if prop._dbus_signature != u"ay":
 
621
                raise ValueError
593
622
            value = dbus.ByteArray(''.join(unichr(byte)
594
623
                                           for byte in value))
595
624
        prop(value)
677
706
    # dbus.service.Object doesn't use super(), so we can't either.
678
707
    
679
708
    def __init__(self, bus = None, *args, **kwargs):
 
709
        self._approvals_pending = 0
680
710
        self.bus = bus
681
711
        Client.__init__(self, *args, **kwargs)
682
712
        # Only now, when this client is initialized, can it show up on
686
716
                                  + self.name.replace(u".", u"_")))
687
717
        DBusObjectWithProperties.__init__(self, self.bus,
688
718
                                          self.dbus_object_path)
 
719
        
 
720
    def _get_approvals_pending(self):
 
721
        return self._approvals_pending
 
722
    def _set_approvals_pending(self, value):
 
723
        old_value = self._approvals_pending
 
724
        self._approvals_pending = value
 
725
        bval = bool(value)
 
726
        if (hasattr(self, "dbus_object_path")
 
727
            and bval is not bool(old_value)):
 
728
            dbus_bool = dbus.Boolean(bval, variant_level=1)
 
729
            self.PropertyChanged(dbus.String(u"ApprovalPending"),
 
730
                                 dbus_bool)
 
731
 
 
732
    approvals_pending = property(_get_approvals_pending,
 
733
                                 _set_approvals_pending)
 
734
    del _get_approvals_pending, _set_approvals_pending
689
735
    
690
736
    @staticmethod
691
737
    def _datetime_to_dbus(dt, variant_level=0):
698
744
        r = Client.enable(self)
699
745
        if oldstate != self.enabled:
700
746
            # Emit D-Bus signals
701
 
            self.PropertyChanged(dbus.String(u"enabled"),
 
747
            self.PropertyChanged(dbus.String(u"Enabled"),
702
748
                                 dbus.Boolean(True, variant_level=1))
703
749
            self.PropertyChanged(
704
 
                dbus.String(u"last_enabled"),
 
750
                dbus.String(u"LastEnabled"),
705
751
                self._datetime_to_dbus(self.last_enabled,
706
752
                                       variant_level=1))
707
753
        return r
711
757
        r = Client.disable(self, quiet=quiet)
712
758
        if not quiet and oldstate != self.enabled:
713
759
            # Emit D-Bus signal
714
 
            self.PropertyChanged(dbus.String(u"enabled"),
 
760
            self.PropertyChanged(dbus.String(u"Enabled"),
715
761
                                 dbus.Boolean(False, variant_level=1))
716
762
        return r
717
763
    
729
775
        self.checker_callback_tag = None
730
776
        self.checker = None
731
777
        # Emit D-Bus signal
732
 
        self.PropertyChanged(dbus.String(u"checker_running"),
 
778
        self.PropertyChanged(dbus.String(u"CheckerRunning"),
733
779
                             dbus.Boolean(False, variant_level=1))
734
780
        if os.WIFEXITED(condition):
735
781
            exitstatus = os.WEXITSTATUS(condition)
750
796
        r = Client.checked_ok(self, *args, **kwargs)
751
797
        # Emit D-Bus signal
752
798
        self.PropertyChanged(
753
 
            dbus.String(u"last_checked_ok"),
 
799
            dbus.String(u"LastCheckedOK"),
754
800
            (self._datetime_to_dbus(self.last_checked_ok,
755
801
                                    variant_level=1)))
756
802
        return r
768
814
            # Emit D-Bus signal
769
815
            self.CheckerStarted(self.current_checker_command)
770
816
            self.PropertyChanged(
771
 
                dbus.String(u"checker_running"),
 
817
                dbus.String(u"CheckerRunning"),
772
818
                dbus.Boolean(True, variant_level=1))
773
819
        return r
774
820
    
777
823
        r = Client.stop_checker(self, *args, **kwargs)
778
824
        if (old_checker is not None
779
825
            and getattr(self, u"checker", None) is None):
780
 
            self.PropertyChanged(dbus.String(u"checker_running"),
 
826
            self.PropertyChanged(dbus.String(u"CheckerRunning"),
781
827
                                 dbus.Boolean(False, variant_level=1))
782
828
        return r
783
 
    
784
 
    ## D-Bus methods & signals
 
829
 
 
830
    def _reset_approved(self):
 
831
        self._approved = None
 
832
        return False
 
833
    
 
834
    def approve(self, value=True):
 
835
        self.send_changedstate()
 
836
        self._approved = value
 
837
        gobject.timeout_add(self._timedelta_to_milliseconds
 
838
                            (self.approval_duration),
 
839
                            self._reset_approved)
 
840
    
 
841
    
 
842
    ## D-Bus methods, signals & properties
785
843
    _interface = u"se.bsnet.fukt.Mandos.Client"
786
844
    
787
 
    # CheckedOK - method
788
 
    @dbus.service.method(_interface)
789
 
    def CheckedOK(self):
790
 
        return self.checked_ok()
 
845
    ## Signals
791
846
    
792
847
    # CheckerCompleted - signal
793
848
    @dbus.service.signal(_interface, signature=u"nxs")
810
865
    # GotSecret - signal
811
866
    @dbus.service.signal(_interface)
812
867
    def GotSecret(self):
813
 
        "D-Bus signal"
 
868
        """D-Bus signal
 
869
        Is sent after a successful transfer of secret from the Mandos
 
870
        server to mandos-client
 
871
        """
814
872
        pass
815
873
    
816
874
    # Rejected - signal
817
 
    @dbus.service.signal(_interface)
818
 
    def Rejected(self):
819
 
        "D-Bus signal"
820
 
        pass
 
875
    @dbus.service.signal(_interface, signature=u"s")
 
876
    def Rejected(self, reason):
 
877
        "D-Bus signal"
 
878
        pass
 
879
    
 
880
    # NeedApproval - signal
 
881
    @dbus.service.signal(_interface, signature=u"tb")
 
882
    def NeedApproval(self, timeout, default):
 
883
        "D-Bus signal"
 
884
        pass
 
885
    
 
886
    ## Methods
 
887
 
 
888
    # Approve - method
 
889
    @dbus.service.method(_interface, in_signature=u"b")
 
890
    def Approve(self, value):
 
891
        self.approve(value)
 
892
 
 
893
    # CheckedOK - method
 
894
    @dbus.service.method(_interface)
 
895
    def CheckedOK(self):
 
896
        return self.checked_ok()
821
897
    
822
898
    # Enable - method
823
899
    @dbus.service.method(_interface)
842
918
    def StopChecker(self):
843
919
        self.stop_checker()
844
920
    
845
 
    # name - property
 
921
    ## Properties
 
922
    
 
923
    # ApprovalPending - property
 
924
    @dbus_service_property(_interface, signature=u"b", access=u"read")
 
925
    def ApprovalPending_dbus_property(self):
 
926
        return dbus.Boolean(bool(self.approvals_pending))
 
927
    
 
928
    # ApprovedByDefault - property
 
929
    @dbus_service_property(_interface, signature=u"b",
 
930
                           access=u"readwrite")
 
931
    def ApprovedByDefault_dbus_property(self, value=None):
 
932
        if value is None:       # get
 
933
            return dbus.Boolean(self.approved_by_default)
 
934
        self.approved_by_default = bool(value)
 
935
        # Emit D-Bus signal
 
936
        self.PropertyChanged(dbus.String(u"ApprovedByDefault"),
 
937
                             dbus.Boolean(value, variant_level=1))
 
938
    
 
939
    # ApprovalDelay - property
 
940
    @dbus_service_property(_interface, signature=u"t",
 
941
                           access=u"readwrite")
 
942
    def ApprovalDelay_dbus_property(self, value=None):
 
943
        if value is None:       # get
 
944
            return dbus.UInt64(self.approval_delay_milliseconds())
 
945
        self.approval_delay = datetime.timedelta(0, 0, 0, value)
 
946
        # Emit D-Bus signal
 
947
        self.PropertyChanged(dbus.String(u"ApprovalDelay"),
 
948
                             dbus.UInt64(value, variant_level=1))
 
949
    
 
950
    # ApprovalDuration - property
 
951
    @dbus_service_property(_interface, signature=u"t",
 
952
                           access=u"readwrite")
 
953
    def ApprovalDuration_dbus_property(self, value=None):
 
954
        if value is None:       # get
 
955
            return dbus.UInt64(self._timedelta_to_milliseconds(
 
956
                    self.approval_duration))
 
957
        self.approval_duration = datetime.timedelta(0, 0, 0, value)
 
958
        # Emit D-Bus signal
 
959
        self.PropertyChanged(dbus.String(u"ApprovalDuration"),
 
960
                             dbus.UInt64(value, variant_level=1))
 
961
    
 
962
    # Name - property
846
963
    @dbus_service_property(_interface, signature=u"s", access=u"read")
847
 
    def name_dbus_property(self):
 
964
    def Name_dbus_property(self):
848
965
        return dbus.String(self.name)
849
966
    
850
 
    # fingerprint - property
 
967
    # Fingerprint - property
851
968
    @dbus_service_property(_interface, signature=u"s", access=u"read")
852
 
    def fingerprint_dbus_property(self):
 
969
    def Fingerprint_dbus_property(self):
853
970
        return dbus.String(self.fingerprint)
854
971
    
855
 
    # host - property
 
972
    # Host - property
856
973
    @dbus_service_property(_interface, signature=u"s",
857
974
                           access=u"readwrite")
858
 
    def host_dbus_property(self, value=None):
 
975
    def Host_dbus_property(self, value=None):
859
976
        if value is None:       # get
860
977
            return dbus.String(self.host)
861
978
        self.host = value
862
979
        # Emit D-Bus signal
863
 
        self.PropertyChanged(dbus.String(u"host"),
 
980
        self.PropertyChanged(dbus.String(u"Host"),
864
981
                             dbus.String(value, variant_level=1))
865
982
    
866
 
    # created - property
 
983
    # Created - property
867
984
    @dbus_service_property(_interface, signature=u"s", access=u"read")
868
 
    def created_dbus_property(self):
 
985
    def Created_dbus_property(self):
869
986
        return dbus.String(self._datetime_to_dbus(self.created))
870
987
    
871
 
    # last_enabled - property
 
988
    # LastEnabled - property
872
989
    @dbus_service_property(_interface, signature=u"s", access=u"read")
873
 
    def last_enabled_dbus_property(self):
 
990
    def LastEnabled_dbus_property(self):
874
991
        if self.last_enabled is None:
875
992
            return dbus.String(u"")
876
993
        return dbus.String(self._datetime_to_dbus(self.last_enabled))
877
994
    
878
 
    # enabled - property
 
995
    # Enabled - property
879
996
    @dbus_service_property(_interface, signature=u"b",
880
997
                           access=u"readwrite")
881
 
    def enabled_dbus_property(self, value=None):
 
998
    def Enabled_dbus_property(self, value=None):
882
999
        if value is None:       # get
883
1000
            return dbus.Boolean(self.enabled)
884
1001
        if value:
886
1003
        else:
887
1004
            self.disable()
888
1005
    
889
 
    # last_checked_ok - property
 
1006
    # LastCheckedOK - property
890
1007
    @dbus_service_property(_interface, signature=u"s",
891
1008
                           access=u"readwrite")
892
 
    def last_checked_ok_dbus_property(self, value=None):
 
1009
    def LastCheckedOK_dbus_property(self, value=None):
893
1010
        if value is not None:
894
1011
            self.checked_ok()
895
1012
            return
898
1015
        return dbus.String(self._datetime_to_dbus(self
899
1016
                                                  .last_checked_ok))
900
1017
    
901
 
    # timeout - property
 
1018
    # Timeout - property
902
1019
    @dbus_service_property(_interface, signature=u"t",
903
1020
                           access=u"readwrite")
904
 
    def timeout_dbus_property(self, value=None):
 
1021
    def Timeout_dbus_property(self, value=None):
905
1022
        if value is None:       # get
906
1023
            return dbus.UInt64(self.timeout_milliseconds())
907
1024
        self.timeout = datetime.timedelta(0, 0, 0, value)
908
1025
        # Emit D-Bus signal
909
 
        self.PropertyChanged(dbus.String(u"timeout"),
 
1026
        self.PropertyChanged(dbus.String(u"Timeout"),
910
1027
                             dbus.UInt64(value, variant_level=1))
911
1028
        if getattr(self, u"disable_initiator_tag", None) is None:
912
1029
            return
926
1043
            self.disable_initiator_tag = (gobject.timeout_add
927
1044
                                          (time_to_die, self.disable))
928
1045
    
929
 
    # interval - property
 
1046
    # Interval - property
930
1047
    @dbus_service_property(_interface, signature=u"t",
931
1048
                           access=u"readwrite")
932
 
    def interval_dbus_property(self, value=None):
 
1049
    def Interval_dbus_property(self, value=None):
933
1050
        if value is None:       # get
934
1051
            return dbus.UInt64(self.interval_milliseconds())
935
1052
        self.interval = datetime.timedelta(0, 0, 0, value)
936
1053
        # Emit D-Bus signal
937
 
        self.PropertyChanged(dbus.String(u"interval"),
 
1054
        self.PropertyChanged(dbus.String(u"Interval"),
938
1055
                             dbus.UInt64(value, variant_level=1))
939
1056
        if getattr(self, u"checker_initiator_tag", None) is None:
940
1057
            return
944
1061
                                      (value, self.start_checker))
945
1062
        self.start_checker()    # Start one now, too
946
1063
 
947
 
    # checker - property
 
1064
    # Checker - property
948
1065
    @dbus_service_property(_interface, signature=u"s",
949
1066
                           access=u"readwrite")
950
 
    def checker_dbus_property(self, value=None):
 
1067
    def Checker_dbus_property(self, value=None):
951
1068
        if value is None:       # get
952
1069
            return dbus.String(self.checker_command)
953
1070
        self.checker_command = value
954
1071
        # Emit D-Bus signal
955
 
        self.PropertyChanged(dbus.String(u"checker"),
 
1072
        self.PropertyChanged(dbus.String(u"Checker"),
956
1073
                             dbus.String(self.checker_command,
957
1074
                                         variant_level=1))
958
1075
    
959
 
    # checker_running - property
 
1076
    # CheckerRunning - property
960
1077
    @dbus_service_property(_interface, signature=u"b",
961
1078
                           access=u"readwrite")
962
 
    def checker_running_dbus_property(self, value=None):
 
1079
    def CheckerRunning_dbus_property(self, value=None):
963
1080
        if value is None:       # get
964
1081
            return dbus.Boolean(self.checker is not None)
965
1082
        if value:
967
1084
        else:
968
1085
            self.stop_checker()
969
1086
    
970
 
    # object_path - property
 
1087
    # ObjectPath - property
971
1088
    @dbus_service_property(_interface, signature=u"o", access=u"read")
972
 
    def object_path_dbus_property(self):
 
1089
    def ObjectPath_dbus_property(self):
973
1090
        return self.dbus_object_path # is already a dbus.ObjectPath
974
1091
    
975
 
    # secret = property
 
1092
    # Secret = property
976
1093
    @dbus_service_property(_interface, signature=u"ay",
977
1094
                           access=u"write", byte_arrays=True)
978
 
    def secret_dbus_property(self, value):
 
1095
    def Secret_dbus_property(self, value):
979
1096
        self.secret = str(value)
980
1097
    
981
1098
    del _interface
982
1099
 
983
1100
 
 
1101
class ProxyClient(object):
 
1102
    def __init__(self, child_pipe, fpr, address):
 
1103
        self._pipe = child_pipe
 
1104
        self._pipe.send(('init', fpr, address))
 
1105
        if not self._pipe.recv():
 
1106
            raise KeyError()
 
1107
 
 
1108
    def __getattribute__(self, name):
 
1109
        if(name == '_pipe'):
 
1110
            return super(ProxyClient, self).__getattribute__(name)
 
1111
        self._pipe.send(('getattr', name))
 
1112
        data = self._pipe.recv()
 
1113
        if data[0] == 'data':
 
1114
            return data[1]
 
1115
        if data[0] == 'function':
 
1116
            def func(*args, **kwargs):
 
1117
                self._pipe.send(('funcall', name, args, kwargs))
 
1118
                return self._pipe.recv()[1]
 
1119
            return func
 
1120
 
 
1121
    def __setattr__(self, name, value):
 
1122
        if(name == '_pipe'):
 
1123
            return super(ProxyClient, self).__setattr__(name, value)
 
1124
        self._pipe.send(('setattr', name, value))
 
1125
 
 
1126
 
984
1127
class ClientHandler(socketserver.BaseRequestHandler, object):
985
1128
    """A class to handle client connections.
986
1129
    
988
1131
    Note: This will run in its own forked process."""
989
1132
    
990
1133
    def handle(self):
991
 
        logger.info(u"TCP connection from: %s",
992
 
                    unicode(self.client_address))
993
 
        logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
994
 
        # Open IPC pipe to parent process
995
 
        with closing(os.fdopen(self.server.pipe[1], u"w", 1)) as ipc:
 
1134
        with contextlib.closing(self.server.child_pipe) as child_pipe:
 
1135
            logger.info(u"TCP connection from: %s",
 
1136
                        unicode(self.client_address))
 
1137
            logger.debug(u"Pipe FD: %d",
 
1138
                         self.server.child_pipe.fileno())
 
1139
 
996
1140
            session = (gnutls.connection
997
1141
                       .ClientSession(self.request,
998
1142
                                      gnutls.connection
999
1143
                                      .X509Credentials()))
1000
 
            
1001
 
            line = self.request.makefile().readline()
1002
 
            logger.debug(u"Protocol version: %r", line)
1003
 
            try:
1004
 
                if int(line.strip().split()[0]) > 1:
1005
 
                    raise RuntimeError
1006
 
            except (ValueError, IndexError, RuntimeError), error:
1007
 
                logger.error(u"Unknown protocol version: %s", error)
1008
 
                return
1009
 
            
 
1144
 
1010
1145
            # Note: gnutls.connection.X509Credentials is really a
1011
1146
            # generic GnuTLS certificate credentials object so long as
1012
1147
            # no X.509 keys are added to it.  Therefore, we can use it
1013
1148
            # here despite using OpenPGP certificates.
1014
 
            
 
1149
 
1015
1150
            #priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1016
1151
            #                      u"+AES-256-CBC", u"+SHA1",
1017
1152
            #                      u"+COMP-NULL", u"+CTYPE-OPENPGP",
1023
1158
            (gnutls.library.functions
1024
1159
             .gnutls_priority_set_direct(session._c_object,
1025
1160
                                         priority, None))
1026
 
            
 
1161
 
 
1162
            # Start communication using the Mandos protocol
 
1163
            # Get protocol number
 
1164
            line = self.request.makefile().readline()
 
1165
            logger.debug(u"Protocol version: %r", line)
 
1166
            try:
 
1167
                if int(line.strip().split()[0]) > 1:
 
1168
                    raise RuntimeError
 
1169
            except (ValueError, IndexError, RuntimeError), error:
 
1170
                logger.error(u"Unknown protocol version: %s", error)
 
1171
                return
 
1172
 
 
1173
            # Start GnuTLS connection
1027
1174
            try:
1028
1175
                session.handshake()
1029
1176
            except gnutls.errors.GNUTLSError, error:
1032
1179
                # established.  Just abandon the request.
1033
1180
                return
1034
1181
            logger.debug(u"Handshake succeeded")
 
1182
 
 
1183
            approval_required = False
1035
1184
            try:
1036
 
                fpr = self.fingerprint(self.peer_certificate(session))
1037
 
            except (TypeError, gnutls.errors.GNUTLSError), error:
1038
 
                logger.warning(u"Bad certificate: %s", error)
1039
 
                session.bye()
1040
 
                return
1041
 
            logger.debug(u"Fingerprint: %s", fpr)
 
1185
                try:
 
1186
                    fpr = self.fingerprint(self.peer_certificate
 
1187
                                           (session))
 
1188
                except (TypeError, gnutls.errors.GNUTLSError), error:
 
1189
                    logger.warning(u"Bad certificate: %s", error)
 
1190
                    return
 
1191
                logger.debug(u"Fingerprint: %s", fpr)
 
1192
 
 
1193
                try:
 
1194
                    client = ProxyClient(child_pipe, fpr,
 
1195
                                         self.client_address)
 
1196
                except KeyError:
 
1197
                    return
 
1198
                
 
1199
                if client.approval_delay:
 
1200
                    delay = client.approval_delay
 
1201
                    client.approvals_pending += 1
 
1202
                    approval_required = True
 
1203
                
 
1204
                while True:
 
1205
                    if not client.enabled:
 
1206
                        logger.warning(u"Client %s is disabled",
 
1207
                                       client.name)
 
1208
                        if self.server.use_dbus:
 
1209
                            # Emit D-Bus signal
 
1210
                            client.Rejected("Disabled")                    
 
1211
                        return
 
1212
                    
 
1213
                    if client._approved or not client.approval_delay:
 
1214
                        #We are approved or approval is disabled
 
1215
                        break
 
1216
                    elif client._approved is None:
 
1217
                        logger.info(u"Client %s needs approval",
 
1218
                                    client.name)
 
1219
                        if self.server.use_dbus:
 
1220
                            # Emit D-Bus signal
 
1221
                            client.NeedApproval(
 
1222
                                client.approval_delay_milliseconds(),
 
1223
                                client.approved_by_default)
 
1224
                    else:
 
1225
                        logger.warning(u"Client %s was not approved",
 
1226
                                       client.name)
 
1227
                        if self.server.use_dbus:
 
1228
                            # Emit D-Bus signal
 
1229
                            client.Rejected("Denied")
 
1230
                        return
 
1231
                    
 
1232
                    #wait until timeout or approved
 
1233
                    #x = float(client._timedelta_to_milliseconds(delay))
 
1234
                    time = datetime.datetime.now()
 
1235
                    client.changedstate.acquire()
 
1236
                    client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
 
1237
                    client.changedstate.release()
 
1238
                    time2 = datetime.datetime.now()
 
1239
                    if (time2 - time) >= delay:
 
1240
                        if not client.approved_by_default:
 
1241
                            logger.warning("Client %s timed out while"
 
1242
                                           " waiting for approval",
 
1243
                                           client.name)
 
1244
                            if self.server.use_dbus:
 
1245
                                # Emit D-Bus signal
 
1246
                                client.Rejected("Timed out")
 
1247
                            return
 
1248
                        else:
 
1249
                            break
 
1250
                    else:
 
1251
                        delay -= time2 - time
 
1252
                
 
1253
                sent_size = 0
 
1254
                while sent_size < len(client.secret):
 
1255
                    try:
 
1256
                        sent = session.send(client.secret[sent_size:])
 
1257
                    except (gnutls.errors.GNUTLSError), error:
 
1258
                        logger.warning("gnutls send failed")
 
1259
                        return
 
1260
                    logger.debug(u"Sent: %d, remaining: %d",
 
1261
                                 sent, len(client.secret)
 
1262
                                 - (sent_size + sent))
 
1263
                    sent_size += sent
 
1264
 
 
1265
                logger.info(u"Sending secret to %s", client.name)
 
1266
                # bump the timeout as if seen
 
1267
                client.checked_ok()
 
1268
                if self.server.use_dbus:
 
1269
                    # Emit D-Bus signal
 
1270
                    client.GotSecret()
1042
1271
            
1043
 
            for c in self.server.clients:
1044
 
                if c.fingerprint == fpr:
1045
 
                    client = c
1046
 
                    break
1047
 
            else:
1048
 
                ipc.write(u"NOTFOUND %s %s\n"
1049
 
                          % (fpr, unicode(self.client_address)))
1050
 
                session.bye()
1051
 
                return
1052
 
            # Have to check if client.still_valid(), since it is
1053
 
            # possible that the client timed out while establishing
1054
 
            # the GnuTLS session.
1055
 
            if not client.still_valid():
1056
 
                ipc.write(u"INVALID %s\n" % client.name)
1057
 
                session.bye()
1058
 
                return
1059
 
            ipc.write(u"SENDING %s\n" % client.name)
1060
 
            sent_size = 0
1061
 
            while sent_size < len(client.secret):
1062
 
                sent = session.send(client.secret[sent_size:])
1063
 
                logger.debug(u"Sent: %d, remaining: %d",
1064
 
                             sent, len(client.secret)
1065
 
                             - (sent_size + sent))
1066
 
                sent_size += sent
1067
 
            session.bye()
 
1272
            finally:
 
1273
                if approval_required:
 
1274
                    client.approvals_pending -= 1
 
1275
                try:
 
1276
                    session.bye()
 
1277
                except (gnutls.errors.GNUTLSError), error:
 
1278
                    logger.warning("GnuTLS bye failed")
1068
1279
    
1069
1280
    @staticmethod
1070
1281
    def peer_certificate(session):
1130
1341
        return hex_fpr
1131
1342
 
1132
1343
 
1133
 
class ForkingMixInWithPipe(socketserver.ForkingMixIn, object):
1134
 
    """Like socketserver.ForkingMixIn, but also pass a pipe."""
 
1344
class MultiprocessingMixIn(object):
 
1345
    """Like socketserver.ThreadingMixIn, but with multiprocessing"""
 
1346
    def sub_process_main(self, request, address):
 
1347
        try:
 
1348
            self.finish_request(request, address)
 
1349
        except:
 
1350
            self.handle_error(request, address)
 
1351
        self.close_request(request)
 
1352
            
 
1353
    def process_request(self, request, address):
 
1354
        """Start a new process to process the request."""
 
1355
        multiprocessing.Process(target = self.sub_process_main,
 
1356
                                args = (request, address)).start()
 
1357
 
 
1358
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
 
1359
    """ adds a pipe to the MixIn """
1135
1360
    def process_request(self, request, client_address):
1136
1361
        """Overrides and wraps the original process_request().
1137
1362
        
1138
1363
        This function creates a new pipe in self.pipe
1139
1364
        """
1140
 
        self.pipe = os.pipe()
1141
 
        super(ForkingMixInWithPipe,
 
1365
        parent_pipe, self.child_pipe = multiprocessing.Pipe()
 
1366
 
 
1367
        super(MultiprocessingMixInWithPipe,
1142
1368
              self).process_request(request, client_address)
1143
 
        os.close(self.pipe[1])  # close write end
1144
 
        self.add_pipe(self.pipe[0])
1145
 
    def add_pipe(self, pipe):
 
1369
        self.child_pipe.close()
 
1370
        self.add_pipe(parent_pipe)
 
1371
 
 
1372
    def add_pipe(self, parent_pipe):
1146
1373
        """Dummy function; override as necessary"""
1147
 
        os.close(pipe)
1148
 
 
1149
 
 
1150
 
class IPv6_TCPServer(ForkingMixInWithPipe,
 
1374
        pass
 
1375
 
 
1376
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1151
1377
                     socketserver.TCPServer, object):
1152
1378
    """IPv6-capable TCP server.  Accepts 'None' as address and/or port
1153
1379
    
1238
1464
            return socketserver.TCPServer.server_activate(self)
1239
1465
    def enable(self):
1240
1466
        self.enabled = True
1241
 
    def add_pipe(self, pipe):
 
1467
    def add_pipe(self, parent_pipe):
1242
1468
        # Call "handle_ipc" for both data and EOF events
1243
 
        gobject.io_add_watch(pipe, gobject.IO_IN | gobject.IO_HUP,
1244
 
                             self.handle_ipc)
1245
 
    def handle_ipc(self, source, condition, file_objects={}):
 
1469
        gobject.io_add_watch(parent_pipe.fileno(),
 
1470
                             gobject.IO_IN | gobject.IO_HUP,
 
1471
                             functools.partial(self.handle_ipc,
 
1472
                                               parent_pipe = parent_pipe))
 
1473
        
 
1474
    def handle_ipc(self, source, condition, parent_pipe=None,
 
1475
                   client_object=None):
1246
1476
        condition_names = {
1247
1477
            gobject.IO_IN: u"IN",   # There is data to read.
1248
1478
            gobject.IO_OUT: u"OUT", # Data can be written (without
1259
1489
                                       if cond & condition)
1260
1490
        logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1261
1491
                     conditions_string)
1262
 
        
1263
 
        # Turn the pipe file descriptor into a Python file object
1264
 
        if source not in file_objects:
1265
 
            file_objects[source] = os.fdopen(source, u"r", 1)
1266
 
        
1267
 
        # Read a line from the file object
1268
 
        cmdline = file_objects[source].readline()
1269
 
        if not cmdline:             # Empty line means end of file
1270
 
            # close the IPC pipe
1271
 
            file_objects[source].close()
1272
 
            del file_objects[source]
1273
 
            
1274
 
            # Stop calling this function
1275
 
            return False
1276
 
        
1277
 
        logger.debug(u"IPC command: %r", cmdline)
1278
 
        
1279
 
        # Parse and act on command
1280
 
        cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1281
 
        
1282
 
        if cmd == u"NOTFOUND":
1283
 
            fpr, address = args.split(None, 1)
1284
 
            logger.warning(u"Client not found for fingerprint: %s, ad"
1285
 
                           u"dress: %s", fpr, address)
1286
 
            if self.use_dbus:
1287
 
                # Emit D-Bus signal
1288
 
                mandos_dbus_service.ClientNotFound(fpr, address)
1289
 
        elif cmd == u"INVALID":
1290
 
            for client in self.clients:
1291
 
                if client.name == args:
1292
 
                    logger.warning(u"Client %s is invalid", args)
1293
 
                    if self.use_dbus:
1294
 
                        # Emit D-Bus signal
1295
 
                        client.Rejected()
1296
 
                    break
1297
 
            else:
1298
 
                logger.error(u"Unknown client %s is invalid", args)
1299
 
        elif cmd == u"SENDING":
1300
 
            for client in self.clients:
1301
 
                if client.name == args:
1302
 
                    logger.info(u"Sending secret to %s", client.name)
1303
 
                    client.checked_ok()
1304
 
                    if self.use_dbus:
1305
 
                        # Emit D-Bus signal
1306
 
                        client.GotSecret()
1307
 
                    break
1308
 
            else:
1309
 
                logger.error(u"Sending secret to unknown client %s",
1310
 
                             args)
1311
 
        else:
1312
 
            logger.error(u"Unknown IPC command: %r", cmdline)
1313
 
        
1314
 
        # Keep calling this function
 
1492
 
 
1493
        # error or the other end of multiprocessing.Pipe has closed
 
1494
        if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
 
1495
            return False
 
1496
        
 
1497
        # Read a request from the child
 
1498
        request = parent_pipe.recv()
 
1499
        logger.debug(u"IPC request: %s", repr(request))
 
1500
        command = request[0]
 
1501
        
 
1502
        if command == 'init':
 
1503
            fpr = request[1]
 
1504
            address = request[2]
 
1505
            
 
1506
            for c in self.clients:
 
1507
                if c.fingerprint == fpr:
 
1508
                    client = c
 
1509
                    break
 
1510
            else:
 
1511
                logger.warning(u"Client not found for fingerprint: %s, ad"
 
1512
                               u"dress: %s", fpr, address)
 
1513
                if self.use_dbus:
 
1514
                    # Emit D-Bus signal
 
1515
                    mandos_dbus_service.ClientNotFound(fpr, address)
 
1516
                parent_pipe.send(False)
 
1517
                return False
 
1518
            
 
1519
            gobject.io_add_watch(parent_pipe.fileno(),
 
1520
                                 gobject.IO_IN | gobject.IO_HUP,
 
1521
                                 functools.partial(self.handle_ipc,
 
1522
                                                   parent_pipe = parent_pipe,
 
1523
                                                   client_object = client))
 
1524
            parent_pipe.send(True)
 
1525
            # remove the old hook in favor of the new above hook on same fileno
 
1526
            return False
 
1527
        if command == 'funcall':
 
1528
            funcname = request[1]
 
1529
            args = request[2]
 
1530
            kwargs = request[3]
 
1531
            
 
1532
            parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
 
1533
 
 
1534
        if command == 'getattr':
 
1535
            attrname = request[1]
 
1536
            if callable(client_object.__getattribute__(attrname)):
 
1537
                parent_pipe.send(('function',))
 
1538
            else:
 
1539
                parent_pipe.send(('data', client_object.__getattribute__(attrname)))
 
1540
        
 
1541
        if command == 'setattr':
 
1542
            attrname = request[1]
 
1543
            value = request[2]
 
1544
            setattr(client_object, attrname, value)
 
1545
 
1315
1546
        return True
1316
1547
 
1317
1548
 
1368
1599
        def if_nametoindex(interface):
1369
1600
            "Get an interface index the hard way, i.e. using fcntl()"
1370
1601
            SIOCGIFINDEX = 0x8933  # From /usr/include/linux/sockios.h
1371
 
            with closing(socket.socket()) as s:
 
1602
            with contextlib.closing(socket.socket()) as s:
1372
1603
                ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1373
1604
                                    struct.pack(str(u"16s16x"),
1374
1605
                                                interface))
1420
1651
    parser.add_option("--debug", action=u"store_true",
1421
1652
                      help=u"Debug mode; run in foreground and log to"
1422
1653
                      u" terminal")
 
1654
    parser.add_option("--debuglevel", type=u"string", metavar="Level",
 
1655
                      help=u"Debug level for stdout output")
1423
1656
    parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1424
1657
                      u" priority string (see GnuTLS documentation)")
1425
1658
    parser.add_option("--servicename", type=u"string",
1450
1683
                        u"servicename": u"Mandos",
1451
1684
                        u"use_dbus": u"True",
1452
1685
                        u"use_ipv6": u"True",
 
1686
                        u"debuglevel": u"",
1453
1687
                        }
1454
1688
    
1455
1689
    # Parse config file for server-global settings
1472
1706
    # options, if set.
1473
1707
    for option in (u"interface", u"address", u"port", u"debug",
1474
1708
                   u"priority", u"servicename", u"configdir",
1475
 
                   u"use_dbus", u"use_ipv6"):
 
1709
                   u"use_dbus", u"use_ipv6", u"debuglevel"):
1476
1710
        value = getattr(options, option)
1477
1711
        if value is not None:
1478
1712
            server_settings[option] = value
1487
1721
    
1488
1722
    # For convenience
1489
1723
    debug = server_settings[u"debug"]
 
1724
    debuglevel = server_settings[u"debuglevel"]
1490
1725
    use_dbus = server_settings[u"use_dbus"]
1491
1726
    use_ipv6 = server_settings[u"use_ipv6"]
1492
 
    
1493
 
    if not debug:
1494
 
        syslogger.setLevel(logging.WARNING)
1495
 
        console.setLevel(logging.WARNING)
1496
 
    
 
1727
 
1497
1728
    if server_settings[u"servicename"] != u"Mandos":
1498
1729
        syslogger.setFormatter(logging.Formatter
1499
1730
                               (u'Mandos (%s) [%%(process)d]:'
1505
1736
                        u"interval": u"5m",
1506
1737
                        u"checker": u"fping -q -- %%(host)s",
1507
1738
                        u"host": u"",
 
1739
                        u"approval_delay": u"0s",
 
1740
                        u"approval_duration": u"1s",
1508
1741
                        }
1509
1742
    client_config = configparser.SafeConfigParser(client_defaults)
1510
1743
    client_config.read(os.path.join(server_settings[u"configdir"],
1516
1749
    tcp_server = MandosServer((server_settings[u"address"],
1517
1750
                               server_settings[u"port"]),
1518
1751
                              ClientHandler,
1519
 
                              interface=server_settings[u"interface"],
 
1752
                              interface=(server_settings[u"interface"]
 
1753
                                         or None),
1520
1754
                              use_ipv6=use_ipv6,
1521
1755
                              gnutls_priority=
1522
1756
                              server_settings[u"priority"],
1548
1782
        if error[0] != errno.EPERM:
1549
1783
            raise error
1550
1784
    
1551
 
    # Enable all possible GnuTLS debugging
 
1785
    if not debug and not debuglevel:
 
1786
        syslogger.setLevel(logging.WARNING)
 
1787
        console.setLevel(logging.WARNING)
 
1788
    if debuglevel:
 
1789
        level = getattr(logging, debuglevel.upper())
 
1790
        syslogger.setLevel(level)
 
1791
        console.setLevel(level)
 
1792
 
1552
1793
    if debug:
 
1794
        # Enable all possible GnuTLS debugging
 
1795
        
1553
1796
        # "Use a log level over 10 to enable all debugging options."
1554
1797
        # - GnuTLS manual
1555
1798
        gnutls.library.functions.gnutls_global_set_log_level(11)
1560
1803
        
1561
1804
        (gnutls.library.functions
1562
1805
         .gnutls_global_set_log_function(debug_gnutls))
 
1806
        
 
1807
        # Redirect stdin so all checkers get /dev/null
 
1808
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
 
1809
        os.dup2(null, sys.stdin.fileno())
 
1810
        if null > 2:
 
1811
            os.close(null)
 
1812
    else:
 
1813
        # No console logging
 
1814
        logger.removeHandler(console)
 
1815
    
1563
1816
    
1564
1817
    global main_loop
1565
1818
    # From the Avahi example code
1583
1836
    if server_settings["interface"]:
1584
1837
        service.interface = (if_nametoindex
1585
1838
                             (str(server_settings[u"interface"])))
 
1839
 
 
1840
    if not debug:
 
1841
        # Close all input and output, do double fork, etc.
 
1842
        daemon()
 
1843
        
 
1844
    global multiprocessing_manager
 
1845
    multiprocessing_manager = multiprocessing.Manager()
1586
1846
    
1587
1847
    client_class = Client
1588
1848
    if use_dbus:
1589
1849
        client_class = functools.partial(ClientDBus, bus = bus)
 
1850
    def client_config_items(config, section):
 
1851
        special_settings = {
 
1852
            "approved_by_default":
 
1853
                lambda: config.getboolean(section,
 
1854
                                          "approved_by_default"),
 
1855
            }
 
1856
        for name, value in config.items(section):
 
1857
            try:
 
1858
                yield (name, special_settings[name]())
 
1859
            except KeyError:
 
1860
                yield (name, value)
 
1861
    
1590
1862
    tcp_server.clients.update(set(
1591
1863
            client_class(name = section,
1592
 
                         config= dict(client_config.items(section)))
 
1864
                         config= dict(client_config_items(
 
1865
                        client_config, section)))
1593
1866
            for section in client_config.sections()))
1594
1867
    if not tcp_server.clients:
1595
1868
        logger.warning(u"No clients defined")
1596
 
    
1597
 
    if debug:
1598
 
        # Redirect stdin so all checkers get /dev/null
1599
 
        null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1600
 
        os.dup2(null, sys.stdin.fileno())
1601
 
        if null > 2:
1602
 
            os.close(null)
1603
 
    else:
1604
 
        # No console logging
1605
 
        logger.removeHandler(console)
1606
 
        # Close all input and output, do double fork, etc.
1607
 
        daemon()
1608
 
    
 
1869
        
1609
1870
    try:
1610
 
        with closing(pidfile):
 
1871
        with pidfile:
1611
1872
            pid = os.getpid()
1612
1873
            pidfile.write(str(pid) + "\n")
1613
1874
        del pidfile
1631
1892
                dbus.service.Object.__init__(self, bus, u"/")
1632
1893
            _interface = u"se.bsnet.fukt.Mandos"
1633
1894
            
1634
 
            @dbus.service.signal(_interface, signature=u"oa{sv}")
1635
 
            def ClientAdded(self, objpath, properties):
 
1895
            @dbus.service.signal(_interface, signature=u"o")
 
1896
            def ClientAdded(self, objpath):
1636
1897
                "D-Bus signal"
1637
1898
                pass
1638
1899
            
1700
1961
    for client in tcp_server.clients:
1701
1962
        if use_dbus:
1702
1963
            # Emit D-Bus signal
1703
 
            mandos_dbus_service.ClientAdded(client.dbus_object_path,
1704
 
                                            client.GetAll(u""))
 
1964
            mandos_dbus_service.ClientAdded(client.dbus_object_path)
1705
1965
        client.enable()
1706
1966
    
1707
1967
    tcp_server.enable()