104
107
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
105
108
with contextlib.closing(socket.socket()) as s:
106
109
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
struct.pack(str("16s16x"),
109
interface_index = struct.unpack(str("I"),
110
struct.pack(b"16s16x", interface))
111
interface_index = struct.unpack("I", ifreq[16:20])[0]
111
112
return interface_index
114
def initlogger(level=logging.WARNING):
115
def initlogger(debug, level=logging.WARNING):
115
116
"""init logger and add loglevel"""
119
syslogger = (logging.handlers.SysLogHandler
121
logging.handlers.SysLogHandler.LOG_DAEMON,
122
address = "/dev/log"))
117
123
syslogger.setFormatter(logging.Formatter
118
124
('Mandos [%(process)d]: %(levelname)s:'
120
126
logger.addHandler(syslogger)
122
console = logging.StreamHandler()
123
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
127
logger.addHandler(console)
129
console = logging.StreamHandler()
130
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
134
logger.addHandler(console)
128
135
logger.setLevel(level)
131
class CryptoError(Exception):
138
class PGPError(Exception):
139
"""Exception if encryption/decryption fails"""
135
class Crypto(object):
143
class PGPEngine(object):
136
144
"""A simple class for OpenPGP symmetric encryption & decryption"""
137
145
def __init__(self):
138
self.gnupg = GnuPGInterface.GnuPG()
139
146
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
140
self.gnupg = GnuPGInterface.GnuPG()
141
self.gnupg.options.meta_interactive = False
142
self.gnupg.options.homedir = self.tempdir
143
self.gnupg.options.extra_args.extend(['--force-mdc',
147
self.gnupgargs = ['--batch',
148
'--home', self.tempdir,
146
153
def __enter__(self):
149
def __exit__ (self, exc_type, exc_value, traceback):
156
def __exit__(self, exc_type, exc_value, traceback):
169
176
def password_encode(self, password):
170
177
# Passphrase can not be empty and can not contain newlines or
171
178
# NUL bytes. So we prefix it and hex encode it.
172
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"))
174
187
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
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:
189
203
return ciphertext
191
205
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
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:
206
222
return decrypted_plaintext
210
225
class AvahiError(Exception):
211
226
def __init__(self, value, *args, **kwargs):
212
227
self.value = value
213
super(AvahiError, self).__init__(value, *args, **kwargs)
214
def __unicode__(self):
215
return unicode(repr(self.value))
228
return super(AvahiError, self).__init__(value, *args,
217
231
class AvahiServiceError(AvahiError):
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")
435
def timeout_milliseconds(self):
436
"Return the 'timeout' attribute in milliseconds"
437
return _timedelta_to_milliseconds(self.timeout)
439
def extended_timeout_milliseconds(self):
440
"Return the 'extended_timeout' attribute in milliseconds"
441
return _timedelta_to_milliseconds(self.extended_timeout)
443
def interval_milliseconds(self):
444
"Return the 'interval' attribute in milliseconds"
445
return _timedelta_to_milliseconds(self.interval)
447
def approval_delay_milliseconds(self):
448
return _timedelta_to_milliseconds(self.approval_delay)
450
def __init__(self, name = None, config=None):
451
"""Note: the 'checker' key in 'config' sets the
452
'checker_command' attribute and *not* the 'checker'
459
client_defaults = { "timeout": "PT5M",
460
"extended_timeout": "PT15M",
462
"checker": "fping -q -- %%(host)s",
464
"approval_delay": "PT0S",
465
"approval_duration": "PT1S",
466
"approved_by_default": "True",
471
def config_parser(config):
472
"""Construct a new dict of client settings of this form:
473
{ client_name: {setting_name: value, ...}, ...}
474
with exceptions for any special settings as defined above.
475
NOTE: Must be a pure function. Must return the same result
476
value given the same arguments.
479
for client_name in config.sections():
480
section = dict(config.items(client_name))
481
client = settings[client_name] = {}
483
client["host"] = section["host"]
484
# Reformat values from string types to Python types
485
client["approved_by_default"] = config.getboolean(
486
client_name, "approved_by_default")
487
client["enabled"] = config.getboolean(client_name,
490
client["fingerprint"] = (section["fingerprint"].upper()
492
if "secret" in section:
493
client["secret"] = section["secret"].decode("base64")
494
elif "secfile" in section:
495
with open(os.path.expanduser(os.path.expandvars
496
(section["secfile"])),
498
client["secret"] = secfile.read()
500
raise TypeError("No secret or secfile for section {}"
502
client["timeout"] = string_to_delta(section["timeout"])
503
client["extended_timeout"] = string_to_delta(
504
section["extended_timeout"])
505
client["interval"] = string_to_delta(section["interval"])
506
client["approval_delay"] = string_to_delta(
507
section["approval_delay"])
508
client["approval_duration"] = string_to_delta(
509
section["approval_duration"])
510
client["checker_command"] = section["checker"]
511
client["last_approval_request"] = None
512
client["last_checked_ok"] = None
513
client["last_checker_status"] = -2
517
def __init__(self, settings, name = None, server_settings=None):
519
if server_settings is None:
521
self.server_settings = server_settings
522
# adding all client settings
523
for setting, value in settings.items():
524
setattr(self, setting, value)
527
if not hasattr(self, "last_enabled"):
528
self.last_enabled = datetime.datetime.utcnow()
529
if not hasattr(self, "expires"):
530
self.expires = (datetime.datetime.utcnow()
533
self.last_enabled = None
457
536
logger.debug("Creating client %r", self.name)
458
537
# Uppercase and remove spaces from fingerprint for later
459
538
# comparison purposes with return value from the fingerprint()
461
self.fingerprint = (config["fingerprint"].upper()
463
540
logger.debug(" Fingerprint: %s", self.fingerprint)
464
if "secret" in config:
465
self.secret = config["secret"].decode("base64")
466
elif "secfile" in config:
467
with open(os.path.expanduser(os.path.expandvars
468
(config["secfile"])),
470
self.secret = secfile.read()
472
raise TypeError("No secret or secfile for client %s"
474
self.host = config.get("host", "")
475
self.created = datetime.datetime.utcnow()
476
self.enabled = config.get("enabled", True)
477
self.last_approval_request = None
479
self.last_enabled = datetime.datetime.utcnow()
481
self.last_enabled = None
482
self.last_checked_ok = None
483
self.last_checker_status = None
484
self.timeout = string_to_delta(config["timeout"])
485
self.extended_timeout = string_to_delta(config
486
["extended_timeout"])
487
self.interval = string_to_delta(config["interval"])
541
self.created = settings.get("created",
542
datetime.datetime.utcnow())
544
# attributes specific for this server instance
488
545
self.checker = None
489
546
self.checker_initiator_tag = None
490
547
self.disable_initiator_tag = None
492
self.expires = datetime.datetime.utcnow() + self.timeout
495
548
self.checker_callback_tag = None
496
self.checker_command = config["checker"]
497
549
self.current_checker_command = None
498
self._approved = None
499
self.approved_by_default = config.get("approved_by_default",
501
551
self.approvals_pending = 0
502
self.approval_delay = string_to_delta(
503
config["approval_delay"])
504
self.approval_duration = string_to_delta(
505
config["approval_duration"])
506
552
self.changedstate = (multiprocessing_manager
507
553
.Condition(multiprocessing_manager
664
710
# in normal mode, that is already done by daemon(),
665
711
# and in debug mode we don't want to. (Stdin is
666
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,
667
721
self.checker = subprocess.Popen(command,
670
self.checker_callback_tag = (gobject.child_watch_add
672
self.checker_callback,
674
# The checker may have completed before the gobject
675
# 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.
676
736
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
678
gobject.source_remove(self.checker_callback_tag)
679
self.checker_callback(pid, status, command)
680
737
except OSError as error:
681
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)
683
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
735
836
class DBusPropertyException(dbus.exceptions.DBusException):
736
837
"""A base class for D-Bus property-related exceptions
738
def __unicode__(self):
739
return unicode(str(self))
742
841
class DBusPropertyAccessException(DBusPropertyException):
743
842
"""A property's access permissions disallows an operation.
859
980
e.setAttribute("access", prop._dbus_access)
861
982
for if_tag in document.getElementsByTagName("interface"):
862
984
for tag in (make_tag(document, name, prop)
864
in self._get_all_dbus_properties()
986
in self._get_all_dbus_things("property")
865
987
if prop._dbus_interface
866
988
== if_tag.getAttribute("name")):
867
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)
868
1021
# Add the names to the return values for the
869
1022
# "org.freedesktop.DBus.Properties" methods
870
1023
if (if_tag.getAttribute("name")
897
1050
variant_level=variant_level)
900
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
902
"""Applied to an empty subclass of a D-Bus object, this metaclass
903
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).
905
def __new__(mcs, name, bases, attr):
906
# Go through all the base classes which could have D-Bus
907
# methods, signals, or properties in them
908
for base in (b for b in bases
909
if issubclass(b, dbus.service.Object)):
910
# Go though all attributes of the base class
911
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):
912
1083
# Ignore non-D-Bus attributes, and D-Bus attributes
913
1084
# with the wrong interface name
914
1085
if (not hasattr(attribute, "_dbus_interface")
915
1086
or not attribute._dbus_interface
916
.startswith("se.recompile.Mandos")):
1087
.startswith(orig_interface_name)):
918
1089
# Create an alternate D-Bus interface name based on
919
1090
# the current name
920
1091
alt_interface = (attribute._dbus_interface
921
.replace("se.recompile.Mandos",
922
"se.bsnet.fukt.Mandos"))
1092
.replace(orig_interface_name,
1093
alt_interface_name))
1094
interface_names.add(alt_interface)
923
1095
# Is this a D-Bus signal?
924
1096
if getattr(attribute, "_dbus_is_signal", False):
925
# Extract the original non-method function by
1097
# Extract the original non-method undecorated
1098
# function by black magic
927
1099
nonmethod_func = (dict(
928
1100
zip(attribute.func_code.co_freevars,
929
1101
attribute.__closure__))["func"]
992
1176
attribute.func_name,
993
1177
attribute.func_defaults,
994
1178
attribute.func_closure)))
995
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"})
998
1224
class ClientDBus(Client, DBusObjectWithProperties):
999
1225
"""A Client class using D-Bus
1064
1300
checker is not None)
1065
1301
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1066
1302
"LastCheckedOK")
1303
last_checker_status = notifychangeproperty(dbus.Int16,
1304
"LastCheckerStatus")
1067
1305
last_approval_request = notifychangeproperty(
1068
1306
datetime_to_dbus, "LastApprovalRequest")
1069
1307
approved_by_default = notifychangeproperty(dbus.Boolean,
1070
1308
"ApprovedByDefault")
1071
approval_delay = notifychangeproperty(dbus.UInt16,
1309
approval_delay = notifychangeproperty(dbus.UInt64,
1072
1310
"ApprovalDelay",
1074
_timedelta_to_milliseconds)
1312
lambda td: td.total_seconds()
1075
1314
approval_duration = notifychangeproperty(
1076
dbus.UInt16, "ApprovalDuration",
1077
type_func = _timedelta_to_milliseconds)
1315
dbus.UInt64, "ApprovalDuration",
1316
type_func = lambda td: td.total_seconds() * 1000)
1078
1317
host = notifychangeproperty(dbus.String, "Host")
1079
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1081
_timedelta_to_milliseconds)
1318
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1319
type_func = lambda td:
1320
td.total_seconds() * 1000)
1082
1321
extended_timeout = notifychangeproperty(
1083
dbus.UInt16, "ExtendedTimeout",
1084
type_func = _timedelta_to_milliseconds)
1085
interval = notifychangeproperty(dbus.UInt16,
1322
dbus.UInt64, "ExtendedTimeout",
1323
type_func = lambda td: td.total_seconds() * 1000)
1324
interval = notifychangeproperty(dbus.UInt64,
1088
_timedelta_to_milliseconds)
1327
lambda td: td.total_seconds()
1089
1329
checker_command = notifychangeproperty(dbus.String, "Checker")
1330
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1331
invalidate_only=True)
1091
1333
del notifychangeproperty
1326
1563
access="readwrite")
1327
1564
def Timeout_dbus_property(self, value=None):
1328
1565
if value is None: # get
1329
return dbus.UInt64(self.timeout_milliseconds())
1566
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1567
old_timeout = self.timeout
1330
1568
self.timeout = datetime.timedelta(0, 0, 0, value)
1331
if getattr(self, "disable_initiator_tag", None) is None:
1333
# Reschedule timeout
1334
gobject.source_remove(self.disable_initiator_tag)
1335
self.disable_initiator_tag = None
1337
time_to_die = _timedelta_to_milliseconds((self
1342
if time_to_die <= 0:
1343
# The timeout has passed
1346
self.expires = (datetime.datetime.utcnow()
1347
+ datetime.timedelta(milliseconds =
1349
self.disable_initiator_tag = (gobject.timeout_add
1350
(time_to_die, self.disable))
1569
# Reschedule disabling
1571
now = datetime.datetime.utcnow()
1572
self.expires += self.timeout - old_timeout
1573
if self.expires <= now:
1574
# The timeout has passed
1577
if (getattr(self, "disable_initiator_tag", None)
1580
gobject.source_remove(self.disable_initiator_tag)
1581
self.disable_initiator_tag = (
1582
gobject.timeout_add(
1583
int((self.expires - now).total_seconds()
1584
* 1000), self.disable))
1352
1586
# ExtendedTimeout - property
1353
1587
@dbus_service_property(_interface, signature="t",
1354
1588
access="readwrite")
1355
1589
def ExtendedTimeout_dbus_property(self, value=None):
1356
1590
if value is None: # get
1357
return dbus.UInt64(self.extended_timeout_milliseconds())
1591
return dbus.UInt64(self.extended_timeout.total_seconds()
1358
1593
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1360
1595
# Interval - property
1705
1932
use_ipv6: Boolean; to use IPv6 or not
1707
1934
def __init__(self, server_address, RequestHandlerClass,
1708
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().
1709
1939
self.interface = interface
1711
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.
1712
1968
socketserver.TCPServer.__init__(self, server_address,
1713
1969
RequestHandlerClass)
1714
1971
def server_bind(self):
1715
1972
"""This overrides the normal server_bind() function
1716
1973
to bind to an interface if one was specified, and also NOT to
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")
1881
2226
def string_to_delta(interval):
1882
2227
"""Parse a string and return a datetime.timedelta
1975
2326
parser.add_argument("--no-dbus", action="store_false",
1976
2327
dest="use_dbus", help="Do not provide D-Bus"
1977
" system bus interface")
2328
" system bus interface", default=None)
1978
2329
parser.add_argument("--no-ipv6", action="store_false",
1979
dest="use_ipv6", help="Do not use IPv6")
2330
dest="use_ipv6", help="Do not use IPv6",
1980
2332
parser.add_argument("--no-restore", action="store_false",
1981
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")
1983
2338
parser.add_argument("--statedir", metavar="DIR",
1984
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",
1986
2346
options = parser.parse_args()
1988
2348
if options.check:
2350
fail_count, test_count = doctest.testmod()
2351
sys.exit(os.EX_OK if fail_count == 0 else 1)
1993
2353
# Default values for config file for server-global settings
1994
2354
server_defaults = { "interface": "",
2026
2398
for option in ("interface", "address", "port", "debug",
2027
2399
"priority", "servicename", "configdir",
2028
2400
"use_dbus", "use_ipv6", "debuglevel", "restore",
2401
"statedir", "socket", "foreground", "zeroconf"):
2030
2402
value = getattr(options, option)
2031
2403
if value is not None:
2032
2404
server_settings[option] = value
2034
2406
# Force all strings to be unicode
2035
2407
for option in server_settings.keys():
2036
if type(server_settings[option]) is str:
2037
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
2038
2418
# Now we have our good server settings in "server_settings"
2040
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"
2042
2428
# For convenience
2043
2429
debug = server_settings["debug"]
2044
2430
debuglevel = server_settings["debuglevel"]
2046
2432
use_ipv6 = server_settings["use_ipv6"]
2047
2433
stored_state_path = os.path.join(server_settings["statedir"],
2048
2434
stored_state_file)
2435
foreground = server_settings["foreground"]
2436
zeroconf = server_settings["zeroconf"]
2051
initlogger(logging.DEBUG)
2439
initlogger(debug, logging.DEBUG)
2053
2441
if not debuglevel:
2056
2444
level = getattr(logging, debuglevel.upper())
2445
initlogger(debug, level)
2059
2447
if server_settings["servicename"] != "Mandos":
2060
2448
syslogger.setFormatter(logging.Formatter
2061
('Mandos (%s) [%%(process)d]:'
2062
' %%(levelname)s: %%(message)s'
2063
% server_settings["servicename"]))
2449
('Mandos ({}) [%(process)d]:'
2450
' %(levelname)s: %(message)s'
2451
.format(server_settings
2065
2454
# Parse config file with clients
2066
client_defaults = { "timeout": "5m",
2067
"extended_timeout": "15m",
2069
"checker": "fping -q -- %%(host)s",
2071
"approval_delay": "0s",
2072
"approval_duration": "1s",
2074
client_config = configparser.SafeConfigParser(client_defaults)
2455
client_config = configparser.SafeConfigParser(Client
2075
2457
client_config.read(os.path.join(server_settings["configdir"],
2076
2458
"clients.conf"))
2078
2460
global mandos_dbus_service
2079
2461
mandos_dbus_service = None
2464
if server_settings["socket"] != "":
2465
socketfd = server_settings["socket"]
2081
2466
tcp_server = MandosServer((server_settings["address"],
2082
2467
server_settings["port"]),
2157
2544
("se.bsnet.fukt.Mandos", bus,
2158
2545
do_not_queue=True))
2159
2546
except dbus.exceptions.NameExistsException as e:
2160
logger.error(unicode(e) + ", disabling D-Bus")
2547
logger.error("Disabling D-Bus:", exc_info=e)
2161
2548
use_dbus = False
2162
2549
server_settings["use_dbus"] = False
2163
2550
tcp_server.use_dbus = False
2164
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2165
service = AvahiServiceToSyslog(name =
2166
server_settings["servicename"],
2167
servicetype = "_mandos._tcp",
2168
protocol = protocol, bus = bus)
2169
if server_settings["interface"]:
2170
service.interface = (if_nametoindex
2171
(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"]
2173
2562
global multiprocessing_manager
2174
2563
multiprocessing_manager = multiprocessing.Manager()
2176
2565
client_class = Client
2178
client_class = functools.partial(ClientDBusTransitional,
2181
special_settings = {
2182
# Some settings need to be accessd by special methods;
2183
# booleans need .getboolean(), etc. Here is a list of them:
2184
"approved_by_default":
2186
client_config.getboolean(section, "approved_by_default"),
2189
client_config.getboolean(section, "enabled"),
2191
# Construct a new dict of client settings of this form:
2192
# { client_name: {setting_name: value, ...}, ...}
2193
# with exceptions for any special settings as defined above
2194
client_settings = dict((clientname,
2197
if setting not in special_settings
2198
else special_settings[setting]
2200
for setting, value in
2201
client_config.items(clientname)))
2202
for clientname in client_config.sections())
2567
client_class = functools.partial(ClientDBus, bus = bus)
2569
client_settings = Client.config_parser(client_config)
2204
2570
old_client_settings = {}
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:
2207
2581
# Get client data and settings from last running state.
2208
2582
if server_settings["restore"]:
2234
2616
if (name != "secret" and
2235
2617
value != old_client_settings[client_name]
2237
setattr(client, name, value)
2619
client[name] = value
2238
2620
except KeyError:
2241
2623
# Clients who has passed its expire date can still be
2242
# enabled if its last checker was sucessful. Clients
2243
# whose checker failed before we stored its state is
2244
# assumed to have failed all checkers during downtime.
2245
if client["enabled"] and client["last_checked_ok"]:
2246
if ((datetime.datetime.utcnow()
2247
- client["last_checked_ok"])
2248
> client["interval"]):
2249
if client["last_checker_status"] != 0:
2624
# enabled if its last checker was successful. Clients
2625
# whose checker succeeded before we stored its state is
2626
# assumed to have successfully run all checkers during
2628
if client["enabled"]:
2629
if datetime.datetime.utcnow() >= client["expires"]:
2630
if not client["last_checked_ok"]:
2632
"disabling client {} - Client never "
2633
"performed a successful checker"
2634
.format(client_name))
2635
client["enabled"] = False
2636
elif client["last_checker_status"] != 0:
2638
"disabling client {} - Client last"
2639
" checker failed with error code {}"
2640
.format(client_name,
2641
client["last_checker_status"]))
2250
2642
client["enabled"] = False
2252
2644
client["expires"] = (datetime.datetime
2254
2646
+ client["timeout"])
2256
client["changedstate"] = (multiprocessing_manager
2258
(multiprocessing_manager
2261
new_client = (ClientDBusTransitional.__new__
2262
(ClientDBusTransitional))
2263
tcp_server.clients[client_name] = new_client
2264
new_client.bus = bus
2265
for name, value in client.iteritems():
2266
setattr(new_client, name, value)
2267
client_object_name = unicode(client_name).translate(
2268
{ord("."): ord("_"),
2269
ord("-"): ord("_")})
2270
new_client.dbus_object_path = (dbus.ObjectPath
2272
+ client_object_name))
2273
DBusObjectWithProperties.__init__(new_client,
2278
tcp_server.clients[client_name] = (Client.__new__
2280
for name, value in client.iteritems():
2281
setattr(tcp_server.clients[client_name],
2647
logger.debug("Last checker succeeded,"
2648
" keeping {} enabled"
2649
.format(client_name))
2285
tcp_server.clients[client_name].secret = (
2286
crypt.decrypt(tcp_server.clients[client_name]
2288
client_settings[client_name]
2651
client["secret"] = (
2652
pgp.decrypt(client["encrypted_secret"],
2653
client_settings[client_name]
2291
2656
# If decryption fails, we use secret from new settings
2292
tcp_server.clients[client_name].secret = (
2657
logger.debug("Failed to decrypt {} old secret"
2658
.format(client_name))
2659
client["secret"] = (
2293
2660
client_settings[client_name]["secret"])
2295
# Create/remove clients based on new changes made to config
2296
for clientname in set(old_client_settings) - set(client_settings):
2297
del tcp_server.clients[clientname]
2298
for clientname in set(client_settings) - set(old_client_settings):
2299
tcp_server.clients[clientname] = (client_class(name
2662
# Add/remove clients based on new changes made to config
2663
for client_name in (set(old_client_settings)
2664
- set(client_settings)):
2665
del clients_data[client_name]
2666
for client_name in (set(client_settings)
2667
- set(old_client_settings)):
2668
clients_data[client_name] = client_settings[client_name]
2670
# Create all client objects
2671
for client_name, client in clients_data.items():
2672
tcp_server.clients[client_name] = client_class(
2673
name = client_name, settings = client,
2674
server_settings = server_settings)
2305
2676
if not tcp_server.clients:
2306
2677
logger.warning("No clients defined")
2312
pidfile.write(str(pid) + "\n".encode("utf-8"))
2315
logger.error("Could not write to file %r with PID %d",
2318
# "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",
2320
2689
del pidfilename
2322
signal.signal(signal.SIGINT, signal.SIG_IGN)
2324
2691
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2325
2692
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2328
class MandosDBusService(dbus.service.Object):
2695
@alternate_dbus_interfaces({"se.recompile.Mandos":
2696
"se.bsnet.fukt.Mandos"})
2697
class MandosDBusService(DBusObjectWithProperties):
2329
2698
"""A D-Bus proxy object"""
2330
2699
def __init__(self):
2331
2700
dbus.service.Object.__init__(self, bus, "/")
2332
2701
_interface = "se.recompile.Mandos"
2703
@dbus_interface_annotations(_interface)
2705
return { "org.freedesktop.DBus.Property"
2706
".EmitsChangedSignal":
2334
2709
@dbus.service.signal(_interface, signature="o")
2335
2710
def ClientAdded(self, objpath):
2414
2790
if attr not in exclude:
2415
2791
client_dict[attr] = getattr(client, attr)
2417
clients.append(client_dict)
2793
clients[client.name] = client_dict
2418
2794
del client_settings[client.name]["secret"]
2421
with os.fdopen(os.open(stored_state_path,
2422
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2423
0600), "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:
2424
2801
pickle.dump((clients, client_settings), stored_state)
2802
tempname=stored_state.name
2803
os.rename(tempname, stored_state_path)
2425
2804
except (IOError, OSError) as e:
2426
logger.warning("Could not save persistent state: {0}"
2428
if e.errno not in (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:",
2431
2818
# Delete all clients, and settings from config
2456
2843
tcp_server.server_activate()
2458
2845
# Find out what port we got
2459
service.port = tcp_server.socket.getsockname()[1]
2847
service.port = tcp_server.socket.getsockname()[1]
2461
2849
logger.info("Now listening on address %r, port %d,"
2462
" flowinfo %d, scope_id %d"
2463
% tcp_server.socket.getsockname())
2850
" flowinfo %d, scope_id %d",
2851
*tcp_server.socket.getsockname())
2465
logger.info("Now listening on address %r, port %d"
2466
% tcp_server.socket.getsockname())
2853
logger.info("Now listening on address %r, port %d",
2854
*tcp_server.socket.getsockname())
2468
2856
#service.interface = tcp_server.socket.getsockname()[3]
2471
# From the Avahi example code
2474
except dbus.exceptions.DBusException as error:
2475
logger.critical("DBusException: %s", error)
2478
# 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
2480
2869
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2481
2870
lambda *args, **kwargs: