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):
261
274
self.server = None
263
276
self.entry_group_state_changed_match = None
278
def rename(self, remove=True):
265
279
"""Derived from the Avahi example code"""
266
280
if self.rename_count >= self.max_renames:
267
281
logger.critical("No suitable Zeroconf service name found"
268
282
" after %i retries, exiting.",
269
283
self.rename_count)
270
284
raise AvahiServiceError("Too many renames")
271
self.name = unicode(self.server
272
.GetAlternativeServiceName(self.name))
285
self.name = str(self.server
286
.GetAlternativeServiceName(self.name))
287
self.rename_count += 1
273
288
logger.info("Changing Zeroconf service name to %r ...",
278
294
except dbus.exceptions.DBusException as error:
279
logger.critical("DBusException: %s", error)
282
self.rename_count += 1
295
if (error.get_dbus_name()
296
== "org.freedesktop.Avahi.CollisionError"):
297
logger.info("Local Zeroconf service name collision.")
298
return self.rename(remove=False)
300
logger.critical("D-Bus Exception", exc_info=error)
283
304
def remove(self):
284
305
"""Derived from the Avahi example code"""
285
306
if self.entry_group_state_changed_match is not None:
369
395
self.server_state_changed)
370
396
self.server_state_changed(self.server.GetState())
372
399
class AvahiServiceToSyslog(AvahiService):
400
def rename(self, *args, **kwargs):
374
401
"""Add the new name to the syslog messages"""
375
ret = AvahiService.rename(self)
402
ret = AvahiService.rename(self, *args, **kwargs)
376
403
syslogger.setFormatter(logging.Formatter
377
('Mandos (%s) [%%(process)d]:'
378
' %%(levelname)s: %%(message)s'
404
('Mandos ({}) [%(process)d]:'
405
' %(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
410
class Client(object):
389
411
"""A representation of a client host served by this server.
426
448
runtime_expansions: Allowed attributes for runtime expansion.
427
449
expires: datetime.datetime(); time (UTC) when a client will be
428
450
disabled, or None
451
server_settings: The server_settings dict from main()
431
454
runtime_expansions = ("approval_delay", "approval_duration",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
455
"created", "enabled", "expires",
456
"fingerprint", "host", "interval",
457
"last_approval_request", "last_checked_ok",
434
458
"last_enabled", "name", "timeout")
435
client_defaults = { "timeout": "5m",
436
"extended_timeout": "15m",
459
client_defaults = { "timeout": "PT5M",
460
"extended_timeout": "PT15M",
438
462
"checker": "fping -q -- %%(host)s",
440
"approval_delay": "0s",
441
"approval_duration": "1s",
464
"approval_delay": "PT0S",
465
"approval_duration": "PT1S",
442
466
"approved_by_default": "True",
443
467
"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
471
def config_parser(config):
463
472
"""Construct a new dict of client settings of this form:
501
510
client["checker_command"] = section["checker"]
502
511
client["last_approval_request"] = None
503
512
client["last_checked_ok"] = None
504
client["last_checker_status"] = None
513
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'
517
def __init__(self, settings, name = None, server_settings=None):
519
if server_settings is None:
521
self.server_settings = server_settings
514
522
# adding all client settings
515
for setting, value in settings.iteritems():
523
for setting, value in settings.items():
516
524
setattr(self, setting, value)
566
574
if getattr(self, "enabled", False):
567
575
# Already enabled
569
self.send_changedstate()
570
577
self.expires = datetime.datetime.utcnow() + self.timeout
571
578
self.enabled = True
572
579
self.last_enabled = datetime.datetime.utcnow()
573
580
self.init_checker()
581
self.send_changedstate()
575
583
def disable(self, quiet=True):
576
584
"""Disable this client."""
577
585
if not getattr(self, "enabled", False):
580
self.send_changedstate()
582
588
logger.info("Disabling client %s", self.name)
583
if getattr(self, "disable_initiator_tag", False):
589
if getattr(self, "disable_initiator_tag", None) is not None:
584
590
gobject.source_remove(self.disable_initiator_tag)
585
591
self.disable_initiator_tag = None
586
592
self.expires = None
587
if getattr(self, "checker_initiator_tag", False):
593
if getattr(self, "checker_initiator_tag", None) is not None:
588
594
gobject.source_remove(self.checker_initiator_tag)
589
595
self.checker_initiator_tag = None
590
596
self.stop_checker()
591
597
self.enabled = False
599
self.send_changedstate()
592
600
# Do not run this again if called by a gobject.timeout_add
598
606
def init_checker(self):
599
607
# Schedule a new checker to be started an 'interval' from now,
600
608
# and every interval from then on.
609
if self.checker_initiator_tag is not None:
610
gobject.source_remove(self.checker_initiator_tag)
601
611
self.checker_initiator_tag = (gobject.timeout_add
602
(self.interval_milliseconds(),
613
.total_seconds() * 1000),
603
614
self.start_checker))
604
615
# Schedule a disable() when 'timeout' has passed
616
if self.disable_initiator_tag is not None:
617
gobject.source_remove(self.disable_initiator_tag)
605
618
self.disable_initiator_tag = (gobject.timeout_add
606
(self.timeout_milliseconds(),
620
.total_seconds() * 1000),
608
622
# Also start a new checker *right now*.
609
623
self.start_checker()
626
640
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,
643
def checked_ok(self):
644
"""Assert that the client has been seen, alive and well."""
645
self.last_checked_ok = datetime.datetime.utcnow()
646
self.last_checker_status = 0
649
def bump_timeout(self, timeout=None):
650
"""Bump up the timeout for this client."""
635
651
if timeout is None:
636
652
timeout = self.timeout
637
self.last_checked_ok = datetime.datetime.utcnow()
638
653
if self.disable_initiator_tag is not None:
639
654
gobject.source_remove(self.disable_initiator_tag)
655
self.disable_initiator_tag = None
640
656
if getattr(self, "enabled", False):
641
657
self.disable_initiator_tag = (gobject.timeout_add
642
(timedelta_to_milliseconds
643
(timeout), self.disable))
658
(int(timeout.total_seconds()
659
* 1000), self.disable))
644
660
self.expires = datetime.datetime.utcnow() + timeout
646
662
def need_approval(self):
652
668
If a checker already exists, leave it running and do
654
670
# 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
671
# did that, and if a checker (for some reason) started running
672
# slowly and taking more than 'interval' time, then the client
673
# would inevitably timeout, since no checker would get a
674
# chance to run to completion. If we instead leave running
659
675
# checkers alone, the checker would have to take more time
660
676
# than 'timeout' for the client to be disabled, which is as it
675
692
self.current_checker_command)
676
693
# Start a new checker if needed
677
694
if self.checker is None:
695
# Escape attributes for the shell
696
escaped_attrs = { attr:
697
re.escape(str(getattr(self, attr)))
698
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
700
command = self.checker_command % escaped_attrs
701
except TypeError as error:
702
logger.error('Could not format string "%s"',
703
self.checker_command, exc_info=error)
704
return True # Try again later
697
705
self.current_checker_command = command
699
707
logger.info("Starting checker %r for %s",
702
710
# in normal mode, that is already done by daemon(),
703
711
# and in debug mode we don't want to. (Stdin is
704
712
# always replaced by /dev/null.)
713
# The exception is when not debugging but nevertheless
714
# running in the foreground; use the previously
717
if (not self.server_settings["debug"]
718
and self.server_settings["foreground"]):
719
popen_args.update({"stdout": wnull,
705
721
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.
725
except OSError as error:
726
logger.error("Failed to start subprocess",
729
self.checker_callback_tag = (gobject.child_watch_add
731
self.checker_callback,
733
# The checker may have completed before the gobject
734
# watch was added. Check for this.
714
736
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
737
except OSError as error:
719
logger.error("Failed to start subprocess: %s",
738
if error.errno == errno.ECHILD:
739
# This should never happen
740
logger.error("Child process vanished",
745
gobject.source_remove(self.checker_callback_tag)
746
self.checker_callback(pid, status, command)
721
747
# Re-run this periodically if run by gobject.timeout_add
799
def dbus_interface_annotations(dbus_interface):
800
"""Decorator for marking functions returning interface annotations
804
@dbus_interface_annotations("org.example.Interface")
805
def _foo(self): # Function name does not matter
806
return {"org.freedesktop.DBus.Deprecated": "true",
807
"org.freedesktop.DBus.Property.EmitsChangedSignal":
811
func._dbus_is_interface = True
812
func._dbus_interface = dbus_interface
813
func._dbus_name = dbus_interface
818
def dbus_annotations(annotations):
819
"""Decorator to annotate D-Bus methods, signals or properties
822
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
823
"org.freedesktop.DBus.Property."
824
"EmitsChangedSignal": "false"})
825
@dbus_service_property("org.example.Interface", signature="b",
827
def Property_dbus_property(self):
828
return dbus.Boolean(False)
831
func._dbus_annotations = annotations
773
836
class DBusPropertyException(dbus.exceptions.DBusException):
774
837
"""A base class for D-Bus property-related exceptions
776
def __unicode__(self):
777
return unicode(str(self))
780
841
class DBusPropertyAccessException(DBusPropertyException):
781
842
"""A property's access permissions disallows an operation.
801
def _is_dbus_property(obj):
802
return getattr(obj, "_dbus_is_property", False)
862
def _is_dbus_thing(thing):
863
"""Returns a function testing if an attribute is a D-Bus thing
865
If called like _is_dbus_thing("method") it returns a function
866
suitable for use as predicate to inspect.getmembers().
868
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
804
def _get_all_dbus_properties(self):
871
def _get_all_dbus_things(self, thing):
805
872
"""Returns a generator of (name, attribute) pairs
807
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
874
return ((getattr(athing.__get__(self), "_dbus_name",
876
athing.__get__(self))
808
877
for cls in self.__class__.__mro__
810
inspect.getmembers(cls, self._is_dbus_property))
879
inspect.getmembers(cls,
880
self._is_dbus_thing(thing)))
812
882
def _get_dbus_property(self, interface_name, property_name):
813
883
"""Returns a bound method if one exists which is a D-Bus
879
952
value.variant_level+1)
880
953
return dbus.Dictionary(properties, signature="sv")
955
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
956
def PropertiesChanged(self, interface_name, changed_properties,
957
invalidated_properties):
958
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
882
963
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
883
964
out_signature="s",
884
965
path_keyword='object_path',
885
966
connection_keyword='connection')
886
967
def Introspect(self, object_path, connection):
887
"""Standard D-Bus method, overloaded to insert property tags.
968
"""Overloading of standard D-Bus method.
970
Inserts property tags and interface annotation tags.
889
972
xmlstring = dbus.service.Object.Introspect(self, object_path,
897
980
e.setAttribute("access", prop._dbus_access)
899
982
for if_tag in document.getElementsByTagName("interface"):
900
984
for tag in (make_tag(document, name, prop)
902
in self._get_all_dbus_properties()
986
in self._get_all_dbus_things("property")
903
987
if prop._dbus_interface
904
988
== if_tag.getAttribute("name")):
905
989
if_tag.appendChild(tag)
990
# Add annotation tags
991
for typ in ("method", "signal", "property"):
992
for tag in if_tag.getElementsByTagName(typ):
994
for name, prop in (self.
995
_get_all_dbus_things(typ)):
996
if (name == tag.getAttribute("name")
997
and prop._dbus_interface
998
== if_tag.getAttribute("name")):
999
annots.update(getattr
1001
"_dbus_annotations",
1003
for name, value in annots.items():
1004
ann_tag = document.createElement(
1006
ann_tag.setAttribute("name", name)
1007
ann_tag.setAttribute("value", value)
1008
tag.appendChild(ann_tag)
1009
# Add interface annotation tags
1010
for annotation, value in dict(
1011
itertools.chain.from_iterable(
1012
annotations().items()
1013
for name, annotations in
1014
self._get_all_dbus_things("interface")
1015
if name == if_tag.getAttribute("name")
1017
ann_tag = document.createElement("annotation")
1018
ann_tag.setAttribute("name", annotation)
1019
ann_tag.setAttribute("value", value)
1020
if_tag.appendChild(ann_tag)
906
1021
# Add the names to the return values for the
907
1022
# "org.freedesktop.DBus.Properties" methods
908
1023
if (if_tag.getAttribute("name")
935
1050
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.
1053
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1054
"""A class decorator; applied to a subclass of
1055
dbus.service.Object, it will add alternate D-Bus attributes with
1056
interface names according to the "alt_interface_names" mapping.
1059
@alternate_dbus_interfaces({"org.example.Interface":
1060
"net.example.AlternateInterface"})
1061
class SampleDBusObject(dbus.service.Object):
1062
@dbus.service.method("org.example.Interface")
1063
def SampleDBusMethod():
1066
The above "SampleDBusMethod" on "SampleDBusObject" will be
1067
reachable via two interfaces: "org.example.Interface" and
1068
"net.example.AlternateInterface", the latter of which will have
1069
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1070
"true", unless "deprecate" is passed with a False value.
1072
This works for methods and signals, and also for D-Bus properties
1073
(from DBusObjectWithProperties) and interfaces (from the
1074
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):
1077
for orig_interface_name, alt_interface_name in (
1078
alt_interface_names.items()):
1080
interface_names = set()
1081
# Go though all attributes of the class
1082
for attrname, attribute in inspect.getmembers(cls):
950
1083
# Ignore non-D-Bus attributes, and D-Bus attributes
951
1084
# with the wrong interface name
952
1085
if (not hasattr(attribute, "_dbus_interface")
953
1086
or not attribute._dbus_interface
954
.startswith("se.recompile.Mandos")):
1087
.startswith(orig_interface_name)):
956
1089
# Create an alternate D-Bus interface name based on
957
1090
# the current name
958
1091
alt_interface = (attribute._dbus_interface
959
.replace("se.recompile.Mandos",
960
"se.bsnet.fukt.Mandos"))
1092
.replace(orig_interface_name,
1093
alt_interface_name))
1094
interface_names.add(alt_interface)
961
1095
# Is this a D-Bus signal?
962
1096
if getattr(attribute, "_dbus_is_signal", False):
963
# Extract the original non-method function by
1097
# Extract the original non-method undecorated
1098
# function by black magic
965
1099
nonmethod_func = (dict(
966
1100
zip(attribute.func_code.co_freevars,
967
1101
attribute.__closure__))["func"]
978
1112
nonmethod_func.func_name,
979
1113
nonmethod_func.func_defaults,
980
1114
nonmethod_func.func_closure)))
1115
# Copy annotations, if any
1117
new_function._dbus_annotations = (
1118
dict(attribute._dbus_annotations))
1119
except AttributeError:
981
1121
# 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
1122
# original and alternate functions, so both the
1123
# original and alternate signals gets sent when
1124
# the function is called
984
1125
def fixscope(func1, func2):
985
1126
"""This function is a scope container to pass
986
1127
func1 and func2 to the "call_both" function
1030
1176
attribute.func_name,
1031
1177
attribute.func_defaults,
1032
1178
attribute.func_closure)))
1033
return type.__new__(mcs, name, bases, attr)
1179
# Copy annotations, if any
1181
attr[attrname]._dbus_annotations = (
1182
dict(attribute._dbus_annotations))
1183
except AttributeError:
1185
# Is this a D-Bus interface?
1186
elif getattr(attribute, "_dbus_is_interface", False):
1187
# Create a new, but exactly alike, function
1188
# object. Decorate it to be a new D-Bus interface
1189
# with the alternate D-Bus interface name. Add it
1191
attr[attrname] = (dbus_interface_annotations
1194
(attribute.func_code,
1195
attribute.func_globals,
1196
attribute.func_name,
1197
attribute.func_defaults,
1198
attribute.func_closure)))
1200
# Deprecate all alternate interfaces
1201
iname="_AlternateDBusNames_interface_annotation{}"
1202
for interface_name in interface_names:
1203
@dbus_interface_annotations(interface_name)
1205
return { "org.freedesktop.DBus.Deprecated":
1207
# Find an unused name
1208
for aname in (iname.format(i)
1209
for i in itertools.count()):
1210
if aname not in attr:
1214
# Replace the class with a new subclass of it with
1215
# methods, signals, etc. as created above.
1216
cls = type(b"{}Alternate".format(cls.__name__),
1222
@alternate_dbus_interfaces({"se.recompile.Mandos":
1223
"se.bsnet.fukt.Mandos"})
1036
1224
class ClientDBus(Client, DBusObjectWithProperties):
1037
1225
"""A Client class using D-Bus
1051
1241
Client.__init__(self, *args, **kwargs)
1052
1242
# Only now, when this client is initialized, can it show up on
1054
client_object_name = unicode(self.name).translate(
1244
client_object_name = str(self.name).translate(
1055
1245
{ord("."): ord("_"),
1056
1246
ord("-"): ord("_")})
1057
1247
self.dbus_object_path = (dbus.ObjectPath
1058
1248
("/clients/" + client_object_name))
1059
1249
DBusObjectWithProperties.__init__(self, self.bus,
1060
1250
self.dbus_object_path)
1062
1252
def notifychangeproperty(transform_func,
1063
1253
dbus_name, type_func=lambda x: x,
1254
variant_level=1, invalidate_only=False,
1255
_interface=_interface):
1065
1256
""" Modify a variable so that it's a property which announces
1066
1257
its changes to DBus.
1072
1263
to the D-Bus. Default: no transform
1073
1264
variant_level: D-Bus variant level. Default: 1
1075
attrname = "_{0}".format(dbus_name)
1266
attrname = "_{}".format(dbus_name)
1076
1267
def setter(self, value):
1077
1268
if hasattr(self, "dbus_object_path"):
1078
1269
if (not hasattr(self, attrname) or
1079
1270
type_func(getattr(self, attrname, None))
1080
1271
!= type_func(value)):
1081
dbus_value = transform_func(type_func(value),
1084
self.PropertyChanged(dbus.String(dbus_name),
1273
self.PropertiesChanged(_interface,
1278
dbus_value = transform_func(type_func(value),
1281
self.PropertyChanged(dbus.String(dbus_name),
1283
self.PropertiesChanged(_interface,
1285
dbus.String(dbus_name):
1286
dbus_value }), dbus.Array())
1086
1287
setattr(self, attrname, value)
1088
1289
return property(lambda self: getattr(self, attrname), setter)
1091
1291
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1092
1292
approvals_pending = notifychangeproperty(dbus.Boolean,
1093
1293
"ApprovalPending",
1107
1309
approval_delay = notifychangeproperty(dbus.UInt64,
1108
1310
"ApprovalDelay",
1110
timedelta_to_milliseconds)
1312
lambda td: td.total_seconds()
1111
1314
approval_duration = notifychangeproperty(
1112
1315
dbus.UInt64, "ApprovalDuration",
1113
type_func = timedelta_to_milliseconds)
1316
type_func = lambda td: td.total_seconds() * 1000)
1114
1317
host = notifychangeproperty(dbus.String, "Host")
1115
1318
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1117
timedelta_to_milliseconds)
1319
type_func = lambda td:
1320
td.total_seconds() * 1000)
1118
1321
extended_timeout = notifychangeproperty(
1119
1322
dbus.UInt64, "ExtendedTimeout",
1120
type_func = timedelta_to_milliseconds)
1323
type_func = lambda td: td.total_seconds() * 1000)
1121
1324
interval = notifychangeproperty(dbus.UInt64,
1124
timedelta_to_milliseconds)
1327
lambda td: td.total_seconds()
1125
1329
checker_command = notifychangeproperty(dbus.String, "Checker")
1330
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1331
invalidate_only=True)
1127
1333
del notifychangeproperty
1354
1563
access="readwrite")
1355
1564
def Timeout_dbus_property(self, value=None):
1356
1565
if value is None: # get
1357
return dbus.UInt64(self.timeout_milliseconds())
1566
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1567
old_timeout = self.timeout
1358
1568
self.timeout = datetime.timedelta(0, 0, 0, value)
1359
# Reschedule timeout
1569
# Reschedule disabling
1360
1570
if self.enabled:
1361
1571
now = datetime.datetime.utcnow()
1362
time_to_die = timedelta_to_milliseconds(
1363
(self.last_checked_ok + self.timeout) - now)
1364
if time_to_die <= 0:
1572
self.expires += self.timeout - old_timeout
1573
if self.expires <= now:
1365
1574
# The timeout has passed
1368
self.expires = (now +
1369
datetime.timedelta(milliseconds =
1371
1577
if (getattr(self, "disable_initiator_tag", None)
1374
1580
gobject.source_remove(self.disable_initiator_tag)
1375
self.disable_initiator_tag = (gobject.timeout_add
1581
self.disable_initiator_tag = (
1582
gobject.timeout_add(
1583
int((self.expires - now).total_seconds()
1584
* 1000), self.disable))
1379
1586
# ExtendedTimeout - property
1380
1587
@dbus_service_property(_interface, signature="t",
1381
1588
access="readwrite")
1382
1589
def ExtendedTimeout_dbus_property(self, value=None):
1383
1590
if value is None: # get
1384
return dbus.UInt64(self.extended_timeout_milliseconds())
1591
return dbus.UInt64(self.extended_timeout.total_seconds()
1385
1593
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1387
1595
# Interval - property
1729
1932
use_ipv6: Boolean; to use IPv6 or not
1731
1934
def __init__(self, server_address, RequestHandlerClass,
1732
interface=None, use_ipv6=True):
1935
interface=None, use_ipv6=True, socketfd=None):
1936
"""If socketfd is set, use that file descriptor instead of
1937
creating a new one with socket.socket().
1733
1939
self.interface = interface
1735
1941
self.address_family = socket.AF_INET6
1942
if socketfd is not None:
1943
# Save the file descriptor
1944
self.socketfd = socketfd
1945
# Save the original socket.socket() function
1946
self.socket_socket = socket.socket
1947
# To implement --socket, we monkey patch socket.socket.
1949
# (When socketserver.TCPServer is a new-style class, we
1950
# could make self.socket into a property instead of monkey
1951
# patching socket.socket.)
1953
# Create a one-time-only replacement for socket.socket()
1954
@functools.wraps(socket.socket)
1955
def socket_wrapper(*args, **kwargs):
1956
# Restore original function so subsequent calls are
1958
socket.socket = self.socket_socket
1959
del self.socket_socket
1960
# This time only, return a new socket object from the
1961
# saved file descriptor.
1962
return socket.fromfd(self.socketfd, *args, **kwargs)
1963
# Replace socket.socket() function with wrapper
1964
socket.socket = socket_wrapper
1965
# The socketserver.TCPServer.__init__ will call
1966
# socket.socket(), which might be our replacement,
1967
# socket_wrapper(), if socketfd was set.
1736
1968
socketserver.TCPServer.__init__(self, server_address,
1737
1969
RequestHandlerClass)
1738
1971
def server_bind(self):
1739
1972
"""This overrides the normal server_bind() function
1740
1973
to bind to an interface if one was specified, and also NOT to
1749
1982
self.socket.setsockopt(socket.SOL_SOCKET,
1750
1983
SO_BINDTODEVICE,
1984
(self.interface + "\0")
1753
1986
except socket.error as error:
1754
if error[0] == errno.EPERM:
1755
logger.error("No permission to"
1756
" bind to interface %s",
1758
elif error[0] == errno.ENOPROTOOPT:
1987
if error.errno == errno.EPERM:
1988
logger.error("No permission to bind to"
1989
" interface %s", self.interface)
1990
elif error.errno == errno.ENOPROTOOPT:
1759
1991
logger.error("SO_BINDTODEVICE not available;"
1760
1992
" cannot bind to interface %s",
1761
1993
self.interface)
1994
elif error.errno == errno.ENODEV:
1995
logger.error("Interface %s does not exist,"
1996
" cannot bind", self.interface)
1764
1999
# Only bind(2) the socket if we really need to.
1824
2060
def handle_ipc(self, source, condition, parent_pipe=None,
1825
2061
proc = None, client_object=None):
1827
gobject.IO_IN: "IN", # There is data to read.
1828
gobject.IO_OUT: "OUT", # Data can be written (without
1830
gobject.IO_PRI: "PRI", # There is urgent data to read.
1831
gobject.IO_ERR: "ERR", # Error condition.
1832
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1833
# broken, usually for pipes and
1836
conditions_string = ' | '.join(name
1838
condition_names.iteritems()
1839
if cond & condition)
1840
2062
# error, or the other end of multiprocessing.Pipe has closed
1841
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2063
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1842
2064
# Wait for other process to exit
2127
def rfc3339_duration_to_delta(duration):
2128
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2130
>>> rfc3339_duration_to_delta("P7D")
2131
datetime.timedelta(7)
2132
>>> rfc3339_duration_to_delta("PT60S")
2133
datetime.timedelta(0, 60)
2134
>>> rfc3339_duration_to_delta("PT60M")
2135
datetime.timedelta(0, 3600)
2136
>>> rfc3339_duration_to_delta("PT24H")
2137
datetime.timedelta(1)
2138
>>> rfc3339_duration_to_delta("P1W")
2139
datetime.timedelta(7)
2140
>>> rfc3339_duration_to_delta("PT5M30S")
2141
datetime.timedelta(0, 330)
2142
>>> rfc3339_duration_to_delta("P1DT3M20S")
2143
datetime.timedelta(1, 200)
2146
# Parsing an RFC 3339 duration with regular expressions is not
2147
# possible - there would have to be multiple places for the same
2148
# values, like seconds. The current code, while more esoteric, is
2149
# cleaner without depending on a parsing library. If Python had a
2150
# built-in library for parsing we would use it, but we'd like to
2151
# avoid excessive use of external libraries.
2153
# New type for defining tokens, syntax, and semantics all-in-one
2154
Token = collections.namedtuple("Token",
2155
("regexp", # To match token; if
2156
# "value" is not None,
2157
# must have a "group"
2159
"value", # datetime.timedelta or
2161
"followers")) # Tokens valid after
2163
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2164
# the "duration" ABNF definition in RFC 3339, Appendix A.
2165
token_end = Token(re.compile(r"$"), None, frozenset())
2166
token_second = Token(re.compile(r"(\d+)S"),
2167
datetime.timedelta(seconds=1),
2168
frozenset((token_end,)))
2169
token_minute = Token(re.compile(r"(\d+)M"),
2170
datetime.timedelta(minutes=1),
2171
frozenset((token_second, token_end)))
2172
token_hour = Token(re.compile(r"(\d+)H"),
2173
datetime.timedelta(hours=1),
2174
frozenset((token_minute, token_end)))
2175
token_time = Token(re.compile(r"T"),
2177
frozenset((token_hour, token_minute,
2179
token_day = Token(re.compile(r"(\d+)D"),
2180
datetime.timedelta(days=1),
2181
frozenset((token_time, token_end)))
2182
token_month = Token(re.compile(r"(\d+)M"),
2183
datetime.timedelta(weeks=4),
2184
frozenset((token_day, token_end)))
2185
token_year = Token(re.compile(r"(\d+)Y"),
2186
datetime.timedelta(weeks=52),
2187
frozenset((token_month, token_end)))
2188
token_week = Token(re.compile(r"(\d+)W"),
2189
datetime.timedelta(weeks=1),
2190
frozenset((token_end,)))
2191
token_duration = Token(re.compile(r"P"), None,
2192
frozenset((token_year, token_month,
2193
token_day, token_time,
2195
# Define starting values
2196
value = datetime.timedelta() # Value so far
2198
followers = frozenset((token_duration,)) # Following valid tokens
2199
s = duration # String left to parse
2200
# Loop until end token is found
2201
while found_token is not token_end:
2202
# Search for any currently valid tokens
2203
for token in followers:
2204
match = token.regexp.match(s)
2205
if match is not None:
2207
if token.value is not None:
2208
# Value found, parse digits
2209
factor = int(match.group(1), 10)
2210
# Add to value so far
2211
value += factor * token.value
2212
# Strip token from string
2213
s = token.regexp.sub("", s, 1)
2216
# Set valid next tokens
2217
followers = found_token.followers
2220
# No currently valid tokens were found
2221
raise ValueError("Invalid RFC 3339 duration")
1905
2226
def string_to_delta(interval):
1906
2227
"""Parse a string and return a datetime.timedelta
1999
2326
parser.add_argument("--no-dbus", action="store_false",
2000
2327
dest="use_dbus", help="Do not provide D-Bus"
2001
" system bus interface")
2328
" system bus interface", default=None)
2002
2329
parser.add_argument("--no-ipv6", action="store_false",
2003
dest="use_ipv6", help="Do not use IPv6")
2330
dest="use_ipv6", help="Do not use IPv6",
2004
2332
parser.add_argument("--no-restore", action="store_false",
2005
2333
dest="restore", help="Do not restore stored"
2334
" state", default=None)
2335
parser.add_argument("--socket", type=int,
2336
help="Specify a file descriptor to a network"
2337
" socket to use instead of creating one")
2007
2338
parser.add_argument("--statedir", metavar="DIR",
2008
2339
help="Directory to save/restore state in")
2340
parser.add_argument("--foreground", action="store_true",
2341
help="Run in foreground", default=None)
2342
parser.add_argument("--no-zeroconf", action="store_false",
2343
dest="zeroconf", help="Do not use Zeroconf",
2010
2346
options = parser.parse_args()
2012
2348
if options.check:
2350
fail_count, test_count = doctest.testmod()
2351
sys.exit(os.EX_OK if fail_count == 0 else 1)
2017
2353
# Default values for config file for server-global settings
2018
2354
server_defaults = { "interface": "",
2037
2376
# Convert the SafeConfigParser object to a dict
2038
2377
server_settings = server_config.defaults()
2039
2378
# Use the appropriate methods on the non-string config options
2040
for option in ("debug", "use_dbus", "use_ipv6"):
2379
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2041
2380
server_settings[option] = server_config.getboolean("DEFAULT",
2043
2382
if server_settings["port"]:
2044
2383
server_settings["port"] = server_config.getint("DEFAULT",
2385
if server_settings["socket"]:
2386
server_settings["socket"] = server_config.getint("DEFAULT",
2388
# Later, stdin will, and stdout and stderr might, be dup'ed
2389
# over with an opened os.devnull. But we don't want this to
2390
# happen with a supplied network socket.
2391
if 0 <= server_settings["socket"] <= 2:
2392
server_settings["socket"] = os.dup(server_settings
2046
2394
del server_config
2048
2396
# Override the settings from the config file with command line
2050
2398
for option in ("interface", "address", "port", "debug",
2051
2399
"priority", "servicename", "configdir",
2052
2400
"use_dbus", "use_ipv6", "debuglevel", "restore",
2401
"statedir", "socket", "foreground", "zeroconf"):
2054
2402
value = getattr(options, option)
2055
2403
if value is not None:
2056
2404
server_settings[option] = value
2058
2406
# Force all strings to be unicode
2059
2407
for option in server_settings.keys():
2060
if type(server_settings[option]) is str:
2061
server_settings[option] = unicode(server_settings[option])
2408
if isinstance(server_settings[option], bytes):
2409
server_settings[option] = (server_settings[option]
2411
# Force all boolean options to be boolean
2412
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2413
"foreground", "zeroconf"):
2414
server_settings[option] = bool(server_settings[option])
2415
# Debug implies foreground
2416
if server_settings["debug"]:
2417
server_settings["foreground"] = True
2062
2418
# Now we have our good server settings in "server_settings"
2064
2420
##################################################################
2422
if (not server_settings["zeroconf"] and
2423
not (server_settings["port"]
2424
or server_settings["socket"] != "")):
2425
parser.error("Needs port or socket to work without"
2066
2428
# For convenience
2067
2429
debug = server_settings["debug"]
2068
2430
debuglevel = server_settings["debuglevel"]
2103
2471
use_ipv6=use_ipv6,
2104
2472
gnutls_priority=
2105
2473
server_settings["priority"],
2108
pidfilename = "/var/run/mandos.pid"
2477
pidfilename = "/run/mandos.pid"
2478
if not os.path.isdir("/run/."):
2479
pidfilename = "/var/run/mandos.pid"
2110
2482
pidfile = open(pidfilename, "w")
2112
logger.error("Could not open file %r", pidfilename)
2483
except IOError as e:
2484
logger.error("Could not open file %r", pidfilename,
2115
uid = pwd.getpwnam("_mandos").pw_uid
2116
gid = pwd.getpwnam("_mandos").pw_gid
2487
for name in ("_mandos", "mandos", "nobody"):
2119
uid = pwd.getpwnam("mandos").pw_uid
2120
gid = pwd.getpwnam("mandos").pw_gid
2489
uid = pwd.getpwnam(name).pw_uid
2490
gid = pwd.getpwnam(name).pw_gid
2121
2492
except KeyError:
2123
uid = pwd.getpwnam("nobody").pw_uid
2124
gid = pwd.getpwnam("nobody").pw_gid
2131
2500
except OSError as error:
2132
if error[0] != errno.EPERM:
2501
if error.errno != errno.EPERM:
2136
2505
# Enable all possible GnuTLS debugging
2147
2516
.gnutls_global_set_log_function(debug_gnutls))
2149
2518
# Redirect stdin so all checkers get /dev/null
2150
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2519
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2151
2520
os.dup2(null, sys.stdin.fileno())
2155
2524
# Need to fork before connecting to D-Bus
2157
2526
# Close all input and output, do double fork, etc.
2529
# multiprocessing will use threads, so before we use gobject we
2530
# need to inform gobject that threads will be used.
2160
2531
gobject.threads_init()
2162
2533
global main_loop
2163
2534
# From the Avahi example code
2164
DBusGMainLoop(set_as_default=True )
2535
DBusGMainLoop(set_as_default=True)
2165
2536
main_loop = gobject.MainLoop()
2166
2537
bus = dbus.SystemBus()
2167
2538
# End of Avahi example code
2173
2544
("se.bsnet.fukt.Mandos", bus,
2174
2545
do_not_queue=True))
2175
2546
except dbus.exceptions.NameExistsException as e:
2176
logger.error(unicode(e) + ", disabling D-Bus")
2547
logger.error("Disabling D-Bus:", exc_info=e)
2177
2548
use_dbus = False
2178
2549
server_settings["use_dbus"] = False
2179
2550
tcp_server.use_dbus = False
2180
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2181
service = AvahiServiceToSyslog(name =
2182
server_settings["servicename"],
2183
servicetype = "_mandos._tcp",
2184
protocol = protocol, bus = bus)
2185
if server_settings["interface"]:
2186
service.interface = (if_nametoindex
2187
(str(server_settings["interface"])))
2552
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2553
service = AvahiServiceToSyslog(name =
2554
server_settings["servicename"],
2555
servicetype = "_mandos._tcp",
2556
protocol = protocol, bus = bus)
2557
if server_settings["interface"]:
2558
service.interface = (if_nametoindex
2559
(server_settings["interface"]
2189
2562
global multiprocessing_manager
2190
2563
multiprocessing_manager = multiprocessing.Manager()
2192
2565
client_class = Client
2194
client_class = functools.partial(ClientDBusTransitional,
2567
client_class = functools.partial(ClientDBus, bus = bus)
2197
2569
client_settings = Client.config_parser(client_config)
2198
2570
old_client_settings = {}
2199
2571
clients_data = {}
2573
# This is used to redirect stdout and stderr for checker processes
2575
wnull = open(os.devnull, "w") # A writable /dev/null
2576
# Only used if server is running in foreground but not in debug
2578
if debug or not foreground:
2201
2581
# Get client data and settings from last running state.
2202
2582
if server_settings["restore"]:
2206
2586
(stored_state))
2207
2587
os.remove(stored_state_path)
2208
2588
except IOError as e:
2209
logger.warning("Could not load persistent state: {0}"
2211
if e.errno != errno.ENOENT:
2589
if e.errno == errno.ENOENT:
2590
logger.warning("Could not load persistent state: {}"
2591
.format(os.strerror(e.errno)))
2593
logger.critical("Could not load persistent state:",
2213
2596
except EOFError as e:
2214
2597
logger.warning("Could not load persistent state: "
2215
"EOFError: {0}".format(e))
2598
"EOFError:", exc_info=e)
2217
2600
with PGPEngine() as pgp:
2218
for client_name, client in clients_data.iteritems():
2601
for client_name, client in clients_data.items():
2602
# Skip removed clients
2603
if client_name not in client_settings:
2219
2606
# Decide which value to use after restoring saved state.
2220
2607
# We have three different values: Old config file,
2221
2608
# new config file, and saved state.
2280
2666
for client_name in (set(client_settings)
2281
2667
- set(old_client_settings)):
2282
2668
clients_data[client_name] = client_settings[client_name]
2284
2670
# Create all client objects
2285
for client_name, client in clients_data.iteritems():
2671
for client_name, client in clients_data.items():
2286
2672
tcp_server.clients[client_name] = client_class(
2287
name = client_name, settings = client)
2673
name = client_name, settings = client,
2674
server_settings = server_settings)
2289
2676
if not tcp_server.clients:
2290
2677
logger.warning("No clients defined")
2296
pidfile.write(str(pid) + "\n".encode("utf-8"))
2299
logger.error("Could not write to file %r with PID %d",
2302
# "pidfile" was never created
2680
if pidfile is not None:
2684
pidfile.write("{}\n".format(pid).encode("utf-8"))
2686
logger.error("Could not write to file %r with PID %d",
2304
2689
del pidfilename
2305
signal.signal(signal.SIGINT, signal.SIG_IGN)
2307
2691
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2308
2692
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2311
class MandosDBusService(dbus.service.Object):
2695
@alternate_dbus_interfaces({"se.recompile.Mandos":
2696
"se.bsnet.fukt.Mandos"})
2697
class MandosDBusService(DBusObjectWithProperties):
2312
2698
"""A D-Bus proxy object"""
2313
2699
def __init__(self):
2314
2700
dbus.service.Object.__init__(self, bus, "/")
2315
2701
_interface = "se.recompile.Mandos"
2703
@dbus_interface_annotations(_interface)
2705
return { "org.freedesktop.DBus.Property"
2706
".EmitsChangedSignal":
2317
2709
@dbus.service.signal(_interface, signature="o")
2318
2710
def ClientAdded(self, objpath):
2402
2794
del client_settings[client.name]["secret"]
2405
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2408
(stored_state_path))
2409
with os.fdopen(tempfd, "wb") as stored_state:
2797
with (tempfile.NamedTemporaryFile
2798
(mode='wb', suffix=".pickle", prefix='clients-',
2799
dir=os.path.dirname(stored_state_path),
2800
delete=False)) as stored_state:
2410
2801
pickle.dump((clients, client_settings), stored_state)
2802
tempname=stored_state.name
2411
2803
os.rename(tempname, stored_state_path)
2412
2804
except (IOError, OSError) as e:
2413
logger.warning("Could not save persistent state: {0}"
2417
2807
os.remove(tempname)
2418
2808
except NameError:
2420
if e.errno not in set((errno.ENOENT, errno.EACCES,
2810
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2811
logger.warning("Could not save persistent state: {}"
2812
.format(os.strerror(e.errno)))
2814
logger.warning("Could not save persistent state:",
2424
2818
# Delete all clients, and settings from config
2425
2819
while tcp_server.clients:
2449
2843
tcp_server.server_activate()
2451
2845
# Find out what port we got
2452
service.port = tcp_server.socket.getsockname()[1]
2847
service.port = tcp_server.socket.getsockname()[1]
2454
2849
logger.info("Now listening on address %r, port %d,"
2455
" flowinfo %d, scope_id %d"
2456
% tcp_server.socket.getsockname())
2850
" flowinfo %d, scope_id %d",
2851
*tcp_server.socket.getsockname())
2458
logger.info("Now listening on address %r, port %d"
2459
% tcp_server.socket.getsockname())
2853
logger.info("Now listening on address %r, port %d",
2854
*tcp_server.socket.getsockname())
2461
2856
#service.interface = tcp_server.socket.getsockname()[3]
2464
# From the Avahi example code
2467
except dbus.exceptions.DBusException as error:
2468
logger.critical("DBusException: %s", error)
2471
# End of Avahi example code
2860
# From the Avahi example code
2863
except dbus.exceptions.DBusException as error:
2864
logger.critical("D-Bus Exception", exc_info=error)
2867
# End of Avahi example code
2473
2869
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2474
2870
lambda *args, **kwargs: