170
172
def password_encode(self, password):
171
173
# Passphrase can not be empty and can not contain newlines or
172
174
# NUL bytes. So we prefix it and hex encode it.
173
return b"mandos" + binascii.hexlify(password)
175
encoded = b"mandos" + binascii.hexlify(password)
176
if len(encoded) > 2048:
177
# GnuPG can't handle long passwords, so encode differently
178
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
179
.replace(b"\n", b"\\n")
180
.replace(b"\0", b"\\x00"))
175
183
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
184
passphrase = self.password_encode(password)
185
with tempfile.NamedTemporaryFile(dir=self.tempdir
187
passfile.write(passphrase)
189
proc = subprocess.Popen(['gpg', '--symmetric',
193
stdin = subprocess.PIPE,
194
stdout = subprocess.PIPE,
195
stderr = subprocess.PIPE)
196
ciphertext, err = proc.communicate(input = data)
197
if proc.returncode != 0:
190
199
return ciphertext
192
201
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
202
passphrase = self.password_encode(password)
203
with tempfile.NamedTemporaryFile(dir = self.tempdir
205
passfile.write(passphrase)
207
proc = subprocess.Popen(['gpg', '--decrypt',
211
stdin = subprocess.PIPE,
212
stdout = subprocess.PIPE,
213
stderr = subprocess.PIPE)
214
decrypted_plaintext, err = proc.communicate(input
216
if proc.returncode != 0:
207
218
return decrypted_plaintext
211
221
class AvahiError(Exception):
212
222
def __init__(self, value, *args, **kwargs):
213
223
self.value = value
412
433
interval: datetime.timedelta(); How often to start a new checker
413
434
last_approval_request: datetime.datetime(); (UTC) or None
414
435
last_checked_ok: datetime.datetime(); (UTC) or None
416
436
last_checker_status: integer between 0 and 255 reflecting exit
417
437
status of last checker. -1 reflects crashed
438
checker, -2 means no checker completed yet.
419
439
last_enabled: datetime.datetime(); (UTC) or None
420
440
name: string; from the config file, used in log messages and
421
441
D-Bus identifiers
422
442
secret: bytestring; sent verbatim (over TLS) to client
423
443
timeout: datetime.timedelta(); How long from last_checked_ok
424
444
until this client is disabled
425
extended_timeout: extra long timeout when password has been sent
445
extended_timeout: extra long timeout when secret has been sent
426
446
runtime_expansions: Allowed attributes for runtime expansion.
427
447
expires: datetime.datetime(); time (UTC) when a client will be
428
448
disabled, or None
449
server_settings: The server_settings dict from main()
431
452
runtime_expansions = ("approval_delay", "approval_duration",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
453
"created", "enabled", "expires",
454
"fingerprint", "host", "interval",
455
"last_approval_request", "last_checked_ok",
434
456
"last_enabled", "name", "timeout")
457
client_defaults = { "timeout": "PT5M",
458
"extended_timeout": "PT15M",
460
"checker": "fping -q -- %%(host)s",
462
"approval_delay": "PT0S",
463
"approval_duration": "PT1S",
464
"approved_by_default": "True",
436
468
def timeout_milliseconds(self):
437
469
"Return the 'timeout' attribute in milliseconds"
448
480
def approval_delay_milliseconds(self):
449
481
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'
484
def config_parser(config):
485
"""Construct a new dict of client settings of this form:
486
{ client_name: {setting_name: value, ...}, ...}
487
with exceptions for any special settings as defined above.
488
NOTE: Must be a pure function. Must return the same result
489
value given the same arguments.
492
for client_name in config.sections():
493
section = dict(config.items(client_name))
494
client = settings[client_name] = {}
496
client["host"] = section["host"]
497
# Reformat values from string types to Python types
498
client["approved_by_default"] = config.getboolean(
499
client_name, "approved_by_default")
500
client["enabled"] = config.getboolean(client_name,
503
client["fingerprint"] = (section["fingerprint"].upper()
505
if "secret" in section:
506
client["secret"] = section["secret"].decode("base64")
507
elif "secfile" in section:
508
with open(os.path.expanduser(os.path.expandvars
509
(section["secfile"])),
511
client["secret"] = secfile.read()
513
raise TypeError("No secret or secfile for section {0}"
515
client["timeout"] = string_to_delta(section["timeout"])
516
client["extended_timeout"] = string_to_delta(
517
section["extended_timeout"])
518
client["interval"] = string_to_delta(section["interval"])
519
client["approval_delay"] = string_to_delta(
520
section["approval_delay"])
521
client["approval_duration"] = string_to_delta(
522
section["approval_duration"])
523
client["checker_command"] = section["checker"]
524
client["last_approval_request"] = None
525
client["last_checked_ok"] = None
526
client["last_checker_status"] = -2
530
def __init__(self, settings, name = None, server_settings=None):
532
if server_settings is None:
534
self.server_settings = server_settings
535
# adding all client settings
536
for setting, value in settings.iteritems():
537
setattr(self, setting, value)
540
if not hasattr(self, "last_enabled"):
541
self.last_enabled = datetime.datetime.utcnow()
542
if not hasattr(self, "expires"):
543
self.expires = (datetime.datetime.utcnow()
546
self.last_enabled = None
458
549
logger.debug("Creating client %r", self.name)
459
550
# Uppercase and remove spaces from fingerprint for later
460
551
# comparison purposes with return value from the fingerprint()
462
self.fingerprint = (config["fingerprint"].upper()
464
553
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"])
554
self.created = settings.get("created",
555
datetime.datetime.utcnow())
557
# attributes specific for this server instance
489
558
self.checker = None
490
559
self.checker_initiator_tag = None
491
560
self.disable_initiator_tag = None
493
self.expires = datetime.datetime.utcnow() + self.timeout
496
561
self.checker_callback_tag = None
497
self.checker_command = config["checker"]
498
562
self.current_checker_command = None
499
563
self.approved = None
500
self.approved_by_default = config.get("approved_by_default",
502
564
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
565
self.changedstate = (multiprocessing_manager
508
566
.Condition(multiprocessing_manager
529
587
if getattr(self, "enabled", False):
530
588
# Already enabled
532
self.send_changedstate()
533
590
self.expires = datetime.datetime.utcnow() + self.timeout
534
591
self.enabled = True
535
592
self.last_enabled = datetime.datetime.utcnow()
536
593
self.init_checker()
594
self.send_changedstate()
538
596
def disable(self, quiet=True):
539
597
"""Disable this client."""
540
598
if not getattr(self, "enabled", False):
543
self.send_changedstate()
545
601
logger.info("Disabling client %s", self.name)
546
if getattr(self, "disable_initiator_tag", False):
602
if getattr(self, "disable_initiator_tag", None) is not None:
547
603
gobject.source_remove(self.disable_initiator_tag)
548
604
self.disable_initiator_tag = None
549
605
self.expires = None
550
if getattr(self, "checker_initiator_tag", False):
606
if getattr(self, "checker_initiator_tag", None) is not None:
551
607
gobject.source_remove(self.checker_initiator_tag)
552
608
self.checker_initiator_tag = None
553
609
self.stop_checker()
554
610
self.enabled = False
612
self.send_changedstate()
555
613
# Do not run this again if called by a gobject.timeout_add
589
651
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,
654
def checked_ok(self):
655
"""Assert that the client has been seen, alive and well."""
656
self.last_checked_ok = datetime.datetime.utcnow()
657
self.last_checker_status = 0
660
def bump_timeout(self, timeout=None):
661
"""Bump up the timeout for this client."""
598
662
if timeout is None:
599
663
timeout = self.timeout
600
self.last_checked_ok = datetime.datetime.utcnow()
601
664
if self.disable_initiator_tag is not None:
602
665
gobject.source_remove(self.disable_initiator_tag)
666
self.disable_initiator_tag = None
603
667
if getattr(self, "enabled", False):
604
668
self.disable_initiator_tag = (gobject.timeout_add
605
669
(timedelta_to_milliseconds
615
679
If a checker already exists, leave it running and do
617
681
# 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
682
# did that, and if a checker (for some reason) started running
683
# slowly and taking more than 'interval' time, then the client
684
# would inevitably timeout, since no checker would get a
685
# chance to run to completion. If we instead leave running
622
686
# checkers alone, the checker would have to take more time
623
687
# than 'timeout' for the client to be disabled, which is as it
638
702
self.current_checker_command)
639
703
# Start a new checker if needed
640
704
if self.checker is None:
705
# Escape attributes for the shell
706
escaped_attrs = dict(
707
(attr, re.escape(unicode(getattr(self, attr))))
709
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
711
command = self.checker_command % escaped_attrs
712
except TypeError as error:
713
logger.error('Could not format string "%s"',
714
self.checker_command, exc_info=error)
715
return True # Try again later
660
716
self.current_checker_command = command
662
718
logger.info("Starting checker %r for %s",
665
721
# in normal mode, that is already done by daemon(),
666
722
# and in debug mode we don't want to. (Stdin is
667
723
# always replaced by /dev/null.)
724
# The exception is when not debugging but nevertheless
725
# running in the foreground; use the previously
728
if (not self.server_settings["debug"]
729
and self.server_settings["foreground"]):
730
popen_args.update({"stdout": wnull,
668
732
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.
736
except OSError as error:
737
logger.error("Failed to start subprocess",
740
self.checker_callback_tag = (gobject.child_watch_add
742
self.checker_callback,
744
# The checker may have completed before the gobject
745
# watch was added. Check for this.
677
747
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
748
except OSError as error:
682
logger.error("Failed to start subprocess: %s",
749
if error.errno == errno.ECHILD:
750
# This should never happen
751
logger.error("Child process vanished",
756
gobject.source_remove(self.checker_callback_tag)
757
self.checker_callback(pid, status, command)
684
758
# Re-run this periodically if run by gobject.timeout_add
810
def dbus_interface_annotations(dbus_interface):
811
"""Decorator for marking functions returning interface annotations
815
@dbus_interface_annotations("org.example.Interface")
816
def _foo(self): # Function name does not matter
817
return {"org.freedesktop.DBus.Deprecated": "true",
818
"org.freedesktop.DBus.Property.EmitsChangedSignal":
822
func._dbus_is_interface = True
823
func._dbus_interface = dbus_interface
824
func._dbus_name = dbus_interface
829
def dbus_annotations(annotations):
830
"""Decorator to annotate D-Bus methods, signals or properties
833
@dbus_service_property("org.example.Interface", signature="b",
835
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
836
"org.freedesktop.DBus.Property."
837
"EmitsChangedSignal": "false"})
838
def Property_dbus_property(self):
839
return dbus.Boolean(False)
842
func._dbus_annotations = annotations
736
847
class DBusPropertyException(dbus.exceptions.DBusException):
737
848
"""A base class for D-Bus property-related exceptions
764
def _is_dbus_property(obj):
765
return getattr(obj, "_dbus_is_property", False)
875
def _is_dbus_thing(thing):
876
"""Returns a function testing if an attribute is a D-Bus thing
878
If called like _is_dbus_thing("method") it returns a function
879
suitable for use as predicate to inspect.getmembers().
881
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
767
def _get_all_dbus_properties(self):
884
def _get_all_dbus_things(self, thing):
768
885
"""Returns a generator of (name, attribute) pairs
770
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
887
return ((getattr(athing.__get__(self), "_dbus_name",
889
athing.__get__(self))
771
890
for cls in self.__class__.__mro__
773
inspect.getmembers(cls, self._is_dbus_property))
892
inspect.getmembers(cls,
893
self._is_dbus_thing(thing)))
775
895
def _get_dbus_property(self, interface_name, property_name):
776
896
"""Returns a bound method if one exists which is a D-Bus
860
983
e.setAttribute("access", prop._dbus_access)
862
985
for if_tag in document.getElementsByTagName("interface"):
863
987
for tag in (make_tag(document, name, prop)
865
in self._get_all_dbus_properties()
989
in self._get_all_dbus_things("property")
866
990
if prop._dbus_interface
867
991
== if_tag.getAttribute("name")):
868
992
if_tag.appendChild(tag)
993
# Add annotation tags
994
for typ in ("method", "signal", "property"):
995
for tag in if_tag.getElementsByTagName(typ):
997
for name, prop in (self.
998
_get_all_dbus_things(typ)):
999
if (name == tag.getAttribute("name")
1000
and prop._dbus_interface
1001
== if_tag.getAttribute("name")):
1002
annots.update(getattr
1004
"_dbus_annotations",
1006
for name, value in annots.iteritems():
1007
ann_tag = document.createElement(
1009
ann_tag.setAttribute("name", name)
1010
ann_tag.setAttribute("value", value)
1011
tag.appendChild(ann_tag)
1012
# Add interface annotation tags
1013
for annotation, value in dict(
1014
itertools.chain.from_iterable(
1015
annotations().iteritems()
1016
for name, annotations in
1017
self._get_all_dbus_things("interface")
1018
if name == if_tag.getAttribute("name")
1020
ann_tag = document.createElement("annotation")
1021
ann_tag.setAttribute("name", annotation)
1022
ann_tag.setAttribute("value", value)
1023
if_tag.appendChild(ann_tag)
869
1024
# Add the names to the return values for the
870
1025
# "org.freedesktop.DBus.Properties" methods
871
1026
if (if_tag.getAttribute("name")
898
1053
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.
1056
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1057
"""A class decorator; applied to a subclass of
1058
dbus.service.Object, it will add alternate D-Bus attributes with
1059
interface names according to the "alt_interface_names" mapping.
1062
@alternate_dbus_interfaces({"org.example.Interface":
1063
"net.example.AlternateInterface"})
1064
class SampleDBusObject(dbus.service.Object):
1065
@dbus.service.method("org.example.Interface")
1066
def SampleDBusMethod():
1069
The above "SampleDBusMethod" on "SampleDBusObject" will be
1070
reachable via two interfaces: "org.example.Interface" and
1071
"net.example.AlternateInterface", the latter of which will have
1072
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1073
"true", unless "deprecate" is passed with a False value.
1075
This works for methods and signals, and also for D-Bus properties
1076
(from DBusObjectWithProperties) and interfaces (from the
1077
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):
1080
for orig_interface_name, alt_interface_name in (
1081
alt_interface_names.iteritems()):
1083
interface_names = set()
1084
# Go though all attributes of the class
1085
for attrname, attribute in inspect.getmembers(cls):
913
1086
# Ignore non-D-Bus attributes, and D-Bus attributes
914
1087
# with the wrong interface name
915
1088
if (not hasattr(attribute, "_dbus_interface")
916
1089
or not attribute._dbus_interface
917
.startswith("se.recompile.Mandos")):
1090
.startswith(orig_interface_name)):
919
1092
# Create an alternate D-Bus interface name based on
920
1093
# the current name
921
1094
alt_interface = (attribute._dbus_interface
922
.replace("se.recompile.Mandos",
923
"se.bsnet.fukt.Mandos"))
1095
.replace(orig_interface_name,
1096
alt_interface_name))
1097
interface_names.add(alt_interface)
924
1098
# Is this a D-Bus signal?
925
1099
if getattr(attribute, "_dbus_is_signal", False):
926
# Extract the original non-method function by
1100
# Extract the original non-method undecorated
1101
# function by black magic
928
1102
nonmethod_func = (dict(
929
1103
zip(attribute.func_code.co_freevars,
930
1104
attribute.__closure__))["func"]
941
1115
nonmethod_func.func_name,
942
1116
nonmethod_func.func_defaults,
943
1117
nonmethod_func.func_closure)))
1118
# Copy annotations, if any
1120
new_function._dbus_annotations = (
1121
dict(attribute._dbus_annotations))
1122
except AttributeError:
944
1124
# 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
1125
# original and alternate functions, so both the
1126
# original and alternate signals gets sent when
1127
# the function is called
947
1128
def fixscope(func1, func2):
948
1129
"""This function is a scope container to pass
949
1130
func1 and func2 to the "call_both" function
993
1179
attribute.func_name,
994
1180
attribute.func_defaults,
995
1181
attribute.func_closure)))
996
return type.__new__(mcs, name, bases, attr)
1182
# Copy annotations, if any
1184
attr[attrname]._dbus_annotations = (
1185
dict(attribute._dbus_annotations))
1186
except AttributeError:
1188
# Is this a D-Bus interface?
1189
elif getattr(attribute, "_dbus_is_interface", False):
1190
# Create a new, but exactly alike, function
1191
# object. Decorate it to be a new D-Bus interface
1192
# with the alternate D-Bus interface name. Add it
1194
attr[attrname] = (dbus_interface_annotations
1197
(attribute.func_code,
1198
attribute.func_globals,
1199
attribute.func_name,
1200
attribute.func_defaults,
1201
attribute.func_closure)))
1203
# Deprecate all alternate interfaces
1204
iname="_AlternateDBusNames_interface_annotation{0}"
1205
for interface_name in interface_names:
1206
@dbus_interface_annotations(interface_name)
1208
return { "org.freedesktop.DBus.Deprecated":
1210
# Find an unused name
1211
for aname in (iname.format(i)
1212
for i in itertools.count()):
1213
if aname not in attr:
1217
# Replace the class with a new subclass of it with
1218
# methods, signals, etc. as created above.
1219
cls = type(b"{0}Alternate".format(cls.__name__),
1225
@alternate_dbus_interfaces({"se.recompile.Mandos":
1226
"se.bsnet.fukt.Mandos"})
999
1227
class ClientDBus(Client, DBusObjectWithProperties):
1000
1228
"""A Client class using D-Bus
1328
1559
def Timeout_dbus_property(self, value=None):
1329
1560
if value is None: # get
1330
1561
return dbus.UInt64(self.timeout_milliseconds())
1562
old_timeout = self.timeout
1331
1563
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))
1564
# Reschedule disabling
1566
now = datetime.datetime.utcnow()
1567
self.expires += self.timeout - old_timeout
1568
if self.expires <= now:
1569
# The timeout has passed
1572
if (getattr(self, "disable_initiator_tag", None)
1575
gobject.source_remove(self.disable_initiator_tag)
1576
self.disable_initiator_tag = (
1577
gobject.timeout_add(
1578
timedelta_to_milliseconds(self.expires - now),
1353
1581
# ExtendedTimeout - property
1354
1582
@dbus_service_property(_interface, signature="t",
1707
1928
use_ipv6: Boolean; to use IPv6 or not
1709
1930
def __init__(self, server_address, RequestHandlerClass,
1710
interface=None, use_ipv6=True):
1931
interface=None, use_ipv6=True, socketfd=None):
1932
"""If socketfd is set, use that file descriptor instead of
1933
creating a new one with socket.socket().
1711
1935
self.interface = interface
1713
1937
self.address_family = socket.AF_INET6
1938
if socketfd is not None:
1939
# Save the file descriptor
1940
self.socketfd = socketfd
1941
# Save the original socket.socket() function
1942
self.socket_socket = socket.socket
1943
# To implement --socket, we monkey patch socket.socket.
1945
# (When socketserver.TCPServer is a new-style class, we
1946
# could make self.socket into a property instead of monkey
1947
# patching socket.socket.)
1949
# Create a one-time-only replacement for socket.socket()
1950
@functools.wraps(socket.socket)
1951
def socket_wrapper(*args, **kwargs):
1952
# Restore original function so subsequent calls are
1954
socket.socket = self.socket_socket
1955
del self.socket_socket
1956
# This time only, return a new socket object from the
1957
# saved file descriptor.
1958
return socket.fromfd(self.socketfd, *args, **kwargs)
1959
# Replace socket.socket() function with wrapper
1960
socket.socket = socket_wrapper
1961
# The socketserver.TCPServer.__init__ will call
1962
# socket.socket(), which might be our replacement,
1963
# socket_wrapper(), if socketfd was set.
1714
1964
socketserver.TCPServer.__init__(self, server_address,
1715
1965
RequestHandlerClass)
1716
1967
def server_bind(self):
1717
1968
"""This overrides the normal server_bind() function
1718
1969
to bind to an interface if one was specified, and also NOT to
1727
1978
self.socket.setsockopt(socket.SOL_SOCKET,
1728
1979
SO_BINDTODEVICE,
1980
str(self.interface + '\0'))
1731
1981
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:
1982
if error.errno == errno.EPERM:
1983
logger.error("No permission to bind to"
1984
" interface %s", self.interface)
1985
elif error.errno == errno.ENOPROTOOPT:
1737
1986
logger.error("SO_BINDTODEVICE not available;"
1738
1987
" cannot bind to interface %s",
1739
1988
self.interface)
1989
elif error.errno == errno.ENODEV:
1990
logger.error("Interface %s does not exist,"
1991
" cannot bind", self.interface)
1742
1994
# Only bind(2) the socket if we really need to.
1802
2055
def handle_ipc(self, source, condition, parent_pipe=None,
1803
2056
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
2057
# error, or the other end of multiprocessing.Pipe has closed
1819
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2058
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1820
2059
# Wait for other process to exit
2122
def rfc3339_duration_to_delta(duration):
2123
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2125
>>> rfc3339_duration_to_delta("P7D")
2126
datetime.timedelta(7)
2127
>>> rfc3339_duration_to_delta("PT60S")
2128
datetime.timedelta(0, 60)
2129
>>> rfc3339_duration_to_delta("PT60M")
2130
datetime.timedelta(0, 3600)
2131
>>> rfc3339_duration_to_delta("PT24H")
2132
datetime.timedelta(1)
2133
>>> rfc3339_duration_to_delta("P1W")
2134
datetime.timedelta(7)
2135
>>> rfc3339_duration_to_delta("PT5M30S")
2136
datetime.timedelta(0, 330)
2137
>>> rfc3339_duration_to_delta("P1DT3M20S")
2138
datetime.timedelta(1, 200)
2141
# Parsing an RFC 3339 duration with regular expressions is not
2142
# possible - there would have to be multiple places for the same
2143
# values, like seconds. The current code, while more esoteric, is
2144
# cleaner without depending on a parsing library. If Python had a
2145
# built-in library for parsing we would use it, but we'd like to
2146
# avoid excessive use of external libraries.
2148
# New type for defining tokens, syntax, and semantics all-in-one
2149
Token = collections.namedtuple("Token",
2150
("regexp", # To match token; if
2151
# "value" is not None,
2152
# must have a "group"
2154
"value", # datetime.timedelta or
2156
"followers")) # Tokens valid after
2158
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2159
# the "duration" ABNF definition in RFC 3339, Appendix A.
2160
token_end = Token(re.compile(r"$"), None, frozenset())
2161
token_second = Token(re.compile(r"(\d+)S"),
2162
datetime.timedelta(seconds=1),
2163
frozenset((token_end,)))
2164
token_minute = Token(re.compile(r"(\d+)M"),
2165
datetime.timedelta(minutes=1),
2166
frozenset((token_second, token_end)))
2167
token_hour = Token(re.compile(r"(\d+)H"),
2168
datetime.timedelta(hours=1),
2169
frozenset((token_minute, token_end)))
2170
token_time = Token(re.compile(r"T"),
2172
frozenset((token_hour, token_minute,
2174
token_day = Token(re.compile(r"(\d+)D"),
2175
datetime.timedelta(days=1),
2176
frozenset((token_time, token_end)))
2177
token_month = Token(re.compile(r"(\d+)M"),
2178
datetime.timedelta(weeks=4),
2179
frozenset((token_day, token_end)))
2180
token_year = Token(re.compile(r"(\d+)Y"),
2181
datetime.timedelta(weeks=52),
2182
frozenset((token_month, token_end)))
2183
token_week = Token(re.compile(r"(\d+)W"),
2184
datetime.timedelta(weeks=1),
2185
frozenset((token_end,)))
2186
token_duration = Token(re.compile(r"P"), None,
2187
frozenset((token_year, token_month,
2188
token_day, token_time,
2190
# Define starting values
2191
value = datetime.timedelta() # Value so far
2193
followers = frozenset(token_duration,) # Following valid tokens
2194
s = duration # String left to parse
2195
# Loop until end token is found
2196
while found_token is not token_end:
2197
# Search for any currently valid tokens
2198
for token in followers:
2199
match = token.regexp.match(s)
2200
if match is not None:
2202
if token.value is not None:
2203
# Value found, parse digits
2204
factor = int(match.group(1), 10)
2205
# Add to value so far
2206
value += factor * token.value
2207
# Strip token from string
2208
s = token.regexp.sub("", s, 1)
2211
# Set valid next tokens
2212
followers = found_token.followers
2215
# No currently valid tokens were found
2216
raise ValueError("Invalid RFC 3339 duration")
1883
2221
def string_to_delta(interval):
1884
2222
"""Parse a string and return a datetime.timedelta
1977
2322
parser.add_argument("--no-dbus", action="store_false",
1978
2323
dest="use_dbus", help="Do not provide D-Bus"
1979
" system bus interface")
2324
" system bus interface", default=None)
1980
2325
parser.add_argument("--no-ipv6", action="store_false",
1981
dest="use_ipv6", help="Do not use IPv6")
2326
dest="use_ipv6", help="Do not use IPv6",
1982
2328
parser.add_argument("--no-restore", action="store_false",
1983
2329
dest="restore", help="Do not restore stored"
2330
" state", default=None)
2331
parser.add_argument("--socket", type=int,
2332
help="Specify a file descriptor to a network"
2333
" socket to use instead of creating one")
1985
2334
parser.add_argument("--statedir", metavar="DIR",
1986
2335
help="Directory to save/restore state in")
2336
parser.add_argument("--foreground", action="store_true",
2337
help="Run in foreground", default=None)
1988
2339
options = parser.parse_args()
2015
2368
# Convert the SafeConfigParser object to a dict
2016
2369
server_settings = server_config.defaults()
2017
2370
# Use the appropriate methods on the non-string config options
2018
for option in ("debug", "use_dbus", "use_ipv6"):
2371
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2019
2372
server_settings[option] = server_config.getboolean("DEFAULT",
2021
2374
if server_settings["port"]:
2022
2375
server_settings["port"] = server_config.getint("DEFAULT",
2377
if server_settings["socket"]:
2378
server_settings["socket"] = server_config.getint("DEFAULT",
2380
# Later, stdin will, and stdout and stderr might, be dup'ed
2381
# over with an opened os.devnull. But we don't want this to
2382
# happen with a supplied network socket.
2383
if 0 <= server_settings["socket"] <= 2:
2384
server_settings["socket"] = os.dup(server_settings
2024
2386
del server_config
2026
2388
# Override the settings from the config file with command line
2048
2417
use_ipv6 = server_settings["use_ipv6"]
2049
2418
stored_state_path = os.path.join(server_settings["statedir"],
2050
2419
stored_state_file)
2420
foreground = server_settings["foreground"]
2053
initlogger(logging.DEBUG)
2423
initlogger(debug, logging.DEBUG)
2055
2425
if not debuglevel:
2058
2428
level = getattr(logging, debuglevel.upper())
2429
initlogger(debug, level)
2061
2431
if server_settings["servicename"] != "Mandos":
2062
2432
syslogger.setFormatter(logging.Formatter
2063
('Mandos (%s) [%%(process)d]:'
2064
' %%(levelname)s: %%(message)s'
2065
% server_settings["servicename"]))
2433
('Mandos ({0}) [%(process)d]:'
2434
' %(levelname)s: %(message)s'
2435
.format(server_settings
2067
2438
# 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)
2439
client_config = configparser.SafeConfigParser(Client
2077
2441
client_config.read(os.path.join(server_settings["configdir"],
2078
2442
"clients.conf"))
2088
2452
use_ipv6=use_ipv6,
2089
2453
gnutls_priority=
2090
2454
server_settings["priority"],
2093
pidfilename = "/var/run/mandos.pid"
2456
socketfd=(server_settings["socket"]
2459
pidfilename = "/run/mandos.pid"
2095
2462
pidfile = open(pidfilename, "w")
2097
logger.error("Could not open file %r", pidfilename)
2463
except IOError as e:
2464
logger.error("Could not open file %r", pidfilename,
2100
uid = pwd.getpwnam("_mandos").pw_uid
2101
gid = pwd.getpwnam("_mandos").pw_gid
2467
for name in ("_mandos", "mandos", "nobody"):
2104
uid = pwd.getpwnam("mandos").pw_uid
2105
gid = pwd.getpwnam("mandos").pw_gid
2469
uid = pwd.getpwnam(name).pw_uid
2470
gid = pwd.getpwnam(name).pw_gid
2106
2472
except KeyError:
2108
uid = pwd.getpwnam("nobody").pw_uid
2109
gid = pwd.getpwnam("nobody").pw_gid
2116
2480
except OSError as error:
2117
if error[0] != errno.EPERM:
2481
if error.errno != errno.EPERM:
2132
2496
.gnutls_global_set_log_function(debug_gnutls))
2134
2498
# Redirect stdin so all checkers get /dev/null
2135
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2499
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2136
2500
os.dup2(null, sys.stdin.fileno())
2140
# No console logging
2141
logger.removeHandler(console)
2143
2504
# Need to fork before connecting to D-Bus
2145
2506
# Close all input and output, do double fork, etc.
2509
# multiprocessing will use threads, so before we use gobject we
2510
# need to inform gobject that threads will be used.
2511
gobject.threads_init()
2148
2513
global main_loop
2149
2514
# From the Avahi example code
2150
DBusGMainLoop(set_as_default=True )
2515
DBusGMainLoop(set_as_default=True)
2151
2516
main_loop = gobject.MainLoop()
2152
2517
bus = dbus.SystemBus()
2153
2518
# End of Avahi example code
2178
2543
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())
2545
client_class = functools.partial(ClientDBus, bus = bus)
2547
client_settings = Client.config_parser(client_config)
2206
2548
old_client_settings = {}
2551
# This is used to redirect stdout and stderr for checker processes
2553
wnull = open(os.devnull, "w") # A writable /dev/null
2554
# Only used if server is running in foreground but not in debug
2556
if debug or not foreground:
2209
2559
# Get client data and settings from last running state.
2210
2560
if server_settings["restore"]:
2214
2564
(stored_state))
2215
2565
os.remove(stored_state_path)
2216
2566
except IOError as e:
2217
logger.warning("Could not load persistent state: {0}"
2219
if e.errno != errno.ENOENT:
2567
if e.errno == errno.ENOENT:
2568
logger.warning("Could not load persistent state: {0}"
2569
.format(os.strerror(e.errno)))
2571
logger.critical("Could not load persistent state:",
2574
except EOFError as e:
2575
logger.warning("Could not load persistent state: "
2576
"EOFError:", exc_info=e)
2222
2578
with PGPEngine() as pgp:
2223
for client in clients_data:
2224
client_name = client["name"]
2579
for client_name, client in clients_data.iteritems():
2580
# Skip removed clients
2581
if client_name not in client_settings:
2226
2584
# Decide which value to use after restoring saved state.
2227
2585
# We have three different values: Old config file,
2236
2594
if (name != "secret" and
2237
2595
value != old_client_settings[client_name]
2239
setattr(client, name, value)
2597
client[name] = value
2240
2598
except KeyError:
2243
2601
# 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.
2602
# enabled if its last checker was successful. Clients
2603
# whose checker succeeded before we stored its state is
2604
# assumed to have successfully run all checkers during
2247
2606
if client["enabled"]:
2248
if client["expires"] <= (datetime.datetime
2250
# Client has expired
2251
if client["last_checker_status"] != 0:
2607
if datetime.datetime.utcnow() >= client["expires"]:
2608
if not client["last_checked_ok"]:
2610
"disabling client {0} - Client never "
2611
"performed a successful checker"
2612
.format(client_name))
2613
client["enabled"] = False
2614
elif client["last_checker_status"] != 0:
2616
"disabling client {0} - Client "
2617
"last checker failed with error code {1}"
2618
.format(client_name,
2619
client["last_checker_status"]))
2252
2620
client["enabled"] = False
2254
2622
client["expires"] = (datetime.datetime
2256
2624
+ 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],
2625
logger.debug("Last checker succeeded,"
2626
" keeping {0} enabled"
2627
.format(client_name))
2287
tcp_server.clients[client_name].secret = (
2288
pgp.decrypt(tcp_server.clients[client_name]
2629
client["secret"] = (
2630
pgp.decrypt(client["encrypted_secret"],
2290
2631
client_settings[client_name]
2292
2633
except PGPError:
2293
2634
# If decryption fails, we use secret from new settings
2294
2635
logger.debug("Failed to decrypt {0} old secret"
2295
2636
.format(client_name))
2296
tcp_server.clients[client_name].secret = (
2637
client["secret"] = (
2297
2638
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
2640
# Add/remove clients based on new changes made to config
2641
for client_name in (set(old_client_settings)
2642
- set(client_settings)):
2643
del clients_data[client_name]
2644
for client_name in (set(client_settings)
2645
- set(old_client_settings)):
2646
clients_data[client_name] = client_settings[client_name]
2648
# Create all client objects
2649
for client_name, client in clients_data.iteritems():
2650
tcp_server.clients[client_name] = client_class(
2651
name = client_name, settings = client,
2652
server_settings = server_settings)
2309
2654
if not tcp_server.clients:
2310
2655
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
2658
if pidfile is not None:
2662
pidfile.write(str(pid) + "\n".encode("utf-8"))
2664
logger.error("Could not write to file %r with PID %d",
2324
2667
del pidfilename
2326
signal.signal(signal.SIGINT, signal.SIG_IGN)
2328
2669
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2329
2670
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2332
class MandosDBusService(dbus.service.Object):
2673
@alternate_dbus_interfaces({"se.recompile.Mandos":
2674
"se.bsnet.fukt.Mandos"})
2675
class MandosDBusService(DBusObjectWithProperties):
2333
2676
"""A D-Bus proxy object"""
2334
2677
def __init__(self):
2335
2678
dbus.service.Object.__init__(self, bus, "/")
2336
2679
_interface = "se.recompile.Mandos"
2681
@dbus_interface_annotations(_interface)
2683
return { "org.freedesktop.DBus.Property"
2684
".EmitsChangedSignal":
2338
2687
@dbus.service.signal(_interface, signature="o")
2339
2688
def ClientAdded(self, objpath):
2418
2767
if attr not in exclude:
2419
2768
client_dict[attr] = getattr(client, attr)
2421
clients.append(client_dict)
2770
clients[client.name] = client_dict
2422
2771
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:
2774
with (tempfile.NamedTemporaryFile
2775
(mode='wb', suffix=".pickle", prefix='clients-',
2776
dir=os.path.dirname(stored_state_path),
2777
delete=False)) as stored_state:
2428
2778
pickle.dump((clients, client_settings), stored_state)
2779
tempname=stored_state.name
2780
os.rename(tempname, stored_state_path)
2429
2781
except (IOError, OSError) as e:
2430
logger.warning("Could not save persistent state: {0}"
2432
if e.errno not in (errno.ENOENT, errno.EACCES):
2787
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2788
logger.warning("Could not save persistent state: {0}"
2789
.format(os.strerror(e.errno)))
2791
logger.warning("Could not save persistent state:",
2435
2795
# Delete all clients, and settings from config
2436
2796
while tcp_server.clients: