110
111
return interface_index
113
def initlogger(level=logging.WARNING):
114
def initlogger(debug, level=logging.WARNING):
114
115
"""init logger and add loglevel"""
117
syslogger = (logging.handlers.SysLogHandler
119
logging.handlers.SysLogHandler.LOG_DAEMON,
120
address = str("/dev/log")))
116
121
syslogger.setFormatter(logging.Formatter
117
122
('Mandos [%(process)d]: %(levelname)s:'
119
124
logger.addHandler(syslogger)
121
console = logging.StreamHandler()
122
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
126
logger.addHandler(console)
127
console = logging.StreamHandler()
128
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
132
logger.addHandler(console)
127
133
logger.setLevel(level)
169
174
def password_encode(self, password):
170
175
# Passphrase can not be empty and can not contain newlines or
171
176
# NUL bytes. So we prefix it and hex encode it.
172
return b"mandos" + binascii.hexlify(password)
177
encoded = b"mandos" + binascii.hexlify(password)
178
if len(encoded) > 2048:
179
# GnuPG can't handle long passwords, so encode differently
180
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
181
.replace(b"\n", b"\\n")
182
.replace(b"\0", b"\\x00"))
174
185
def encrypt(self, data, password):
175
self.gnupg.passphrase = self.password_encode(password)
176
with open(os.devnull) as devnull:
178
proc = self.gnupg.run(['--symmetric'],
179
create_fhs=['stdin', 'stdout'],
180
attach_fhs={'stderr': devnull})
181
with contextlib.closing(proc.handles['stdin']) as f:
183
with contextlib.closing(proc.handles['stdout']) as f:
184
ciphertext = f.read()
188
self.gnupg.passphrase = None
186
passphrase = self.password_encode(password)
187
with tempfile.NamedTemporaryFile(dir=self.tempdir
189
passfile.write(passphrase)
191
proc = subprocess.Popen(['gpg', '--symmetric',
195
stdin = subprocess.PIPE,
196
stdout = subprocess.PIPE,
197
stderr = subprocess.PIPE)
198
ciphertext, err = proc.communicate(input = data)
199
if proc.returncode != 0:
189
201
return ciphertext
191
203
def decrypt(self, data, password):
192
self.gnupg.passphrase = self.password_encode(password)
193
with open(os.devnull) as devnull:
195
proc = self.gnupg.run(['--decrypt'],
196
create_fhs=['stdin', 'stdout'],
197
attach_fhs={'stderr': devnull})
198
with contextlib.closing(proc.handles['stdin'] ) as f:
200
with contextlib.closing(proc.handles['stdout']) as f:
201
decrypted_plaintext = f.read()
205
self.gnupg.passphrase = None
204
passphrase = self.password_encode(password)
205
with tempfile.NamedTemporaryFile(dir = self.tempdir
207
passfile.write(passphrase)
209
proc = subprocess.Popen(['gpg', '--decrypt',
213
stdin = subprocess.PIPE,
214
stdout = subprocess.PIPE,
215
stderr = subprocess.PIPE)
216
decrypted_plaintext, err = proc.communicate(input
218
if proc.returncode != 0:
206
220
return decrypted_plaintext
210
223
class AvahiError(Exception):
211
224
def __init__(self, value, *args, **kwargs):
212
225
self.value = value
367
388
self.server_state_changed)
368
389
self.server_state_changed(self.server.GetState())
370
392
class AvahiServiceToSyslog(AvahiService):
371
393
def rename(self):
372
394
"""Add the new name to the syslog messages"""
373
395
ret = AvahiService.rename(self)
374
396
syslogger.setFormatter(logging.Formatter
375
('Mandos (%s) [%%(process)d]:'
376
' %%(levelname)s: %%(message)s'
397
('Mandos ({0}) [%(process)d]:'
398
' %(levelname)s: %(message)s'
380
403
def timedelta_to_milliseconds(td):
381
404
"Convert a datetime.timedelta() to milliseconds"
382
405
return ((td.days * 24 * 60 * 60 * 1000)
383
406
+ (td.seconds * 1000)
384
407
+ (td.microseconds // 1000))
386
410
class Client(object):
387
411
"""A representation of a client host served by this server.
411
435
interval: datetime.timedelta(); How often to start a new checker
412
436
last_approval_request: datetime.datetime(); (UTC) or None
413
437
last_checked_ok: datetime.datetime(); (UTC) or None
415
438
last_checker_status: integer between 0 and 255 reflecting exit
416
439
status of last checker. -1 reflects crashed
440
checker, -2 means no checker completed yet.
418
441
last_enabled: datetime.datetime(); (UTC) or None
419
442
name: string; from the config file, used in log messages and
420
443
D-Bus identifiers
421
444
secret: bytestring; sent verbatim (over TLS) to client
422
445
timeout: datetime.timedelta(); How long from last_checked_ok
423
446
until this client is disabled
424
extended_timeout: extra long timeout when password has been sent
447
extended_timeout: extra long timeout when secret has been sent
425
448
runtime_expansions: Allowed attributes for runtime expansion.
426
449
expires: datetime.datetime(); time (UTC) when a client will be
427
450
disabled, or None
451
server_settings: The server_settings dict from main()
430
454
runtime_expansions = ("approval_delay", "approval_duration",
431
"created", "enabled", "fingerprint",
432
"host", "interval", "last_checked_ok",
455
"created", "enabled", "expires",
456
"fingerprint", "host", "interval",
457
"last_approval_request", "last_checked_ok",
433
458
"last_enabled", "name", "timeout")
434
client_defaults = { "timeout": "5m",
435
"extended_timeout": "15m",
459
client_defaults = { "timeout": "PT5M",
460
"extended_timeout": "PT15M",
437
462
"checker": "fping -q -- %%(host)s",
439
"approval_delay": "0s",
440
"approval_duration": "1s",
464
"approval_delay": "PT0S",
465
"approval_duration": "PT1S",
441
466
"approved_by_default": "True",
442
467
"enabled": "True",
457
482
def approval_delay_milliseconds(self):
458
483
return timedelta_to_milliseconds(self.approval_delay)
461
486
def config_parser(config):
462
""" Construct a new dict of client settings of this form:
487
"""Construct a new dict of client settings of this form:
463
488
{ client_name: {setting_name: value, ...}, ...}
464
with exceptions for any special settings as defined above"""
489
with exceptions for any special settings as defined above.
490
NOTE: Must be a pure function. Must return the same result
491
value given the same arguments.
466
494
for client_name in config.sections():
467
495
section = dict(config.items(client_name))
468
496
client = settings[client_name] = {}
470
# Default copying each value from config to new dict
471
for setting, value in section.iteritems():
472
client[setting] = value
498
client["host"] = section["host"]
474
499
# Reformat values from string types to Python types
475
500
client["approved_by_default"] = config.getboolean(
476
501
client_name, "approved_by_default")
477
client["enabled"] = config.getboolean(client_name, "enabled")
502
client["enabled"] = config.getboolean(client_name,
479
505
client["fingerprint"] = (section["fingerprint"].upper()
480
506
.replace(" ", ""))
496
522
section["approval_delay"])
497
523
client["approval_duration"] = string_to_delta(
498
524
section["approval_duration"])
525
client["checker_command"] = section["checker"]
526
client["last_approval_request"] = None
527
client["last_checked_ok"] = None
528
client["last_checker_status"] = -2
503
def __init__(self, config, name = None):
504
"""Note: the 'checker' key in 'config' sets the
505
'checker_command' attribute and *not* the 'checker'
532
def __init__(self, settings, name = None, server_settings=None):
534
if server_settings is None:
536
self.server_settings = server_settings
537
# adding all client settings
538
for setting, value in settings.iteritems():
539
setattr(self, setting, value)
542
if not hasattr(self, "last_enabled"):
543
self.last_enabled = datetime.datetime.utcnow()
544
if not hasattr(self, "expires"):
545
self.expires = (datetime.datetime.utcnow()
548
self.last_enabled = None
508
551
logger.debug("Creating client %r", self.name)
509
552
# Uppercase and remove spaces from fingerprint for later
510
553
# comparison purposes with return value from the fingerprint()
512
self.fingerprint = config["fingerprint"]
513
555
logger.debug(" Fingerprint: %s", self.fingerprint)
514
self.secret = config["secret"]
515
self.host = config["host"]
516
self.created = datetime.datetime.utcnow()
517
self.enabled = config["enabled"]
518
self.last_approval_request = None
520
self.last_enabled = datetime.datetime.utcnow()
522
self.last_enabled = None
523
self.last_checked_ok = None
524
self.last_checker_status = None
525
self.timeout = config["timeout"]
526
self.extended_timeout = config["extended_timeout"]
527
self.interval = config["interval"]
556
self.created = settings.get("created",
557
datetime.datetime.utcnow())
559
# attributes specific for this server instance
528
560
self.checker = None
529
561
self.checker_initiator_tag = None
530
562
self.disable_initiator_tag = None
532
self.expires = datetime.datetime.utcnow() + self.timeout
535
563
self.checker_callback_tag = None
536
self.checker_command = config["checker"]
537
564
self.current_checker_command = None
538
565
self.approved = None
539
self.approved_by_default = config["approved_by_default"]
540
566
self.approvals_pending = 0
541
self.approval_delay = config["approval_delay"]
542
self.approval_duration = config["approval_duration"]
543
567
self.changedstate = (multiprocessing_manager
544
568
.Condition(multiprocessing_manager
565
589
if getattr(self, "enabled", False):
566
590
# Already enabled
568
self.send_changedstate()
569
592
self.expires = datetime.datetime.utcnow() + self.timeout
570
593
self.enabled = True
571
594
self.last_enabled = datetime.datetime.utcnow()
572
595
self.init_checker()
596
self.send_changedstate()
574
598
def disable(self, quiet=True):
575
599
"""Disable this client."""
576
600
if not getattr(self, "enabled", False):
579
self.send_changedstate()
581
603
logger.info("Disabling client %s", self.name)
582
if getattr(self, "disable_initiator_tag", False):
604
if getattr(self, "disable_initiator_tag", None) is not None:
583
605
gobject.source_remove(self.disable_initiator_tag)
584
606
self.disable_initiator_tag = None
585
607
self.expires = None
586
if getattr(self, "checker_initiator_tag", False):
608
if getattr(self, "checker_initiator_tag", None) is not None:
587
609
gobject.source_remove(self.checker_initiator_tag)
588
610
self.checker_initiator_tag = None
589
611
self.stop_checker()
590
612
self.enabled = False
614
self.send_changedstate()
591
615
# Do not run this again if called by a gobject.timeout_add
625
653
logger.warning("Checker for %(name)s crashed?",
628
def checked_ok(self, timeout=None):
629
"""Bump up the timeout for this client.
631
This should only be called when the client has been seen,
656
def checked_ok(self):
657
"""Assert that the client has been seen, alive and well."""
658
self.last_checked_ok = datetime.datetime.utcnow()
659
self.last_checker_status = 0
662
def bump_timeout(self, timeout=None):
663
"""Bump up the timeout for this client."""
634
664
if timeout is None:
635
665
timeout = self.timeout
636
self.last_checked_ok = datetime.datetime.utcnow()
637
666
if self.disable_initiator_tag is not None:
638
667
gobject.source_remove(self.disable_initiator_tag)
668
self.disable_initiator_tag = None
639
669
if getattr(self, "enabled", False):
640
670
self.disable_initiator_tag = (gobject.timeout_add
641
671
(timedelta_to_milliseconds
651
681
If a checker already exists, leave it running and do
653
683
# The reason for not killing a running checker is that if we
654
# did that, then if a checker (for some reason) started
655
# running slowly and taking more than 'interval' time, the
656
# client would inevitably timeout, since no checker would get
657
# a chance to run to completion. If we instead leave running
684
# did that, and if a checker (for some reason) started running
685
# slowly and taking more than 'interval' time, then the client
686
# would inevitably timeout, since no checker would get a
687
# chance to run to completion. If we instead leave running
658
688
# checkers alone, the checker would have to take more time
659
689
# than 'timeout' for the client to be disabled, which is as it
674
705
self.current_checker_command)
675
706
# Start a new checker if needed
676
707
if self.checker is None:
708
# Escape attributes for the shell
709
escaped_attrs = dict(
710
(attr, re.escape(unicode(getattr(self, attr))))
712
self.runtime_expansions)
678
# In case checker_command has exactly one % operator
679
command = self.checker_command % self.host
681
# Escape attributes for the shell
682
escaped_attrs = dict(
684
re.escape(unicode(str(getattr(self, attr, "")),
688
self.runtime_expansions)
691
command = self.checker_command % escaped_attrs
692
except TypeError as error:
693
logger.error('Could not format string "%s":'
694
' %s', self.checker_command, error)
695
return True # Try again later
714
command = self.checker_command % escaped_attrs
715
except TypeError as error:
716
logger.error('Could not format string "%s"',
717
self.checker_command, exc_info=error)
718
return True # Try again later
696
719
self.current_checker_command = command
698
721
logger.info("Starting checker %r for %s",
701
724
# in normal mode, that is already done by daemon(),
702
725
# and in debug mode we don't want to. (Stdin is
703
726
# always replaced by /dev/null.)
727
# The exception is when not debugging but nevertheless
728
# running in the foreground; use the previously
731
if (not self.server_settings["debug"]
732
and self.server_settings["foreground"]):
733
popen_args.update({"stdout": wnull,
704
735
self.checker = subprocess.Popen(command,
707
self.checker_callback_tag = (gobject.child_watch_add
709
self.checker_callback,
711
# The checker may have completed before the gobject
712
# watch was added. Check for this.
739
except OSError as error:
740
logger.error("Failed to start subprocess",
743
self.checker_callback_tag = (gobject.child_watch_add
745
self.checker_callback,
747
# The checker may have completed before the gobject
748
# watch was added. Check for this.
713
750
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
715
gobject.source_remove(self.checker_callback_tag)
716
self.checker_callback(pid, status, command)
717
751
except OSError as error:
718
logger.error("Failed to start subprocess: %s",
752
if error.errno == errno.ECHILD:
753
# This should never happen
754
logger.error("Child process vanished",
759
gobject.source_remove(self.checker_callback_tag)
760
self.checker_callback(pid, status, command)
720
761
# Re-run this periodically if run by gobject.timeout_add
813
def dbus_interface_annotations(dbus_interface):
814
"""Decorator for marking functions returning interface annotations
818
@dbus_interface_annotations("org.example.Interface")
819
def _foo(self): # Function name does not matter
820
return {"org.freedesktop.DBus.Deprecated": "true",
821
"org.freedesktop.DBus.Property.EmitsChangedSignal":
825
func._dbus_is_interface = True
826
func._dbus_interface = dbus_interface
827
func._dbus_name = dbus_interface
832
def dbus_annotations(annotations):
833
"""Decorator to annotate D-Bus methods, signals or properties
836
@dbus_service_property("org.example.Interface", signature="b",
838
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
839
"org.freedesktop.DBus.Property."
840
"EmitsChangedSignal": "false"})
841
def Property_dbus_property(self):
842
return dbus.Boolean(False)
845
func._dbus_annotations = annotations
772
850
class DBusPropertyException(dbus.exceptions.DBusException):
773
851
"""A base class for D-Bus property-related exceptions
800
def _is_dbus_property(obj):
801
return getattr(obj, "_dbus_is_property", False)
878
def _is_dbus_thing(thing):
879
"""Returns a function testing if an attribute is a D-Bus thing
881
If called like _is_dbus_thing("method") it returns a function
882
suitable for use as predicate to inspect.getmembers().
884
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
803
def _get_all_dbus_properties(self):
887
def _get_all_dbus_things(self, thing):
804
888
"""Returns a generator of (name, attribute) pairs
806
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
890
return ((getattr(athing.__get__(self), "_dbus_name",
892
athing.__get__(self))
807
893
for cls in self.__class__.__mro__
809
inspect.getmembers(cls, self._is_dbus_property))
895
inspect.getmembers(cls,
896
self._is_dbus_thing(thing)))
811
898
def _get_dbus_property(self, interface_name, property_name):
812
899
"""Returns a bound method if one exists which is a D-Bus
896
988
e.setAttribute("access", prop._dbus_access)
898
990
for if_tag in document.getElementsByTagName("interface"):
899
992
for tag in (make_tag(document, name, prop)
901
in self._get_all_dbus_properties()
994
in self._get_all_dbus_things("property")
902
995
if prop._dbus_interface
903
996
== if_tag.getAttribute("name")):
904
997
if_tag.appendChild(tag)
998
# Add annotation tags
999
for typ in ("method", "signal", "property"):
1000
for tag in if_tag.getElementsByTagName(typ):
1002
for name, prop in (self.
1003
_get_all_dbus_things(typ)):
1004
if (name == tag.getAttribute("name")
1005
and prop._dbus_interface
1006
== if_tag.getAttribute("name")):
1007
annots.update(getattr
1009
"_dbus_annotations",
1011
for name, value in annots.iteritems():
1012
ann_tag = document.createElement(
1014
ann_tag.setAttribute("name", name)
1015
ann_tag.setAttribute("value", value)
1016
tag.appendChild(ann_tag)
1017
# Add interface annotation tags
1018
for annotation, value in dict(
1019
itertools.chain.from_iterable(
1020
annotations().iteritems()
1021
for name, annotations in
1022
self._get_all_dbus_things("interface")
1023
if name == if_tag.getAttribute("name")
1025
ann_tag = document.createElement("annotation")
1026
ann_tag.setAttribute("name", annotation)
1027
ann_tag.setAttribute("value", value)
1028
if_tag.appendChild(ann_tag)
905
1029
# Add the names to the return values for the
906
1030
# "org.freedesktop.DBus.Properties" methods
907
1031
if (if_tag.getAttribute("name")
934
1058
variant_level=variant_level)
937
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
939
"""Applied to an empty subclass of a D-Bus object, this metaclass
940
will add additional D-Bus attributes matching a certain pattern.
1061
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1062
"""A class decorator; applied to a subclass of
1063
dbus.service.Object, it will add alternate D-Bus attributes with
1064
interface names according to the "alt_interface_names" mapping.
1067
@alternate_dbus_interfaces({"org.example.Interface":
1068
"net.example.AlternateInterface"})
1069
class SampleDBusObject(dbus.service.Object):
1070
@dbus.service.method("org.example.Interface")
1071
def SampleDBusMethod():
1074
The above "SampleDBusMethod" on "SampleDBusObject" will be
1075
reachable via two interfaces: "org.example.Interface" and
1076
"net.example.AlternateInterface", the latter of which will have
1077
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1078
"true", unless "deprecate" is passed with a False value.
1080
This works for methods and signals, and also for D-Bus properties
1081
(from DBusObjectWithProperties) and interfaces (from the
1082
dbus_interface_annotations decorator).
942
def __new__(mcs, name, bases, attr):
943
# Go through all the base classes which could have D-Bus
944
# methods, signals, or properties in them
945
for base in (b for b in bases
946
if issubclass(b, dbus.service.Object)):
947
# Go though all attributes of the base class
948
for attrname, attribute in inspect.getmembers(base):
1085
for orig_interface_name, alt_interface_name in (
1086
alt_interface_names.iteritems()):
1088
interface_names = set()
1089
# Go though all attributes of the class
1090
for attrname, attribute in inspect.getmembers(cls):
949
1091
# Ignore non-D-Bus attributes, and D-Bus attributes
950
1092
# with the wrong interface name
951
1093
if (not hasattr(attribute, "_dbus_interface")
952
1094
or not attribute._dbus_interface
953
.startswith("se.recompile.Mandos")):
1095
.startswith(orig_interface_name)):
955
1097
# Create an alternate D-Bus interface name based on
956
1098
# the current name
957
1099
alt_interface = (attribute._dbus_interface
958
.replace("se.recompile.Mandos",
959
"se.bsnet.fukt.Mandos"))
1100
.replace(orig_interface_name,
1101
alt_interface_name))
1102
interface_names.add(alt_interface)
960
1103
# Is this a D-Bus signal?
961
1104
if getattr(attribute, "_dbus_is_signal", False):
962
# Extract the original non-method function by
1105
# Extract the original non-method undecorated
1106
# function by black magic
964
1107
nonmethod_func = (dict(
965
1108
zip(attribute.func_code.co_freevars,
966
1109
attribute.__closure__))["func"]
977
1120
nonmethod_func.func_name,
978
1121
nonmethod_func.func_defaults,
979
1122
nonmethod_func.func_closure)))
1123
# Copy annotations, if any
1125
new_function._dbus_annotations = (
1126
dict(attribute._dbus_annotations))
1127
except AttributeError:
980
1129
# Define a creator of a function to call both the
981
# old and new functions, so both the old and new
982
# signals gets sent when the function is called
1130
# original and alternate functions, so both the
1131
# original and alternate signals gets sent when
1132
# the function is called
983
1133
def fixscope(func1, func2):
984
1134
"""This function is a scope container to pass
985
1135
func1 and func2 to the "call_both" function
1029
1184
attribute.func_name,
1030
1185
attribute.func_defaults,
1031
1186
attribute.func_closure)))
1032
return type.__new__(mcs, name, bases, attr)
1187
# Copy annotations, if any
1189
attr[attrname]._dbus_annotations = (
1190
dict(attribute._dbus_annotations))
1191
except AttributeError:
1193
# Is this a D-Bus interface?
1194
elif getattr(attribute, "_dbus_is_interface", False):
1195
# Create a new, but exactly alike, function
1196
# object. Decorate it to be a new D-Bus interface
1197
# with the alternate D-Bus interface name. Add it
1199
attr[attrname] = (dbus_interface_annotations
1202
(attribute.func_code,
1203
attribute.func_globals,
1204
attribute.func_name,
1205
attribute.func_defaults,
1206
attribute.func_closure)))
1208
# Deprecate all alternate interfaces
1209
iname="_AlternateDBusNames_interface_annotation{0}"
1210
for interface_name in interface_names:
1211
@dbus_interface_annotations(interface_name)
1213
return { "org.freedesktop.DBus.Deprecated":
1215
# Find an unused name
1216
for aname in (iname.format(i)
1217
for i in itertools.count()):
1218
if aname not in attr:
1222
# Replace the class with a new subclass of it with
1223
# methods, signals, etc. as created above.
1224
cls = type(b"{0}Alternate".format(cls.__name__),
1230
@alternate_dbus_interfaces({"se.recompile.Mandos":
1231
"se.bsnet.fukt.Mandos"})
1035
1232
class ClientDBus(Client, DBusObjectWithProperties):
1036
1233
"""A Client class using D-Bus
1364
1560
def Timeout_dbus_property(self, value=None):
1365
1561
if value is None: # get
1366
1562
return dbus.UInt64(self.timeout_milliseconds())
1563
old_timeout = self.timeout
1367
1564
self.timeout = datetime.timedelta(0, 0, 0, value)
1368
if getattr(self, "disable_initiator_tag", None) is None:
1370
# Reschedule timeout
1371
gobject.source_remove(self.disable_initiator_tag)
1372
self.disable_initiator_tag = None
1374
time_to_die = timedelta_to_milliseconds((self
1379
if time_to_die <= 0:
1380
# The timeout has passed
1383
self.expires = (datetime.datetime.utcnow()
1384
+ datetime.timedelta(milliseconds =
1386
self.disable_initiator_tag = (gobject.timeout_add
1387
(time_to_die, self.disable))
1565
# Reschedule disabling
1567
now = datetime.datetime.utcnow()
1568
self.expires += self.timeout - old_timeout
1569
if self.expires <= now:
1570
# The timeout has passed
1573
if (getattr(self, "disable_initiator_tag", None)
1576
gobject.source_remove(self.disable_initiator_tag)
1577
self.disable_initiator_tag = (
1578
gobject.timeout_add(
1579
timedelta_to_milliseconds(self.expires - now),
1389
1582
# ExtendedTimeout - property
1390
1583
@dbus_service_property(_interface, signature="t",
1743
1929
use_ipv6: Boolean; to use IPv6 or not
1745
1931
def __init__(self, server_address, RequestHandlerClass,
1746
interface=None, use_ipv6=True):
1932
interface=None, use_ipv6=True, socketfd=None):
1933
"""If socketfd is set, use that file descriptor instead of
1934
creating a new one with socket.socket().
1747
1936
self.interface = interface
1749
1938
self.address_family = socket.AF_INET6
1939
if socketfd is not None:
1940
# Save the file descriptor
1941
self.socketfd = socketfd
1942
# Save the original socket.socket() function
1943
self.socket_socket = socket.socket
1944
# To implement --socket, we monkey patch socket.socket.
1946
# (When socketserver.TCPServer is a new-style class, we
1947
# could make self.socket into a property instead of monkey
1948
# patching socket.socket.)
1950
# Create a one-time-only replacement for socket.socket()
1951
@functools.wraps(socket.socket)
1952
def socket_wrapper(*args, **kwargs):
1953
# Restore original function so subsequent calls are
1955
socket.socket = self.socket_socket
1956
del self.socket_socket
1957
# This time only, return a new socket object from the
1958
# saved file descriptor.
1959
return socket.fromfd(self.socketfd, *args, **kwargs)
1960
# Replace socket.socket() function with wrapper
1961
socket.socket = socket_wrapper
1962
# The socketserver.TCPServer.__init__ will call
1963
# socket.socket(), which might be our replacement,
1964
# socket_wrapper(), if socketfd was set.
1750
1965
socketserver.TCPServer.__init__(self, server_address,
1751
1966
RequestHandlerClass)
1752
1968
def server_bind(self):
1753
1969
"""This overrides the normal server_bind() function
1754
1970
to bind to an interface if one was specified, and also NOT to
1763
1979
self.socket.setsockopt(socket.SOL_SOCKET,
1764
1980
SO_BINDTODEVICE,
1981
str(self.interface + '\0'))
1767
1982
except socket.error as error:
1768
if error[0] == errno.EPERM:
1769
logger.error("No permission to"
1770
" bind to interface %s",
1772
elif error[0] == errno.ENOPROTOOPT:
1983
if error.errno == errno.EPERM:
1984
logger.error("No permission to bind to"
1985
" interface %s", self.interface)
1986
elif error.errno == errno.ENOPROTOOPT:
1773
1987
logger.error("SO_BINDTODEVICE not available;"
1774
1988
" cannot bind to interface %s",
1775
1989
self.interface)
1990
elif error.errno == errno.ENODEV:
1991
logger.error("Interface %s does not exist,"
1992
" cannot bind", self.interface)
1778
1995
# Only bind(2) the socket if we really need to.
1838
2056
def handle_ipc(self, source, condition, parent_pipe=None,
1839
2057
proc = None, client_object=None):
1841
gobject.IO_IN: "IN", # There is data to read.
1842
gobject.IO_OUT: "OUT", # Data can be written (without
1844
gobject.IO_PRI: "PRI", # There is urgent data to read.
1845
gobject.IO_ERR: "ERR", # Error condition.
1846
gobject.IO_HUP: "HUP" # Hung up (the connection has been
1847
# broken, usually for pipes and
1850
conditions_string = ' | '.join(name
1852
condition_names.iteritems()
1853
if cond & condition)
1854
2058
# error, or the other end of multiprocessing.Pipe has closed
1855
if condition & (gobject.IO_ERR | condition & gobject.IO_HUP):
2059
if condition & (gobject.IO_ERR | gobject.IO_HUP):
1856
2060
# Wait for other process to exit
2123
def rfc3339_duration_to_delta(duration):
2124
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2126
>>> rfc3339_duration_to_delta("P7D")
2127
datetime.timedelta(7)
2128
>>> rfc3339_duration_to_delta("PT60S")
2129
datetime.timedelta(0, 60)
2130
>>> rfc3339_duration_to_delta("PT60M")
2131
datetime.timedelta(0, 3600)
2132
>>> rfc3339_duration_to_delta("PT24H")
2133
datetime.timedelta(1)
2134
>>> rfc3339_duration_to_delta("P1W")
2135
datetime.timedelta(7)
2136
>>> rfc3339_duration_to_delta("PT5M30S")
2137
datetime.timedelta(0, 330)
2138
>>> rfc3339_duration_to_delta("P1DT3M20S")
2139
datetime.timedelta(1, 200)
2142
# Parsing an RFC 3339 duration with regular expressions is not
2143
# possible - there would have to be multiple places for the same
2144
# values, like seconds. The current code, while more esoteric, is
2145
# cleaner without depending on a parsing library. If Python had a
2146
# built-in library for parsing we would use it, but we'd like to
2147
# avoid excessive use of external libraries.
2149
# New type for defining tokens, syntax, and semantics all-in-one
2150
Token = collections.namedtuple("Token",
2151
("regexp", # To match token; if
2152
# "value" is not None,
2153
# must have a "group"
2155
"value", # datetime.timedelta or
2157
"followers")) # Tokens valid after
2159
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2160
# the "duration" ABNF definition in RFC 3339, Appendix A.
2161
token_end = Token(re.compile(r"$"), None, frozenset())
2162
token_second = Token(re.compile(r"(\d+)S"),
2163
datetime.timedelta(seconds=1),
2164
frozenset((token_end,)))
2165
token_minute = Token(re.compile(r"(\d+)M"),
2166
datetime.timedelta(minutes=1),
2167
frozenset((token_second, token_end)))
2168
token_hour = Token(re.compile(r"(\d+)H"),
2169
datetime.timedelta(hours=1),
2170
frozenset((token_minute, token_end)))
2171
token_time = Token(re.compile(r"T"),
2173
frozenset((token_hour, token_minute,
2175
token_day = Token(re.compile(r"(\d+)D"),
2176
datetime.timedelta(days=1),
2177
frozenset((token_time, token_end)))
2178
token_month = Token(re.compile(r"(\d+)M"),
2179
datetime.timedelta(weeks=4),
2180
frozenset((token_day, token_end)))
2181
token_year = Token(re.compile(r"(\d+)Y"),
2182
datetime.timedelta(weeks=52),
2183
frozenset((token_month, token_end)))
2184
token_week = Token(re.compile(r"(\d+)W"),
2185
datetime.timedelta(weeks=1),
2186
frozenset((token_end,)))
2187
token_duration = Token(re.compile(r"P"), None,
2188
frozenset((token_year, token_month,
2189
token_day, token_time,
2191
# Define starting values
2192
value = datetime.timedelta() # Value so far
2194
followers = frozenset(token_duration,) # Following valid tokens
2195
s = duration # String left to parse
2196
# Loop until end token is found
2197
while found_token is not token_end:
2198
# Search for any currently valid tokens
2199
for token in followers:
2200
match = token.regexp.match(s)
2201
if match is not None:
2203
if token.value is not None:
2204
# Value found, parse digits
2205
factor = int(match.group(1), 10)
2206
# Add to value so far
2207
value += factor * token.value
2208
# Strip token from string
2209
s = token.regexp.sub("", s, 1)
2212
# Set valid next tokens
2213
followers = found_token.followers
2216
# No currently valid tokens were found
2217
raise ValueError("Invalid RFC 3339 duration")
1919
2222
def string_to_delta(interval):
1920
2223
"""Parse a string and return a datetime.timedelta
2013
2323
parser.add_argument("--no-dbus", action="store_false",
2014
2324
dest="use_dbus", help="Do not provide D-Bus"
2015
" system bus interface")
2325
" system bus interface", default=None)
2016
2326
parser.add_argument("--no-ipv6", action="store_false",
2017
dest="use_ipv6", help="Do not use IPv6")
2327
dest="use_ipv6", help="Do not use IPv6",
2018
2329
parser.add_argument("--no-restore", action="store_false",
2019
2330
dest="restore", help="Do not restore stored"
2331
" state", default=None)
2332
parser.add_argument("--socket", type=int,
2333
help="Specify a file descriptor to a network"
2334
" socket to use instead of creating one")
2021
2335
parser.add_argument("--statedir", metavar="DIR",
2022
2336
help="Directory to save/restore state in")
2337
parser.add_argument("--foreground", action="store_true",
2338
help="Run in foreground", default=None)
2024
2340
options = parser.parse_args()
2026
2342
if options.check:
2344
fail_count, test_count = doctest.testmod()
2345
sys.exit(os.EX_OK if fail_count == 0 else 1)
2031
2347
# Default values for config file for server-global settings
2032
2348
server_defaults = { "interface": "",
2051
2369
# Convert the SafeConfigParser object to a dict
2052
2370
server_settings = server_config.defaults()
2053
2371
# Use the appropriate methods on the non-string config options
2054
for option in ("debug", "use_dbus", "use_ipv6"):
2372
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2055
2373
server_settings[option] = server_config.getboolean("DEFAULT",
2057
2375
if server_settings["port"]:
2058
2376
server_settings["port"] = server_config.getint("DEFAULT",
2378
if server_settings["socket"]:
2379
server_settings["socket"] = server_config.getint("DEFAULT",
2381
# Later, stdin will, and stdout and stderr might, be dup'ed
2382
# over with an opened os.devnull. But we don't want this to
2383
# happen with a supplied network socket.
2384
if 0 <= server_settings["socket"] <= 2:
2385
server_settings["socket"] = os.dup(server_settings
2060
2387
del server_config
2062
2389
# Override the settings from the config file with command line
2084
2418
use_ipv6 = server_settings["use_ipv6"]
2085
2419
stored_state_path = os.path.join(server_settings["statedir"],
2086
2420
stored_state_file)
2421
foreground = server_settings["foreground"]
2089
initlogger(logging.DEBUG)
2424
initlogger(debug, logging.DEBUG)
2091
2426
if not debuglevel:
2094
2429
level = getattr(logging, debuglevel.upper())
2430
initlogger(debug, level)
2097
2432
if server_settings["servicename"] != "Mandos":
2098
2433
syslogger.setFormatter(logging.Formatter
2099
('Mandos (%s) [%%(process)d]:'
2100
' %%(levelname)s: %%(message)s'
2101
% server_settings["servicename"]))
2434
('Mandos ({0}) [%(process)d]:'
2435
' %(levelname)s: %(message)s'
2436
.format(server_settings
2103
2439
# Parse config file with clients
2104
client_config = configparser.SafeConfigParser(Client.client_defaults)
2440
client_config = configparser.SafeConfigParser(Client
2105
2442
client_config.read(os.path.join(server_settings["configdir"],
2106
2443
"clients.conf"))
2116
2453
use_ipv6=use_ipv6,
2117
2454
gnutls_priority=
2118
2455
server_settings["priority"],
2121
pidfilename = "/var/run/mandos.pid"
2457
socketfd=(server_settings["socket"]
2460
pidfilename = "/run/mandos.pid"
2461
if not os.path.isdir("/run/."):
2462
pidfilename = "/var/run/mandos.pid"
2123
2465
pidfile = open(pidfilename, "w")
2125
logger.error("Could not open file %r", pidfilename)
2466
except IOError as e:
2467
logger.error("Could not open file %r", pidfilename,
2128
uid = pwd.getpwnam("_mandos").pw_uid
2129
gid = pwd.getpwnam("_mandos").pw_gid
2470
for name in ("_mandos", "mandos", "nobody"):
2132
uid = pwd.getpwnam("mandos").pw_uid
2133
gid = pwd.getpwnam("mandos").pw_gid
2472
uid = pwd.getpwnam(name).pw_uid
2473
gid = pwd.getpwnam(name).pw_gid
2134
2475
except KeyError:
2136
uid = pwd.getpwnam("nobody").pw_uid
2137
gid = pwd.getpwnam("nobody").pw_gid
2144
2483
except OSError as error:
2145
if error[0] != errno.EPERM:
2484
if error.errno != errno.EPERM:
2149
2488
# Enable all possible GnuTLS debugging
2160
2499
.gnutls_global_set_log_function(debug_gnutls))
2162
2501
# Redirect stdin so all checkers get /dev/null
2163
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2502
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2164
2503
os.dup2(null, sys.stdin.fileno())
2168
# No console logging
2169
logger.removeHandler(console)
2171
2507
# Need to fork before connecting to D-Bus
2173
2509
# Close all input and output, do double fork, etc.
2512
# multiprocessing will use threads, so before we use gobject we
2513
# need to inform gobject that threads will be used.
2514
gobject.threads_init()
2176
2516
global main_loop
2177
2517
# From the Avahi example code
2178
DBusGMainLoop(set_as_default=True )
2518
DBusGMainLoop(set_as_default=True)
2179
2519
main_loop = gobject.MainLoop()
2180
2520
bus = dbus.SystemBus()
2181
2521
# End of Avahi example code
2220
2567
(stored_state))
2221
2568
os.remove(stored_state_path)
2222
2569
except IOError as e:
2223
logger.warning("Could not load persistent state: {0}"
2225
if e.errno != errno.ENOENT:
2570
if e.errno == errno.ENOENT:
2571
logger.warning("Could not load persistent state: {0}"
2572
.format(os.strerror(e.errno)))
2574
logger.critical("Could not load persistent state:",
2577
except EOFError as e:
2578
logger.warning("Could not load persistent state: "
2579
"EOFError:", exc_info=e)
2228
2581
with PGPEngine() as pgp:
2229
for client in clients_data:
2230
client_name = client["name"]
2582
for client_name, client in clients_data.iteritems():
2583
# Skip removed clients
2584
if client_name not in client_settings:
2232
2587
# Decide which value to use after restoring saved state.
2233
2588
# We have three different values: Old config file,
2249
2604
# Clients who has passed its expire date can still be
2250
2605
# enabled if its last checker was successful. Clients
2251
# whose checker failed before we stored its state is
2252
# assumed to have failed all checkers during downtime.
2606
# whose checker succeeded before we stored its state is
2607
# assumed to have successfully run all checkers during
2253
2609
if client["enabled"]:
2254
2610
if datetime.datetime.utcnow() >= client["expires"]:
2255
2611
if not client["last_checked_ok"]:
2256
2612
logger.warning(
2257
2613
"disabling client {0} - Client never "
2258
"performed a successfull checker"
2259
.format(client["name"]))
2614
"performed a successful checker"
2615
.format(client_name))
2260
2616
client["enabled"] = False
2261
2617
elif client["last_checker_status"] != 0:
2262
2618
logger.warning(
2263
2619
"disabling client {0} - Client "
2264
2620
"last checker failed with error code {1}"
2265
.format(client["name"],
2621
.format(client_name,
2266
2622
client["last_checker_status"]))
2267
2623
client["enabled"] = False
2269
2625
client["expires"] = (datetime.datetime
2271
2627
+ client["timeout"])
2273
client["changedstate"] = (multiprocessing_manager
2275
(multiprocessing_manager
2277
client["checker"] = None
2279
new_client = (ClientDBusTransitional.__new__
2280
(ClientDBusTransitional))
2281
tcp_server.clients[client_name] = new_client
2282
new_client.bus = bus
2283
for name, value in client.iteritems():
2284
setattr(new_client, name, value)
2285
client_object_name = unicode(client_name).translate(
2286
{ord("."): ord("_"),
2287
ord("-"): ord("_")})
2288
new_client.dbus_object_path = (dbus.ObjectPath
2290
+ client_object_name))
2291
DBusObjectWithProperties.__init__(new_client,
2296
tcp_server.clients[client_name] = (Client.__new__
2298
for name, value in client.iteritems():
2299
setattr(tcp_server.clients[client_name],
2628
logger.debug("Last checker succeeded,"
2629
" keeping {0} enabled"
2630
.format(client_name))
2303
tcp_server.clients[client_name].secret = (
2304
pgp.decrypt(tcp_server.clients[client_name]
2632
client["secret"] = (
2633
pgp.decrypt(client["encrypted_secret"],
2306
2634
client_settings[client_name]
2308
2636
except PGPError:
2309
2637
# If decryption fails, we use secret from new settings
2310
2638
logger.debug("Failed to decrypt {0} old secret"
2311
2639
.format(client_name))
2312
tcp_server.clients[client_name].secret = (
2640
client["secret"] = (
2313
2641
client_settings[client_name]["secret"])
2315
# Create/remove clients based on new changes made to config
2316
for clientname in set(old_client_settings) - set(client_settings):
2317
del tcp_server.clients[clientname]
2318
for clientname in set(client_settings) - set(old_client_settings):
2319
tcp_server.clients[clientname] = (client_class(name = clientname,
2643
# Add/remove clients based on new changes made to config
2644
for client_name in (set(old_client_settings)
2645
- set(client_settings)):
2646
del clients_data[client_name]
2647
for client_name in (set(client_settings)
2648
- set(old_client_settings)):
2649
clients_data[client_name] = client_settings[client_name]
2651
# Create all client objects
2652
for client_name, client in clients_data.iteritems():
2653
tcp_server.clients[client_name] = client_class(
2654
name = client_name, settings = client,
2655
server_settings = server_settings)
2324
2657
if not tcp_server.clients:
2325
2658
logger.warning("No clients defined")
2331
pidfile.write(str(pid) + "\n".encode("utf-8"))
2334
logger.error("Could not write to file %r with PID %d",
2337
# "pidfile" was never created
2661
if pidfile is not None:
2665
pidfile.write(str(pid) + "\n".encode("utf-8"))
2667
logger.error("Could not write to file %r with PID %d",
2339
2670
del pidfilename
2340
signal.signal(signal.SIGINT, signal.SIG_IGN)
2342
2672
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2343
2673
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2346
class MandosDBusService(dbus.service.Object):
2676
@alternate_dbus_interfaces({"se.recompile.Mandos":
2677
"se.bsnet.fukt.Mandos"})
2678
class MandosDBusService(DBusObjectWithProperties):
2347
2679
"""A D-Bus proxy object"""
2348
2680
def __init__(self):
2349
2681
dbus.service.Object.__init__(self, bus, "/")
2350
2682
_interface = "se.recompile.Mandos"
2684
@dbus_interface_annotations(_interface)
2686
return { "org.freedesktop.DBus.Property"
2687
".EmitsChangedSignal":
2352
2690
@dbus.service.signal(_interface, signature="o")
2353
2691
def ClientAdded(self, objpath):
2433
2770
if attr not in exclude:
2434
2771
client_dict[attr] = getattr(client, attr)
2436
clients.append(client_dict)
2773
clients[client.name] = client_dict
2437
2774
del client_settings[client.name]["secret"]
2440
with os.fdopen(os.open(stored_state_path,
2441
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2442
0600), "wb") as stored_state:
2777
with (tempfile.NamedTemporaryFile
2778
(mode='wb', suffix=".pickle", prefix='clients-',
2779
dir=os.path.dirname(stored_state_path),
2780
delete=False)) as stored_state:
2443
2781
pickle.dump((clients, client_settings), stored_state)
2782
tempname=stored_state.name
2783
os.rename(tempname, stored_state_path)
2444
2784
except (IOError, OSError) as e:
2445
logger.warning("Could not save persistent state: {0}"
2447
if e.errno not in (errno.ENOENT, errno.EACCES):
2790
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2791
logger.warning("Could not save persistent state: {0}"
2792
.format(os.strerror(e.errno)))
2794
logger.warning("Could not save persistent state:",
2450
2798
# Delete all clients, and settings from config
2478
2826
service.port = tcp_server.socket.getsockname()[1]
2480
2828
logger.info("Now listening on address %r, port %d,"
2481
" flowinfo %d, scope_id %d"
2482
% tcp_server.socket.getsockname())
2829
" flowinfo %d, scope_id %d",
2830
*tcp_server.socket.getsockname())
2484
logger.info("Now listening on address %r, port %d"
2485
% tcp_server.socket.getsockname())
2832
logger.info("Now listening on address %r, port %d",
2833
*tcp_server.socket.getsockname())
2487
2835
#service.interface = tcp_server.socket.getsockname()[3]