11
11
# "AvahiService" class, and some lines in "main".
13
13
# Everything else is
14
# Copyright © 2008-2011 Teddy Hogeborn
15
# Copyright © 2008-2011 Björn Påhlsson
14
# Copyright © 2008-2012 Teddy Hogeborn
15
# Copyright © 2008-2012 Björn Påhlsson
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
141
145
self.gnupg.options.meta_interactive = False
142
146
self.gnupg.options.homedir = self.tempdir
143
147
self.gnupg.options.extra_args.extend(['--force-mdc',
146
151
def __enter__(self):
149
def __exit__ (self, exc_type, exc_value, traceback):
154
def __exit__(self, exc_type, exc_value, traceback):
174
179
def encrypt(self, data, password):
175
180
self.gnupg.passphrase = self.password_encode(password)
176
with open(os.devnull) as devnull:
181
with open(os.devnull, "w") as devnull:
178
183
proc = self.gnupg.run(['--symmetric'],
179
184
create_fhs=['stdin', 'stdout'],
191
196
def decrypt(self, data, password):
192
197
self.gnupg.passphrase = self.password_encode(password)
193
with open(os.devnull) as devnull:
198
with open(os.devnull, "w") as devnull:
195
200
proc = self.gnupg.run(['--decrypt'],
196
201
create_fhs=['stdin', 'stdout'],
197
202
attach_fhs={'stderr': devnull})
198
with contextlib.closing(proc.handles['stdin'] ) as f:
203
with contextlib.closing(proc.handles['stdin']) as f:
200
205
with contextlib.closing(proc.handles['stdout']) as f:
201
206
decrypted_plaintext = f.read()
367
379
self.server_state_changed)
368
380
self.server_state_changed(self.server.GetState())
370
383
class AvahiServiceToSyslog(AvahiService):
371
384
def rename(self):
372
385
"""Add the new name to the syslog messages"""
373
386
ret = AvahiService.rename(self)
374
387
syslogger.setFormatter(logging.Formatter
375
('Mandos (%s) [%%(process)d]:'
376
' %%(levelname)s: %%(message)s'
388
('Mandos ({0}) [%(process)d]:'
389
' %(levelname)s: %(message)s'
380
394
def timedelta_to_milliseconds(td):
381
395
"Convert a datetime.timedelta() to milliseconds"
382
396
return ((td.days * 24 * 60 * 60 * 1000)
383
397
+ (td.seconds * 1000)
384
398
+ (td.microseconds // 1000))
386
401
class Client(object):
387
402
"""A representation of a client host served by this server.
413
428
last_checked_ok: datetime.datetime(); (UTC) or None
414
429
last_checker_status: integer between 0 and 255 reflecting exit
415
430
status of last checker. -1 reflects crashed
431
checker, -2 means no checker completed yet.
417
432
last_enabled: datetime.datetime(); (UTC) or None
418
433
name: string; from the config file, used in log messages and
419
434
D-Bus identifiers
420
435
secret: bytestring; sent verbatim (over TLS) to client
421
436
timeout: datetime.timedelta(); How long from last_checked_ok
422
437
until this client is disabled
423
extended_timeout: extra long timeout when password has been sent
438
extended_timeout: extra long timeout when secret has been sent
424
439
runtime_expansions: Allowed attributes for runtime expansion.
425
440
expires: datetime.datetime(); time (UTC) when a client will be
426
441
disabled, or None
429
444
runtime_expansions = ("approval_delay", "approval_duration",
430
"created", "enabled", "fingerprint",
431
"host", "interval", "last_checked_ok",
445
"created", "enabled", "expires",
446
"fingerprint", "host", "interval",
447
"last_approval_request", "last_checked_ok",
432
448
"last_enabled", "name", "timeout")
433
449
client_defaults = { "timeout": "5m",
434
450
"extended_timeout": "15m",
456
472
def approval_delay_milliseconds(self):
457
473
return timedelta_to_milliseconds(self.approval_delay)
460
476
def config_parser(config):
461
""" Construct a new dict of client settings of this form:
477
"""Construct a new dict of client settings of this form:
462
478
{ client_name: {setting_name: value, ...}, ...}
463
with exceptions for any special settings as defined above"""
479
with exceptions for any special settings as defined above.
480
NOTE: Must be a pure function. Must return the same result
481
value given the same arguments.
465
484
for client_name in config.sections():
466
485
section = dict(config.items(client_name))
495
515
client["checker_command"] = section["checker"]
496
516
client["last_approval_request"] = None
497
517
client["last_checked_ok"] = None
498
client["last_checker_status"] = None
499
if client["enabled"]:
500
client["last_enabled"] = datetime.datetime.utcnow()
501
client["expires"] = (datetime.datetime.utcnow()
504
client["last_enabled"] = None
505
client["expires"] = None
518
client["last_checker_status"] = -2
510
522
def __init__(self, settings, name = None):
511
"""Note: the 'checker' key in 'config' sets the
512
'checker_command' attribute and *not* the 'checker'
515
524
# adding all client settings
516
525
for setting, value in settings.iteritems():
517
526
setattr(self, setting, value)
529
if not hasattr(self, "last_enabled"):
530
self.last_enabled = datetime.datetime.utcnow()
531
if not hasattr(self, "expires"):
532
self.expires = (datetime.datetime.utcnow()
535
self.last_enabled = None
519
538
logger.debug("Creating client %r", self.name)
520
539
# Uppercase and remove spaces from fingerprint for later
521
540
# comparison purposes with return value from the fingerprint()
523
542
logger.debug(" Fingerprint: %s", self.fingerprint)
524
self.created = settings.get("created", datetime.datetime.utcnow())
543
self.created = settings.get("created",
544
datetime.datetime.utcnow())
526
546
# attributes specific for this server instance
527
547
self.checker = None
528
548
self.checker_initiator_tag = None
556
576
if getattr(self, "enabled", False):
557
577
# Already enabled
559
self.send_changedstate()
560
579
self.expires = datetime.datetime.utcnow() + self.timeout
561
580
self.enabled = True
562
581
self.last_enabled = datetime.datetime.utcnow()
563
582
self.init_checker()
583
self.send_changedstate()
565
585
def disable(self, quiet=True):
566
586
"""Disable this client."""
567
587
if not getattr(self, "enabled", False):
570
self.send_changedstate()
572
590
logger.info("Disabling client %s", self.name)
573
if getattr(self, "disable_initiator_tag", False):
591
if getattr(self, "disable_initiator_tag", None) is not None:
574
592
gobject.source_remove(self.disable_initiator_tag)
575
593
self.disable_initiator_tag = None
576
594
self.expires = None
577
if getattr(self, "checker_initiator_tag", False):
595
if getattr(self, "checker_initiator_tag", None) is not None:
578
596
gobject.source_remove(self.checker_initiator_tag)
579
597
self.checker_initiator_tag = None
580
598
self.stop_checker()
581
599
self.enabled = False
601
self.send_changedstate()
582
602
# Do not run this again if called by a gobject.timeout_add
588
608
def init_checker(self):
589
609
# Schedule a new checker to be started an 'interval' from now,
590
610
# and every interval from then on.
611
if self.checker_initiator_tag is not None:
612
gobject.source_remove(self.checker_initiator_tag)
591
613
self.checker_initiator_tag = (gobject.timeout_add
592
614
(self.interval_milliseconds(),
593
615
self.start_checker))
594
616
# Schedule a disable() when 'timeout' has passed
617
if self.disable_initiator_tag is not None:
618
gobject.source_remove(self.disable_initiator_tag)
595
619
self.disable_initiator_tag = (gobject.timeout_add
596
620
(self.timeout_milliseconds(),
616
640
logger.warning("Checker for %(name)s crashed?",
619
def checked_ok(self, timeout=None):
620
"""Bump up the timeout for this client.
622
This should only be called when the client has been seen,
643
def checked_ok(self):
644
"""Assert that the client has been seen, alive and well."""
645
self.last_checked_ok = datetime.datetime.utcnow()
646
self.last_checker_status = 0
649
def bump_timeout(self, timeout=None):
650
"""Bump up the timeout for this client."""
625
651
if timeout is None:
626
652
timeout = self.timeout
627
self.last_checked_ok = datetime.datetime.utcnow()
628
653
if self.disable_initiator_tag is not None:
629
654
gobject.source_remove(self.disable_initiator_tag)
655
self.disable_initiator_tag = None
630
656
if getattr(self, "enabled", False):
631
657
self.disable_initiator_tag = (gobject.timeout_add
632
658
(timedelta_to_milliseconds
642
668
If a checker already exists, leave it running and do
644
670
# The reason for not killing a running checker is that if we
645
# did that, then if a checker (for some reason) started
646
# running slowly and taking more than 'interval' time, the
647
# client would inevitably timeout, since no checker would get
648
# a chance to run to completion. If we instead leave running
671
# did that, and if a checker (for some reason) started running
672
# slowly and taking more than 'interval' time, then the client
673
# would inevitably timeout, since no checker would get a
674
# chance to run to completion. If we instead leave running
649
675
# checkers alone, the checker would have to take more time
650
676
# than 'timeout' for the client to be disabled, which is as it
665
691
self.current_checker_command)
666
692
# Start a new checker if needed
667
693
if self.checker is None:
694
# Escape attributes for the shell
695
escaped_attrs = dict(
696
(attr, re.escape(unicode(getattr(self, attr))))
698
self.runtime_expansions)
669
# In case checker_command has exactly one % operator
670
command = self.checker_command % self.host
672
# Escape attributes for the shell
673
escaped_attrs = dict(
675
re.escape(unicode(str(getattr(self, attr, "")),
679
self.runtime_expansions)
682
command = self.checker_command % escaped_attrs
683
except TypeError as error:
684
logger.error('Could not format string "%s":'
685
' %s', self.checker_command, error)
686
return True # Try again later
700
command = self.checker_command % escaped_attrs
701
except TypeError as error:
702
logger.error('Could not format string "%s"',
703
self.checker_command, exc_info=error)
704
return True # Try again later
687
705
self.current_checker_command = command
689
707
logger.info("Starting checker %r for %s",
695
713
self.checker = subprocess.Popen(command,
697
715
shell=True, cwd="/")
698
self.checker_callback_tag = (gobject.child_watch_add
700
self.checker_callback,
702
# The checker may have completed before the gobject
703
# watch was added. Check for this.
704
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
706
gobject.source_remove(self.checker_callback_tag)
707
self.checker_callback(pid, status, command)
708
716
except OSError as error:
709
logger.error("Failed to start subprocess: %s",
717
logger.error("Failed to start subprocess",
719
self.checker_callback_tag = (gobject.child_watch_add
721
self.checker_callback,
723
# The checker may have completed before the gobject
724
# watch was added. Check for this.
725
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
727
gobject.source_remove(self.checker_callback_tag)
728
self.checker_callback(pid, status, command)
711
729
# Re-run this periodically if run by gobject.timeout_add
781
def dbus_interface_annotations(dbus_interface):
782
"""Decorator for marking functions returning interface annotations
786
@dbus_interface_annotations("org.example.Interface")
787
def _foo(self): # Function name does not matter
788
return {"org.freedesktop.DBus.Deprecated": "true",
789
"org.freedesktop.DBus.Property.EmitsChangedSignal":
793
func._dbus_is_interface = True
794
func._dbus_interface = dbus_interface
795
func._dbus_name = dbus_interface
800
def dbus_annotations(annotations):
801
"""Decorator to annotate D-Bus methods, signals or properties
804
@dbus_service_property("org.example.Interface", signature="b",
806
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
807
"org.freedesktop.DBus.Property."
808
"EmitsChangedSignal": "false"})
809
def Property_dbus_property(self):
810
return dbus.Boolean(False)
813
func._dbus_annotations = annotations
763
818
class DBusPropertyException(dbus.exceptions.DBusException):
764
819
"""A base class for D-Bus property-related exceptions
791
def _is_dbus_property(obj):
792
return getattr(obj, "_dbus_is_property", False)
846
def _is_dbus_thing(thing):
847
"""Returns a function testing if an attribute is a D-Bus thing
849
If called like _is_dbus_thing("method") it returns a function
850
suitable for use as predicate to inspect.getmembers().
852
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
794
def _get_all_dbus_properties(self):
855
def _get_all_dbus_things(self, thing):
795
856
"""Returns a generator of (name, attribute) pairs
797
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
858
return ((getattr(athing.__get__(self), "_dbus_name",
860
athing.__get__(self))
798
861
for cls in self.__class__.__mro__
800
inspect.getmembers(cls, self._is_dbus_property))
863
inspect.getmembers(cls,
864
self._is_dbus_thing(thing)))
802
866
def _get_dbus_property(self, interface_name, property_name):
803
867
"""Returns a bound method if one exists which is a D-Bus
806
870
for cls in self.__class__.__mro__:
807
871
for name, value in (inspect.getmembers
808
(cls, self._is_dbus_property)):
873
self._is_dbus_thing("property"))):
809
874
if (value._dbus_name == property_name
810
875
and value._dbus_interface == interface_name):
811
876
return value.__get__(self)
874
939
path_keyword='object_path',
875
940
connection_keyword='connection')
876
941
def Introspect(self, object_path, connection):
877
"""Standard D-Bus method, overloaded to insert property tags.
942
"""Overloading of standard D-Bus method.
944
Inserts property tags and interface annotation tags.
879
946
xmlstring = dbus.service.Object.Introspect(self, object_path,
887
954
e.setAttribute("access", prop._dbus_access)
889
956
for if_tag in document.getElementsByTagName("interface"):
890
958
for tag in (make_tag(document, name, prop)
892
in self._get_all_dbus_properties()
960
in self._get_all_dbus_things("property")
893
961
if prop._dbus_interface
894
962
== if_tag.getAttribute("name")):
895
963
if_tag.appendChild(tag)
964
# Add annotation tags
965
for typ in ("method", "signal", "property"):
966
for tag in if_tag.getElementsByTagName(typ):
968
for name, prop in (self.
969
_get_all_dbus_things(typ)):
970
if (name == tag.getAttribute("name")
971
and prop._dbus_interface
972
== if_tag.getAttribute("name")):
973
annots.update(getattr
977
for name, value in annots.iteritems():
978
ann_tag = document.createElement(
980
ann_tag.setAttribute("name", name)
981
ann_tag.setAttribute("value", value)
982
tag.appendChild(ann_tag)
983
# Add interface annotation tags
984
for annotation, value in dict(
985
itertools.chain.from_iterable(
986
annotations().iteritems()
987
for name, annotations in
988
self._get_all_dbus_things("interface")
989
if name == if_tag.getAttribute("name")
991
ann_tag = document.createElement("annotation")
992
ann_tag.setAttribute("name", annotation)
993
ann_tag.setAttribute("value", value)
994
if_tag.appendChild(ann_tag)
896
995
# Add the names to the return values for the
897
996
# "org.freedesktop.DBus.Properties" methods
898
997
if (if_tag.getAttribute("name")
913
1012
except (AttributeError, xml.dom.DOMException,
914
1013
xml.parsers.expat.ExpatError) as error:
915
1014
logger.error("Failed to override Introspection method",
917
1016
return xmlstring
920
def datetime_to_dbus (dt, variant_level=0):
1019
def datetime_to_dbus(dt, variant_level=0):
921
1020
"""Convert a UTC datetime.datetime() to a D-Bus type."""
923
1022
return dbus.String("", variant_level = variant_level)
925
1024
variant_level=variant_level)
928
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
930
"""Applied to an empty subclass of a D-Bus object, this metaclass
931
will add additional D-Bus attributes matching a certain pattern.
1027
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1028
"""A class decorator; applied to a subclass of
1029
dbus.service.Object, it will add alternate D-Bus attributes with
1030
interface names according to the "alt_interface_names" mapping.
1033
@alternate_dbus_interfaces({"org.example.Interface":
1034
"net.example.AlternateInterface"})
1035
class SampleDBusObject(dbus.service.Object):
1036
@dbus.service.method("org.example.Interface")
1037
def SampleDBusMethod():
1040
The above "SampleDBusMethod" on "SampleDBusObject" will be
1041
reachable via two interfaces: "org.example.Interface" and
1042
"net.example.AlternateInterface", the latter of which will have
1043
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1044
"true", unless "deprecate" is passed with a False value.
1046
This works for methods and signals, and also for D-Bus properties
1047
(from DBusObjectWithProperties) and interfaces (from the
1048
dbus_interface_annotations decorator).
933
def __new__(mcs, name, bases, attr):
934
# Go through all the base classes which could have D-Bus
935
# methods, signals, or properties in them
936
for base in (b for b in bases
937
if issubclass(b, dbus.service.Object)):
938
# Go though all attributes of the base class
939
for attrname, attribute in inspect.getmembers(base):
1051
for orig_interface_name, alt_interface_name in (
1052
alt_interface_names.iteritems()):
1054
interface_names = set()
1055
# Go though all attributes of the class
1056
for attrname, attribute in inspect.getmembers(cls):
940
1057
# Ignore non-D-Bus attributes, and D-Bus attributes
941
1058
# with the wrong interface name
942
1059
if (not hasattr(attribute, "_dbus_interface")
943
1060
or not attribute._dbus_interface
944
.startswith("se.recompile.Mandos")):
1061
.startswith(orig_interface_name)):
946
1063
# Create an alternate D-Bus interface name based on
947
1064
# the current name
948
1065
alt_interface = (attribute._dbus_interface
949
.replace("se.recompile.Mandos",
950
"se.bsnet.fukt.Mandos"))
1066
.replace(orig_interface_name,
1067
alt_interface_name))
1068
interface_names.add(alt_interface)
951
1069
# Is this a D-Bus signal?
952
1070
if getattr(attribute, "_dbus_is_signal", False):
953
1071
# Extract the original non-method function by
968
1086
nonmethod_func.func_name,
969
1087
nonmethod_func.func_defaults,
970
1088
nonmethod_func.func_closure)))
1089
# Copy annotations, if any
1091
new_function._dbus_annotations = (
1092
dict(attribute._dbus_annotations))
1093
except AttributeError:
971
1095
# Define a creator of a function to call both the
972
# old and new functions, so both the old and new
973
# signals gets sent when the function is called
1096
# original and alternate functions, so both the
1097
# original and alternate signals gets sent when
1098
# the function is called
974
1099
def fixscope(func1, func2):
975
1100
"""This function is a scope container to pass
976
1101
func1 and func2 to the "call_both" function
983
1108
return call_both
984
1109
# Create the "call_both" function and add it to
986
attr[attrname] = fixscope(attribute,
1111
attr[attrname] = fixscope(attribute, new_function)
988
1112
# Is this a D-Bus method?
989
1113
elif getattr(attribute, "_dbus_is_method", False):
990
1114
# Create a new, but exactly alike, function
1001
1125
attribute.func_name,
1002
1126
attribute.func_defaults,
1003
1127
attribute.func_closure)))
1128
# Copy annotations, if any
1130
attr[attrname]._dbus_annotations = (
1131
dict(attribute._dbus_annotations))
1132
except AttributeError:
1004
1134
# Is this a D-Bus property?
1005
1135
elif getattr(attribute, "_dbus_is_property", False):
1006
1136
# Create a new, but exactly alike, function
1020
1150
attribute.func_name,
1021
1151
attribute.func_defaults,
1022
1152
attribute.func_closure)))
1023
return type.__new__(mcs, name, bases, attr)
1153
# Copy annotations, if any
1155
attr[attrname]._dbus_annotations = (
1156
dict(attribute._dbus_annotations))
1157
except AttributeError:
1159
# Is this a D-Bus interface?
1160
elif getattr(attribute, "_dbus_is_interface", False):
1161
# Create a new, but exactly alike, function
1162
# object. Decorate it to be a new D-Bus interface
1163
# with the alternate D-Bus interface name. Add it
1165
attr[attrname] = (dbus_interface_annotations
1168
(attribute.func_code,
1169
attribute.func_globals,
1170
attribute.func_name,
1171
attribute.func_defaults,
1172
attribute.func_closure)))
1174
# Deprecate all alternate interfaces
1175
iname="_AlternateDBusNames_interface_annotation{0}"
1176
for interface_name in interface_names:
1177
@dbus_interface_annotations(interface_name)
1179
return { "org.freedesktop.DBus.Deprecated":
1181
# Find an unused name
1182
for aname in (iname.format(i)
1183
for i in itertools.count()):
1184
if aname not in attr:
1188
# Replace the class with a new subclass of it with
1189
# methods, signals, etc. as created above.
1190
cls = type(b"{0}Alternate".format(cls.__name__),
1196
@alternate_dbus_interfaces({"se.recompile.Mandos":
1197
"se.bsnet.fukt.Mandos"})
1026
1198
class ClientDBus(Client, DBusObjectWithProperties):
1027
1199
"""A Client class using D-Bus
1039
1211
def __init__(self, bus = None, *args, **kwargs):
1041
1213
Client.__init__(self, *args, **kwargs)
1042
self._approvals_pending = 0
1044
self._approvals_pending = 0
1045
1214
# Only now, when this client is initialized, can it show up on
1047
1216
client_object_name = unicode(self.name).translate(
1168
1338
def approve(self, value=True):
1169
self.send_changedstate()
1170
1339
self.approved = value
1171
1340
gobject.timeout_add(timedelta_to_milliseconds
1172
1341
(self.approval_duration),
1173
1342
self._reset_approved)
1343
self.send_changedstate()
1176
1345
## D-Bus methods, signals & properties
1177
1346
_interface = "se.recompile.Mandos.Client"
1350
@dbus_interface_annotations(_interface)
1352
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1181
1357
# CheckerCompleted - signal
1341
1509
return datetime_to_dbus(self.last_checked_ok)
1511
# LastCheckerStatus - property
1512
@dbus_service_property(_interface, signature="n",
1514
def LastCheckerStatus_dbus_property(self):
1515
return dbus.Int16(self.last_checker_status)
1343
1517
# Expires - property
1344
1518
@dbus_service_property(_interface, signature="s", access="read")
1345
1519
def Expires_dbus_property(self):
1356
1530
def Timeout_dbus_property(self, value=None):
1357
1531
if value is None: # get
1358
1532
return dbus.UInt64(self.timeout_milliseconds())
1533
old_timeout = self.timeout
1359
1534
self.timeout = datetime.timedelta(0, 0, 0, value)
1360
if getattr(self, "disable_initiator_tag", None) is None:
1362
# Reschedule timeout
1363
gobject.source_remove(self.disable_initiator_tag)
1364
self.disable_initiator_tag = None
1366
time_to_die = timedelta_to_milliseconds((self
1371
if time_to_die <= 0:
1372
# The timeout has passed
1375
self.expires = (datetime.datetime.utcnow()
1376
+ datetime.timedelta(milliseconds =
1378
self.disable_initiator_tag = (gobject.timeout_add
1379
(time_to_die, self.disable))
1535
# Reschedule disabling
1537
now = datetime.datetime.utcnow()
1538
self.expires += self.timeout - old_timeout
1539
if self.expires <= now:
1540
# The timeout has passed
1543
if (getattr(self, "disable_initiator_tag", None)
1546
gobject.source_remove(self.disable_initiator_tag)
1547
self.disable_initiator_tag = (
1548
gobject.timeout_add(
1549
timedelta_to_milliseconds(self.expires - now),
1381
1552
# ExtendedTimeout - property
1382
1553
@dbus_service_property(_interface, signature="t",
1578
1741
#wait until timeout or approved
1579
1742
time = datetime.datetime.now()
1580
1743
client.changedstate.acquire()
1581
(client.changedstate.wait
1582
(float(client.timedelta_to_milliseconds(delay)
1744
client.changedstate.wait(
1745
float(timedelta_to_milliseconds(delay)
1584
1747
client.changedstate.release()
1585
1748
time2 = datetime.datetime.now()
1586
1749
if (time2 - time) >= delay:
1735
1899
use_ipv6: Boolean; to use IPv6 or not
1737
1901
def __init__(self, server_address, RequestHandlerClass,
1738
interface=None, use_ipv6=True):
1902
interface=None, use_ipv6=True, socketfd=None):
1903
"""If socketfd is set, use that file descriptor instead of
1904
creating a new one with socket.socket().
1739
1906
self.interface = interface
1741
1908
self.address_family = socket.AF_INET6
1909
if socketfd is not None:
1910
# Save the file descriptor
1911
self.socketfd = socketfd
1912
# Save the original socket.socket() function
1913
self.socket_socket = socket.socket
1914
# To implement --socket, we monkey patch socket.socket.
1916
# (When socketserver.TCPServer is a new-style class, we
1917
# could make self.socket into a property instead of monkey
1918
# patching socket.socket.)
1920
# Create a one-time-only replacement for socket.socket()
1921
@functools.wraps(socket.socket)
1922
def socket_wrapper(*args, **kwargs):
1923
# Restore original function so subsequent calls are
1925
socket.socket = self.socket_socket
1926
del self.socket_socket
1927
# This time only, return a new socket object from the
1928
# saved file descriptor.
1929
return socket.fromfd(self.socketfd, *args, **kwargs)
1930
# Replace socket.socket() function with wrapper
1931
socket.socket = socket_wrapper
1932
# The socketserver.TCPServer.__init__ will call
1933
# socket.socket(), which might be our replacement,
1934
# socket_wrapper(), if socketfd was set.
1742
1935
socketserver.TCPServer.__init__(self, server_address,
1743
1936
RequestHandlerClass)
1744
1938
def server_bind(self):
1745
1939
"""This overrides the normal server_bind() function
1746
1940
to bind to an interface if one was specified, and also NOT to
1755
1949
self.socket.setsockopt(socket.SOL_SOCKET,
1756
1950
SO_BINDTODEVICE,
1951
str(self.interface + '\0'))
1759
1952
except socket.error as error:
1760
if error[0] == errno.EPERM:
1761
logger.error("No permission to"
1762
" bind to interface %s",
1764
elif error[0] == errno.ENOPROTOOPT:
1953
if error.errno == errno.EPERM:
1954
logger.error("No permission to bind to"
1955
" interface %s", self.interface)
1956
elif error.errno == errno.ENOPROTOOPT:
1765
1957
logger.error("SO_BINDTODEVICE not available;"
1766
1958
" cannot bind to interface %s",
1767
1959
self.interface)
1960
elif error.errno == errno.ENODEV:
1961
logger.error("Interface %s does not exist,"
1962
" cannot bind", self.interface)
1770
1965
# Only bind(2) the socket if we really need to.
1801
1996
def __init__(self, server_address, RequestHandlerClass,
1802
1997
interface=None, use_ipv6=True, clients=None,
1803
gnutls_priority=None, use_dbus=True):
1998
gnutls_priority=None, use_dbus=True, socketfd=None):
1804
1999
self.enabled = False
1805
2000
self.clients = clients
1806
2001
if self.clients is None:
1830
2026
def handle_ipc(self, source, condition, parent_pipe=None,
1831
2027
proc = None, client_object=None):
1833
gobject.IO_IN: "IN", # There is data to read.
1834
gobject.IO_OUT: "OUT", # Data can be written (without
1836
gobject.IO_PRI: "PRI", # There is urgent data to read.
1837
gobject.IO_ERR: "ERR", # Error condition.
1838
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1839
# broken, usually for pipes and
1842
conditions_string = ' | '.join(name
1844
condition_names.iteritems()
1845
if cond & condition)
1846
2028
# error, or the other end of multiprocessing.Pipe has closed
1847
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2029
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1848
2030
# Wait for other process to exit
1940
2122
elif suffix == "w":
1941
2123
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1943
raise ValueError("Unknown suffix %r" % suffix)
2125
raise ValueError("Unknown suffix {0!r}"
1944
2127
except (ValueError, IndexError) as e:
1945
2128
raise ValueError(*(e.args))
1946
2129
timevalue += delta
1961
2144
if not noclose:
1962
2145
# Close all standard open file descriptors
1963
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2146
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1964
2147
if not stat.S_ISCHR(os.fstat(null).st_mode):
1965
2148
raise OSError(errno.ENODEV,
1966
"%s not a character device"
2149
"{0} not a character device"
2150
.format(os.devnull))
1968
2151
os.dup2(null, sys.stdin.fileno())
1969
2152
os.dup2(null, sys.stdout.fileno())
1970
2153
os.dup2(null, sys.stderr.fileno())
1980
2163
parser = argparse.ArgumentParser()
1981
2164
parser.add_argument("-v", "--version", action="version",
1982
version = "%%(prog)s %s" % version,
2165
version = "%(prog)s {0}".format(version),
1983
2166
help="show version number and exit")
1984
2167
parser.add_argument("-i", "--interface", metavar="IF",
1985
2168
help="Bind to interface IF")
2010
2193
parser.add_argument("--no-restore", action="store_false",
2011
2194
dest="restore", help="Do not restore stored"
2196
parser.add_argument("--socket", type=int,
2197
help="Specify a file descriptor to a network"
2198
" socket to use instead of creating one")
2013
2199
parser.add_argument("--statedir", metavar="DIR",
2014
2200
help="Directory to save/restore state in")
2201
parser.add_argument("--foreground", action="store_true",
2202
help="Run in foreground")
2016
2204
options = parser.parse_args()
2043
2233
# Convert the SafeConfigParser object to a dict
2044
2234
server_settings = server_config.defaults()
2045
2235
# Use the appropriate methods on the non-string config options
2046
for option in ("debug", "use_dbus", "use_ipv6"):
2236
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2047
2237
server_settings[option] = server_config.getboolean("DEFAULT",
2049
2239
if server_settings["port"]:
2050
2240
server_settings["port"] = server_config.getint("DEFAULT",
2242
if server_settings["socket"]:
2243
server_settings["socket"] = server_config.getint("DEFAULT",
2245
# Later, stdin will, and stdout and stderr might, be dup'ed
2246
# over with an opened os.devnull. But we don't want this to
2247
# happen with a supplied network socket.
2248
if 0 <= server_settings["socket"] <= 2:
2249
server_settings["socket"] = os.dup(server_settings
2052
2251
del server_config
2054
2253
# Override the settings from the config file with command line
2056
2255
for option in ("interface", "address", "port", "debug",
2057
2256
"priority", "servicename", "configdir",
2058
2257
"use_dbus", "use_ipv6", "debuglevel", "restore",
2258
"statedir", "socket", "foreground"):
2060
2259
value = getattr(options, option)
2061
2260
if value is not None:
2062
2261
server_settings[option] = value
2065
2264
for option in server_settings.keys():
2066
2265
if type(server_settings[option]) is str:
2067
2266
server_settings[option] = unicode(server_settings[option])
2267
# Debug implies foreground
2268
if server_settings["debug"]:
2269
server_settings["foreground"] = True
2068
2270
# Now we have our good server settings in "server_settings"
2070
2272
##################################################################
2076
2278
use_ipv6 = server_settings["use_ipv6"]
2077
2279
stored_state_path = os.path.join(server_settings["statedir"],
2078
2280
stored_state_file)
2281
foreground = server_settings["foreground"]
2081
initlogger(logging.DEBUG)
2284
initlogger(debug, logging.DEBUG)
2083
2286
if not debuglevel:
2086
2289
level = getattr(logging, debuglevel.upper())
2290
initlogger(debug, level)
2089
2292
if server_settings["servicename"] != "Mandos":
2090
2293
syslogger.setFormatter(logging.Formatter
2091
('Mandos (%s) [%%(process)d]:'
2092
' %%(levelname)s: %%(message)s'
2093
% server_settings["servicename"]))
2294
('Mandos ({0}) [%(process)d]:'
2295
' %(levelname)s: %(message)s'
2296
.format(server_settings
2095
2299
# Parse config file with clients
2096
client_config = configparser.SafeConfigParser(Client.client_defaults)
2300
client_config = configparser.SafeConfigParser(Client
2097
2302
client_config.read(os.path.join(server_settings["configdir"],
2098
2303
"clients.conf"))
2108
2313
use_ipv6=use_ipv6,
2109
2314
gnutls_priority=
2110
2315
server_settings["priority"],
2317
socketfd=(server_settings["socket"]
2113
2320
pidfilename = "/var/run/mandos.pid"
2115
2323
pidfile = open(pidfilename, "w")
2117
logger.error("Could not open file %r", pidfilename)
2324
except IOError as e:
2325
logger.error("Could not open file %r", pidfilename,
2120
uid = pwd.getpwnam("_mandos").pw_uid
2121
gid = pwd.getpwnam("_mandos").pw_gid
2328
for name in ("_mandos", "mandos", "nobody"):
2124
uid = pwd.getpwnam("mandos").pw_uid
2125
gid = pwd.getpwnam("mandos").pw_gid
2330
uid = pwd.getpwnam(name).pw_uid
2331
gid = pwd.getpwnam(name).pw_gid
2126
2333
except KeyError:
2128
uid = pwd.getpwnam("nobody").pw_uid
2129
gid = pwd.getpwnam("nobody").pw_gid
2136
2341
except OSError as error:
2137
if error[0] != errno.EPERM:
2342
if error.errno != errno.EPERM:
2152
2357
.gnutls_global_set_log_function(debug_gnutls))
2154
2359
# Redirect stdin so all checkers get /dev/null
2155
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2360
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2156
2361
os.dup2(null, sys.stdin.fileno())
2160
# No console logging
2161
logger.removeHandler(console)
2163
2365
# Need to fork before connecting to D-Bus
2165
2367
# Close all input and output, do double fork, etc.
2370
# multiprocessing will use threads, so before we use gobject we
2371
# need to inform gobject that threads will be used.
2168
2372
gobject.threads_init()
2170
2374
global main_loop
2171
2375
# From the Avahi example code
2172
DBusGMainLoop(set_as_default=True )
2376
DBusGMainLoop(set_as_default=True)
2173
2377
main_loop = gobject.MainLoop()
2174
2378
bus = dbus.SystemBus()
2175
2379
# End of Avahi example code
2214
2417
(stored_state))
2215
2418
os.remove(stored_state_path)
2216
2419
except IOError as e:
2217
logger.warning("Could not load persistent state: {0}"
2219
if e.errno != errno.ENOENT:
2420
if e.errno == errno.ENOENT:
2421
logger.warning("Could not load persistent state: {0}"
2422
.format(os.strerror(e.errno)))
2424
logger.critical("Could not load persistent state:",
2221
2427
except EOFError as e:
2222
2428
logger.warning("Could not load persistent state: "
2223
"EOFError: {0}".format(e))
2429
"EOFError:", exc_info=e)
2225
2431
with PGPEngine() as pgp:
2226
2432
for client_name, client in clients_data.iteritems():
2244
2450
# Clients who has passed its expire date can still be
2245
2451
# enabled if its last checker was successful. Clients
2246
# whose checker failed before we stored its state is
2247
# assumed to have failed all checkers during downtime.
2452
# whose checker succeeded before we stored its state is
2453
# assumed to have successfully run all checkers during
2248
2455
if client["enabled"]:
2249
2456
if datetime.datetime.utcnow() >= client["expires"]:
2250
2457
if not client["last_checked_ok"]:
2251
2458
logger.warning(
2252
2459
"disabling client {0} - Client never "
2253
"performed a successfull checker"
2254
.format(client["name"]))
2460
"performed a successful checker"
2461
.format(client_name))
2255
2462
client["enabled"] = False
2256
2463
elif client["last_checker_status"] != 0:
2257
2464
logger.warning(
2258
2465
"disabling client {0} - Client "
2259
2466
"last checker failed with error code {1}"
2260
.format(client["name"],
2467
.format(client_name,
2261
2468
client["last_checker_status"]))
2262
2469
client["enabled"] = False
2264
2471
client["expires"] = (datetime.datetime
2266
2473
+ client["timeout"])
2474
logger.debug("Last checker succeeded,"
2475
" keeping {0} enabled"
2476
.format(client_name))
2269
2478
client["secret"] = (
2270
2479
pgp.decrypt(client["encrypted_secret"],
2276
2485
.format(client_name))
2277
2486
client["secret"] = (
2278
2487
client_settings[client_name]["secret"])
2281
2489
# Add/remove clients based on new changes made to config
2282
for client_name in set(old_client_settings) - set(client_settings):
2490
for client_name in (set(old_client_settings)
2491
- set(client_settings)):
2283
2492
del clients_data[client_name]
2284
for client_name in set(client_settings) - set(old_client_settings):
2493
for client_name in (set(client_settings)
2494
- set(old_client_settings)):
2285
2495
clients_data[client_name] = client_settings[client_name]
2287
# Create clients all clients
2497
# Create all client objects
2288
2498
for client_name, client in clients_data.iteritems():
2289
2499
tcp_server.clients[client_name] = client_class(
2290
2500
name = client_name, settings = client)
2292
2502
if not tcp_server.clients:
2293
2503
logger.warning("No clients defined")
2299
pidfile.write(str(pid) + "\n".encode("utf-8"))
2302
logger.error("Could not write to file %r with PID %d",
2305
# "pidfile" was never created
2506
if pidfile is not None:
2510
pidfile.write(str(pid) + "\n".encode("utf-8"))
2512
logger.error("Could not write to file %r with PID %d",
2307
2515
del pidfilename
2308
signal.signal(signal.SIGINT, signal.SIG_IGN)
2310
2517
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2311
2518
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2314
class MandosDBusService(dbus.service.Object):
2521
@alternate_dbus_interfaces({"se.recompile.Mandos":
2522
"se.bsnet.fukt.Mandos"})
2523
class MandosDBusService(DBusObjectWithProperties):
2315
2524
"""A D-Bus proxy object"""
2316
2525
def __init__(self):
2317
2526
dbus.service.Object.__init__(self, bus, "/")
2318
2527
_interface = "se.recompile.Mandos"
2529
@dbus_interface_annotations(_interface)
2531
return { "org.freedesktop.DBus.Property"
2532
".EmitsChangedSignal":
2320
2535
@dbus.service.signal(_interface, signature="o")
2321
2536
def ClientAdded(self, objpath):
2405
2618
del client_settings[client.name]["secret"]
2408
with os.fdopen(os.open(stored_state_path,
2409
(os.O_CREAT | os.O_WRONLY
2410
| os.O_TRUNC | os.O_EXCL),
2411
(stat.S_IREAD | stat.S_IWRITE)),
2412
"wb") as stored_state:
2621
with (tempfile.NamedTemporaryFile
2622
(mode='wb', suffix=".pickle", prefix='clients-',
2623
dir=os.path.dirname(stored_state_path),
2624
delete=False)) as stored_state:
2413
2625
pickle.dump((clients, client_settings), stored_state)
2626
tempname=stored_state.name
2627
os.rename(tempname, stored_state_path)
2414
2628
except (IOError, OSError) as e:
2415
logger.warning("Could not save persistent state: {0}"
2417
if e.errno not in set((errno.ENOENT, errno.EACCES,
2634
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2635
logger.warning("Could not save persistent state: {0}"
2636
.format(os.strerror(e.errno)))
2638
logger.warning("Could not save persistent state:",
2421
2642
# Delete all clients, and settings from config
2422
2643
while tcp_server.clients:
2449
2670
service.port = tcp_server.socket.getsockname()[1]
2451
2672
logger.info("Now listening on address %r, port %d,"
2452
" flowinfo %d, scope_id %d"
2453
% tcp_server.socket.getsockname())
2673
" flowinfo %d, scope_id %d",
2674
*tcp_server.socket.getsockname())
2455
logger.info("Now listening on address %r, port %d"
2456
% tcp_server.socket.getsockname())
2676
logger.info("Now listening on address %r, port %d",
2677
*tcp_server.socket.getsockname())
2458
2679
#service.interface = tcp_server.socket.getsockname()[3]