103
104
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
104
105
with contextlib.closing(socket.socket()) as s:
105
106
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
106
struct.pack(str("16s16x"),
108
interface_index = struct.unpack(str("I"),
107
struct.pack(b"16s16x", interface))
108
interface_index = struct.unpack("I", ifreq[16:20])[0]
110
109
return interface_index
113
112
def initlogger(debug, level=logging.WARNING):
114
113
"""init logger and add loglevel"""
116
syslogger = (logging.handlers.SysLogHandler
118
logging.handlers.SysLogHandler.LOG_DAEMON,
119
address = "/dev/log"))
116
120
syslogger.setFormatter(logging.Formatter
117
121
('Mandos [%(process)d]: %(levelname)s:'
171
173
def password_encode(self, password):
172
174
# Passphrase can not be empty and can not contain newlines or
173
175
# NUL bytes. So we prefix it and hex encode it.
174
return b"mandos" + binascii.hexlify(password)
176
encoded = b"mandos" + binascii.hexlify(password)
177
if len(encoded) > 2048:
178
# GnuPG can't handle long passwords, so encode differently
179
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
180
.replace(b"\n", b"\\n")
181
.replace(b"\0", b"\\x00"))
176
184
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
185
passphrase = self.password_encode(password)
186
with tempfile.NamedTemporaryFile(dir=self.tempdir
188
passfile.write(passphrase)
190
proc = subprocess.Popen(['gpg', '--symmetric',
194
stdin = subprocess.PIPE,
195
stdout = subprocess.PIPE,
196
stderr = subprocess.PIPE)
197
ciphertext, err = proc.communicate(input = data)
198
if proc.returncode != 0:
191
200
return ciphertext
193
202
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
203
passphrase = self.password_encode(password)
204
with tempfile.NamedTemporaryFile(dir = self.tempdir
206
passfile.write(passphrase)
208
proc = subprocess.Popen(['gpg', '--decrypt',
212
stdin = subprocess.PIPE,
213
stdout = subprocess.PIPE,
214
stderr = subprocess.PIPE)
215
decrypted_plaintext, err = proc.communicate(input
217
if proc.returncode != 0:
208
219
return decrypted_plaintext
212
222
class AvahiError(Exception):
213
223
def __init__(self, value, *args, **kwargs):
214
224
self.value = value
215
super(AvahiError, self).__init__(value, *args, **kwargs)
216
def __unicode__(self):
217
return unicode(repr(self.value))
225
return super(AvahiError, self).__init__(value, *args,
219
228
class AvahiServiceError(AvahiError):
369
386
self.server_state_changed)
370
387
self.server_state_changed(self.server.GetState())
372
390
class AvahiServiceToSyslog(AvahiService):
373
391
def rename(self):
374
392
"""Add the new name to the syslog messages"""
375
393
ret = AvahiService.rename(self)
376
394
syslogger.setFormatter(logging.Formatter
377
('Mandos (%s) [%%(process)d]:'
378
' %%(levelname)s: %%(message)s'
395
('Mandos ({}) [%(process)d]:'
396
' %(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
401
class Client(object):
389
402
"""A representation of a client host served by this server.
415
428
last_checked_ok: datetime.datetime(); (UTC) or None
416
429
last_checker_status: integer between 0 and 255 reflecting exit
417
430
status of last checker. -1 reflects crashed
431
checker, -2 means no checker completed yet.
419
432
last_enabled: datetime.datetime(); (UTC) or None
420
433
name: string; from the config file, used in log messages and
421
434
D-Bus identifiers
422
435
secret: bytestring; sent verbatim (over TLS) to client
423
436
timeout: datetime.timedelta(); How long from last_checked_ok
424
437
until this client is disabled
425
extended_timeout: extra long timeout when password has been sent
438
extended_timeout: extra long timeout when secret has been sent
426
439
runtime_expansions: Allowed attributes for runtime expansion.
427
440
expires: datetime.datetime(); time (UTC) when a client will be
428
441
disabled, or None
442
server_settings: The server_settings dict from main()
431
445
runtime_expansions = ("approval_delay", "approval_duration",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
446
"created", "enabled", "expires",
447
"fingerprint", "host", "interval",
448
"last_approval_request", "last_checked_ok",
434
449
"last_enabled", "name", "timeout")
435
client_defaults = { "timeout": "5m",
436
"extended_timeout": "15m",
450
client_defaults = { "timeout": "PT5M",
451
"extended_timeout": "PT15M",
438
453
"checker": "fping -q -- %%(host)s",
440
"approval_delay": "0s",
441
"approval_duration": "1s",
455
"approval_delay": "PT0S",
456
"approval_duration": "PT1S",
442
457
"approved_by_default": "True",
443
458
"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
462
def config_parser(config):
463
463
"""Construct a new dict of client settings of this form:
501
501
client["checker_command"] = section["checker"]
502
502
client["last_approval_request"] = None
503
503
client["last_checked_ok"] = None
504
client["last_checker_status"] = None
504
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'
508
def __init__(self, settings, name = None, server_settings=None):
510
if server_settings is None:
512
self.server_settings = server_settings
514
513
# adding all client settings
515
for setting, value in settings.iteritems():
514
for setting, value in settings.items():
516
515
setattr(self, setting, value)
566
565
if getattr(self, "enabled", False):
567
566
# Already enabled
569
self.send_changedstate()
570
568
self.expires = datetime.datetime.utcnow() + self.timeout
571
569
self.enabled = True
572
570
self.last_enabled = datetime.datetime.utcnow()
573
571
self.init_checker()
572
self.send_changedstate()
575
574
def disable(self, quiet=True):
576
575
"""Disable this client."""
577
576
if not getattr(self, "enabled", False):
580
self.send_changedstate()
582
579
logger.info("Disabling client %s", self.name)
583
if getattr(self, "disable_initiator_tag", False):
580
if getattr(self, "disable_initiator_tag", None) is not None:
584
581
gobject.source_remove(self.disable_initiator_tag)
585
582
self.disable_initiator_tag = None
586
583
self.expires = None
587
if getattr(self, "checker_initiator_tag", False):
584
if getattr(self, "checker_initiator_tag", None) is not None:
588
585
gobject.source_remove(self.checker_initiator_tag)
589
586
self.checker_initiator_tag = None
590
587
self.stop_checker()
591
588
self.enabled = False
590
self.send_changedstate()
592
591
# Do not run this again if called by a gobject.timeout_add
598
597
def init_checker(self):
599
598
# Schedule a new checker to be started an 'interval' from now,
600
599
# and every interval from then on.
600
if self.checker_initiator_tag is not None:
601
gobject.source_remove(self.checker_initiator_tag)
601
602
self.checker_initiator_tag = (gobject.timeout_add
602
(self.interval_milliseconds(),
604
.total_seconds() * 1000),
603
605
self.start_checker))
604
606
# Schedule a disable() when 'timeout' has passed
607
if self.disable_initiator_tag is not None:
608
gobject.source_remove(self.disable_initiator_tag)
605
609
self.disable_initiator_tag = (gobject.timeout_add
606
(self.timeout_milliseconds(),
611
.total_seconds() * 1000),
608
613
# Also start a new checker *right now*.
609
614
self.start_checker()
626
631
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,
634
def checked_ok(self):
635
"""Assert that the client has been seen, alive and well."""
636
self.last_checked_ok = datetime.datetime.utcnow()
637
self.last_checker_status = 0
640
def bump_timeout(self, timeout=None):
641
"""Bump up the timeout for this client."""
635
642
if timeout is None:
636
643
timeout = self.timeout
637
self.last_checked_ok = datetime.datetime.utcnow()
638
644
if self.disable_initiator_tag is not None:
639
645
gobject.source_remove(self.disable_initiator_tag)
646
self.disable_initiator_tag = None
640
647
if getattr(self, "enabled", False):
641
648
self.disable_initiator_tag = (gobject.timeout_add
642
(timedelta_to_milliseconds
643
(timeout), self.disable))
649
(int(timeout.total_seconds()
650
* 1000), self.disable))
644
651
self.expires = datetime.datetime.utcnow() + timeout
646
653
def need_approval(self):
652
659
If a checker already exists, leave it running and do
654
661
# 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
662
# did that, and if a checker (for some reason) started running
663
# slowly and taking more than 'interval' time, then the client
664
# would inevitably timeout, since no checker would get a
665
# chance to run to completion. If we instead leave running
659
666
# checkers alone, the checker would have to take more time
660
667
# than 'timeout' for the client to be disabled, which is as it
675
683
self.current_checker_command)
676
684
# Start a new checker if needed
677
685
if self.checker is None:
686
# Escape attributes for the shell
687
escaped_attrs = { attr:
688
re.escape(unicode(getattr(self,
690
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
692
command = self.checker_command % escaped_attrs
693
except TypeError as error:
694
logger.error('Could not format string "%s"',
695
self.checker_command, exc_info=error)
696
return True # Try again later
697
697
self.current_checker_command = command
699
699
logger.info("Starting checker %r for %s",
702
702
# in normal mode, that is already done by daemon(),
703
703
# and in debug mode we don't want to. (Stdin is
704
704
# always replaced by /dev/null.)
705
# The exception is when not debugging but nevertheless
706
# running in the foreground; use the previously
709
if (not self.server_settings["debug"]
710
and self.server_settings["foreground"]):
711
popen_args.update({"stdout": wnull,
705
713
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.
717
except OSError as error:
718
logger.error("Failed to start subprocess",
721
self.checker_callback_tag = (gobject.child_watch_add
723
self.checker_callback,
725
# The checker may have completed before the gobject
726
# watch was added. Check for this.
714
728
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
729
except OSError as error:
719
logger.error("Failed to start subprocess: %s",
730
if error.errno == errno.ECHILD:
731
# This should never happen
732
logger.error("Child process vanished",
737
gobject.source_remove(self.checker_callback_tag)
738
self.checker_callback(pid, status, command)
721
739
# Re-run this periodically if run by gobject.timeout_add
791
def dbus_interface_annotations(dbus_interface):
792
"""Decorator for marking functions returning interface annotations
796
@dbus_interface_annotations("org.example.Interface")
797
def _foo(self): # Function name does not matter
798
return {"org.freedesktop.DBus.Deprecated": "true",
799
"org.freedesktop.DBus.Property.EmitsChangedSignal":
803
func._dbus_is_interface = True
804
func._dbus_interface = dbus_interface
805
func._dbus_name = dbus_interface
810
def dbus_annotations(annotations):
811
"""Decorator to annotate D-Bus methods, signals or properties
814
@dbus_service_property("org.example.Interface", signature="b",
816
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
817
"org.freedesktop.DBus.Property."
818
"EmitsChangedSignal": "false"})
819
def Property_dbus_property(self):
820
return dbus.Boolean(False)
823
func._dbus_annotations = annotations
773
828
class DBusPropertyException(dbus.exceptions.DBusException):
774
829
"""A base class for D-Bus property-related exceptions
776
def __unicode__(self):
777
return unicode(str(self))
780
833
class DBusPropertyAccessException(DBusPropertyException):
781
834
"""A property's access permissions disallows an operation.
801
def _is_dbus_property(obj):
802
return getattr(obj, "_dbus_is_property", False)
854
def _is_dbus_thing(thing):
855
"""Returns a function testing if an attribute is a D-Bus thing
857
If called like _is_dbus_thing("method") it returns a function
858
suitable for use as predicate to inspect.getmembers().
860
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
804
def _get_all_dbus_properties(self):
863
def _get_all_dbus_things(self, thing):
805
864
"""Returns a generator of (name, attribute) pairs
807
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
866
return ((getattr(athing.__get__(self), "_dbus_name",
868
athing.__get__(self))
808
869
for cls in self.__class__.__mro__
810
inspect.getmembers(cls, self._is_dbus_property))
871
inspect.getmembers(cls,
872
self._is_dbus_thing(thing)))
812
874
def _get_dbus_property(self, interface_name, property_name):
813
875
"""Returns a bound method if one exists which is a D-Bus
897
964
e.setAttribute("access", prop._dbus_access)
899
966
for if_tag in document.getElementsByTagName("interface"):
900
968
for tag in (make_tag(document, name, prop)
902
in self._get_all_dbus_properties()
970
in self._get_all_dbus_things("property")
903
971
if prop._dbus_interface
904
972
== if_tag.getAttribute("name")):
905
973
if_tag.appendChild(tag)
974
# Add annotation tags
975
for typ in ("method", "signal", "property"):
976
for tag in if_tag.getElementsByTagName(typ):
978
for name, prop in (self.
979
_get_all_dbus_things(typ)):
980
if (name == tag.getAttribute("name")
981
and prop._dbus_interface
982
== if_tag.getAttribute("name")):
983
annots.update(getattr
987
for name, value in annots.items():
988
ann_tag = document.createElement(
990
ann_tag.setAttribute("name", name)
991
ann_tag.setAttribute("value", value)
992
tag.appendChild(ann_tag)
993
# Add interface annotation tags
994
for annotation, value in dict(
995
itertools.chain.from_iterable(
996
annotations().items()
997
for name, annotations in
998
self._get_all_dbus_things("interface")
999
if name == if_tag.getAttribute("name")
1001
ann_tag = document.createElement("annotation")
1002
ann_tag.setAttribute("name", annotation)
1003
ann_tag.setAttribute("value", value)
1004
if_tag.appendChild(ann_tag)
906
1005
# Add the names to the return values for the
907
1006
# "org.freedesktop.DBus.Properties" methods
908
1007
if (if_tag.getAttribute("name")
935
1034
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.
1037
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1038
"""A class decorator; applied to a subclass of
1039
dbus.service.Object, it will add alternate D-Bus attributes with
1040
interface names according to the "alt_interface_names" mapping.
1043
@alternate_dbus_interfaces({"org.example.Interface":
1044
"net.example.AlternateInterface"})
1045
class SampleDBusObject(dbus.service.Object):
1046
@dbus.service.method("org.example.Interface")
1047
def SampleDBusMethod():
1050
The above "SampleDBusMethod" on "SampleDBusObject" will be
1051
reachable via two interfaces: "org.example.Interface" and
1052
"net.example.AlternateInterface", the latter of which will have
1053
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1054
"true", unless "deprecate" is passed with a False value.
1056
This works for methods and signals, and also for D-Bus properties
1057
(from DBusObjectWithProperties) and interfaces (from the
1058
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):
1061
for orig_interface_name, alt_interface_name in (
1062
alt_interface_names.items()):
1064
interface_names = set()
1065
# Go though all attributes of the class
1066
for attrname, attribute in inspect.getmembers(cls):
950
1067
# Ignore non-D-Bus attributes, and D-Bus attributes
951
1068
# with the wrong interface name
952
1069
if (not hasattr(attribute, "_dbus_interface")
953
1070
or not attribute._dbus_interface
954
.startswith("se.recompile.Mandos")):
1071
.startswith(orig_interface_name)):
956
1073
# Create an alternate D-Bus interface name based on
957
1074
# the current name
958
1075
alt_interface = (attribute._dbus_interface
959
.replace("se.recompile.Mandos",
960
"se.bsnet.fukt.Mandos"))
1076
.replace(orig_interface_name,
1077
alt_interface_name))
1078
interface_names.add(alt_interface)
961
1079
# Is this a D-Bus signal?
962
1080
if getattr(attribute, "_dbus_is_signal", False):
963
# Extract the original non-method function by
1081
# Extract the original non-method undecorated
1082
# function by black magic
965
1083
nonmethod_func = (dict(
966
1084
zip(attribute.func_code.co_freevars,
967
1085
attribute.__closure__))["func"]
978
1096
nonmethod_func.func_name,
979
1097
nonmethod_func.func_defaults,
980
1098
nonmethod_func.func_closure)))
1099
# Copy annotations, if any
1101
new_function._dbus_annotations = (
1102
dict(attribute._dbus_annotations))
1103
except AttributeError:
981
1105
# 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
1106
# original and alternate functions, so both the
1107
# original and alternate signals gets sent when
1108
# the function is called
984
1109
def fixscope(func1, func2):
985
1110
"""This function is a scope container to pass
986
1111
func1 and func2 to the "call_both" function
1030
1160
attribute.func_name,
1031
1161
attribute.func_defaults,
1032
1162
attribute.func_closure)))
1033
return type.__new__(mcs, name, bases, attr)
1163
# Copy annotations, if any
1165
attr[attrname]._dbus_annotations = (
1166
dict(attribute._dbus_annotations))
1167
except AttributeError:
1169
# Is this a D-Bus interface?
1170
elif getattr(attribute, "_dbus_is_interface", False):
1171
# Create a new, but exactly alike, function
1172
# object. Decorate it to be a new D-Bus interface
1173
# with the alternate D-Bus interface name. Add it
1175
attr[attrname] = (dbus_interface_annotations
1178
(attribute.func_code,
1179
attribute.func_globals,
1180
attribute.func_name,
1181
attribute.func_defaults,
1182
attribute.func_closure)))
1184
# Deprecate all alternate interfaces
1185
iname="_AlternateDBusNames_interface_annotation{}"
1186
for interface_name in interface_names:
1187
@dbus_interface_annotations(interface_name)
1189
return { "org.freedesktop.DBus.Deprecated":
1191
# Find an unused name
1192
for aname in (iname.format(i)
1193
for i in itertools.count()):
1194
if aname not in attr:
1198
# Replace the class with a new subclass of it with
1199
# methods, signals, etc. as created above.
1200
cls = type(b"{}Alternate".format(cls.__name__),
1206
@alternate_dbus_interfaces({"se.recompile.Mandos":
1207
"se.bsnet.fukt.Mandos"})
1036
1208
class ClientDBus(Client, DBusObjectWithProperties):
1037
1209
"""A Client class using D-Bus
1110
1280
approval_delay = notifychangeproperty(dbus.UInt64,
1111
1281
"ApprovalDelay",
1113
timedelta_to_milliseconds)
1283
lambda td: td.total_seconds()
1114
1285
approval_duration = notifychangeproperty(
1115
1286
dbus.UInt64, "ApprovalDuration",
1116
type_func = timedelta_to_milliseconds)
1287
type_func = lambda td: td.total_seconds() * 1000)
1117
1288
host = notifychangeproperty(dbus.String, "Host")
1118
1289
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1120
timedelta_to_milliseconds)
1290
type_func = lambda td:
1291
td.total_seconds() * 1000)
1121
1292
extended_timeout = notifychangeproperty(
1122
1293
dbus.UInt64, "ExtendedTimeout",
1123
type_func = timedelta_to_milliseconds)
1294
type_func = lambda td: td.total_seconds() * 1000)
1124
1295
interval = notifychangeproperty(dbus.UInt64,
1127
timedelta_to_milliseconds)
1298
lambda td: td.total_seconds()
1128
1300
checker_command = notifychangeproperty(dbus.String, "Checker")
1130
1302
del notifychangeproperty
1365
1537
access="readwrite")
1366
1538
def Timeout_dbus_property(self, value=None):
1367
1539
if value is None: # get
1368
return dbus.UInt64(self.timeout_milliseconds())
1540
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1541
old_timeout = self.timeout
1369
1542
self.timeout = datetime.timedelta(0, 0, 0, value)
1370
# Reschedule timeout
1543
# Reschedule disabling
1371
1544
if self.enabled:
1372
1545
now = datetime.datetime.utcnow()
1373
time_to_die = timedelta_to_milliseconds(
1374
(self.last_checked_ok + self.timeout) - now)
1375
if time_to_die <= 0:
1546
self.expires += self.timeout - old_timeout
1547
if self.expires <= now:
1376
1548
# The timeout has passed
1379
self.expires = (now +
1380
datetime.timedelta(milliseconds =
1382
1551
if (getattr(self, "disable_initiator_tag", None)
1385
1554
gobject.source_remove(self.disable_initiator_tag)
1386
self.disable_initiator_tag = (gobject.timeout_add
1555
self.disable_initiator_tag = (
1556
gobject.timeout_add(
1557
int((self.expires - now).total_seconds()
1558
* 1000), self.disable))
1390
1560
# ExtendedTimeout - property
1391
1561
@dbus_service_property(_interface, signature="t",
1392
1562
access="readwrite")
1393
1563
def ExtendedTimeout_dbus_property(self, value=None):
1394
1564
if value is None: # get
1395
return dbus.UInt64(self.extended_timeout_milliseconds())
1565
return dbus.UInt64(self.extended_timeout.total_seconds()
1396
1567
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1398
1569
# Interval - property
1744
1906
use_ipv6: Boolean; to use IPv6 or not
1746
1908
def __init__(self, server_address, RequestHandlerClass,
1747
interface=None, use_ipv6=True):
1909
interface=None, use_ipv6=True, socketfd=None):
1910
"""If socketfd is set, use that file descriptor instead of
1911
creating a new one with socket.socket().
1748
1913
self.interface = interface
1750
1915
self.address_family = socket.AF_INET6
1916
if socketfd is not None:
1917
# Save the file descriptor
1918
self.socketfd = socketfd
1919
# Save the original socket.socket() function
1920
self.socket_socket = socket.socket
1921
# To implement --socket, we monkey patch socket.socket.
1923
# (When socketserver.TCPServer is a new-style class, we
1924
# could make self.socket into a property instead of monkey
1925
# patching socket.socket.)
1927
# Create a one-time-only replacement for socket.socket()
1928
@functools.wraps(socket.socket)
1929
def socket_wrapper(*args, **kwargs):
1930
# Restore original function so subsequent calls are
1932
socket.socket = self.socket_socket
1933
del self.socket_socket
1934
# This time only, return a new socket object from the
1935
# saved file descriptor.
1936
return socket.fromfd(self.socketfd, *args, **kwargs)
1937
# Replace socket.socket() function with wrapper
1938
socket.socket = socket_wrapper
1939
# The socketserver.TCPServer.__init__ will call
1940
# socket.socket(), which might be our replacement,
1941
# socket_wrapper(), if socketfd was set.
1751
1942
socketserver.TCPServer.__init__(self, server_address,
1752
1943
RequestHandlerClass)
1753
1945
def server_bind(self):
1754
1946
"""This overrides the normal server_bind() function
1755
1947
to bind to an interface if one was specified, and also NOT to
1764
1956
self.socket.setsockopt(socket.SOL_SOCKET,
1765
1957
SO_BINDTODEVICE,
1958
(self.interface + "\0")
1768
1960
except socket.error as error:
1769
if error[0] == errno.EPERM:
1770
logger.error("No permission to"
1771
" bind to interface %s",
1773
elif error[0] == errno.ENOPROTOOPT:
1961
if error.errno == errno.EPERM:
1962
logger.error("No permission to bind to"
1963
" interface %s", self.interface)
1964
elif error.errno == errno.ENOPROTOOPT:
1774
1965
logger.error("SO_BINDTODEVICE not available;"
1775
1966
" cannot bind to interface %s",
1776
1967
self.interface)
1968
elif error.errno == errno.ENODEV:
1969
logger.error("Interface %s does not exist,"
1970
" cannot bind", self.interface)
1779
1973
# Only bind(2) the socket if we really need to.
1839
2034
def handle_ipc(self, source, condition, parent_pipe=None,
1840
2035
proc = None, client_object=None):
1842
gobject.IO_IN: "IN", # There is data to read.
1843
gobject.IO_OUT: "OUT", # Data can be written (without
1845
gobject.IO_PRI: "PRI", # There is urgent data to read.
1846
gobject.IO_ERR: "ERR", # Error condition.
1847
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1848
# broken, usually for pipes and
1851
conditions_string = ' | '.join(name
1853
condition_names.iteritems()
1854
if cond & condition)
1855
2036
# error, or the other end of multiprocessing.Pipe has closed
1856
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2037
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1857
2038
# Wait for other process to exit
2101
def rfc3339_duration_to_delta(duration):
2102
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2104
>>> rfc3339_duration_to_delta("P7D")
2105
datetime.timedelta(7)
2106
>>> rfc3339_duration_to_delta("PT60S")
2107
datetime.timedelta(0, 60)
2108
>>> rfc3339_duration_to_delta("PT60M")
2109
datetime.timedelta(0, 3600)
2110
>>> rfc3339_duration_to_delta("PT24H")
2111
datetime.timedelta(1)
2112
>>> rfc3339_duration_to_delta("P1W")
2113
datetime.timedelta(7)
2114
>>> rfc3339_duration_to_delta("PT5M30S")
2115
datetime.timedelta(0, 330)
2116
>>> rfc3339_duration_to_delta("P1DT3M20S")
2117
datetime.timedelta(1, 200)
2120
# Parsing an RFC 3339 duration with regular expressions is not
2121
# possible - there would have to be multiple places for the same
2122
# values, like seconds. The current code, while more esoteric, is
2123
# cleaner without depending on a parsing library. If Python had a
2124
# built-in library for parsing we would use it, but we'd like to
2125
# avoid excessive use of external libraries.
2127
# New type for defining tokens, syntax, and semantics all-in-one
2128
Token = collections.namedtuple("Token",
2129
("regexp", # To match token; if
2130
# "value" is not None,
2131
# must have a "group"
2133
"value", # datetime.timedelta or
2135
"followers")) # Tokens valid after
2137
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2138
# the "duration" ABNF definition in RFC 3339, Appendix A.
2139
token_end = Token(re.compile(r"$"), None, frozenset())
2140
token_second = Token(re.compile(r"(\d+)S"),
2141
datetime.timedelta(seconds=1),
2142
frozenset((token_end,)))
2143
token_minute = Token(re.compile(r"(\d+)M"),
2144
datetime.timedelta(minutes=1),
2145
frozenset((token_second, token_end)))
2146
token_hour = Token(re.compile(r"(\d+)H"),
2147
datetime.timedelta(hours=1),
2148
frozenset((token_minute, token_end)))
2149
token_time = Token(re.compile(r"T"),
2151
frozenset((token_hour, token_minute,
2153
token_day = Token(re.compile(r"(\d+)D"),
2154
datetime.timedelta(days=1),
2155
frozenset((token_time, token_end)))
2156
token_month = Token(re.compile(r"(\d+)M"),
2157
datetime.timedelta(weeks=4),
2158
frozenset((token_day, token_end)))
2159
token_year = Token(re.compile(r"(\d+)Y"),
2160
datetime.timedelta(weeks=52),
2161
frozenset((token_month, token_end)))
2162
token_week = Token(re.compile(r"(\d+)W"),
2163
datetime.timedelta(weeks=1),
2164
frozenset((token_end,)))
2165
token_duration = Token(re.compile(r"P"), None,
2166
frozenset((token_year, token_month,
2167
token_day, token_time,
2169
# Define starting values
2170
value = datetime.timedelta() # Value so far
2172
followers = frozenset((token_duration,)) # Following valid tokens
2173
s = duration # String left to parse
2174
# Loop until end token is found
2175
while found_token is not token_end:
2176
# Search for any currently valid tokens
2177
for token in followers:
2178
match = token.regexp.match(s)
2179
if match is not None:
2181
if token.value is not None:
2182
# Value found, parse digits
2183
factor = int(match.group(1), 10)
2184
# Add to value so far
2185
value += factor * token.value
2186
# Strip token from string
2187
s = token.regexp.sub("", s, 1)
2190
# Set valid next tokens
2191
followers = found_token.followers
2194
# No currently valid tokens were found
2195
raise ValueError("Invalid RFC 3339 duration")
1920
2200
def string_to_delta(interval):
1921
2201
"""Parse a string and return a datetime.timedelta
2014
2300
parser.add_argument("--no-dbus", action="store_false",
2015
2301
dest="use_dbus", help="Do not provide D-Bus"
2016
" system bus interface")
2302
" system bus interface", default=None)
2017
2303
parser.add_argument("--no-ipv6", action="store_false",
2018
dest="use_ipv6", help="Do not use IPv6")
2304
dest="use_ipv6", help="Do not use IPv6",
2019
2306
parser.add_argument("--no-restore", action="store_false",
2020
2307
dest="restore", help="Do not restore stored"
2308
" state", default=None)
2309
parser.add_argument("--socket", type=int,
2310
help="Specify a file descriptor to a network"
2311
" socket to use instead of creating one")
2022
2312
parser.add_argument("--statedir", metavar="DIR",
2023
2313
help="Directory to save/restore state in")
2314
parser.add_argument("--foreground", action="store_true",
2315
help="Run in foreground", default=None)
2316
parser.add_argument("--no-zeroconf", action="store_false",
2317
dest="zeroconf", help="Do not use Zeroconf",
2025
2320
options = parser.parse_args()
2027
2322
if options.check:
2324
fail_count, test_count = doctest.testmod()
2325
sys.exit(os.EX_OK if fail_count == 0 else 1)
2032
2327
# Default values for config file for server-global settings
2033
2328
server_defaults = { "interface": "",
2052
2350
# Convert the SafeConfigParser object to a dict
2053
2351
server_settings = server_config.defaults()
2054
2352
# Use the appropriate methods on the non-string config options
2055
for option in ("debug", "use_dbus", "use_ipv6"):
2353
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2056
2354
server_settings[option] = server_config.getboolean("DEFAULT",
2058
2356
if server_settings["port"]:
2059
2357
server_settings["port"] = server_config.getint("DEFAULT",
2359
if server_settings["socket"]:
2360
server_settings["socket"] = server_config.getint("DEFAULT",
2362
# Later, stdin will, and stdout and stderr might, be dup'ed
2363
# over with an opened os.devnull. But we don't want this to
2364
# happen with a supplied network socket.
2365
if 0 <= server_settings["socket"] <= 2:
2366
server_settings["socket"] = os.dup(server_settings
2061
2368
del server_config
2063
2370
# Override the settings from the config file with command line
2065
2372
for option in ("interface", "address", "port", "debug",
2066
2373
"priority", "servicename", "configdir",
2067
2374
"use_dbus", "use_ipv6", "debuglevel", "restore",
2375
"statedir", "socket", "foreground", "zeroconf"):
2069
2376
value = getattr(options, option)
2070
2377
if value is not None:
2071
2378
server_settings[option] = value
2073
2380
# Force all strings to be unicode
2074
2381
for option in server_settings.keys():
2075
if type(server_settings[option]) is str:
2076
server_settings[option] = unicode(server_settings[option])
2382
if isinstance(server_settings[option], bytes):
2383
server_settings[option] = (server_settings[option]
2385
# Force all boolean options to be boolean
2386
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2387
"foreground", "zeroconf"):
2388
server_settings[option] = bool(server_settings[option])
2389
# Debug implies foreground
2390
if server_settings["debug"]:
2391
server_settings["foreground"] = True
2077
2392
# Now we have our good server settings in "server_settings"
2079
2394
##################################################################
2396
if (not server_settings["zeroconf"] and
2397
not (server_settings["port"]
2398
or server_settings["socket"] != "")):
2399
parser.error("Needs port or socket to work without"
2081
2402
# For convenience
2082
2403
debug = server_settings["debug"]
2083
2404
debuglevel = server_settings["debuglevel"]
2118
2445
use_ipv6=use_ipv6,
2119
2446
gnutls_priority=
2120
2447
server_settings["priority"],
2123
pidfilename = "/var/run/mandos.pid"
2451
pidfilename = "/run/mandos.pid"
2452
if not os.path.isdir("/run/."):
2453
pidfilename = "/var/run/mandos.pid"
2125
2456
pidfile = open(pidfilename, "w")
2127
logger.error("Could not open file %r", pidfilename)
2457
except IOError as e:
2458
logger.error("Could not open file %r", pidfilename,
2130
uid = pwd.getpwnam("_mandos").pw_uid
2131
gid = pwd.getpwnam("_mandos").pw_gid
2461
for name in ("_mandos", "mandos", "nobody"):
2134
uid = pwd.getpwnam("mandos").pw_uid
2135
gid = pwd.getpwnam("mandos").pw_gid
2463
uid = pwd.getpwnam(name).pw_uid
2464
gid = pwd.getpwnam(name).pw_gid
2136
2466
except KeyError:
2138
uid = pwd.getpwnam("nobody").pw_uid
2139
gid = pwd.getpwnam("nobody").pw_gid
2146
2474
except OSError as error:
2147
if error[0] != errno.EPERM:
2475
if error.errno != errno.EPERM:
2151
2479
# Enable all possible GnuTLS debugging
2162
2490
.gnutls_global_set_log_function(debug_gnutls))
2164
2492
# Redirect stdin so all checkers get /dev/null
2165
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2493
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2166
2494
os.dup2(null, sys.stdin.fileno())
2170
2498
# Need to fork before connecting to D-Bus
2172
2500
# Close all input and output, do double fork, etc.
2503
# multiprocessing will use threads, so before we use gobject we
2504
# need to inform gobject that threads will be used.
2175
2505
gobject.threads_init()
2177
2507
global main_loop
2178
2508
# From the Avahi example code
2179
DBusGMainLoop(set_as_default=True )
2509
DBusGMainLoop(set_as_default=True)
2180
2510
main_loop = gobject.MainLoop()
2181
2511
bus = dbus.SystemBus()
2182
2512
# End of Avahi example code
2188
2518
("se.bsnet.fukt.Mandos", bus,
2189
2519
do_not_queue=True))
2190
2520
except dbus.exceptions.NameExistsException as e:
2191
logger.error(unicode(e) + ", disabling D-Bus")
2521
logger.error("Disabling D-Bus:", exc_info=e)
2192
2522
use_dbus = False
2193
2523
server_settings["use_dbus"] = False
2194
2524
tcp_server.use_dbus = False
2195
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2196
service = AvahiServiceToSyslog(name =
2197
server_settings["servicename"],
2198
servicetype = "_mandos._tcp",
2199
protocol = protocol, bus = bus)
2200
if server_settings["interface"]:
2201
service.interface = (if_nametoindex
2202
(str(server_settings["interface"])))
2526
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2527
service = AvahiServiceToSyslog(name =
2528
server_settings["servicename"],
2529
servicetype = "_mandos._tcp",
2530
protocol = protocol, bus = bus)
2531
if server_settings["interface"]:
2532
service.interface = (if_nametoindex
2533
(server_settings["interface"]
2204
2536
global multiprocessing_manager
2205
2537
multiprocessing_manager = multiprocessing.Manager()
2207
2539
client_class = Client
2209
client_class = functools.partial(ClientDBusTransitional,
2541
client_class = functools.partial(ClientDBus, bus = bus)
2212
2543
client_settings = Client.config_parser(client_config)
2213
2544
old_client_settings = {}
2214
2545
clients_data = {}
2547
# This is used to redirect stdout and stderr for checker processes
2549
wnull = open(os.devnull, "w") # A writable /dev/null
2550
# Only used if server is running in foreground but not in debug
2552
if debug or not foreground:
2216
2555
# Get client data and settings from last running state.
2217
2556
if server_settings["restore"]:
2221
2560
(stored_state))
2222
2561
os.remove(stored_state_path)
2223
2562
except IOError as e:
2224
logger.warning("Could not load persistent state: {0}"
2226
if e.errno != errno.ENOENT:
2563
if e.errno == errno.ENOENT:
2564
logger.warning("Could not load persistent state: {}"
2565
.format(os.strerror(e.errno)))
2567
logger.critical("Could not load persistent state:",
2228
2570
except EOFError as e:
2229
2571
logger.warning("Could not load persistent state: "
2230
"EOFError: {0}".format(e))
2572
"EOFError:", exc_info=e)
2232
2574
with PGPEngine() as pgp:
2233
for client_name, client in clients_data.iteritems():
2575
for client_name, client in clients_data.items():
2576
# Skip removed clients
2577
if client_name not in client_settings:
2234
2580
# Decide which value to use after restoring saved state.
2235
2581
# We have three different values: Old config file,
2236
2582
# new config file, and saved state.
2251
2597
# Clients who has passed its expire date can still be
2252
2598
# enabled if its last checker was successful. Clients
2253
# whose checker failed before we stored its state is
2254
# assumed to have failed all checkers during downtime.
2599
# whose checker succeeded before we stored its state is
2600
# assumed to have successfully run all checkers during
2255
2602
if client["enabled"]:
2256
2603
if datetime.datetime.utcnow() >= client["expires"]:
2257
2604
if not client["last_checked_ok"]:
2258
2605
logger.warning(
2259
"disabling client {0} - Client never "
2260
"performed a successfull checker"
2261
.format(client["name"]))
2606
"disabling client {} - Client never "
2607
"performed a successful checker"
2608
.format(client_name))
2262
2609
client["enabled"] = False
2263
2610
elif client["last_checker_status"] != 0:
2264
2611
logger.warning(
2265
"disabling client {0} - Client "
2266
"last checker failed with error code {1}"
2267
.format(client["name"],
2612
"disabling client {} - Client last"
2613
" checker failed with error code {}"
2614
.format(client_name,
2268
2615
client["last_checker_status"]))
2269
2616
client["enabled"] = False
2294
2640
for client_name in (set(client_settings)
2295
2641
- set(old_client_settings)):
2296
2642
clients_data[client_name] = client_settings[client_name]
2298
# Create clients all clients
2299
for client_name, client in clients_data.iteritems():
2644
# Create all client objects
2645
for client_name, client in clients_data.items():
2300
2646
tcp_server.clients[client_name] = client_class(
2301
name = client_name, settings = client)
2647
name = client_name, settings = client,
2648
server_settings = server_settings)
2303
2650
if not tcp_server.clients:
2304
2651
logger.warning("No clients defined")
2310
pidfile.write(str(pid) + "\n".encode("utf-8"))
2313
logger.error("Could not write to file %r with PID %d",
2316
# "pidfile" was never created
2654
if pidfile is not None:
2658
pidfile.write("{}\n".format(pid).encode("utf-8"))
2660
logger.error("Could not write to file %r with PID %d",
2318
2663
del pidfilename
2319
signal.signal(signal.SIGINT, signal.SIG_IGN)
2321
2665
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2322
2666
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2325
class MandosDBusService(dbus.service.Object):
2669
@alternate_dbus_interfaces({"se.recompile.Mandos":
2670
"se.bsnet.fukt.Mandos"})
2671
class MandosDBusService(DBusObjectWithProperties):
2326
2672
"""A D-Bus proxy object"""
2327
2673
def __init__(self):
2328
2674
dbus.service.Object.__init__(self, bus, "/")
2329
2675
_interface = "se.recompile.Mandos"
2677
@dbus_interface_annotations(_interface)
2679
return { "org.freedesktop.DBus.Property"
2680
".EmitsChangedSignal":
2331
2683
@dbus.service.signal(_interface, signature="o")
2332
2684
def ClientAdded(self, objpath):
2416
2768
del client_settings[client.name]["secret"]
2419
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2422
(stored_state_path))
2423
with os.fdopen(tempfd, "wb") as stored_state:
2771
with (tempfile.NamedTemporaryFile
2772
(mode='wb', suffix=".pickle", prefix='clients-',
2773
dir=os.path.dirname(stored_state_path),
2774
delete=False)) as stored_state:
2424
2775
pickle.dump((clients, client_settings), stored_state)
2776
tempname=stored_state.name
2425
2777
os.rename(tempname, stored_state_path)
2426
2778
except (IOError, OSError) as e:
2427
logger.warning("Could not save persistent state: {0}"
2431
2781
os.remove(tempname)
2432
2782
except NameError:
2434
if e.errno not in set((errno.ENOENT, errno.EACCES,
2784
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2785
logger.warning("Could not save persistent state: {}"
2786
.format(os.strerror(e.errno)))
2788
logger.warning("Could not save persistent state:",
2438
2792
# Delete all clients, and settings from config
2439
2793
while tcp_server.clients:
2463
2817
tcp_server.server_activate()
2465
2819
# Find out what port we got
2466
service.port = tcp_server.socket.getsockname()[1]
2821
service.port = tcp_server.socket.getsockname()[1]
2468
2823
logger.info("Now listening on address %r, port %d,"
2469
" flowinfo %d, scope_id %d"
2470
% tcp_server.socket.getsockname())
2824
" flowinfo %d, scope_id %d",
2825
*tcp_server.socket.getsockname())
2472
logger.info("Now listening on address %r, port %d"
2473
% tcp_server.socket.getsockname())
2827
logger.info("Now listening on address %r, port %d",
2828
*tcp_server.socket.getsockname())
2475
2830
#service.interface = tcp_server.socket.getsockname()[3]
2478
# From the Avahi example code
2481
except dbus.exceptions.DBusException as error:
2482
logger.critical("DBusException: %s", error)
2485
# End of Avahi example code
2834
# From the Avahi example code
2837
except dbus.exceptions.DBusException as error:
2838
logger.critical("D-Bus Exception", exc_info=error)
2841
# End of Avahi example code
2487
2843
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2488
2844
lambda *args, **kwargs: