175
170
def password_encode(self, password):
176
171
# Passphrase can not be empty and can not contain newlines or
177
172
# NUL bytes. So we prefix it and hex encode it.
178
encoded = b"mandos" + binascii.hexlify(password)
179
if len(encoded) > 2048:
180
# GnuPG can't handle long passwords, so encode differently
181
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
182
.replace(b"\n", b"\\n")
183
.replace(b"\0", b"\\x00"))
173
return b"mandos" + binascii.hexlify(password)
186
175
def encrypt(self, data, password):
187
passphrase = self.password_encode(password)
188
with tempfile.NamedTemporaryFile(dir=self.tempdir
190
passfile.write(passphrase)
192
proc = subprocess.Popen(['gpg', '--symmetric',
196
stdin = subprocess.PIPE,
197
stdout = subprocess.PIPE,
198
stderr = subprocess.PIPE)
199
ciphertext, err = proc.communicate(input = data)
200
if proc.returncode != 0:
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
202
190
return ciphertext
204
192
def decrypt(self, data, password):
205
passphrase = self.password_encode(password)
206
with tempfile.NamedTemporaryFile(dir = self.tempdir
208
passfile.write(passphrase)
210
proc = subprocess.Popen(['gpg', '--decrypt',
214
stdin = subprocess.PIPE,
215
stdout = subprocess.PIPE,
216
stderr = subprocess.PIPE)
217
decrypted_plaintext, err = proc.communicate(input
219
if proc.returncode != 0:
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
221
207
return decrypted_plaintext
224
211
class AvahiError(Exception):
225
212
def __init__(self, value, *args, **kwargs):
226
213
self.value = value
389
368
self.server_state_changed)
390
369
self.server_state_changed(self.server.GetState())
393
371
class AvahiServiceToSyslog(AvahiService):
394
372
def rename(self):
395
373
"""Add the new name to the syslog messages"""
396
374
ret = AvahiService.rename(self)
397
375
syslogger.setFormatter(logging.Formatter
398
('Mandos ({}) [%(process)d]:'
399
' %(levelname)s: %(message)s'
376
('Mandos (%s) [%%(process)d]:'
377
' %%(levelname)s: %%(message)s'
381
def timedelta_to_milliseconds(td):
382
"Convert a datetime.timedelta() to milliseconds"
383
return ((td.days * 24 * 60 * 60 * 1000)
384
+ (td.seconds * 1000)
385
+ (td.microseconds // 1000))
404
387
class Client(object):
405
388
"""A representation of a client host served by this server.
431
414
last_checked_ok: datetime.datetime(); (UTC) or None
432
415
last_checker_status: integer between 0 and 255 reflecting exit
433
416
status of last checker. -1 reflects crashed
434
checker, -2 means no checker completed yet.
435
418
last_enabled: datetime.datetime(); (UTC) or None
436
419
name: string; from the config file, used in log messages and
437
420
D-Bus identifiers
438
421
secret: bytestring; sent verbatim (over TLS) to client
439
422
timeout: datetime.timedelta(); How long from last_checked_ok
440
423
until this client is disabled
441
extended_timeout: extra long timeout when secret has been sent
424
extended_timeout: extra long timeout when password has been sent
442
425
runtime_expansions: Allowed attributes for runtime expansion.
443
426
expires: datetime.datetime(); time (UTC) when a client will be
444
427
disabled, or None
445
server_settings: The server_settings dict from main()
448
430
runtime_expansions = ("approval_delay", "approval_duration",
449
"created", "enabled", "expires",
450
"fingerprint", "host", "interval",
451
"last_approval_request", "last_checked_ok",
431
"created", "enabled", "fingerprint",
432
"host", "interval", "last_checked_ok",
452
433
"last_enabled", "name", "timeout")
453
client_defaults = { "timeout": "PT5M",
454
"extended_timeout": "PT15M",
434
client_defaults = { "timeout": "5m",
435
"extended_timeout": "15m",
456
437
"checker": "fping -q -- %%(host)s",
458
"approval_delay": "PT0S",
459
"approval_duration": "PT1S",
439
"approval_delay": "0s",
440
"approval_duration": "1s",
460
441
"approved_by_default": "True",
461
442
"enabled": "True",
445
def timeout_milliseconds(self):
446
"Return the 'timeout' attribute in milliseconds"
447
return timedelta_to_milliseconds(self.timeout)
449
def extended_timeout_milliseconds(self):
450
"Return the 'extended_timeout' attribute in milliseconds"
451
return timedelta_to_milliseconds(self.extended_timeout)
453
def interval_milliseconds(self):
454
"Return the 'interval' attribute in milliseconds"
455
return timedelta_to_milliseconds(self.interval)
457
def approval_delay_milliseconds(self):
458
return timedelta_to_milliseconds(self.approval_delay)
465
461
def config_parser(config):
466
"""Construct a new dict of client settings of this form:
462
""" Construct a new dict of client settings of this form:
467
463
{ client_name: {setting_name: value, ...}, ...}
468
with exceptions for any special settings as defined above.
469
NOTE: Must be a pure function. Must return the same result
470
value given the same arguments.
464
with exceptions for any special settings as defined above"""
473
466
for client_name in config.sections():
474
467
section = dict(config.items(client_name))
504
496
client["checker_command"] = section["checker"]
505
497
client["last_approval_request"] = None
506
498
client["last_checked_ok"] = None
507
client["last_checker_status"] = -2
499
client["last_checker_status"] = None
500
if client["enabled"]:
501
client["last_enabled"] = datetime.datetime.utcnow()
502
client["expires"] = (datetime.datetime.utcnow()
505
client["last_enabled"] = None
506
client["expires"] = None
511
def __init__(self, settings, name = None, server_settings=None):
511
def __init__(self, settings, name = None):
512
"""Note: the 'checker' key in 'config' sets the
513
'checker_command' attribute and *not* the 'checker'
513
if server_settings is None:
515
self.server_settings = server_settings
516
516
# adding all client settings
517
for setting, value in settings.items():
517
for setting, value in settings.iteritems():
518
518
setattr(self, setting, value)
521
if not hasattr(self, "last_enabled"):
522
self.last_enabled = datetime.datetime.utcnow()
523
if not hasattr(self, "expires"):
524
self.expires = (datetime.datetime.utcnow()
527
self.last_enabled = None
530
520
logger.debug("Creating client %r", self.name)
531
521
# Uppercase and remove spaces from fingerprint for later
532
522
# comparison purposes with return value from the fingerprint()
534
524
logger.debug(" Fingerprint: %s", self.fingerprint)
535
self.created = settings.get("created",
536
datetime.datetime.utcnow())
525
self.created = settings.get("created", datetime.datetime.utcnow())
538
527
# attributes specific for this server instance
539
528
self.checker = None
540
529
self.checker_initiator_tag = None
568
557
if getattr(self, "enabled", False):
569
558
# Already enabled
560
self.send_changedstate()
571
561
self.expires = datetime.datetime.utcnow() + self.timeout
572
562
self.enabled = True
573
563
self.last_enabled = datetime.datetime.utcnow()
574
564
self.init_checker()
575
self.send_changedstate()
577
566
def disable(self, quiet=True):
578
567
"""Disable this client."""
579
568
if not getattr(self, "enabled", False):
571
self.send_changedstate()
582
573
logger.info("Disabling client %s", self.name)
583
if getattr(self, "disable_initiator_tag", None) is not None:
574
if getattr(self, "disable_initiator_tag", False):
584
575
gobject.source_remove(self.disable_initiator_tag)
585
576
self.disable_initiator_tag = None
586
577
self.expires = None
587
if getattr(self, "checker_initiator_tag", None) is not None:
578
if getattr(self, "checker_initiator_tag", False):
588
579
gobject.source_remove(self.checker_initiator_tag)
589
580
self.checker_initiator_tag = None
590
581
self.stop_checker()
591
582
self.enabled = False
593
self.send_changedstate()
594
583
# Do not run this again if called by a gobject.timeout_add
600
589
def init_checker(self):
601
590
# Schedule a new checker to be started an 'interval' from now,
602
591
# and every interval from then on.
603
if self.checker_initiator_tag is not None:
604
gobject.source_remove(self.checker_initiator_tag)
605
592
self.checker_initiator_tag = (gobject.timeout_add
607
.total_seconds() * 1000),
593
(self.interval_milliseconds(),
608
594
self.start_checker))
609
595
# Schedule a disable() when 'timeout' has passed
610
if self.disable_initiator_tag is not None:
611
gobject.source_remove(self.disable_initiator_tag)
612
596
self.disable_initiator_tag = (gobject.timeout_add
614
.total_seconds() * 1000),
597
(self.timeout_milliseconds(),
616
599
# Also start a new checker *right now*.
617
600
self.start_checker()
634
617
logger.warning("Checker for %(name)s crashed?",
637
def checked_ok(self):
638
"""Assert that the client has been seen, alive and well."""
639
self.last_checked_ok = datetime.datetime.utcnow()
640
self.last_checker_status = 0
643
def bump_timeout(self, timeout=None):
644
"""Bump up the timeout for this client."""
620
def checked_ok(self, timeout=None):
621
"""Bump up the timeout for this client.
623
This should only be called when the client has been seen,
645
626
if timeout is None:
646
627
timeout = self.timeout
628
self.last_checked_ok = datetime.datetime.utcnow()
647
629
if self.disable_initiator_tag is not None:
648
630
gobject.source_remove(self.disable_initiator_tag)
649
self.disable_initiator_tag = None
650
631
if getattr(self, "enabled", False):
651
632
self.disable_initiator_tag = (gobject.timeout_add
652
(int(timeout.total_seconds()
653
* 1000), self.disable))
633
(timedelta_to_milliseconds
634
(timeout), self.disable))
654
635
self.expires = datetime.datetime.utcnow() + timeout
656
637
def need_approval(self):
662
643
If a checker already exists, leave it running and do
664
645
# The reason for not killing a running checker is that if we
665
# did that, and if a checker (for some reason) started running
666
# slowly and taking more than 'interval' time, then the client
667
# would inevitably timeout, since no checker would get a
668
# chance to run to completion. If we instead leave running
646
# did that, then if a checker (for some reason) started
647
# running slowly and taking more than 'interval' time, the
648
# client would inevitably timeout, since no checker would get
649
# a chance to run to completion. If we instead leave running
669
650
# checkers alone, the checker would have to take more time
670
651
# than 'timeout' for the client to be disabled, which is as it
686
666
self.current_checker_command)
687
667
# Start a new checker if needed
688
668
if self.checker is None:
689
# Escape attributes for the shell
690
escaped_attrs = { attr:
691
re.escape(unicode(getattr(self,
693
for attr in self.runtime_expansions }
695
command = self.checker_command % escaped_attrs
696
except TypeError as error:
697
logger.error('Could not format string "%s"',
698
self.checker_command, exc_info=error)
699
return True # Try again later
670
# In case checker_command has exactly one % operator
671
command = self.checker_command % self.host
673
# Escape attributes for the shell
674
escaped_attrs = dict(
676
re.escape(unicode(str(getattr(self, attr, "")),
680
self.runtime_expansions)
683
command = self.checker_command % escaped_attrs
684
except TypeError as error:
685
logger.error('Could not format string "%s":'
686
' %s', self.checker_command, error)
687
return True # Try again later
700
688
self.current_checker_command = command
702
690
logger.info("Starting checker %r for %s",
705
693
# in normal mode, that is already done by daemon(),
706
694
# and in debug mode we don't want to. (Stdin is
707
695
# always replaced by /dev/null.)
708
# The exception is when not debugging but nevertheless
709
# running in the foreground; use the previously
712
if (not self.server_settings["debug"]
713
and self.server_settings["foreground"]):
714
popen_args.update({"stdout": wnull,
716
696
self.checker = subprocess.Popen(command,
720
except OSError as error:
721
logger.error("Failed to start subprocess",
724
self.checker_callback_tag = (gobject.child_watch_add
726
self.checker_callback,
728
# The checker may have completed before the gobject
729
# watch was added. Check for this.
699
self.checker_callback_tag = (gobject.child_watch_add
701
self.checker_callback,
703
# The checker may have completed before the gobject
704
# watch was added. Check for this.
731
705
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
707
gobject.source_remove(self.checker_callback_tag)
708
self.checker_callback(pid, status, command)
732
709
except OSError as error:
733
if error.errno == errno.ECHILD:
734
# This should never happen
735
logger.error("Child process vanished",
740
gobject.source_remove(self.checker_callback_tag)
741
self.checker_callback(pid, status, command)
710
logger.error("Failed to start subprocess: %s",
742
712
# Re-run this periodically if run by gobject.timeout_add
794
def dbus_interface_annotations(dbus_interface):
795
"""Decorator for marking functions returning interface annotations
799
@dbus_interface_annotations("org.example.Interface")
800
def _foo(self): # Function name does not matter
801
return {"org.freedesktop.DBus.Deprecated": "true",
802
"org.freedesktop.DBus.Property.EmitsChangedSignal":
806
func._dbus_is_interface = True
807
func._dbus_interface = dbus_interface
808
func._dbus_name = dbus_interface
813
def dbus_annotations(annotations):
814
"""Decorator to annotate D-Bus methods, signals or properties
817
@dbus_service_property("org.example.Interface", signature="b",
819
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
820
"org.freedesktop.DBus.Property."
821
"EmitsChangedSignal": "false"})
822
def Property_dbus_property(self):
823
return dbus.Boolean(False)
826
func._dbus_annotations = annotations
831
764
class DBusPropertyException(dbus.exceptions.DBusException):
832
765
"""A base class for D-Bus property-related exceptions
859
def _is_dbus_thing(thing):
860
"""Returns a function testing if an attribute is a D-Bus thing
862
If called like _is_dbus_thing("method") it returns a function
863
suitable for use as predicate to inspect.getmembers().
865
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
792
def _is_dbus_property(obj):
793
return getattr(obj, "_dbus_is_property", False)
868
def _get_all_dbus_things(self, thing):
795
def _get_all_dbus_properties(self):
869
796
"""Returns a generator of (name, attribute) pairs
871
return ((getattr(athing.__get__(self), "_dbus_name",
873
athing.__get__(self))
798
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
874
799
for cls in self.__class__.__mro__
876
inspect.getmembers(cls,
877
self._is_dbus_thing(thing)))
801
inspect.getmembers(cls, self._is_dbus_property))
879
803
def _get_dbus_property(self, interface_name, property_name):
880
804
"""Returns a bound method if one exists which is a D-Bus
969
888
e.setAttribute("access", prop._dbus_access)
971
890
for if_tag in document.getElementsByTagName("interface"):
973
891
for tag in (make_tag(document, name, prop)
975
in self._get_all_dbus_things("property")
893
in self._get_all_dbus_properties()
976
894
if prop._dbus_interface
977
895
== if_tag.getAttribute("name")):
978
896
if_tag.appendChild(tag)
979
# Add annotation tags
980
for typ in ("method", "signal", "property"):
981
for tag in if_tag.getElementsByTagName(typ):
983
for name, prop in (self.
984
_get_all_dbus_things(typ)):
985
if (name == tag.getAttribute("name")
986
and prop._dbus_interface
987
== if_tag.getAttribute("name")):
988
annots.update(getattr
992
for name, value in annots.items():
993
ann_tag = document.createElement(
995
ann_tag.setAttribute("name", name)
996
ann_tag.setAttribute("value", value)
997
tag.appendChild(ann_tag)
998
# Add interface annotation tags
999
for annotation, value in dict(
1000
itertools.chain.from_iterable(
1001
annotations().items()
1002
for name, annotations in
1003
self._get_all_dbus_things("interface")
1004
if name == if_tag.getAttribute("name")
1006
ann_tag = document.createElement("annotation")
1007
ann_tag.setAttribute("name", annotation)
1008
ann_tag.setAttribute("value", value)
1009
if_tag.appendChild(ann_tag)
1010
897
# Add the names to the return values for the
1011
898
# "org.freedesktop.DBus.Properties" methods
1012
899
if (if_tag.getAttribute("name")
1039
926
variant_level=variant_level)
1042
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1043
"""A class decorator; applied to a subclass of
1044
dbus.service.Object, it will add alternate D-Bus attributes with
1045
interface names according to the "alt_interface_names" mapping.
1048
@alternate_dbus_interfaces({"org.example.Interface":
1049
"net.example.AlternateInterface"})
1050
class SampleDBusObject(dbus.service.Object):
1051
@dbus.service.method("org.example.Interface")
1052
def SampleDBusMethod():
1055
The above "SampleDBusMethod" on "SampleDBusObject" will be
1056
reachable via two interfaces: "org.example.Interface" and
1057
"net.example.AlternateInterface", the latter of which will have
1058
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1059
"true", unless "deprecate" is passed with a False value.
1061
This works for methods and signals, and also for D-Bus properties
1062
(from DBusObjectWithProperties) and interfaces (from the
1063
dbus_interface_annotations decorator).
929
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
931
"""Applied to an empty subclass of a D-Bus object, this metaclass
932
will add additional D-Bus attributes matching a certain pattern.
1066
for orig_interface_name, alt_interface_name in (
1067
alt_interface_names.items()):
1069
interface_names = set()
1070
# Go though all attributes of the class
1071
for attrname, attribute in inspect.getmembers(cls):
934
def __new__(mcs, name, bases, attr):
935
# Go through all the base classes which could have D-Bus
936
# methods, signals, or properties in them
937
for base in (b for b in bases
938
if issubclass(b, dbus.service.Object)):
939
# Go though all attributes of the base class
940
for attrname, attribute in inspect.getmembers(base):
1072
941
# Ignore non-D-Bus attributes, and D-Bus attributes
1073
942
# with the wrong interface name
1074
943
if (not hasattr(attribute, "_dbus_interface")
1075
944
or not attribute._dbus_interface
1076
.startswith(orig_interface_name)):
945
.startswith("se.recompile.Mandos")):
1078
947
# Create an alternate D-Bus interface name based on
1079
948
# the current name
1080
949
alt_interface = (attribute._dbus_interface
1081
.replace(orig_interface_name,
1082
alt_interface_name))
1083
interface_names.add(alt_interface)
950
.replace("se.recompile.Mandos",
951
"se.bsnet.fukt.Mandos"))
1084
952
# Is this a D-Bus signal?
1085
953
if getattr(attribute, "_dbus_is_signal", False):
1086
# Extract the original non-method undecorated
1087
# function by black magic
954
# Extract the original non-method function by
1088
956
nonmethod_func = (dict(
1089
957
zip(attribute.func_code.co_freevars,
1090
958
attribute.__closure__))["func"]
1101
969
nonmethod_func.func_name,
1102
970
nonmethod_func.func_defaults,
1103
971
nonmethod_func.func_closure)))
1104
# Copy annotations, if any
1106
new_function._dbus_annotations = (
1107
dict(attribute._dbus_annotations))
1108
except AttributeError:
1110
972
# Define a creator of a function to call both the
1111
# original and alternate functions, so both the
1112
# original and alternate signals gets sent when
1113
# the function is called
973
# old and new functions, so both the old and new
974
# signals gets sent when the function is called
1114
975
def fixscope(func1, func2):
1115
976
"""This function is a scope container to pass
1116
977
func1 and func2 to the "call_both" function
1165
1021
attribute.func_name,
1166
1022
attribute.func_defaults,
1167
1023
attribute.func_closure)))
1168
# Copy annotations, if any
1170
attr[attrname]._dbus_annotations = (
1171
dict(attribute._dbus_annotations))
1172
except AttributeError:
1174
# Is this a D-Bus interface?
1175
elif getattr(attribute, "_dbus_is_interface", False):
1176
# Create a new, but exactly alike, function
1177
# object. Decorate it to be a new D-Bus interface
1178
# with the alternate D-Bus interface name. Add it
1180
attr[attrname] = (dbus_interface_annotations
1183
(attribute.func_code,
1184
attribute.func_globals,
1185
attribute.func_name,
1186
attribute.func_defaults,
1187
attribute.func_closure)))
1189
# Deprecate all alternate interfaces
1190
iname="_AlternateDBusNames_interface_annotation{}"
1191
for interface_name in interface_names:
1192
@dbus_interface_annotations(interface_name)
1194
return { "org.freedesktop.DBus.Deprecated":
1196
# Find an unused name
1197
for aname in (iname.format(i)
1198
for i in itertools.count()):
1199
if aname not in attr:
1203
# Replace the class with a new subclass of it with
1204
# methods, signals, etc. as created above.
1205
cls = type(b"{}Alternate".format(cls.__name__),
1211
@alternate_dbus_interfaces({"se.recompile.Mandos":
1212
"se.bsnet.fukt.Mandos"})
1024
return type.__new__(mcs, name, bases, attr)
1213
1027
class ClientDBus(Client, DBusObjectWithProperties):
1214
1028
"""A Client class using D-Bus
1285
1101
approval_delay = notifychangeproperty(dbus.UInt64,
1286
1102
"ApprovalDelay",
1288
lambda td: td.total_seconds()
1104
timedelta_to_milliseconds)
1290
1105
approval_duration = notifychangeproperty(
1291
1106
dbus.UInt64, "ApprovalDuration",
1292
type_func = lambda td: td.total_seconds() * 1000)
1107
type_func = timedelta_to_milliseconds)
1293
1108
host = notifychangeproperty(dbus.String, "Host")
1294
1109
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1295
type_func = lambda td:
1296
td.total_seconds() * 1000)
1111
timedelta_to_milliseconds)
1297
1112
extended_timeout = notifychangeproperty(
1298
1113
dbus.UInt64, "ExtendedTimeout",
1299
type_func = lambda td: td.total_seconds() * 1000)
1114
type_func = timedelta_to_milliseconds)
1300
1115
interval = notifychangeproperty(dbus.UInt64,
1303
lambda td: td.total_seconds()
1118
timedelta_to_milliseconds)
1305
1119
checker_command = notifychangeproperty(dbus.String, "Checker")
1307
1121
del notifychangeproperty
1542
1356
access="readwrite")
1543
1357
def Timeout_dbus_property(self, value=None):
1544
1358
if value is None: # get
1545
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1546
old_timeout = self.timeout
1359
return dbus.UInt64(self.timeout_milliseconds())
1547
1360
self.timeout = datetime.timedelta(0, 0, 0, value)
1548
# Reschedule disabling
1550
now = datetime.datetime.utcnow()
1551
self.expires += self.timeout - old_timeout
1552
if self.expires <= now:
1553
# The timeout has passed
1556
if (getattr(self, "disable_initiator_tag", None)
1559
gobject.source_remove(self.disable_initiator_tag)
1560
self.disable_initiator_tag = (
1561
gobject.timeout_add(
1562
int((self.expires - now).total_seconds()
1563
* 1000), self.disable))
1361
if getattr(self, "disable_initiator_tag", None) is None:
1363
# Reschedule timeout
1364
gobject.source_remove(self.disable_initiator_tag)
1365
self.disable_initiator_tag = None
1367
time_to_die = timedelta_to_milliseconds((self
1372
if time_to_die <= 0:
1373
# The timeout has passed
1376
self.expires = (datetime.datetime.utcnow()
1377
+ datetime.timedelta(milliseconds =
1379
self.disable_initiator_tag = (gobject.timeout_add
1380
(time_to_die, self.disable))
1565
1382
# ExtendedTimeout - property
1566
1383
@dbus_service_property(_interface, signature="t",
1567
1384
access="readwrite")
1568
1385
def ExtendedTimeout_dbus_property(self, value=None):
1569
1386
if value is None: # get
1570
return dbus.UInt64(self.extended_timeout.total_seconds()
1387
return dbus.UInt64(self.extended_timeout_milliseconds())
1572
1388
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1574
1390
# Interval - property
1911
1736
use_ipv6: Boolean; to use IPv6 or not
1913
1738
def __init__(self, server_address, RequestHandlerClass,
1914
interface=None, use_ipv6=True, socketfd=None):
1915
"""If socketfd is set, use that file descriptor instead of
1916
creating a new one with socket.socket().
1739
interface=None, use_ipv6=True):
1918
1740
self.interface = interface
1920
1742
self.address_family = socket.AF_INET6
1921
if socketfd is not None:
1922
# Save the file descriptor
1923
self.socketfd = socketfd
1924
# Save the original socket.socket() function
1925
self.socket_socket = socket.socket
1926
# To implement --socket, we monkey patch socket.socket.
1928
# (When socketserver.TCPServer is a new-style class, we
1929
# could make self.socket into a property instead of monkey
1930
# patching socket.socket.)
1932
# Create a one-time-only replacement for socket.socket()
1933
@functools.wraps(socket.socket)
1934
def socket_wrapper(*args, **kwargs):
1935
# Restore original function so subsequent calls are
1937
socket.socket = self.socket_socket
1938
del self.socket_socket
1939
# This time only, return a new socket object from the
1940
# saved file descriptor.
1941
return socket.fromfd(self.socketfd, *args, **kwargs)
1942
# Replace socket.socket() function with wrapper
1943
socket.socket = socket_wrapper
1944
# The socketserver.TCPServer.__init__ will call
1945
# socket.socket(), which might be our replacement,
1946
# socket_wrapper(), if socketfd was set.
1947
1743
socketserver.TCPServer.__init__(self, server_address,
1948
1744
RequestHandlerClass)
1950
1745
def server_bind(self):
1951
1746
"""This overrides the normal server_bind() function
1952
1747
to bind to an interface if one was specified, and also NOT to
1961
1756
self.socket.setsockopt(socket.SOL_SOCKET,
1962
1757
SO_BINDTODEVICE,
1963
str(self.interface + '\0'))
1964
1760
except socket.error as error:
1965
if error.errno == errno.EPERM:
1966
logger.error("No permission to bind to"
1967
" interface %s", self.interface)
1968
elif error.errno == errno.ENOPROTOOPT:
1761
if error[0] == errno.EPERM:
1762
logger.error("No permission to"
1763
" bind to interface %s",
1765
elif error[0] == errno.ENOPROTOOPT:
1969
1766
logger.error("SO_BINDTODEVICE not available;"
1970
1767
" cannot bind to interface %s",
1971
1768
self.interface)
1972
elif error.errno == errno.ENODEV:
1973
logger.error("Interface %s does not exist,"
1974
" cannot bind", self.interface)
1977
1771
# Only bind(2) the socket if we really need to.
2038
1831
def handle_ipc(self, source, condition, parent_pipe=None,
2039
1832
proc = None, client_object=None):
1834
gobject.IO_IN: "IN", # There is data to read.
1835
gobject.IO_OUT: "OUT", # Data can be written (without
1837
gobject.IO_PRI: "PRI", # There is urgent data to read.
1838
gobject.IO_ERR: "ERR", # Error condition.
1839
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1840
# broken, usually for pipes and
1843
conditions_string = ' | '.join(name
1845
condition_names.iteritems()
1846
if cond & condition)
2040
1847
# error, or the other end of multiprocessing.Pipe has closed
2041
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1848
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2042
1849
# Wait for other process to exit
2105
def rfc3339_duration_to_delta(duration):
2106
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2108
>>> rfc3339_duration_to_delta("P7D")
2109
datetime.timedelta(7)
2110
>>> rfc3339_duration_to_delta("PT60S")
2111
datetime.timedelta(0, 60)
2112
>>> rfc3339_duration_to_delta("PT60M")
2113
datetime.timedelta(0, 3600)
2114
>>> rfc3339_duration_to_delta("PT24H")
2115
datetime.timedelta(1)
2116
>>> rfc3339_duration_to_delta("P1W")
2117
datetime.timedelta(7)
2118
>>> rfc3339_duration_to_delta("PT5M30S")
2119
datetime.timedelta(0, 330)
2120
>>> rfc3339_duration_to_delta("P1DT3M20S")
2121
datetime.timedelta(1, 200)
2124
# Parsing an RFC 3339 duration with regular expressions is not
2125
# possible - there would have to be multiple places for the same
2126
# values, like seconds. The current code, while more esoteric, is
2127
# cleaner without depending on a parsing library. If Python had a
2128
# built-in library for parsing we would use it, but we'd like to
2129
# avoid excessive use of external libraries.
2131
# New type for defining tokens, syntax, and semantics all-in-one
2132
Token = collections.namedtuple("Token",
2133
("regexp", # To match token; if
2134
# "value" is not None,
2135
# must have a "group"
2137
"value", # datetime.timedelta or
2139
"followers")) # Tokens valid after
2141
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2142
# the "duration" ABNF definition in RFC 3339, Appendix A.
2143
token_end = Token(re.compile(r"$"), None, frozenset())
2144
token_second = Token(re.compile(r"(\d+)S"),
2145
datetime.timedelta(seconds=1),
2146
frozenset((token_end,)))
2147
token_minute = Token(re.compile(r"(\d+)M"),
2148
datetime.timedelta(minutes=1),
2149
frozenset((token_second, token_end)))
2150
token_hour = Token(re.compile(r"(\d+)H"),
2151
datetime.timedelta(hours=1),
2152
frozenset((token_minute, token_end)))
2153
token_time = Token(re.compile(r"T"),
2155
frozenset((token_hour, token_minute,
2157
token_day = Token(re.compile(r"(\d+)D"),
2158
datetime.timedelta(days=1),
2159
frozenset((token_time, token_end)))
2160
token_month = Token(re.compile(r"(\d+)M"),
2161
datetime.timedelta(weeks=4),
2162
frozenset((token_day, token_end)))
2163
token_year = Token(re.compile(r"(\d+)Y"),
2164
datetime.timedelta(weeks=52),
2165
frozenset((token_month, token_end)))
2166
token_week = Token(re.compile(r"(\d+)W"),
2167
datetime.timedelta(weeks=1),
2168
frozenset((token_end,)))
2169
token_duration = Token(re.compile(r"P"), None,
2170
frozenset((token_year, token_month,
2171
token_day, token_time,
2173
# Define starting values
2174
value = datetime.timedelta() # Value so far
2176
followers = frozenset((token_duration,)) # Following valid tokens
2177
s = duration # String left to parse
2178
# Loop until end token is found
2179
while found_token is not token_end:
2180
# Search for any currently valid tokens
2181
for token in followers:
2182
match = token.regexp.match(s)
2183
if match is not None:
2185
if token.value is not None:
2186
# Value found, parse digits
2187
factor = int(match.group(1), 10)
2188
# Add to value so far
2189
value += factor * token.value
2190
# Strip token from string
2191
s = token.regexp.sub("", s, 1)
2194
# Set valid next tokens
2195
followers = found_token.followers
2198
# No currently valid tokens were found
2199
raise ValueError("Invalid RFC 3339 duration")
2204
1912
def string_to_delta(interval):
2205
1913
"""Parse a string and return a datetime.timedelta
2304
2006
parser.add_argument("--no-dbus", action="store_false",
2305
2007
dest="use_dbus", help="Do not provide D-Bus"
2306
" system bus interface", default=None)
2008
" system bus interface")
2307
2009
parser.add_argument("--no-ipv6", action="store_false",
2308
dest="use_ipv6", help="Do not use IPv6",
2010
dest="use_ipv6", help="Do not use IPv6")
2310
2011
parser.add_argument("--no-restore", action="store_false",
2311
2012
dest="restore", help="Do not restore stored"
2312
" state", default=None)
2313
parser.add_argument("--socket", type=int,
2314
help="Specify a file descriptor to a network"
2315
" socket to use instead of creating one")
2316
2014
parser.add_argument("--statedir", metavar="DIR",
2317
2015
help="Directory to save/restore state in")
2318
parser.add_argument("--foreground", action="store_true",
2319
help="Run in foreground", default=None)
2320
parser.add_argument("--no-zeroconf", action="store_false",
2321
dest="zeroconf", help="Do not use Zeroconf",
2324
2017
options = parser.parse_args()
2326
2019
if options.check:
2328
fail_count, test_count = doctest.testmod()
2329
sys.exit(os.EX_OK if fail_count == 0 else 1)
2331
2024
# Default values for config file for server-global settings
2332
2025
server_defaults = { "interface": "",
2354
2044
# Convert the SafeConfigParser object to a dict
2355
2045
server_settings = server_config.defaults()
2356
2046
# Use the appropriate methods on the non-string config options
2357
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2047
for option in ("debug", "use_dbus", "use_ipv6"):
2358
2048
server_settings[option] = server_config.getboolean("DEFAULT",
2360
2050
if server_settings["port"]:
2361
2051
server_settings["port"] = server_config.getint("DEFAULT",
2363
if server_settings["socket"]:
2364
server_settings["socket"] = server_config.getint("DEFAULT",
2366
# Later, stdin will, and stdout and stderr might, be dup'ed
2367
# over with an opened os.devnull. But we don't want this to
2368
# happen with a supplied network socket.
2369
if 0 <= server_settings["socket"] <= 2:
2370
server_settings["socket"] = os.dup(server_settings
2372
2053
del server_config
2374
2055
# Override the settings from the config file with command line
2385
2066
for option in server_settings.keys():
2386
2067
if type(server_settings[option]) is str:
2387
2068
server_settings[option] = unicode(server_settings[option])
2388
# Force all boolean options to be boolean
2389
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2390
"foreground", "zeroconf"):
2391
server_settings[option] = bool(server_settings[option])
2392
# Debug implies foreground
2393
if server_settings["debug"]:
2394
server_settings["foreground"] = True
2395
2069
# Now we have our good server settings in "server_settings"
2397
2071
##################################################################
2399
if (not server_settings["zeroconf"] and
2400
not (server_settings["port"]
2401
or server_settings["socket"] != "")):
2402
parser.error("Needs port or socket to work without"
2405
2073
# For convenience
2406
2074
debug = server_settings["debug"]
2407
2075
debuglevel = server_settings["debuglevel"]
2424
2090
if server_settings["servicename"] != "Mandos":
2425
2091
syslogger.setFormatter(logging.Formatter
2426
('Mandos ({}) [%(process)d]:'
2427
' %(levelname)s: %(message)s'
2428
.format(server_settings
2092
('Mandos (%s) [%%(process)d]:'
2093
' %%(levelname)s: %%(message)s'
2094
% server_settings["servicename"]))
2431
2096
# Parse config file with clients
2432
client_config = configparser.SafeConfigParser(Client
2097
client_config = configparser.SafeConfigParser(Client.client_defaults)
2434
2098
client_config.read(os.path.join(server_settings["configdir"],
2435
2099
"clients.conf"))
2437
2101
global mandos_dbus_service
2438
2102
mandos_dbus_service = None
2441
if server_settings["socket"] != "":
2442
socketfd = server_settings["socket"]
2443
2104
tcp_server = MandosServer((server_settings["address"],
2444
2105
server_settings["port"]),
2448
2109
use_ipv6=use_ipv6,
2449
2110
gnutls_priority=
2450
2111
server_settings["priority"],
2454
pidfilename = "/run/mandos.pid"
2455
if not os.path.isdir("/run/."):
2456
pidfilename = "/var/run/mandos.pid"
2114
pidfilename = "/var/run/mandos.pid"
2459
2116
pidfile = open(pidfilename, "w")
2460
except IOError as e:
2461
logger.error("Could not open file %r", pidfilename,
2118
logger.error("Could not open file %r", pidfilename)
2464
for name in ("_mandos", "mandos", "nobody"):
2121
uid = pwd.getpwnam("_mandos").pw_uid
2122
gid = pwd.getpwnam("_mandos").pw_gid
2466
uid = pwd.getpwnam(name).pw_uid
2467
gid = pwd.getpwnam(name).pw_gid
2125
uid = pwd.getpwnam("mandos").pw_uid
2126
gid = pwd.getpwnam("mandos").pw_gid
2469
2127
except KeyError:
2129
uid = pwd.getpwnam("nobody").pw_uid
2130
gid = pwd.getpwnam("nobody").pw_gid
2477
2137
except OSError as error:
2478
if error.errno != errno.EPERM:
2138
if error[0] != errno.EPERM:
2482
2142
# Enable all possible GnuTLS debugging
2493
2153
.gnutls_global_set_log_function(debug_gnutls))
2495
2155
# Redirect stdin so all checkers get /dev/null
2496
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2156
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2497
2157
os.dup2(null, sys.stdin.fileno())
2501
2161
# Need to fork before connecting to D-Bus
2503
2163
# Close all input and output, do double fork, etc.
2506
# multiprocessing will use threads, so before we use gobject we
2507
# need to inform gobject that threads will be used.
2508
2166
gobject.threads_init()
2510
2168
global main_loop
2511
2169
# From the Avahi example code
2512
DBusGMainLoop(set_as_default=True)
2170
DBusGMainLoop(set_as_default=True )
2513
2171
main_loop = gobject.MainLoop()
2514
2172
bus = dbus.SystemBus()
2515
2173
# End of Avahi example code
2521
2179
("se.bsnet.fukt.Mandos", bus,
2522
2180
do_not_queue=True))
2523
2181
except dbus.exceptions.NameExistsException as e:
2524
logger.error("Disabling D-Bus:", exc_info=e)
2182
logger.error(unicode(e) + ", disabling D-Bus")
2525
2183
use_dbus = False
2526
2184
server_settings["use_dbus"] = False
2527
2185
tcp_server.use_dbus = False
2529
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2530
service = AvahiServiceToSyslog(name =
2531
server_settings["servicename"],
2532
servicetype = "_mandos._tcp",
2533
protocol = protocol, bus = bus)
2534
if server_settings["interface"]:
2535
service.interface = (if_nametoindex
2536
(str(server_settings["interface"])))
2186
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2187
service = AvahiServiceToSyslog(name =
2188
server_settings["servicename"],
2189
servicetype = "_mandos._tcp",
2190
protocol = protocol, bus = bus)
2191
if server_settings["interface"]:
2192
service.interface = (if_nametoindex
2193
(str(server_settings["interface"])))
2538
2195
global multiprocessing_manager
2539
2196
multiprocessing_manager = multiprocessing.Manager()
2541
2198
client_class = Client
2543
client_class = functools.partial(ClientDBus, bus = bus)
2200
client_class = functools.partial(ClientDBusTransitional,
2545
2203
client_settings = Client.config_parser(client_config)
2546
2204
old_client_settings = {}
2547
2205
clients_data = {}
2549
# This is used to redirect stdout and stderr for checker processes
2551
wnull = open(os.devnull, "w") # A writable /dev/null
2552
# Only used if server is running in foreground but not in debug
2554
if debug or not foreground:
2557
2207
# Get client data and settings from last running state.
2558
2208
if server_settings["restore"]:
2562
2212
(stored_state))
2563
2213
os.remove(stored_state_path)
2564
2214
except IOError as e:
2565
if e.errno == errno.ENOENT:
2566
logger.warning("Could not load persistent state: {}"
2567
.format(os.strerror(e.errno)))
2569
logger.critical("Could not load persistent state:",
2215
logger.warning("Could not load persistent state: {0}"
2217
if e.errno != errno.ENOENT:
2572
2219
except EOFError as e:
2573
2220
logger.warning("Could not load persistent state: "
2574
"EOFError:", exc_info=e)
2221
"EOFError: {0}".format(e))
2576
2223
with PGPEngine() as pgp:
2577
for client_name, client in clients_data.items():
2578
# Skip removed clients
2579
if client_name not in client_settings:
2224
for client_name, client in clients_data.iteritems():
2582
2225
# Decide which value to use after restoring saved state.
2583
2226
# We have three different values: Old config file,
2584
2227
# new config file, and saved state.
2599
2242
# Clients who has passed its expire date can still be
2600
2243
# enabled if its last checker was successful. Clients
2601
# whose checker succeeded before we stored its state is
2602
# assumed to have successfully run all checkers during
2244
# whose checker failed before we stored its state is
2245
# assumed to have failed all checkers during downtime.
2604
2246
if client["enabled"]:
2605
2247
if datetime.datetime.utcnow() >= client["expires"]:
2606
2248
if not client["last_checked_ok"]:
2607
2249
logger.warning(
2608
"disabling client {} - Client never "
2609
"performed a successful checker"
2610
.format(client_name))
2250
"disabling client {0} - Client never "
2251
"performed a successfull checker"
2252
.format(client["name"]))
2611
2253
client["enabled"] = False
2612
2254
elif client["last_checker_status"] != 0:
2613
2255
logger.warning(
2614
"disabling client {} - Client last"
2615
" checker failed with error code {}"
2616
.format(client_name,
2256
"disabling client {0} - Client "
2257
"last checker failed with error code {1}"
2258
.format(client["name"],
2617
2259
client["last_checker_status"]))
2618
2260
client["enabled"] = False
2620
2262
client["expires"] = (datetime.datetime
2622
2264
+ client["timeout"])
2623
logger.debug("Last checker succeeded,"
2624
" keeping {} enabled"
2625
.format(client_name))
2627
2267
client["secret"] = (
2628
2268
pgp.decrypt(client["encrypted_secret"],
2631
2271
except PGPError:
2632
2272
# If decryption fails, we use secret from new settings
2633
logger.debug("Failed to decrypt {} old secret"
2273
logger.debug("Failed to decrypt {0} old secret"
2634
2274
.format(client_name))
2635
2275
client["secret"] = (
2636
2276
client_settings[client_name]["secret"])
2638
2279
# Add/remove clients based on new changes made to config
2639
for client_name in (set(old_client_settings)
2640
- set(client_settings)):
2280
for client_name in set(old_client_settings) - set(client_settings):
2641
2281
del clients_data[client_name]
2642
for client_name in (set(client_settings)
2643
- set(old_client_settings)):
2282
for client_name in set(client_settings) - set(old_client_settings):
2644
2283
clients_data[client_name] = client_settings[client_name]
2646
# Create all client objects
2647
for client_name, client in clients_data.items():
2285
# Create clients all clients
2286
for client_name, client in clients_data.iteritems():
2648
2287
tcp_server.clients[client_name] = client_class(
2649
name = client_name, settings = client,
2650
server_settings = server_settings)
2288
name = client_name, settings = client)
2652
2290
if not tcp_server.clients:
2653
2291
logger.warning("No clients defined")
2656
if pidfile is not None:
2660
pidfile.write(str(pid) + "\n".encode("utf-8"))
2662
logger.error("Could not write to file %r with PID %d",
2297
pidfile.write(str(pid) + "\n".encode("utf-8"))
2300
logger.error("Could not write to file %r with PID %d",
2303
# "pidfile" was never created
2665
2305
del pidfilename
2306
signal.signal(signal.SIGINT, signal.SIG_IGN)
2667
2308
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2668
2309
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2671
@alternate_dbus_interfaces({"se.recompile.Mandos":
2672
"se.bsnet.fukt.Mandos"})
2673
class MandosDBusService(DBusObjectWithProperties):
2312
class MandosDBusService(dbus.service.Object):
2674
2313
"""A D-Bus proxy object"""
2675
2314
def __init__(self):
2676
2315
dbus.service.Object.__init__(self, bus, "/")
2677
2316
_interface = "se.recompile.Mandos"
2679
@dbus_interface_annotations(_interface)
2681
return { "org.freedesktop.DBus.Property"
2682
".EmitsChangedSignal":
2685
2318
@dbus.service.signal(_interface, signature="o")
2686
2319
def ClientAdded(self, objpath):
2770
2403
del client_settings[client.name]["secret"]
2773
with (tempfile.NamedTemporaryFile
2774
(mode='wb', suffix=".pickle", prefix='clients-',
2775
dir=os.path.dirname(stored_state_path),
2776
delete=False)) as stored_state:
2406
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2409
(stored_state_path))
2410
with os.fdopen(tempfd, "wb") as stored_state:
2777
2411
pickle.dump((clients, client_settings), stored_state)
2778
tempname=stored_state.name
2779
2412
os.rename(tempname, stored_state_path)
2780
2413
except (IOError, OSError) as e:
2414
logger.warning("Could not save persistent state: {0}"
2783
2418
os.remove(tempname)
2784
2419
except NameError:
2786
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2787
logger.warning("Could not save persistent state: {}"
2788
.format(os.strerror(e.errno)))
2790
logger.warning("Could not save persistent state:",
2421
if e.errno not in set((errno.ENOENT, errno.EACCES,
2794
2425
# Delete all clients, and settings from config
2795
2426
while tcp_server.clients:
2819
2450
tcp_server.server_activate()
2821
2452
# Find out what port we got
2823
service.port = tcp_server.socket.getsockname()[1]
2453
service.port = tcp_server.socket.getsockname()[1]
2825
2455
logger.info("Now listening on address %r, port %d,"
2826
" flowinfo %d, scope_id %d",
2827
*tcp_server.socket.getsockname())
2456
" flowinfo %d, scope_id %d"
2457
% tcp_server.socket.getsockname())
2829
logger.info("Now listening on address %r, port %d",
2830
*tcp_server.socket.getsockname())
2459
logger.info("Now listening on address %r, port %d"
2460
% tcp_server.socket.getsockname())
2832
2462
#service.interface = tcp_server.socket.getsockname()[3]
2836
# From the Avahi example code
2839
except dbus.exceptions.DBusException as error:
2840
logger.critical("D-Bus Exception", exc_info=error)
2843
# End of Avahi example code
2465
# From the Avahi example code
2468
except dbus.exceptions.DBusException as error:
2469
logger.critical("DBusException: %s", error)
2472
# End of Avahi example code
2845
2474
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2846
2475
lambda *args, **kwargs: