103
107
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
104
108
with contextlib.closing(socket.socket()) as s:
105
109
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
106
struct.pack(str("16s16x"),
108
interface_index = struct.unpack(str("I"),
110
struct.pack(b"16s16x", interface))
111
interface_index = struct.unpack("I", ifreq[16:20])[0]
110
112
return interface_index
113
115
def initlogger(debug, level=logging.WARNING):
114
116
"""init logger and add loglevel"""
119
syslogger = (logging.handlers.SysLogHandler
121
logging.handlers.SysLogHandler.LOG_DAEMON,
122
address = "/dev/log"))
116
123
syslogger.setFormatter(logging.Formatter
117
124
('Mandos [%(process)d]: %(levelname)s:'
171
176
def password_encode(self, password):
172
177
# Passphrase can not be empty and can not contain newlines or
173
178
# NUL bytes. So we prefix it and hex encode it.
174
return b"mandos" + binascii.hexlify(password)
179
encoded = b"mandos" + binascii.hexlify(password)
180
if len(encoded) > 2048:
181
# GnuPG can't handle long passwords, so encode differently
182
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
183
.replace(b"\n", b"\\n")
184
.replace(b"\0", b"\\x00"))
176
187
def encrypt(self, data, password):
177
self.gnupg.passphrase = self.password_encode(password)
178
with open(os.devnull) as devnull:
180
proc = self.gnupg.run(['--symmetric'],
181
create_fhs=['stdin', 'stdout'],
182
attach_fhs={'stderr': devnull})
183
with contextlib.closing(proc.handles['stdin']) as f:
185
with contextlib.closing(proc.handles['stdout']) as f:
186
ciphertext = f.read()
190
self.gnupg.passphrase = None
188
passphrase = self.password_encode(password)
189
with tempfile.NamedTemporaryFile(dir=self.tempdir
191
passfile.write(passphrase)
193
proc = subprocess.Popen(['gpg', '--symmetric',
197
stdin = subprocess.PIPE,
198
stdout = subprocess.PIPE,
199
stderr = subprocess.PIPE)
200
ciphertext, err = proc.communicate(input = data)
201
if proc.returncode != 0:
191
203
return ciphertext
193
205
def decrypt(self, data, password):
194
self.gnupg.passphrase = self.password_encode(password)
195
with open(os.devnull) as devnull:
197
proc = self.gnupg.run(['--decrypt'],
198
create_fhs=['stdin', 'stdout'],
199
attach_fhs={'stderr': devnull})
200
with contextlib.closing(proc.handles['stdin'] ) as f:
202
with contextlib.closing(proc.handles['stdout']) as f:
203
decrypted_plaintext = f.read()
207
self.gnupg.passphrase = None
206
passphrase = self.password_encode(password)
207
with tempfile.NamedTemporaryFile(dir = self.tempdir
209
passfile.write(passphrase)
211
proc = subprocess.Popen(['gpg', '--decrypt',
215
stdin = subprocess.PIPE,
216
stdout = subprocess.PIPE,
217
stderr = subprocess.PIPE)
218
decrypted_plaintext, err = proc.communicate(input
220
if proc.returncode != 0:
208
222
return decrypted_plaintext
212
225
class AvahiError(Exception):
213
226
def __init__(self, value, *args, **kwargs):
214
227
self.value = value
215
super(AvahiError, self).__init__(value, *args, **kwargs)
216
def __unicode__(self):
217
return unicode(repr(self.value))
228
return super(AvahiError, self).__init__(value, *args,
219
231
class AvahiServiceError(AvahiError):
369
389
self.server_state_changed)
370
390
self.server_state_changed(self.server.GetState())
372
393
class AvahiServiceToSyslog(AvahiService):
373
394
def rename(self):
374
395
"""Add the new name to the syslog messages"""
375
396
ret = AvahiService.rename(self)
376
397
syslogger.setFormatter(logging.Formatter
377
('Mandos (%s) [%%(process)d]:'
378
' %%(levelname)s: %%(message)s'
398
('Mandos ({}) [%(process)d]:'
399
' %(levelname)s: %(message)s'
382
def timedelta_to_milliseconds(td):
383
"Convert a datetime.timedelta() to milliseconds"
384
return ((td.days * 24 * 60 * 60 * 1000)
385
+ (td.seconds * 1000)
386
+ (td.microseconds // 1000))
388
404
class Client(object):
389
405
"""A representation of a client host served by this server.
426
442
runtime_expansions: Allowed attributes for runtime expansion.
427
443
expires: datetime.datetime(); time (UTC) when a client will be
428
444
disabled, or None
445
server_settings: The server_settings dict from main()
431
448
runtime_expansions = ("approval_delay", "approval_duration",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
449
"created", "enabled", "expires",
450
"fingerprint", "host", "interval",
451
"last_approval_request", "last_checked_ok",
434
452
"last_enabled", "name", "timeout")
435
client_defaults = { "timeout": "5m",
436
"extended_timeout": "15m",
453
client_defaults = { "timeout": "PT5M",
454
"extended_timeout": "PT15M",
438
456
"checker": "fping -q -- %%(host)s",
440
"approval_delay": "0s",
441
"approval_duration": "1s",
458
"approval_delay": "PT0S",
459
"approval_duration": "PT1S",
442
460
"approved_by_default": "True",
443
461
"enabled": "True",
446
def timeout_milliseconds(self):
447
"Return the 'timeout' attribute in milliseconds"
448
return timedelta_to_milliseconds(self.timeout)
450
def extended_timeout_milliseconds(self):
451
"Return the 'extended_timeout' attribute in milliseconds"
452
return timedelta_to_milliseconds(self.extended_timeout)
454
def interval_milliseconds(self):
455
"Return the 'interval' attribute in milliseconds"
456
return timedelta_to_milliseconds(self.interval)
458
def approval_delay_milliseconds(self):
459
return timedelta_to_milliseconds(self.approval_delay)
462
465
def config_parser(config):
463
466
"""Construct a new dict of client settings of this form:
501
504
client["checker_command"] = section["checker"]
502
505
client["last_approval_request"] = None
503
506
client["last_checked_ok"] = None
504
client["last_checker_status"] = None
507
client["last_checker_status"] = -2
509
def __init__(self, settings, name = None):
510
"""Note: the 'checker' key in 'config' sets the
511
'checker_command' attribute and *not* the 'checker'
511
def __init__(self, settings, name = None, server_settings=None):
513
if server_settings is None:
515
self.server_settings = server_settings
514
516
# adding all client settings
515
for setting, value in settings.iteritems():
517
for setting, value in settings.items():
516
518
setattr(self, setting, value)
566
568
if getattr(self, "enabled", False):
567
569
# Already enabled
569
self.send_changedstate()
570
571
self.expires = datetime.datetime.utcnow() + self.timeout
571
572
self.enabled = True
572
573
self.last_enabled = datetime.datetime.utcnow()
573
574
self.init_checker()
575
self.send_changedstate()
575
577
def disable(self, quiet=True):
576
578
"""Disable this client."""
577
579
if not getattr(self, "enabled", False):
580
self.send_changedstate()
582
582
logger.info("Disabling client %s", self.name)
583
if getattr(self, "disable_initiator_tag", False):
583
if getattr(self, "disable_initiator_tag", None) is not None:
584
584
gobject.source_remove(self.disable_initiator_tag)
585
585
self.disable_initiator_tag = None
586
586
self.expires = None
587
if getattr(self, "checker_initiator_tag", False):
587
if getattr(self, "checker_initiator_tag", None) is not None:
588
588
gobject.source_remove(self.checker_initiator_tag)
589
589
self.checker_initiator_tag = None
590
590
self.stop_checker()
591
591
self.enabled = False
593
self.send_changedstate()
592
594
# Do not run this again if called by a gobject.timeout_add
598
600
def init_checker(self):
599
601
# Schedule a new checker to be started an 'interval' from now,
600
602
# and every interval from then on.
603
if self.checker_initiator_tag is not None:
604
gobject.source_remove(self.checker_initiator_tag)
601
605
self.checker_initiator_tag = (gobject.timeout_add
602
(self.interval_milliseconds(),
607
.total_seconds() * 1000),
603
608
self.start_checker))
604
609
# Schedule a disable() when 'timeout' has passed
610
if self.disable_initiator_tag is not None:
611
gobject.source_remove(self.disable_initiator_tag)
605
612
self.disable_initiator_tag = (gobject.timeout_add
606
(self.timeout_milliseconds(),
614
.total_seconds() * 1000),
608
616
# Also start a new checker *right now*.
609
617
self.start_checker()
626
634
logger.warning("Checker for %(name)s crashed?",
629
def checked_ok(self, timeout=None):
630
"""Bump up the timeout for this client.
632
This should only be called when the client has been seen,
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."""
635
645
if timeout is None:
636
646
timeout = self.timeout
637
self.last_checked_ok = datetime.datetime.utcnow()
638
647
if self.disable_initiator_tag is not None:
639
648
gobject.source_remove(self.disable_initiator_tag)
649
self.disable_initiator_tag = None
640
650
if getattr(self, "enabled", False):
641
651
self.disable_initiator_tag = (gobject.timeout_add
642
(timedelta_to_milliseconds
643
(timeout), self.disable))
652
(int(timeout.total_seconds()
653
* 1000), self.disable))
644
654
self.expires = datetime.datetime.utcnow() + timeout
646
656
def need_approval(self):
652
662
If a checker already exists, leave it running and do
654
664
# The reason for not killing a running checker is that if we
655
# did that, then if a checker (for some reason) started
656
# running slowly and taking more than 'interval' time, the
657
# client would inevitably timeout, since no checker would get
658
# a chance to run to completion. If we instead leave running
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
659
669
# checkers alone, the checker would have to take more time
660
670
# than 'timeout' for the client to be disabled, which is as it
675
686
self.current_checker_command)
676
687
# Start a new checker if needed
677
688
if self.checker is None:
689
# Escape attributes for the shell
690
escaped_attrs = { attr:
691
re.escape(str(getattr(self, attr)))
692
for attr in self.runtime_expansions }
679
# In case checker_command has exactly one % operator
680
command = self.checker_command % self.host
682
# Escape attributes for the shell
683
escaped_attrs = dict(
685
re.escape(unicode(str(getattr(self, attr, "")),
689
self.runtime_expansions)
692
command = self.checker_command % escaped_attrs
693
except TypeError as error:
694
logger.error('Could not format string "%s":'
695
' %s', self.checker_command, error)
696
return True # Try again later
694
command = self.checker_command % escaped_attrs
695
except TypeError as error:
696
logger.error('Could not format string "%s"',
697
self.checker_command, exc_info=error)
698
return True # Try again later
697
699
self.current_checker_command = command
699
701
logger.info("Starting checker %r for %s",
702
704
# in normal mode, that is already done by daemon(),
703
705
# and in debug mode we don't want to. (Stdin is
704
706
# always replaced by /dev/null.)
707
# The exception is when not debugging but nevertheless
708
# running in the foreground; use the previously
711
if (not self.server_settings["debug"]
712
and self.server_settings["foreground"]):
713
popen_args.update({"stdout": wnull,
705
715
self.checker = subprocess.Popen(command,
708
self.checker_callback_tag = (gobject.child_watch_add
710
self.checker_callback,
712
# The checker may have completed before the gobject
713
# watch was added. Check for this.
719
except OSError as error:
720
logger.error("Failed to start subprocess",
723
self.checker_callback_tag = (gobject.child_watch_add
725
self.checker_callback,
727
# The checker may have completed before the gobject
728
# watch was added. Check for this.
714
730
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
716
gobject.source_remove(self.checker_callback_tag)
717
self.checker_callback(pid, status, command)
718
731
except OSError as error:
719
logger.error("Failed to start subprocess: %s",
732
if error.errno == errno.ECHILD:
733
# This should never happen
734
logger.error("Child process vanished",
739
gobject.source_remove(self.checker_callback_tag)
740
self.checker_callback(pid, status, command)
721
741
# Re-run this periodically if run by gobject.timeout_add
793
def dbus_interface_annotations(dbus_interface):
794
"""Decorator for marking functions returning interface annotations
798
@dbus_interface_annotations("org.example.Interface")
799
def _foo(self): # Function name does not matter
800
return {"org.freedesktop.DBus.Deprecated": "true",
801
"org.freedesktop.DBus.Property.EmitsChangedSignal":
805
func._dbus_is_interface = True
806
func._dbus_interface = dbus_interface
807
func._dbus_name = dbus_interface
812
def dbus_annotations(annotations):
813
"""Decorator to annotate D-Bus methods, signals or properties
816
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
817
"org.freedesktop.DBus.Property."
818
"EmitsChangedSignal": "false"})
819
@dbus_service_property("org.example.Interface", signature="b",
821
def Property_dbus_property(self):
822
return dbus.Boolean(False)
825
func._dbus_annotations = annotations
773
830
class DBusPropertyException(dbus.exceptions.DBusException):
774
831
"""A base class for D-Bus property-related exceptions
776
def __unicode__(self):
777
return unicode(str(self))
780
835
class DBusPropertyAccessException(DBusPropertyException):
781
836
"""A property's access permissions disallows an operation.
801
def _is_dbus_property(obj):
802
return getattr(obj, "_dbus_is_property", False)
856
def _is_dbus_thing(thing):
857
"""Returns a function testing if an attribute is a D-Bus thing
859
If called like _is_dbus_thing("method") it returns a function
860
suitable for use as predicate to inspect.getmembers().
862
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
804
def _get_all_dbus_properties(self):
865
def _get_all_dbus_things(self, thing):
805
866
"""Returns a generator of (name, attribute) pairs
807
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
868
return ((getattr(athing.__get__(self), "_dbus_name",
870
athing.__get__(self))
808
871
for cls in self.__class__.__mro__
810
inspect.getmembers(cls, self._is_dbus_property))
873
inspect.getmembers(cls,
874
self._is_dbus_thing(thing)))
812
876
def _get_dbus_property(self, interface_name, property_name):
813
877
"""Returns a bound method if one exists which is a D-Bus
879
946
value.variant_level+1)
880
947
return dbus.Dictionary(properties, signature="sv")
949
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
950
def PropertiesChanged(self, interface_name, changed_properties,
951
invalidated_properties):
952
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
882
957
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
883
958
out_signature="s",
884
959
path_keyword='object_path',
885
960
connection_keyword='connection')
886
961
def Introspect(self, object_path, connection):
887
"""Standard D-Bus method, overloaded to insert property tags.
962
"""Overloading of standard D-Bus method.
964
Inserts property tags and interface annotation tags.
889
966
xmlstring = dbus.service.Object.Introspect(self, object_path,
897
974
e.setAttribute("access", prop._dbus_access)
899
976
for if_tag in document.getElementsByTagName("interface"):
900
978
for tag in (make_tag(document, name, prop)
902
in self._get_all_dbus_properties()
980
in self._get_all_dbus_things("property")
903
981
if prop._dbus_interface
904
982
== if_tag.getAttribute("name")):
905
983
if_tag.appendChild(tag)
984
# Add annotation tags
985
for typ in ("method", "signal", "property"):
986
for tag in if_tag.getElementsByTagName(typ):
988
for name, prop in (self.
989
_get_all_dbus_things(typ)):
990
if (name == tag.getAttribute("name")
991
and prop._dbus_interface
992
== if_tag.getAttribute("name")):
993
annots.update(getattr
997
for name, value in annots.items():
998
ann_tag = document.createElement(
1000
ann_tag.setAttribute("name", name)
1001
ann_tag.setAttribute("value", value)
1002
tag.appendChild(ann_tag)
1003
# Add interface annotation tags
1004
for annotation, value in dict(
1005
itertools.chain.from_iterable(
1006
annotations().items()
1007
for name, annotations in
1008
self._get_all_dbus_things("interface")
1009
if name == if_tag.getAttribute("name")
1011
ann_tag = document.createElement("annotation")
1012
ann_tag.setAttribute("name", annotation)
1013
ann_tag.setAttribute("value", value)
1014
if_tag.appendChild(ann_tag)
906
1015
# Add the names to the return values for the
907
1016
# "org.freedesktop.DBus.Properties" methods
908
1017
if (if_tag.getAttribute("name")
935
1044
variant_level=variant_level)
938
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
940
"""Applied to an empty subclass of a D-Bus object, this metaclass
941
will add additional D-Bus attributes matching a certain pattern.
1047
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1048
"""A class decorator; applied to a subclass of
1049
dbus.service.Object, it will add alternate D-Bus attributes with
1050
interface names according to the "alt_interface_names" mapping.
1053
@alternate_dbus_interfaces({"org.example.Interface":
1054
"net.example.AlternateInterface"})
1055
class SampleDBusObject(dbus.service.Object):
1056
@dbus.service.method("org.example.Interface")
1057
def SampleDBusMethod():
1060
The above "SampleDBusMethod" on "SampleDBusObject" will be
1061
reachable via two interfaces: "org.example.Interface" and
1062
"net.example.AlternateInterface", the latter of which will have
1063
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1064
"true", unless "deprecate" is passed with a False value.
1066
This works for methods and signals, and also for D-Bus properties
1067
(from DBusObjectWithProperties) and interfaces (from the
1068
dbus_interface_annotations decorator).
943
def __new__(mcs, name, bases, attr):
944
# Go through all the base classes which could have D-Bus
945
# methods, signals, or properties in them
946
for base in (b for b in bases
947
if issubclass(b, dbus.service.Object)):
948
# Go though all attributes of the base class
949
for attrname, attribute in inspect.getmembers(base):
1071
for orig_interface_name, alt_interface_name in (
1072
alt_interface_names.items()):
1074
interface_names = set()
1075
# Go though all attributes of the class
1076
for attrname, attribute in inspect.getmembers(cls):
950
1077
# Ignore non-D-Bus attributes, and D-Bus attributes
951
1078
# with the wrong interface name
952
1079
if (not hasattr(attribute, "_dbus_interface")
953
1080
or not attribute._dbus_interface
954
.startswith("se.recompile.Mandos")):
1081
.startswith(orig_interface_name)):
956
1083
# Create an alternate D-Bus interface name based on
957
1084
# the current name
958
1085
alt_interface = (attribute._dbus_interface
959
.replace("se.recompile.Mandos",
960
"se.bsnet.fukt.Mandos"))
1086
.replace(orig_interface_name,
1087
alt_interface_name))
1088
interface_names.add(alt_interface)
961
1089
# Is this a D-Bus signal?
962
1090
if getattr(attribute, "_dbus_is_signal", False):
963
# Extract the original non-method function by
1091
# Extract the original non-method undecorated
1092
# function by black magic
965
1093
nonmethod_func = (dict(
966
1094
zip(attribute.func_code.co_freevars,
967
1095
attribute.__closure__))["func"]
978
1106
nonmethod_func.func_name,
979
1107
nonmethod_func.func_defaults,
980
1108
nonmethod_func.func_closure)))
1109
# Copy annotations, if any
1111
new_function._dbus_annotations = (
1112
dict(attribute._dbus_annotations))
1113
except AttributeError:
981
1115
# Define a creator of a function to call both the
982
# old and new functions, so both the old and new
983
# signals gets sent when the function is called
1116
# original and alternate functions, so both the
1117
# original and alternate signals gets sent when
1118
# the function is called
984
1119
def fixscope(func1, func2):
985
1120
"""This function is a scope container to pass
986
1121
func1 and func2 to the "call_both" function
1030
1170
attribute.func_name,
1031
1171
attribute.func_defaults,
1032
1172
attribute.func_closure)))
1033
return type.__new__(mcs, name, bases, attr)
1173
# Copy annotations, if any
1175
attr[attrname]._dbus_annotations = (
1176
dict(attribute._dbus_annotations))
1177
except AttributeError:
1179
# Is this a D-Bus interface?
1180
elif getattr(attribute, "_dbus_is_interface", False):
1181
# Create a new, but exactly alike, function
1182
# object. Decorate it to be a new D-Bus interface
1183
# with the alternate D-Bus interface name. Add it
1185
attr[attrname] = (dbus_interface_annotations
1188
(attribute.func_code,
1189
attribute.func_globals,
1190
attribute.func_name,
1191
attribute.func_defaults,
1192
attribute.func_closure)))
1194
# Deprecate all alternate interfaces
1195
iname="_AlternateDBusNames_interface_annotation{}"
1196
for interface_name in interface_names:
1197
@dbus_interface_annotations(interface_name)
1199
return { "org.freedesktop.DBus.Deprecated":
1201
# Find an unused name
1202
for aname in (iname.format(i)
1203
for i in itertools.count()):
1204
if aname not in attr:
1208
# Replace the class with a new subclass of it with
1209
# methods, signals, etc. as created above.
1210
cls = type(b"{}Alternate".format(cls.__name__),
1216
@alternate_dbus_interfaces({"se.recompile.Mandos":
1217
"se.bsnet.fukt.Mandos"})
1036
1218
class ClientDBus(Client, DBusObjectWithProperties):
1037
1219
"""A Client class using D-Bus
1051
1235
Client.__init__(self, *args, **kwargs)
1052
1236
# Only now, when this client is initialized, can it show up on
1054
client_object_name = unicode(self.name).translate(
1238
client_object_name = str(self.name).translate(
1055
1239
{ord("."): ord("_"),
1056
1240
ord("-"): ord("_")})
1057
1241
self.dbus_object_path = (dbus.ObjectPath
1058
1242
("/clients/" + client_object_name))
1059
1243
DBusObjectWithProperties.__init__(self, self.bus,
1060
1244
self.dbus_object_path)
1062
1246
def notifychangeproperty(transform_func,
1063
1247
dbus_name, type_func=lambda x: x,
1248
variant_level=1, invalidate_only=False,
1249
_interface=_interface):
1065
1250
""" Modify a variable so that it's a property which announces
1066
1251
its changes to DBus.
1072
1257
to the D-Bus. Default: no transform
1073
1258
variant_level: D-Bus variant level. Default: 1
1075
attrname = "_{0}".format(dbus_name)
1260
attrname = "_{}".format(dbus_name)
1076
1261
def setter(self, value):
1077
1262
if hasattr(self, "dbus_object_path"):
1078
1263
if (not hasattr(self, attrname) or
1079
1264
type_func(getattr(self, attrname, None))
1080
1265
!= type_func(value)):
1081
dbus_value = transform_func(type_func(value),
1084
self.PropertyChanged(dbus.String(dbus_name),
1267
self.PropertiesChanged(_interface,
1272
dbus_value = transform_func(type_func(value),
1275
self.PropertyChanged(dbus.String(dbus_name),
1277
self.PropertiesChanged(_interface,
1279
dbus.String(dbus_name):
1280
dbus_value }), dbus.Array())
1086
1281
setattr(self, attrname, value)
1088
1283
return property(lambda self: getattr(self, attrname), setter)
1091
1285
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1092
1286
approvals_pending = notifychangeproperty(dbus.Boolean,
1093
1287
"ApprovalPending",
1107
1303
approval_delay = notifychangeproperty(dbus.UInt64,
1108
1304
"ApprovalDelay",
1110
timedelta_to_milliseconds)
1306
lambda td: td.total_seconds()
1111
1308
approval_duration = notifychangeproperty(
1112
1309
dbus.UInt64, "ApprovalDuration",
1113
type_func = timedelta_to_milliseconds)
1310
type_func = lambda td: td.total_seconds() * 1000)
1114
1311
host = notifychangeproperty(dbus.String, "Host")
1115
1312
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1117
timedelta_to_milliseconds)
1313
type_func = lambda td:
1314
td.total_seconds() * 1000)
1118
1315
extended_timeout = notifychangeproperty(
1119
1316
dbus.UInt64, "ExtendedTimeout",
1120
type_func = timedelta_to_milliseconds)
1317
type_func = lambda td: td.total_seconds() * 1000)
1121
1318
interval = notifychangeproperty(dbus.UInt64,
1124
timedelta_to_milliseconds)
1321
lambda td: td.total_seconds()
1125
1323
checker_command = notifychangeproperty(dbus.String, "Checker")
1324
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1325
invalidate_only=True)
1127
1327
del notifychangeproperty
1362
1557
access="readwrite")
1363
1558
def Timeout_dbus_property(self, value=None):
1364
1559
if value is None: # get
1365
return dbus.UInt64(self.timeout_milliseconds())
1560
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1561
old_timeout = self.timeout
1366
1562
self.timeout = datetime.timedelta(0, 0, 0, value)
1367
# Reschedule timeout
1563
# Reschedule disabling
1368
1564
if self.enabled:
1369
1565
now = datetime.datetime.utcnow()
1370
time_to_die = timedelta_to_milliseconds(
1371
(self.last_checked_ok + self.timeout) - now)
1372
if time_to_die <= 0:
1566
self.expires += self.timeout - old_timeout
1567
if self.expires <= now:
1373
1568
# The timeout has passed
1376
self.expires = (now +
1377
datetime.timedelta(milliseconds =
1379
1571
if (getattr(self, "disable_initiator_tag", None)
1382
1574
gobject.source_remove(self.disable_initiator_tag)
1383
self.disable_initiator_tag = (gobject.timeout_add
1575
self.disable_initiator_tag = (
1576
gobject.timeout_add(
1577
int((self.expires - now).total_seconds()
1578
* 1000), self.disable))
1387
1580
# ExtendedTimeout - property
1388
1581
@dbus_service_property(_interface, signature="t",
1389
1582
access="readwrite")
1390
1583
def ExtendedTimeout_dbus_property(self, value=None):
1391
1584
if value is None: # get
1392
return dbus.UInt64(self.extended_timeout_milliseconds())
1585
return dbus.UInt64(self.extended_timeout.total_seconds()
1393
1587
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1395
1589
# Interval - property
1741
1926
use_ipv6: Boolean; to use IPv6 or not
1743
1928
def __init__(self, server_address, RequestHandlerClass,
1744
interface=None, use_ipv6=True):
1929
interface=None, use_ipv6=True, socketfd=None):
1930
"""If socketfd is set, use that file descriptor instead of
1931
creating a new one with socket.socket().
1745
1933
self.interface = interface
1747
1935
self.address_family = socket.AF_INET6
1936
if socketfd is not None:
1937
# Save the file descriptor
1938
self.socketfd = socketfd
1939
# Save the original socket.socket() function
1940
self.socket_socket = socket.socket
1941
# To implement --socket, we monkey patch socket.socket.
1943
# (When socketserver.TCPServer is a new-style class, we
1944
# could make self.socket into a property instead of monkey
1945
# patching socket.socket.)
1947
# Create a one-time-only replacement for socket.socket()
1948
@functools.wraps(socket.socket)
1949
def socket_wrapper(*args, **kwargs):
1950
# Restore original function so subsequent calls are
1952
socket.socket = self.socket_socket
1953
del self.socket_socket
1954
# This time only, return a new socket object from the
1955
# saved file descriptor.
1956
return socket.fromfd(self.socketfd, *args, **kwargs)
1957
# Replace socket.socket() function with wrapper
1958
socket.socket = socket_wrapper
1959
# The socketserver.TCPServer.__init__ will call
1960
# socket.socket(), which might be our replacement,
1961
# socket_wrapper(), if socketfd was set.
1748
1962
socketserver.TCPServer.__init__(self, server_address,
1749
1963
RequestHandlerClass)
1750
1965
def server_bind(self):
1751
1966
"""This overrides the normal server_bind() function
1752
1967
to bind to an interface if one was specified, and also NOT to
1761
1976
self.socket.setsockopt(socket.SOL_SOCKET,
1762
1977
SO_BINDTODEVICE,
1978
(self.interface + "\0")
1765
1980
except socket.error as error:
1766
if error[0] == errno.EPERM:
1767
logger.error("No permission to"
1768
" bind to interface %s",
1770
elif error[0] == errno.ENOPROTOOPT:
1981
if error.errno == errno.EPERM:
1982
logger.error("No permission to bind to"
1983
" interface %s", self.interface)
1984
elif error.errno == errno.ENOPROTOOPT:
1771
1985
logger.error("SO_BINDTODEVICE not available;"
1772
1986
" cannot bind to interface %s",
1773
1987
self.interface)
1988
elif error.errno == errno.ENODEV:
1989
logger.error("Interface %s does not exist,"
1990
" cannot bind", self.interface)
1776
1993
# Only bind(2) the socket if we really need to.
1836
2054
def handle_ipc(self, source, condition, parent_pipe=None,
1837
2055
proc = None, client_object=None):
1839
gobject.IO_IN: "IN", # There is data to read.
1840
gobject.IO_OUT: "OUT", # Data can be written (without
1842
gobject.IO_PRI: "PRI", # There is urgent data to read.
1843
gobject.IO_ERR: "ERR", # Error condition.
1844
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1845
# broken, usually for pipes and
1848
conditions_string = ' | '.join(name
1850
condition_names.iteritems()
1851
if cond & condition)
1852
2056
# error, or the other end of multiprocessing.Pipe has closed
1853
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2057
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1854
2058
# Wait for other process to exit
2121
def rfc3339_duration_to_delta(duration):
2122
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2124
>>> rfc3339_duration_to_delta("P7D")
2125
datetime.timedelta(7)
2126
>>> rfc3339_duration_to_delta("PT60S")
2127
datetime.timedelta(0, 60)
2128
>>> rfc3339_duration_to_delta("PT60M")
2129
datetime.timedelta(0, 3600)
2130
>>> rfc3339_duration_to_delta("PT24H")
2131
datetime.timedelta(1)
2132
>>> rfc3339_duration_to_delta("P1W")
2133
datetime.timedelta(7)
2134
>>> rfc3339_duration_to_delta("PT5M30S")
2135
datetime.timedelta(0, 330)
2136
>>> rfc3339_duration_to_delta("P1DT3M20S")
2137
datetime.timedelta(1, 200)
2140
# Parsing an RFC 3339 duration with regular expressions is not
2141
# possible - there would have to be multiple places for the same
2142
# values, like seconds. The current code, while more esoteric, is
2143
# cleaner without depending on a parsing library. If Python had a
2144
# built-in library for parsing we would use it, but we'd like to
2145
# avoid excessive use of external libraries.
2147
# New type for defining tokens, syntax, and semantics all-in-one
2148
Token = collections.namedtuple("Token",
2149
("regexp", # To match token; if
2150
# "value" is not None,
2151
# must have a "group"
2153
"value", # datetime.timedelta or
2155
"followers")) # Tokens valid after
2157
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2158
# the "duration" ABNF definition in RFC 3339, Appendix A.
2159
token_end = Token(re.compile(r"$"), None, frozenset())
2160
token_second = Token(re.compile(r"(\d+)S"),
2161
datetime.timedelta(seconds=1),
2162
frozenset((token_end,)))
2163
token_minute = Token(re.compile(r"(\d+)M"),
2164
datetime.timedelta(minutes=1),
2165
frozenset((token_second, token_end)))
2166
token_hour = Token(re.compile(r"(\d+)H"),
2167
datetime.timedelta(hours=1),
2168
frozenset((token_minute, token_end)))
2169
token_time = Token(re.compile(r"T"),
2171
frozenset((token_hour, token_minute,
2173
token_day = Token(re.compile(r"(\d+)D"),
2174
datetime.timedelta(days=1),
2175
frozenset((token_time, token_end)))
2176
token_month = Token(re.compile(r"(\d+)M"),
2177
datetime.timedelta(weeks=4),
2178
frozenset((token_day, token_end)))
2179
token_year = Token(re.compile(r"(\d+)Y"),
2180
datetime.timedelta(weeks=52),
2181
frozenset((token_month, token_end)))
2182
token_week = Token(re.compile(r"(\d+)W"),
2183
datetime.timedelta(weeks=1),
2184
frozenset((token_end,)))
2185
token_duration = Token(re.compile(r"P"), None,
2186
frozenset((token_year, token_month,
2187
token_day, token_time,
2189
# Define starting values
2190
value = datetime.timedelta() # Value so far
2192
followers = frozenset((token_duration,)) # Following valid tokens
2193
s = duration # String left to parse
2194
# Loop until end token is found
2195
while found_token is not token_end:
2196
# Search for any currently valid tokens
2197
for token in followers:
2198
match = token.regexp.match(s)
2199
if match is not None:
2201
if token.value is not None:
2202
# Value found, parse digits
2203
factor = int(match.group(1), 10)
2204
# Add to value so far
2205
value += factor * token.value
2206
# Strip token from string
2207
s = token.regexp.sub("", s, 1)
2210
# Set valid next tokens
2211
followers = found_token.followers
2214
# No currently valid tokens were found
2215
raise ValueError("Invalid RFC 3339 duration")
1917
2220
def string_to_delta(interval):
1918
2221
"""Parse a string and return a datetime.timedelta
2011
2320
parser.add_argument("--no-dbus", action="store_false",
2012
2321
dest="use_dbus", help="Do not provide D-Bus"
2013
" system bus interface")
2322
" system bus interface", default=None)
2014
2323
parser.add_argument("--no-ipv6", action="store_false",
2015
dest="use_ipv6", help="Do not use IPv6")
2324
dest="use_ipv6", help="Do not use IPv6",
2016
2326
parser.add_argument("--no-restore", action="store_false",
2017
2327
dest="restore", help="Do not restore stored"
2328
" state", default=None)
2329
parser.add_argument("--socket", type=int,
2330
help="Specify a file descriptor to a network"
2331
" socket to use instead of creating one")
2019
2332
parser.add_argument("--statedir", metavar="DIR",
2020
2333
help="Directory to save/restore state in")
2334
parser.add_argument("--foreground", action="store_true",
2335
help="Run in foreground", default=None)
2336
parser.add_argument("--no-zeroconf", action="store_false",
2337
dest="zeroconf", help="Do not use Zeroconf",
2022
2340
options = parser.parse_args()
2024
2342
if options.check:
2344
fail_count, test_count = doctest.testmod()
2345
sys.exit(os.EX_OK if fail_count == 0 else 1)
2029
2347
# Default values for config file for server-global settings
2030
2348
server_defaults = { "interface": "",
2049
2370
# Convert the SafeConfigParser object to a dict
2050
2371
server_settings = server_config.defaults()
2051
2372
# Use the appropriate methods on the non-string config options
2052
for option in ("debug", "use_dbus", "use_ipv6"):
2373
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2053
2374
server_settings[option] = server_config.getboolean("DEFAULT",
2055
2376
if server_settings["port"]:
2056
2377
server_settings["port"] = server_config.getint("DEFAULT",
2379
if server_settings["socket"]:
2380
server_settings["socket"] = server_config.getint("DEFAULT",
2382
# Later, stdin will, and stdout and stderr might, be dup'ed
2383
# over with an opened os.devnull. But we don't want this to
2384
# happen with a supplied network socket.
2385
if 0 <= server_settings["socket"] <= 2:
2386
server_settings["socket"] = os.dup(server_settings
2058
2388
del server_config
2060
2390
# Override the settings from the config file with command line
2062
2392
for option in ("interface", "address", "port", "debug",
2063
2393
"priority", "servicename", "configdir",
2064
2394
"use_dbus", "use_ipv6", "debuglevel", "restore",
2395
"statedir", "socket", "foreground", "zeroconf"):
2066
2396
value = getattr(options, option)
2067
2397
if value is not None:
2068
2398
server_settings[option] = value
2070
2400
# Force all strings to be unicode
2071
2401
for option in server_settings.keys():
2072
if type(server_settings[option]) is str:
2073
server_settings[option] = unicode(server_settings[option])
2402
if isinstance(server_settings[option], bytes):
2403
server_settings[option] = (server_settings[option]
2405
# Force all boolean options to be boolean
2406
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2407
"foreground", "zeroconf"):
2408
server_settings[option] = bool(server_settings[option])
2409
# Debug implies foreground
2410
if server_settings["debug"]:
2411
server_settings["foreground"] = True
2074
2412
# Now we have our good server settings in "server_settings"
2076
2414
##################################################################
2416
if (not server_settings["zeroconf"] and
2417
not (server_settings["port"]
2418
or server_settings["socket"] != "")):
2419
parser.error("Needs port or socket to work without"
2078
2422
# For convenience
2079
2423
debug = server_settings["debug"]
2080
2424
debuglevel = server_settings["debuglevel"]
2115
2465
use_ipv6=use_ipv6,
2116
2466
gnutls_priority=
2117
2467
server_settings["priority"],
2120
pidfilename = "/var/run/mandos.pid"
2471
pidfilename = "/run/mandos.pid"
2472
if not os.path.isdir("/run/."):
2473
pidfilename = "/var/run/mandos.pid"
2122
2476
pidfile = open(pidfilename, "w")
2124
logger.error("Could not open file %r", pidfilename)
2477
except IOError as e:
2478
logger.error("Could not open file %r", pidfilename,
2127
uid = pwd.getpwnam("_mandos").pw_uid
2128
gid = pwd.getpwnam("_mandos").pw_gid
2481
for name in ("_mandos", "mandos", "nobody"):
2131
uid = pwd.getpwnam("mandos").pw_uid
2132
gid = pwd.getpwnam("mandos").pw_gid
2483
uid = pwd.getpwnam(name).pw_uid
2484
gid = pwd.getpwnam(name).pw_gid
2133
2486
except KeyError:
2135
uid = pwd.getpwnam("nobody").pw_uid
2136
gid = pwd.getpwnam("nobody").pw_gid
2143
2494
except OSError as error:
2144
if error[0] != errno.EPERM:
2495
if error.errno != errno.EPERM:
2148
2499
# Enable all possible GnuTLS debugging
2159
2510
.gnutls_global_set_log_function(debug_gnutls))
2161
2512
# Redirect stdin so all checkers get /dev/null
2162
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2513
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2163
2514
os.dup2(null, sys.stdin.fileno())
2167
2518
# Need to fork before connecting to D-Bus
2169
2520
# Close all input and output, do double fork, etc.
2523
# multiprocessing will use threads, so before we use gobject we
2524
# need to inform gobject that threads will be used.
2172
2525
gobject.threads_init()
2174
2527
global main_loop
2175
2528
# From the Avahi example code
2176
DBusGMainLoop(set_as_default=True )
2529
DBusGMainLoop(set_as_default=True)
2177
2530
main_loop = gobject.MainLoop()
2178
2531
bus = dbus.SystemBus()
2179
2532
# End of Avahi example code
2185
2538
("se.bsnet.fukt.Mandos", bus,
2186
2539
do_not_queue=True))
2187
2540
except dbus.exceptions.NameExistsException as e:
2188
logger.error(unicode(e) + ", disabling D-Bus")
2541
logger.error("Disabling D-Bus:", exc_info=e)
2189
2542
use_dbus = False
2190
2543
server_settings["use_dbus"] = False
2191
2544
tcp_server.use_dbus = False
2192
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2193
service = AvahiServiceToSyslog(name =
2194
server_settings["servicename"],
2195
servicetype = "_mandos._tcp",
2196
protocol = protocol, bus = bus)
2197
if server_settings["interface"]:
2198
service.interface = (if_nametoindex
2199
(str(server_settings["interface"])))
2546
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2547
service = AvahiServiceToSyslog(name =
2548
server_settings["servicename"],
2549
servicetype = "_mandos._tcp",
2550
protocol = protocol, bus = bus)
2551
if server_settings["interface"]:
2552
service.interface = (if_nametoindex
2553
(server_settings["interface"]
2201
2556
global multiprocessing_manager
2202
2557
multiprocessing_manager = multiprocessing.Manager()
2204
2559
client_class = Client
2206
client_class = functools.partial(ClientDBusTransitional,
2561
client_class = functools.partial(ClientDBus, bus = bus)
2209
2563
client_settings = Client.config_parser(client_config)
2210
2564
old_client_settings = {}
2211
2565
clients_data = {}
2567
# This is used to redirect stdout and stderr for checker processes
2569
wnull = open(os.devnull, "w") # A writable /dev/null
2570
# Only used if server is running in foreground but not in debug
2572
if debug or not foreground:
2213
2575
# Get client data and settings from last running state.
2214
2576
if server_settings["restore"]:
2218
2580
(stored_state))
2219
2581
os.remove(stored_state_path)
2220
2582
except IOError as e:
2221
logger.warning("Could not load persistent state: {0}"
2223
if e.errno != errno.ENOENT:
2583
if e.errno == errno.ENOENT:
2584
logger.warning("Could not load persistent state: {}"
2585
.format(os.strerror(e.errno)))
2587
logger.critical("Could not load persistent state:",
2225
2590
except EOFError as e:
2226
2591
logger.warning("Could not load persistent state: "
2227
"EOFError: {0}".format(e))
2592
"EOFError:", exc_info=e)
2229
2594
with PGPEngine() as pgp:
2230
for client_name, client in clients_data.iteritems():
2595
for client_name, client in clients_data.items():
2596
# Skip removed clients
2597
if client_name not in client_settings:
2231
2600
# Decide which value to use after restoring saved state.
2232
2601
# We have three different values: Old config file,
2233
2602
# new config file, and saved state.
2292
2660
for client_name in (set(client_settings)
2293
2661
- set(old_client_settings)):
2294
2662
clients_data[client_name] = client_settings[client_name]
2296
2664
# Create all client objects
2297
for client_name, client in clients_data.iteritems():
2665
for client_name, client in clients_data.items():
2298
2666
tcp_server.clients[client_name] = client_class(
2299
name = client_name, settings = client)
2667
name = client_name, settings = client,
2668
server_settings = server_settings)
2301
2670
if not tcp_server.clients:
2302
2671
logger.warning("No clients defined")
2308
pidfile.write(str(pid) + "\n".encode("utf-8"))
2311
logger.error("Could not write to file %r with PID %d",
2314
# "pidfile" was never created
2674
if pidfile is not None:
2678
pidfile.write("{}\n".format(pid).encode("utf-8"))
2680
logger.error("Could not write to file %r with PID %d",
2316
2683
del pidfilename
2317
signal.signal(signal.SIGINT, signal.SIG_IGN)
2319
2685
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2320
2686
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2323
class MandosDBusService(dbus.service.Object):
2689
@alternate_dbus_interfaces({"se.recompile.Mandos":
2690
"se.bsnet.fukt.Mandos"})
2691
class MandosDBusService(DBusObjectWithProperties):
2324
2692
"""A D-Bus proxy object"""
2325
2693
def __init__(self):
2326
2694
dbus.service.Object.__init__(self, bus, "/")
2327
2695
_interface = "se.recompile.Mandos"
2697
@dbus_interface_annotations(_interface)
2699
return { "org.freedesktop.DBus.Property"
2700
".EmitsChangedSignal":
2329
2703
@dbus.service.signal(_interface, signature="o")
2330
2704
def ClientAdded(self, objpath):
2414
2788
del client_settings[client.name]["secret"]
2417
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2420
(stored_state_path))
2421
with os.fdopen(tempfd, "wb") as stored_state:
2791
with (tempfile.NamedTemporaryFile
2792
(mode='wb', suffix=".pickle", prefix='clients-',
2793
dir=os.path.dirname(stored_state_path),
2794
delete=False)) as stored_state:
2422
2795
pickle.dump((clients, client_settings), stored_state)
2796
tempname=stored_state.name
2423
2797
os.rename(tempname, stored_state_path)
2424
2798
except (IOError, OSError) as e:
2425
logger.warning("Could not save persistent state: {0}"
2429
2801
os.remove(tempname)
2430
2802
except NameError:
2432
if e.errno not in set((errno.ENOENT, errno.EACCES,
2804
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2805
logger.warning("Could not save persistent state: {}"
2806
.format(os.strerror(e.errno)))
2808
logger.warning("Could not save persistent state:",
2436
2812
# Delete all clients, and settings from config
2437
2813
while tcp_server.clients:
2461
2837
tcp_server.server_activate()
2463
2839
# Find out what port we got
2464
service.port = tcp_server.socket.getsockname()[1]
2841
service.port = tcp_server.socket.getsockname()[1]
2466
2843
logger.info("Now listening on address %r, port %d,"
2467
" flowinfo %d, scope_id %d"
2468
% tcp_server.socket.getsockname())
2844
" flowinfo %d, scope_id %d",
2845
*tcp_server.socket.getsockname())
2470
logger.info("Now listening on address %r, port %d"
2471
% tcp_server.socket.getsockname())
2847
logger.info("Now listening on address %r, port %d",
2848
*tcp_server.socket.getsockname())
2473
2850
#service.interface = tcp_server.socket.getsockname()[3]
2476
# From the Avahi example code
2479
except dbus.exceptions.DBusException as error:
2480
logger.critical("DBusException: %s", error)
2483
# End of Avahi example code
2854
# From the Avahi example code
2857
except dbus.exceptions.DBusException as error:
2858
logger.critical("D-Bus Exception", exc_info=error)
2861
# End of Avahi example code
2485
2863
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2486
2864
lambda *args, **kwargs: