173
175
return b"mandos" + binascii.hexlify(password)
175
177
def encrypt(self, data, password):
176
self.gnupg.passphrase = self.password_encode(password)
177
with open(os.devnull) as devnull:
179
proc = self.gnupg.run(['--symmetric'],
180
create_fhs=['stdin', 'stdout'],
181
attach_fhs={'stderr': devnull})
182
with contextlib.closing(proc.handles['stdin']) as f:
184
with contextlib.closing(proc.handles['stdout']) as f:
185
ciphertext = f.read()
189
self.gnupg.passphrase = None
178
passphrase = self.password_encode(password)
179
with tempfile.NamedTemporaryFile(dir=self.tempdir
181
passfile.write(passphrase)
183
proc = subprocess.Popen(['gpg', '--symmetric',
187
stdin = subprocess.PIPE,
188
stdout = subprocess.PIPE,
189
stderr = subprocess.PIPE)
190
ciphertext, err = proc.communicate(input = data)
191
if proc.returncode != 0:
190
193
return ciphertext
192
195
def decrypt(self, data, password):
193
self.gnupg.passphrase = self.password_encode(password)
194
with open(os.devnull) as devnull:
196
proc = self.gnupg.run(['--decrypt'],
197
create_fhs=['stdin', 'stdout'],
198
attach_fhs={'stderr': devnull})
199
with contextlib.closing(proc.handles['stdin'] ) as f:
201
with contextlib.closing(proc.handles['stdout']) as f:
202
decrypted_plaintext = f.read()
206
self.gnupg.passphrase = None
196
passphrase = self.password_encode(password)
197
with tempfile.NamedTemporaryFile(dir = self.tempdir
199
passfile.write(passphrase)
201
proc = subprocess.Popen(['gpg', '--decrypt',
205
stdin = subprocess.PIPE,
206
stdout = subprocess.PIPE,
207
stderr = subprocess.PIPE)
208
decrypted_plaintext, err = proc.communicate(input
210
if proc.returncode != 0:
207
212
return decrypted_plaintext
211
215
class AvahiError(Exception):
212
216
def __init__(self, value, *args, **kwargs):
213
217
self.value = value
412
427
interval: datetime.timedelta(); How often to start a new checker
413
428
last_approval_request: datetime.datetime(); (UTC) or None
414
429
last_checked_ok: datetime.datetime(); (UTC) or None
416
430
last_checker_status: integer between 0 and 255 reflecting exit
417
431
status of last checker. -1 reflects crashed
432
checker, -2 means no checker completed yet.
419
433
last_enabled: datetime.datetime(); (UTC) or None
420
434
name: string; from the config file, used in log messages and
421
435
D-Bus identifiers
422
436
secret: bytestring; sent verbatim (over TLS) to client
423
437
timeout: datetime.timedelta(); How long from last_checked_ok
424
438
until this client is disabled
425
extended_timeout: extra long timeout when password has been sent
439
extended_timeout: extra long timeout when secret has been sent
426
440
runtime_expansions: Allowed attributes for runtime expansion.
427
441
expires: datetime.datetime(); time (UTC) when a client will be
428
442
disabled, or None
443
server_settings: The server_settings dict from main()
431
446
runtime_expansions = ("approval_delay", "approval_duration",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
447
"created", "enabled", "expires",
448
"fingerprint", "host", "interval",
449
"last_approval_request", "last_checked_ok",
434
450
"last_enabled", "name", "timeout")
451
client_defaults = { "timeout": "PT5M",
452
"extended_timeout": "PT15M",
454
"checker": "fping -q -- %%(host)s",
456
"approval_delay": "PT0S",
457
"approval_duration": "PT1S",
458
"approved_by_default": "True",
436
462
def timeout_milliseconds(self):
437
463
"Return the 'timeout' attribute in milliseconds"
448
474
def approval_delay_milliseconds(self):
449
475
return timedelta_to_milliseconds(self.approval_delay)
451
def __init__(self, name = None, config=None):
452
"""Note: the 'checker' key in 'config' sets the
453
'checker_command' attribute and *not* the 'checker'
478
def config_parser(config):
479
"""Construct a new dict of client settings of this form:
480
{ client_name: {setting_name: value, ...}, ...}
481
with exceptions for any special settings as defined above.
482
NOTE: Must be a pure function. Must return the same result
483
value given the same arguments.
486
for client_name in config.sections():
487
section = dict(config.items(client_name))
488
client = settings[client_name] = {}
490
client["host"] = section["host"]
491
# Reformat values from string types to Python types
492
client["approved_by_default"] = config.getboolean(
493
client_name, "approved_by_default")
494
client["enabled"] = config.getboolean(client_name,
497
client["fingerprint"] = (section["fingerprint"].upper()
499
if "secret" in section:
500
client["secret"] = section["secret"].decode("base64")
501
elif "secfile" in section:
502
with open(os.path.expanduser(os.path.expandvars
503
(section["secfile"])),
505
client["secret"] = secfile.read()
507
raise TypeError("No secret or secfile for section {0}"
509
client["timeout"] = string_to_delta(section["timeout"])
510
client["extended_timeout"] = string_to_delta(
511
section["extended_timeout"])
512
client["interval"] = string_to_delta(section["interval"])
513
client["approval_delay"] = string_to_delta(
514
section["approval_delay"])
515
client["approval_duration"] = string_to_delta(
516
section["approval_duration"])
517
client["checker_command"] = section["checker"]
518
client["last_approval_request"] = None
519
client["last_checked_ok"] = None
520
client["last_checker_status"] = -2
524
def __init__(self, settings, name = None, server_settings=None):
526
if server_settings is None:
528
self.server_settings = server_settings
529
# adding all client settings
530
for setting, value in settings.iteritems():
531
setattr(self, setting, value)
534
if not hasattr(self, "last_enabled"):
535
self.last_enabled = datetime.datetime.utcnow()
536
if not hasattr(self, "expires"):
537
self.expires = (datetime.datetime.utcnow()
540
self.last_enabled = None
458
543
logger.debug("Creating client %r", self.name)
459
544
# Uppercase and remove spaces from fingerprint for later
460
545
# comparison purposes with return value from the fingerprint()
462
self.fingerprint = (config["fingerprint"].upper()
464
547
logger.debug(" Fingerprint: %s", self.fingerprint)
465
if "secret" in config:
466
self.secret = config["secret"].decode("base64")
467
elif "secfile" in config:
468
with open(os.path.expanduser(os.path.expandvars
469
(config["secfile"])),
471
self.secret = secfile.read()
473
raise TypeError("No secret or secfile for client %s"
475
self.host = config.get("host", "")
476
self.created = datetime.datetime.utcnow()
477
self.enabled = config.get("enabled", True)
478
self.last_approval_request = None
480
self.last_enabled = datetime.datetime.utcnow()
482
self.last_enabled = None
483
self.last_checked_ok = None
484
self.last_checker_status = None
485
self.timeout = string_to_delta(config["timeout"])
486
self.extended_timeout = string_to_delta(config
487
["extended_timeout"])
488
self.interval = string_to_delta(config["interval"])
548
self.created = settings.get("created",
549
datetime.datetime.utcnow())
551
# attributes specific for this server instance
489
552
self.checker = None
490
553
self.checker_initiator_tag = None
491
554
self.disable_initiator_tag = None
493
self.expires = datetime.datetime.utcnow() + self.timeout
496
555
self.checker_callback_tag = None
497
self.checker_command = config["checker"]
498
556
self.current_checker_command = None
499
557
self.approved = None
500
self.approved_by_default = config.get("approved_by_default",
502
558
self.approvals_pending = 0
503
self.approval_delay = string_to_delta(
504
config["approval_delay"])
505
self.approval_duration = string_to_delta(
506
config["approval_duration"])
507
559
self.changedstate = (multiprocessing_manager
508
560
.Condition(multiprocessing_manager
529
581
if getattr(self, "enabled", False):
530
582
# Already enabled
532
self.send_changedstate()
533
584
self.expires = datetime.datetime.utcnow() + self.timeout
534
585
self.enabled = True
535
586
self.last_enabled = datetime.datetime.utcnow()
536
587
self.init_checker()
588
self.send_changedstate()
538
590
def disable(self, quiet=True):
539
591
"""Disable this client."""
540
592
if not getattr(self, "enabled", False):
543
self.send_changedstate()
545
595
logger.info("Disabling client %s", self.name)
546
if getattr(self, "disable_initiator_tag", False):
596
if getattr(self, "disable_initiator_tag", None) is not None:
547
597
gobject.source_remove(self.disable_initiator_tag)
548
598
self.disable_initiator_tag = None
549
599
self.expires = None
550
if getattr(self, "checker_initiator_tag", False):
600
if getattr(self, "checker_initiator_tag", None) is not None:
551
601
gobject.source_remove(self.checker_initiator_tag)
552
602
self.checker_initiator_tag = None
553
603
self.stop_checker()
554
604
self.enabled = False
606
self.send_changedstate()
555
607
# Do not run this again if called by a gobject.timeout_add
589
645
logger.warning("Checker for %(name)s crashed?",
592
def checked_ok(self, timeout=None):
593
"""Bump up the timeout for this client.
595
This should only be called when the client has been seen,
648
def checked_ok(self):
649
"""Assert that the client has been seen, alive and well."""
650
self.last_checked_ok = datetime.datetime.utcnow()
651
self.last_checker_status = 0
654
def bump_timeout(self, timeout=None):
655
"""Bump up the timeout for this client."""
598
656
if timeout is None:
599
657
timeout = self.timeout
600
self.last_checked_ok = datetime.datetime.utcnow()
601
658
if self.disable_initiator_tag is not None:
602
659
gobject.source_remove(self.disable_initiator_tag)
660
self.disable_initiator_tag = None
603
661
if getattr(self, "enabled", False):
604
662
self.disable_initiator_tag = (gobject.timeout_add
605
663
(timedelta_to_milliseconds
615
673
If a checker already exists, leave it running and do
617
675
# The reason for not killing a running checker is that if we
618
# did that, then if a checker (for some reason) started
619
# running slowly and taking more than 'interval' time, the
620
# client would inevitably timeout, since no checker would get
621
# a chance to run to completion. If we instead leave running
676
# did that, and if a checker (for some reason) started running
677
# slowly and taking more than 'interval' time, then the client
678
# would inevitably timeout, since no checker would get a
679
# chance to run to completion. If we instead leave running
622
680
# checkers alone, the checker would have to take more time
623
681
# than 'timeout' for the client to be disabled, which is as it
638
696
self.current_checker_command)
639
697
# Start a new checker if needed
640
698
if self.checker is None:
699
# Escape attributes for the shell
700
escaped_attrs = dict(
701
(attr, re.escape(unicode(getattr(self, attr))))
703
self.runtime_expansions)
642
# In case checker_command has exactly one % operator
643
command = self.checker_command % self.host
645
# Escape attributes for the shell
646
escaped_attrs = dict(
648
re.escape(unicode(str(getattr(self, attr, "")),
652
self.runtime_expansions)
655
command = self.checker_command % escaped_attrs
656
except TypeError as error:
657
logger.error('Could not format string "%s":'
658
' %s', self.checker_command, error)
659
return True # Try again later
705
command = self.checker_command % escaped_attrs
706
except TypeError as error:
707
logger.error('Could not format string "%s"',
708
self.checker_command, exc_info=error)
709
return True # Try again later
660
710
self.current_checker_command = command
662
712
logger.info("Starting checker %r for %s",
665
715
# in normal mode, that is already done by daemon(),
666
716
# and in debug mode we don't want to. (Stdin is
667
717
# always replaced by /dev/null.)
718
# The exception is when not debugging but nevertheless
719
# running in the foreground; use the previously
722
if (not self.server_settings["debug"]
723
and self.server_settings["foreground"]):
724
popen_args.update({"stdout": wnull,
668
726
self.checker = subprocess.Popen(command,
671
self.checker_callback_tag = (gobject.child_watch_add
673
self.checker_callback,
675
# The checker may have completed before the gobject
676
# watch was added. Check for this.
730
except OSError as error:
731
logger.error("Failed to start subprocess",
734
self.checker_callback_tag = (gobject.child_watch_add
736
self.checker_callback,
738
# The checker may have completed before the gobject
739
# watch was added. Check for this.
677
741
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
679
gobject.source_remove(self.checker_callback_tag)
680
self.checker_callback(pid, status, command)
681
742
except OSError as error:
682
logger.error("Failed to start subprocess: %s",
743
if error.errno == errno.ECHILD:
744
# This should never happen
745
logger.error("Child process vanished",
750
gobject.source_remove(self.checker_callback_tag)
751
self.checker_callback(pid, status, command)
684
752
# Re-run this periodically if run by gobject.timeout_add
804
def dbus_interface_annotations(dbus_interface):
805
"""Decorator for marking functions returning interface annotations
809
@dbus_interface_annotations("org.example.Interface")
810
def _foo(self): # Function name does not matter
811
return {"org.freedesktop.DBus.Deprecated": "true",
812
"org.freedesktop.DBus.Property.EmitsChangedSignal":
816
func._dbus_is_interface = True
817
func._dbus_interface = dbus_interface
818
func._dbus_name = dbus_interface
823
def dbus_annotations(annotations):
824
"""Decorator to annotate D-Bus methods, signals or properties
827
@dbus_service_property("org.example.Interface", signature="b",
829
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
830
"org.freedesktop.DBus.Property."
831
"EmitsChangedSignal": "false"})
832
def Property_dbus_property(self):
833
return dbus.Boolean(False)
836
func._dbus_annotations = annotations
736
841
class DBusPropertyException(dbus.exceptions.DBusException):
737
842
"""A base class for D-Bus property-related exceptions
764
def _is_dbus_property(obj):
765
return getattr(obj, "_dbus_is_property", False)
869
def _is_dbus_thing(thing):
870
"""Returns a function testing if an attribute is a D-Bus thing
872
If called like _is_dbus_thing("method") it returns a function
873
suitable for use as predicate to inspect.getmembers().
875
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
767
def _get_all_dbus_properties(self):
878
def _get_all_dbus_things(self, thing):
768
879
"""Returns a generator of (name, attribute) pairs
770
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
881
return ((getattr(athing.__get__(self), "_dbus_name",
883
athing.__get__(self))
771
884
for cls in self.__class__.__mro__
773
inspect.getmembers(cls, self._is_dbus_property))
886
inspect.getmembers(cls,
887
self._is_dbus_thing(thing)))
775
889
def _get_dbus_property(self, interface_name, property_name):
776
890
"""Returns a bound method if one exists which is a D-Bus
860
977
e.setAttribute("access", prop._dbus_access)
862
979
for if_tag in document.getElementsByTagName("interface"):
863
981
for tag in (make_tag(document, name, prop)
865
in self._get_all_dbus_properties()
983
in self._get_all_dbus_things("property")
866
984
if prop._dbus_interface
867
985
== if_tag.getAttribute("name")):
868
986
if_tag.appendChild(tag)
987
# Add annotation tags
988
for typ in ("method", "signal", "property"):
989
for tag in if_tag.getElementsByTagName(typ):
991
for name, prop in (self.
992
_get_all_dbus_things(typ)):
993
if (name == tag.getAttribute("name")
994
and prop._dbus_interface
995
== if_tag.getAttribute("name")):
996
annots.update(getattr
1000
for name, value in annots.iteritems():
1001
ann_tag = document.createElement(
1003
ann_tag.setAttribute("name", name)
1004
ann_tag.setAttribute("value", value)
1005
tag.appendChild(ann_tag)
1006
# Add interface annotation tags
1007
for annotation, value in dict(
1008
itertools.chain.from_iterable(
1009
annotations().iteritems()
1010
for name, annotations in
1011
self._get_all_dbus_things("interface")
1012
if name == if_tag.getAttribute("name")
1014
ann_tag = document.createElement("annotation")
1015
ann_tag.setAttribute("name", annotation)
1016
ann_tag.setAttribute("value", value)
1017
if_tag.appendChild(ann_tag)
869
1018
# Add the names to the return values for the
870
1019
# "org.freedesktop.DBus.Properties" methods
871
1020
if (if_tag.getAttribute("name")
898
1047
variant_level=variant_level)
901
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
903
"""Applied to an empty subclass of a D-Bus object, this metaclass
904
will add additional D-Bus attributes matching a certain pattern.
1050
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1051
"""A class decorator; applied to a subclass of
1052
dbus.service.Object, it will add alternate D-Bus attributes with
1053
interface names according to the "alt_interface_names" mapping.
1056
@alternate_dbus_interfaces({"org.example.Interface":
1057
"net.example.AlternateInterface"})
1058
class SampleDBusObject(dbus.service.Object):
1059
@dbus.service.method("org.example.Interface")
1060
def SampleDBusMethod():
1063
The above "SampleDBusMethod" on "SampleDBusObject" will be
1064
reachable via two interfaces: "org.example.Interface" and
1065
"net.example.AlternateInterface", the latter of which will have
1066
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1067
"true", unless "deprecate" is passed with a False value.
1069
This works for methods and signals, and also for D-Bus properties
1070
(from DBusObjectWithProperties) and interfaces (from the
1071
dbus_interface_annotations decorator).
906
def __new__(mcs, name, bases, attr):
907
# Go through all the base classes which could have D-Bus
908
# methods, signals, or properties in them
909
for base in (b for b in bases
910
if issubclass(b, dbus.service.Object)):
911
# Go though all attributes of the base class
912
for attrname, attribute in inspect.getmembers(base):
1074
for orig_interface_name, alt_interface_name in (
1075
alt_interface_names.iteritems()):
1077
interface_names = set()
1078
# Go though all attributes of the class
1079
for attrname, attribute in inspect.getmembers(cls):
913
1080
# Ignore non-D-Bus attributes, and D-Bus attributes
914
1081
# with the wrong interface name
915
1082
if (not hasattr(attribute, "_dbus_interface")
916
1083
or not attribute._dbus_interface
917
.startswith("se.recompile.Mandos")):
1084
.startswith(orig_interface_name)):
919
1086
# Create an alternate D-Bus interface name based on
920
1087
# the current name
921
1088
alt_interface = (attribute._dbus_interface
922
.replace("se.recompile.Mandos",
923
"se.bsnet.fukt.Mandos"))
1089
.replace(orig_interface_name,
1090
alt_interface_name))
1091
interface_names.add(alt_interface)
924
1092
# Is this a D-Bus signal?
925
1093
if getattr(attribute, "_dbus_is_signal", False):
926
# Extract the original non-method function by
1094
# Extract the original non-method undecorated
1095
# function by black magic
928
1096
nonmethod_func = (dict(
929
1097
zip(attribute.func_code.co_freevars,
930
1098
attribute.__closure__))["func"]
941
1109
nonmethod_func.func_name,
942
1110
nonmethod_func.func_defaults,
943
1111
nonmethod_func.func_closure)))
1112
# Copy annotations, if any
1114
new_function._dbus_annotations = (
1115
dict(attribute._dbus_annotations))
1116
except AttributeError:
944
1118
# Define a creator of a function to call both the
945
# old and new functions, so both the old and new
946
# signals gets sent when the function is called
1119
# original and alternate functions, so both the
1120
# original and alternate signals gets sent when
1121
# the function is called
947
1122
def fixscope(func1, func2):
948
1123
"""This function is a scope container to pass
949
1124
func1 and func2 to the "call_both" function
993
1173
attribute.func_name,
994
1174
attribute.func_defaults,
995
1175
attribute.func_closure)))
996
return type.__new__(mcs, name, bases, attr)
1176
# Copy annotations, if any
1178
attr[attrname]._dbus_annotations = (
1179
dict(attribute._dbus_annotations))
1180
except AttributeError:
1182
# Is this a D-Bus interface?
1183
elif getattr(attribute, "_dbus_is_interface", False):
1184
# Create a new, but exactly alike, function
1185
# object. Decorate it to be a new D-Bus interface
1186
# with the alternate D-Bus interface name. Add it
1188
attr[attrname] = (dbus_interface_annotations
1191
(attribute.func_code,
1192
attribute.func_globals,
1193
attribute.func_name,
1194
attribute.func_defaults,
1195
attribute.func_closure)))
1197
# Deprecate all alternate interfaces
1198
iname="_AlternateDBusNames_interface_annotation{0}"
1199
for interface_name in interface_names:
1200
@dbus_interface_annotations(interface_name)
1202
return { "org.freedesktop.DBus.Deprecated":
1204
# Find an unused name
1205
for aname in (iname.format(i)
1206
for i in itertools.count()):
1207
if aname not in attr:
1211
# Replace the class with a new subclass of it with
1212
# methods, signals, etc. as created above.
1213
cls = type(b"{0}Alternate".format(cls.__name__),
1219
@alternate_dbus_interfaces({"se.recompile.Mandos":
1220
"se.bsnet.fukt.Mandos"})
999
1221
class ClientDBus(Client, DBusObjectWithProperties):
1000
1222
"""A Client class using D-Bus
1065
1284
checker is not None)
1066
1285
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1067
1286
"LastCheckedOK")
1287
last_checker_status = notifychangeproperty(dbus.Int16,
1288
"LastCheckerStatus")
1068
1289
last_approval_request = notifychangeproperty(
1069
1290
datetime_to_dbus, "LastApprovalRequest")
1070
1291
approved_by_default = notifychangeproperty(dbus.Boolean,
1071
1292
"ApprovedByDefault")
1072
approval_delay = notifychangeproperty(dbus.UInt16,
1293
approval_delay = notifychangeproperty(dbus.UInt64,
1073
1294
"ApprovalDelay",
1075
1296
timedelta_to_milliseconds)
1076
1297
approval_duration = notifychangeproperty(
1077
dbus.UInt16, "ApprovalDuration",
1298
dbus.UInt64, "ApprovalDuration",
1078
1299
type_func = timedelta_to_milliseconds)
1079
1300
host = notifychangeproperty(dbus.String, "Host")
1080
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1301
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1082
1303
timedelta_to_milliseconds)
1083
1304
extended_timeout = notifychangeproperty(
1084
dbus.UInt16, "ExtendedTimeout",
1305
dbus.UInt64, "ExtendedTimeout",
1085
1306
type_func = timedelta_to_milliseconds)
1086
interval = notifychangeproperty(dbus.UInt16,
1307
interval = notifychangeproperty(dbus.UInt64,
1089
1310
timedelta_to_milliseconds)
1328
1553
def Timeout_dbus_property(self, value=None):
1329
1554
if value is None: # get
1330
1555
return dbus.UInt64(self.timeout_milliseconds())
1556
old_timeout = self.timeout
1331
1557
self.timeout = datetime.timedelta(0, 0, 0, value)
1332
if getattr(self, "disable_initiator_tag", None) is None:
1334
# Reschedule timeout
1335
gobject.source_remove(self.disable_initiator_tag)
1336
self.disable_initiator_tag = None
1338
time_to_die = timedelta_to_milliseconds((self
1343
if time_to_die <= 0:
1344
# The timeout has passed
1347
self.expires = (datetime.datetime.utcnow()
1348
+ datetime.timedelta(milliseconds =
1350
self.disable_initiator_tag = (gobject.timeout_add
1351
(time_to_die, self.disable))
1558
# Reschedule disabling
1560
now = datetime.datetime.utcnow()
1561
self.expires += self.timeout - old_timeout
1562
if self.expires <= now:
1563
# The timeout has passed
1566
if (getattr(self, "disable_initiator_tag", None)
1569
gobject.source_remove(self.disable_initiator_tag)
1570
self.disable_initiator_tag = (
1571
gobject.timeout_add(
1572
timedelta_to_milliseconds(self.expires - now),
1353
1575
# ExtendedTimeout - property
1354
1576
@dbus_service_property(_interface, signature="t",
1707
1922
use_ipv6: Boolean; to use IPv6 or not
1709
1924
def __init__(self, server_address, RequestHandlerClass,
1710
interface=None, use_ipv6=True):
1925
interface=None, use_ipv6=True, socketfd=None):
1926
"""If socketfd is set, use that file descriptor instead of
1927
creating a new one with socket.socket().
1711
1929
self.interface = interface
1713
1931
self.address_family = socket.AF_INET6
1932
if socketfd is not None:
1933
# Save the file descriptor
1934
self.socketfd = socketfd
1935
# Save the original socket.socket() function
1936
self.socket_socket = socket.socket
1937
# To implement --socket, we monkey patch socket.socket.
1939
# (When socketserver.TCPServer is a new-style class, we
1940
# could make self.socket into a property instead of monkey
1941
# patching socket.socket.)
1943
# Create a one-time-only replacement for socket.socket()
1944
@functools.wraps(socket.socket)
1945
def socket_wrapper(*args, **kwargs):
1946
# Restore original function so subsequent calls are
1948
socket.socket = self.socket_socket
1949
del self.socket_socket
1950
# This time only, return a new socket object from the
1951
# saved file descriptor.
1952
return socket.fromfd(self.socketfd, *args, **kwargs)
1953
# Replace socket.socket() function with wrapper
1954
socket.socket = socket_wrapper
1955
# The socketserver.TCPServer.__init__ will call
1956
# socket.socket(), which might be our replacement,
1957
# socket_wrapper(), if socketfd was set.
1714
1958
socketserver.TCPServer.__init__(self, server_address,
1715
1959
RequestHandlerClass)
1716
1961
def server_bind(self):
1717
1962
"""This overrides the normal server_bind() function
1718
1963
to bind to an interface if one was specified, and also NOT to
1727
1972
self.socket.setsockopt(socket.SOL_SOCKET,
1728
1973
SO_BINDTODEVICE,
1974
str(self.interface + '\0'))
1731
1975
except socket.error as error:
1732
if error[0] == errno.EPERM:
1733
logger.error("No permission to"
1734
" bind to interface %s",
1736
elif error[0] == errno.ENOPROTOOPT:
1976
if error.errno == errno.EPERM:
1977
logger.error("No permission to bind to"
1978
" interface %s", self.interface)
1979
elif error.errno == errno.ENOPROTOOPT:
1737
1980
logger.error("SO_BINDTODEVICE not available;"
1738
1981
" cannot bind to interface %s",
1739
1982
self.interface)
1983
elif error.errno == errno.ENODEV:
1984
logger.error("Interface %s does not exist,"
1985
" cannot bind", self.interface)
1742
1988
# Only bind(2) the socket if we really need to.
1802
2049
def handle_ipc(self, source, condition, parent_pipe=None,
1803
2050
proc = None, client_object=None):
1805
gobject.IO_IN: "IN", # There is data to read.
1806
gobject.IO_OUT: "OUT", # Data can be written (without
1808
gobject.IO_PRI: "PRI", # There is urgent data to read.
1809
gobject.IO_ERR: "ERR", # Error condition.
1810
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1811
# broken, usually for pipes and
1814
conditions_string = ' | '.join(name
1816
condition_names.iteritems()
1817
if cond & condition)
1818
2051
# error, or the other end of multiprocessing.Pipe has closed
1819
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2052
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1820
2053
# Wait for other process to exit
2116
def rfc3339_duration_to_delta(duration):
2117
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2119
>>> rfc3339_duration_to_delta("P7D")
2120
datetime.timedelta(7)
2121
>>> rfc3339_duration_to_delta("PT60S")
2122
datetime.timedelta(0, 60)
2123
>>> rfc3339_duration_to_delta("PT60M")
2124
datetime.timedelta(0, 3600)
2125
>>> rfc3339_duration_to_delta("PT24H")
2126
datetime.timedelta(1)
2127
>>> rfc3339_duration_to_delta("P1W")
2128
datetime.timedelta(7)
2129
>>> rfc3339_duration_to_delta("PT5M30S")
2130
datetime.timedelta(0, 330)
2131
>>> rfc3339_duration_to_delta("P1DT3M20S")
2132
datetime.timedelta(1, 200)
2135
# Parsing an RFC 3339 duration with regular expressions is not
2136
# possible - there would have to be multiple places for the same
2137
# values, like seconds. The current code, while more esoteric, is
2138
# cleaner without depending on a parsing library. If Python had a
2139
# built-in library for parsing we would use it, but we'd like to
2140
# avoid excessive use of external libraries.
2142
# New type for defining tokens, syntax, and semantics all-in-one
2143
Token = collections.namedtuple("Token",
2144
("regexp", # To match token; if
2145
# "value" is not None,
2146
# must have a "group"
2148
"value", # datetime.timedelta or
2150
"followers")) # Tokens valid after
2152
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2153
# the "duration" ABNF definition in RFC 3339, Appendix A.
2154
token_end = Token(re.compile(r"$"), None, frozenset())
2155
token_second = Token(re.compile(r"(\d+)S"),
2156
datetime.timedelta(seconds=1),
2157
frozenset((token_end,)))
2158
token_minute = Token(re.compile(r"(\d+)M"),
2159
datetime.timedelta(minutes=1),
2160
frozenset((token_second, token_end)))
2161
token_hour = Token(re.compile(r"(\d+)H"),
2162
datetime.timedelta(hours=1),
2163
frozenset((token_minute, token_end)))
2164
token_time = Token(re.compile(r"T"),
2166
frozenset((token_hour, token_minute,
2168
token_day = Token(re.compile(r"(\d+)D"),
2169
datetime.timedelta(days=1),
2170
frozenset((token_time, token_end)))
2171
token_month = Token(re.compile(r"(\d+)M"),
2172
datetime.timedelta(weeks=4),
2173
frozenset((token_day, token_end)))
2174
token_year = Token(re.compile(r"(\d+)Y"),
2175
datetime.timedelta(weeks=52),
2176
frozenset((token_month, token_end)))
2177
token_week = Token(re.compile(r"(\d+)W"),
2178
datetime.timedelta(weeks=1),
2179
frozenset((token_end,)))
2180
token_duration = Token(re.compile(r"P"), None,
2181
frozenset((token_year, token_month,
2182
token_day, token_time,
2184
# Define starting values
2185
value = datetime.timedelta() # Value so far
2187
followers = frozenset(token_duration,) # Following valid tokens
2188
s = duration # String left to parse
2189
# Loop until end token is found
2190
while found_token is not token_end:
2191
# Search for any currently valid tokens
2192
for token in followers:
2193
match = token.regexp.match(s)
2194
if match is not None:
2196
if token.value is not None:
2197
# Value found, parse digits
2198
factor = int(match.group(1), 10)
2199
# Add to value so far
2200
value += factor * token.value
2201
# Strip token from string
2202
s = token.regexp.sub("", s, 1)
2205
# Set valid next tokens
2206
followers = found_token.followers
2209
# No currently valid tokens were found
2210
raise ValueError("Invalid RFC 3339 duration")
1883
2215
def string_to_delta(interval):
1884
2216
"""Parse a string and return a datetime.timedelta
1977
2316
parser.add_argument("--no-dbus", action="store_false",
1978
2317
dest="use_dbus", help="Do not provide D-Bus"
1979
" system bus interface")
2318
" system bus interface", default=None)
1980
2319
parser.add_argument("--no-ipv6", action="store_false",
1981
dest="use_ipv6", help="Do not use IPv6")
2320
dest="use_ipv6", help="Do not use IPv6",
1982
2322
parser.add_argument("--no-restore", action="store_false",
1983
2323
dest="restore", help="Do not restore stored"
2324
" state", default=None)
2325
parser.add_argument("--socket", type=int,
2326
help="Specify a file descriptor to a network"
2327
" socket to use instead of creating one")
1985
2328
parser.add_argument("--statedir", metavar="DIR",
1986
2329
help="Directory to save/restore state in")
2330
parser.add_argument("--foreground", action="store_true",
2331
help="Run in foreground", default=None)
1988
2333
options = parser.parse_args()
2015
2362
# Convert the SafeConfigParser object to a dict
2016
2363
server_settings = server_config.defaults()
2017
2364
# Use the appropriate methods on the non-string config options
2018
for option in ("debug", "use_dbus", "use_ipv6"):
2365
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2019
2366
server_settings[option] = server_config.getboolean("DEFAULT",
2021
2368
if server_settings["port"]:
2022
2369
server_settings["port"] = server_config.getint("DEFAULT",
2371
if server_settings["socket"]:
2372
server_settings["socket"] = server_config.getint("DEFAULT",
2374
# Later, stdin will, and stdout and stderr might, be dup'ed
2375
# over with an opened os.devnull. But we don't want this to
2376
# happen with a supplied network socket.
2377
if 0 <= server_settings["socket"] <= 2:
2378
server_settings["socket"] = os.dup(server_settings
2024
2380
del server_config
2026
2382
# Override the settings from the config file with command line
2048
2411
use_ipv6 = server_settings["use_ipv6"]
2049
2412
stored_state_path = os.path.join(server_settings["statedir"],
2050
2413
stored_state_file)
2414
foreground = server_settings["foreground"]
2053
initlogger(logging.DEBUG)
2417
initlogger(debug, logging.DEBUG)
2055
2419
if not debuglevel:
2058
2422
level = getattr(logging, debuglevel.upper())
2423
initlogger(debug, level)
2061
2425
if server_settings["servicename"] != "Mandos":
2062
2426
syslogger.setFormatter(logging.Formatter
2063
('Mandos (%s) [%%(process)d]:'
2064
' %%(levelname)s: %%(message)s'
2065
% server_settings["servicename"]))
2427
('Mandos ({0}) [%(process)d]:'
2428
' %(levelname)s: %(message)s'
2429
.format(server_settings
2067
2432
# Parse config file with clients
2068
client_defaults = { "timeout": "5m",
2069
"extended_timeout": "15m",
2071
"checker": "fping -q -- %%(host)s",
2073
"approval_delay": "0s",
2074
"approval_duration": "1s",
2076
client_config = configparser.SafeConfigParser(client_defaults)
2433
client_config = configparser.SafeConfigParser(Client
2077
2435
client_config.read(os.path.join(server_settings["configdir"],
2078
2436
"clients.conf"))
2088
2446
use_ipv6=use_ipv6,
2089
2447
gnutls_priority=
2090
2448
server_settings["priority"],
2093
pidfilename = "/var/run/mandos.pid"
2450
socketfd=(server_settings["socket"]
2453
pidfilename = "/run/mandos.pid"
2095
2456
pidfile = open(pidfilename, "w")
2097
logger.error("Could not open file %r", pidfilename)
2457
except IOError as e:
2458
logger.error("Could not open file %r", pidfilename,
2100
uid = pwd.getpwnam("_mandos").pw_uid
2101
gid = pwd.getpwnam("_mandos").pw_gid
2461
for name in ("_mandos", "mandos", "nobody"):
2104
uid = pwd.getpwnam("mandos").pw_uid
2105
gid = pwd.getpwnam("mandos").pw_gid
2463
uid = pwd.getpwnam(name).pw_uid
2464
gid = pwd.getpwnam(name).pw_gid
2106
2466
except KeyError:
2108
uid = pwd.getpwnam("nobody").pw_uid
2109
gid = pwd.getpwnam("nobody").pw_gid
2116
2474
except OSError as error:
2117
if error[0] != errno.EPERM:
2475
if error.errno != errno.EPERM:
2132
2490
.gnutls_global_set_log_function(debug_gnutls))
2134
2492
# Redirect stdin so all checkers get /dev/null
2135
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2493
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2136
2494
os.dup2(null, sys.stdin.fileno())
2140
# No console logging
2141
logger.removeHandler(console)
2143
2498
# Need to fork before connecting to D-Bus
2145
2500
# Close all input and output, do double fork, etc.
2503
# multiprocessing will use threads, so before we use gobject we
2504
# need to inform gobject that threads will be used.
2505
gobject.threads_init()
2148
2507
global main_loop
2149
2508
# From the Avahi example code
2150
DBusGMainLoop(set_as_default=True )
2509
DBusGMainLoop(set_as_default=True)
2151
2510
main_loop = gobject.MainLoop()
2152
2511
bus = dbus.SystemBus()
2153
2512
# End of Avahi example code
2178
2537
client_class = Client
2180
client_class = functools.partial(ClientDBusTransitional,
2183
special_settings = {
2184
# Some settings need to be accessd by special methods;
2185
# booleans need .getboolean(), etc. Here is a list of them:
2186
"approved_by_default":
2188
client_config.getboolean(section, "approved_by_default"),
2191
client_config.getboolean(section, "enabled"),
2193
# Construct a new dict of client settings of this form:
2194
# { client_name: {setting_name: value, ...}, ...}
2195
# with exceptions for any special settings as defined above
2196
client_settings = dict((clientname,
2199
if setting not in special_settings
2200
else special_settings[setting]
2202
for setting, value in
2203
client_config.items(clientname)))
2204
for clientname in client_config.sections())
2539
client_class = functools.partial(ClientDBus, bus = bus)
2541
client_settings = Client.config_parser(client_config)
2206
2542
old_client_settings = {}
2545
# This is used to redirect stdout and stderr for checker processes
2547
wnull = open(os.devnull, "w") # A writable /dev/null
2548
# Only used if server is running in foreground but not in debug
2550
if debug or not foreground:
2209
2553
# Get client data and settings from last running state.
2210
2554
if server_settings["restore"]:
2214
2558
(stored_state))
2215
2559
os.remove(stored_state_path)
2216
2560
except IOError as e:
2217
logger.warning("Could not load persistent state: {0}"
2219
if e.errno != errno.ENOENT:
2561
if e.errno == errno.ENOENT:
2562
logger.warning("Could not load persistent state: {0}"
2563
.format(os.strerror(e.errno)))
2565
logger.critical("Could not load persistent state:",
2568
except EOFError as e:
2569
logger.warning("Could not load persistent state: "
2570
"EOFError:", exc_info=e)
2222
2572
with PGPEngine() as pgp:
2223
for client in clients_data:
2224
client_name = client["name"]
2573
for client_name, client in clients_data.iteritems():
2574
# Skip removed clients
2575
if client_name not in client_settings:
2226
2578
# Decide which value to use after restoring saved state.
2227
2579
# We have three different values: Old config file,
2236
2588
if (name != "secret" and
2237
2589
value != old_client_settings[client_name]
2239
setattr(client, name, value)
2591
client[name] = value
2240
2592
except KeyError:
2243
2595
# Clients who has passed its expire date can still be
2244
# enabled if its last checker was sucessful. Clients
2245
# whose checker failed before we stored its state is
2246
# assumed to have failed all checkers during downtime.
2247
if client["enabled"] and client["last_checked_ok"]:
2248
if ((datetime.datetime.utcnow()
2249
- client["last_checked_ok"])
2250
> client["interval"]):
2251
if client["last_checker_status"] != 0:
2596
# enabled if its last checker was successful. Clients
2597
# whose checker succeeded before we stored its state is
2598
# assumed to have successfully run all checkers during
2600
if client["enabled"]:
2601
if datetime.datetime.utcnow() >= client["expires"]:
2602
if not client["last_checked_ok"]:
2604
"disabling client {0} - Client never "
2605
"performed a successful checker"
2606
.format(client_name))
2607
client["enabled"] = False
2608
elif client["last_checker_status"] != 0:
2610
"disabling client {0} - Client "
2611
"last checker failed with error code {1}"
2612
.format(client_name,
2613
client["last_checker_status"]))
2252
2614
client["enabled"] = False
2254
2616
client["expires"] = (datetime.datetime
2256
2618
+ client["timeout"])
2258
client["changedstate"] = (multiprocessing_manager
2260
(multiprocessing_manager
2263
new_client = (ClientDBusTransitional.__new__
2264
(ClientDBusTransitional))
2265
tcp_server.clients[client_name] = new_client
2266
new_client.bus = bus
2267
for name, value in client.iteritems():
2268
setattr(new_client, name, value)
2269
client_object_name = unicode(client_name).translate(
2270
{ord("."): ord("_"),
2271
ord("-"): ord("_")})
2272
new_client.dbus_object_path = (dbus.ObjectPath
2274
+ client_object_name))
2275
DBusObjectWithProperties.__init__(new_client,
2280
tcp_server.clients[client_name] = (Client.__new__
2282
for name, value in client.iteritems():
2283
setattr(tcp_server.clients[client_name],
2619
logger.debug("Last checker succeeded,"
2620
" keeping {0} enabled"
2621
.format(client_name))
2287
tcp_server.clients[client_name].secret = (
2288
pgp.decrypt(tcp_server.clients[client_name]
2623
client["secret"] = (
2624
pgp.decrypt(client["encrypted_secret"],
2290
2625
client_settings[client_name]
2292
2627
except PGPError:
2293
2628
# If decryption fails, we use secret from new settings
2294
2629
logger.debug("Failed to decrypt {0} old secret"
2295
2630
.format(client_name))
2296
tcp_server.clients[client_name].secret = (
2631
client["secret"] = (
2297
2632
client_settings[client_name]["secret"])
2299
# Create/remove clients based on new changes made to config
2300
for clientname in set(old_client_settings) - set(client_settings):
2301
del tcp_server.clients[clientname]
2302
for clientname in set(client_settings) - set(old_client_settings):
2303
tcp_server.clients[clientname] = (client_class(name
2634
# Add/remove clients based on new changes made to config
2635
for client_name in (set(old_client_settings)
2636
- set(client_settings)):
2637
del clients_data[client_name]
2638
for client_name in (set(client_settings)
2639
- set(old_client_settings)):
2640
clients_data[client_name] = client_settings[client_name]
2642
# Create all client objects
2643
for client_name, client in clients_data.iteritems():
2644
tcp_server.clients[client_name] = client_class(
2645
name = client_name, settings = client,
2646
server_settings = server_settings)
2309
2648
if not tcp_server.clients:
2310
2649
logger.warning("No clients defined")
2316
pidfile.write(str(pid) + "\n".encode("utf-8"))
2319
logger.error("Could not write to file %r with PID %d",
2322
# "pidfile" was never created
2652
if pidfile is not None:
2656
pidfile.write(str(pid) + "\n".encode("utf-8"))
2658
logger.error("Could not write to file %r with PID %d",
2324
2661
del pidfilename
2326
signal.signal(signal.SIGINT, signal.SIG_IGN)
2328
2663
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2329
2664
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2332
class MandosDBusService(dbus.service.Object):
2667
@alternate_dbus_interfaces({"se.recompile.Mandos":
2668
"se.bsnet.fukt.Mandos"})
2669
class MandosDBusService(DBusObjectWithProperties):
2333
2670
"""A D-Bus proxy object"""
2334
2671
def __init__(self):
2335
2672
dbus.service.Object.__init__(self, bus, "/")
2336
2673
_interface = "se.recompile.Mandos"
2675
@dbus_interface_annotations(_interface)
2677
return { "org.freedesktop.DBus.Property"
2678
".EmitsChangedSignal":
2338
2681
@dbus.service.signal(_interface, signature="o")
2339
2682
def ClientAdded(self, objpath):
2418
2761
if attr not in exclude:
2419
2762
client_dict[attr] = getattr(client, attr)
2421
clients.append(client_dict)
2764
clients[client.name] = client_dict
2422
2765
del client_settings[client.name]["secret"]
2425
with os.fdopen(os.open(stored_state_path,
2426
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2427
0600), "wb") as stored_state:
2768
with (tempfile.NamedTemporaryFile
2769
(mode='wb', suffix=".pickle", prefix='clients-',
2770
dir=os.path.dirname(stored_state_path),
2771
delete=False)) as stored_state:
2428
2772
pickle.dump((clients, client_settings), stored_state)
2773
tempname=stored_state.name
2774
os.rename(tempname, stored_state_path)
2429
2775
except (IOError, OSError) as e:
2430
logger.warning("Could not save persistent state: {0}"
2432
if e.errno not in (errno.ENOENT, errno.EACCES):
2781
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2782
logger.warning("Could not save persistent state: {0}"
2783
.format(os.strerror(e.errno)))
2785
logger.warning("Could not save persistent state:",
2435
2789
# Delete all clients, and settings from config
2436
2790
while tcp_server.clients: