426
412
interval: datetime.timedelta(); How often to start a new checker
427
413
last_approval_request: datetime.datetime(); (UTC) or None
428
414
last_checked_ok: datetime.datetime(); (UTC) or None
429
416
last_checker_status: integer between 0 and 255 reflecting exit
430
417
status of last checker. -1 reflects crashed
431
checker, -2 means no checker completed yet.
432
419
last_enabled: datetime.datetime(); (UTC) or None
433
420
name: string; from the config file, used in log messages and
434
421
D-Bus identifiers
435
422
secret: bytestring; sent verbatim (over TLS) to client
436
423
timeout: datetime.timedelta(); How long from last_checked_ok
437
424
until this client is disabled
438
extended_timeout: extra long timeout when secret has been sent
425
extended_timeout: extra long timeout when password has been sent
439
426
runtime_expansions: Allowed attributes for runtime expansion.
440
427
expires: datetime.datetime(); time (UTC) when a client will be
441
428
disabled, or None
444
431
runtime_expansions = ("approval_delay", "approval_duration",
445
"created", "enabled", "expires",
446
"fingerprint", "host", "interval",
447
"last_approval_request", "last_checked_ok",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
448
434
"last_enabled", "name", "timeout")
449
client_defaults = { "timeout": "5m",
450
"extended_timeout": "15m",
452
"checker": "fping -q -- %%(host)s",
454
"approval_delay": "0s",
455
"approval_duration": "1s",
456
"approved_by_default": "True",
460
436
def timeout_milliseconds(self):
461
437
"Return the 'timeout' attribute in milliseconds"
462
return timedelta_to_milliseconds(self.timeout)
438
return _timedelta_to_milliseconds(self.timeout)
464
440
def extended_timeout_milliseconds(self):
465
441
"Return the 'extended_timeout' attribute in milliseconds"
466
return timedelta_to_milliseconds(self.extended_timeout)
442
return _timedelta_to_milliseconds(self.extended_timeout)
468
444
def interval_milliseconds(self):
469
445
"Return the 'interval' attribute in milliseconds"
470
return timedelta_to_milliseconds(self.interval)
446
return _timedelta_to_milliseconds(self.interval)
472
448
def approval_delay_milliseconds(self):
473
return timedelta_to_milliseconds(self.approval_delay)
476
def config_parser(config):
477
"""Construct a new dict of client settings of this form:
478
{ client_name: {setting_name: value, ...}, ...}
479
with exceptions for any special settings as defined above.
480
NOTE: Must be a pure function. Must return the same result
481
value given the same arguments.
484
for client_name in config.sections():
485
section = dict(config.items(client_name))
486
client = settings[client_name] = {}
488
client["host"] = section["host"]
489
# Reformat values from string types to Python types
490
client["approved_by_default"] = config.getboolean(
491
client_name, "approved_by_default")
492
client["enabled"] = config.getboolean(client_name,
495
client["fingerprint"] = (section["fingerprint"].upper()
497
if "secret" in section:
498
client["secret"] = section["secret"].decode("base64")
499
elif "secfile" in section:
500
with open(os.path.expanduser(os.path.expandvars
501
(section["secfile"])),
503
client["secret"] = secfile.read()
505
raise TypeError("No secret or secfile for section {0}"
507
client["timeout"] = string_to_delta(section["timeout"])
508
client["extended_timeout"] = string_to_delta(
509
section["extended_timeout"])
510
client["interval"] = string_to_delta(section["interval"])
511
client["approval_delay"] = string_to_delta(
512
section["approval_delay"])
513
client["approval_duration"] = string_to_delta(
514
section["approval_duration"])
515
client["checker_command"] = section["checker"]
516
client["last_approval_request"] = None
517
client["last_checked_ok"] = None
518
client["last_checker_status"] = -2
522
def __init__(self, settings, name = None):
449
return _timedelta_to_milliseconds(self.approval_delay)
451
def __init__(self, name = None, config=None):
452
"""Note: the 'checker' key in 'config' sets the
453
'checker_command' attribute and *not* the 'checker'
524
# adding all client settings
525
for setting, value in settings.iteritems():
526
setattr(self, setting, value)
529
if not hasattr(self, "last_enabled"):
530
self.last_enabled = datetime.datetime.utcnow()
531
if not hasattr(self, "expires"):
532
self.expires = (datetime.datetime.utcnow()
535
self.last_enabled = None
538
458
logger.debug("Creating client %r", self.name)
539
459
# Uppercase and remove spaces from fingerprint for later
540
460
# comparison purposes with return value from the fingerprint()
462
self.fingerprint = (config["fingerprint"].upper()
542
464
logger.debug(" Fingerprint: %s", self.fingerprint)
543
self.created = settings.get("created",
544
datetime.datetime.utcnow())
546
# attributes specific for this server instance
465
if "secret" in config:
466
self.secret = config["secret"].decode("base64")
467
elif "secfile" in config:
468
with open(os.path.expanduser(os.path.expandvars
469
(config["secfile"])),
471
self.secret = secfile.read()
473
raise TypeError("No secret or secfile for client %s"
475
self.host = config.get("host", "")
476
self.created = datetime.datetime.utcnow()
477
self.enabled = config.get("enabled", True)
478
self.last_approval_request = None
480
self.last_enabled = datetime.datetime.utcnow()
482
self.last_enabled = None
483
self.last_checked_ok = None
484
self.last_checker_status = None
485
self.timeout = string_to_delta(config["timeout"])
486
self.extended_timeout = string_to_delta(config
487
["extended_timeout"])
488
self.interval = string_to_delta(config["interval"])
547
489
self.checker = None
548
490
self.checker_initiator_tag = None
549
491
self.disable_initiator_tag = None
493
self.expires = datetime.datetime.utcnow() + self.timeout
550
496
self.checker_callback_tag = None
497
self.checker_command = config["checker"]
551
498
self.current_checker_command = None
499
self._approved = None
500
self.approved_by_default = config.get("approved_by_default",
553
502
self.approvals_pending = 0
503
self.approval_delay = string_to_delta(
504
config["approval_delay"])
505
self.approval_duration = string_to_delta(
506
config["approval_duration"])
554
507
self.changedstate = (multiprocessing_manager
555
508
.Condition(multiprocessing_manager
954
860
e.setAttribute("access", prop._dbus_access)
956
862
for if_tag in document.getElementsByTagName("interface"):
958
863
for tag in (make_tag(document, name, prop)
960
in self._get_all_dbus_things("property")
865
in self._get_all_dbus_properties()
961
866
if prop._dbus_interface
962
867
== if_tag.getAttribute("name")):
963
868
if_tag.appendChild(tag)
964
# Add annotation tags
965
for typ in ("method", "signal", "property"):
966
for tag in if_tag.getElementsByTagName(typ):
968
for name, prop in (self.
969
_get_all_dbus_things(typ)):
970
if (name == tag.getAttribute("name")
971
and prop._dbus_interface
972
== if_tag.getAttribute("name")):
973
annots.update(getattr
977
for name, value in annots.iteritems():
978
ann_tag = document.createElement(
980
ann_tag.setAttribute("name", name)
981
ann_tag.setAttribute("value", value)
982
tag.appendChild(ann_tag)
983
# Add interface annotation tags
984
for annotation, value in dict(
985
itertools.chain.from_iterable(
986
annotations().iteritems()
987
for name, annotations in
988
self._get_all_dbus_things("interface")
989
if name == if_tag.getAttribute("name")
991
ann_tag = document.createElement("annotation")
992
ann_tag.setAttribute("name", annotation)
993
ann_tag.setAttribute("value", value)
994
if_tag.appendChild(ann_tag)
995
869
# Add the names to the return values for the
996
870
# "org.freedesktop.DBus.Properties" methods
997
871
if (if_tag.getAttribute("name")
1024
898
variant_level=variant_level)
1027
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1028
"""A class decorator; applied to a subclass of
1029
dbus.service.Object, it will add alternate D-Bus attributes with
1030
interface names according to the "alt_interface_names" mapping.
1033
@alternate_dbus_interfaces({"org.example.Interface":
1034
"net.example.AlternateInterface"})
1035
class SampleDBusObject(dbus.service.Object):
1036
@dbus.service.method("org.example.Interface")
1037
def SampleDBusMethod():
1040
The above "SampleDBusMethod" on "SampleDBusObject" will be
1041
reachable via two interfaces: "org.example.Interface" and
1042
"net.example.AlternateInterface", the latter of which will have
1043
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1044
"true", unless "deprecate" is passed with a False value.
1046
This works for methods and signals, and also for D-Bus properties
1047
(from DBusObjectWithProperties) and interfaces (from the
1048
dbus_interface_annotations decorator).
901
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
903
"""Applied to an empty subclass of a D-Bus object, this metaclass
904
will add additional D-Bus attributes matching a certain pattern.
1051
for orig_interface_name, alt_interface_name in (
1052
alt_interface_names.iteritems()):
1054
interface_names = set()
1055
# Go though all attributes of the class
1056
for attrname, attribute in inspect.getmembers(cls):
906
def __new__(mcs, name, bases, attr):
907
# Go through all the base classes which could have D-Bus
908
# methods, signals, or properties in them
909
for base in (b for b in bases
910
if issubclass(b, dbus.service.Object)):
911
# Go though all attributes of the base class
912
for attrname, attribute in inspect.getmembers(base):
1057
913
# Ignore non-D-Bus attributes, and D-Bus attributes
1058
914
# with the wrong interface name
1059
915
if (not hasattr(attribute, "_dbus_interface")
1060
916
or not attribute._dbus_interface
1061
.startswith(orig_interface_name)):
917
.startswith("se.recompile.Mandos")):
1063
919
# Create an alternate D-Bus interface name based on
1064
920
# the current name
1065
921
alt_interface = (attribute._dbus_interface
1066
.replace(orig_interface_name,
1067
alt_interface_name))
1068
interface_names.add(alt_interface)
922
.replace("se.recompile.Mandos",
923
"se.bsnet.fukt.Mandos"))
1069
924
# Is this a D-Bus signal?
1070
925
if getattr(attribute, "_dbus_is_signal", False):
1071
926
# Extract the original non-method function by
1150
993
attribute.func_name,
1151
994
attribute.func_defaults,
1152
995
attribute.func_closure)))
1153
# Copy annotations, if any
1155
attr[attrname]._dbus_annotations = (
1156
dict(attribute._dbus_annotations))
1157
except AttributeError:
1159
# Is this a D-Bus interface?
1160
elif getattr(attribute, "_dbus_is_interface", False):
1161
# Create a new, but exactly alike, function
1162
# object. Decorate it to be a new D-Bus interface
1163
# with the alternate D-Bus interface name. Add it
1165
attr[attrname] = (dbus_interface_annotations
1168
(attribute.func_code,
1169
attribute.func_globals,
1170
attribute.func_name,
1171
attribute.func_defaults,
1172
attribute.func_closure)))
1174
# Deprecate all alternate interfaces
1175
iname="_AlternateDBusNames_interface_annotation{0}"
1176
for interface_name in interface_names:
1177
@dbus_interface_annotations(interface_name)
1179
return { "org.freedesktop.DBus.Deprecated":
1181
# Find an unused name
1182
for aname in (iname.format(i)
1183
for i in itertools.count()):
1184
if aname not in attr:
1188
# Replace the class with a new subclass of it with
1189
# methods, signals, etc. as created above.
1190
cls = type(b"{0}Alternate".format(cls.__name__),
1196
@alternate_dbus_interfaces({"se.recompile.Mandos":
1197
"se.bsnet.fukt.Mandos"})
996
return type.__new__(mcs, name, bases, attr)
1198
999
class ClientDBus(Client, DBusObjectWithProperties):
1199
1000
"""A Client class using D-Bus
1261
1065
checker is not None)
1262
1066
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1263
1067
"LastCheckedOK")
1264
last_checker_status = notifychangeproperty(dbus.Int16,
1265
"LastCheckerStatus")
1266
1068
last_approval_request = notifychangeproperty(
1267
1069
datetime_to_dbus, "LastApprovalRequest")
1268
1070
approved_by_default = notifychangeproperty(dbus.Boolean,
1269
1071
"ApprovedByDefault")
1270
approval_delay = notifychangeproperty(dbus.UInt64,
1072
approval_delay = notifychangeproperty(dbus.UInt16,
1271
1073
"ApprovalDelay",
1273
timedelta_to_milliseconds)
1075
_timedelta_to_milliseconds)
1274
1076
approval_duration = notifychangeproperty(
1275
dbus.UInt64, "ApprovalDuration",
1276
type_func = timedelta_to_milliseconds)
1077
dbus.UInt16, "ApprovalDuration",
1078
type_func = _timedelta_to_milliseconds)
1277
1079
host = notifychangeproperty(dbus.String, "Host")
1278
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1080
timeout = notifychangeproperty(dbus.UInt16, "Timeout",
1280
timedelta_to_milliseconds)
1082
_timedelta_to_milliseconds)
1281
1083
extended_timeout = notifychangeproperty(
1282
dbus.UInt64, "ExtendedTimeout",
1283
type_func = timedelta_to_milliseconds)
1284
interval = notifychangeproperty(dbus.UInt64,
1084
dbus.UInt16, "ExtendedTimeout",
1085
type_func = _timedelta_to_milliseconds)
1086
interval = notifychangeproperty(dbus.UInt16,
1287
timedelta_to_milliseconds)
1089
_timedelta_to_milliseconds)
1288
1090
checker_command = notifychangeproperty(dbus.String, "Checker")
1290
1092
del notifychangeproperty
1530
1328
def Timeout_dbus_property(self, value=None):
1531
1329
if value is None: # get
1532
1330
return dbus.UInt64(self.timeout_milliseconds())
1533
old_timeout = self.timeout
1534
1331
self.timeout = datetime.timedelta(0, 0, 0, value)
1535
# Reschedule disabling
1537
now = datetime.datetime.utcnow()
1538
self.expires += self.timeout - old_timeout
1539
if self.expires <= now:
1540
# The timeout has passed
1543
if (getattr(self, "disable_initiator_tag", None)
1546
gobject.source_remove(self.disable_initiator_tag)
1547
self.disable_initiator_tag = (
1548
gobject.timeout_add(
1549
timedelta_to_milliseconds(self.expires - now),
1332
if getattr(self, "disable_initiator_tag", None) is None:
1334
# Reschedule timeout
1335
gobject.source_remove(self.disable_initiator_tag)
1336
self.disable_initiator_tag = None
1338
time_to_die = _timedelta_to_milliseconds((self
1343
if time_to_die <= 0:
1344
# The timeout has passed
1347
self.expires = (datetime.datetime.utcnow()
1348
+ datetime.timedelta(milliseconds =
1350
self.disable_initiator_tag = (gobject.timeout_add
1351
(time_to_die, self.disable))
1552
1353
# ExtendedTimeout - property
1553
1354
@dbus_service_property(_interface, signature="t",
1899
1706
use_ipv6: Boolean; to use IPv6 or not
1901
1708
def __init__(self, server_address, RequestHandlerClass,
1902
interface=None, use_ipv6=True, socketfd=None):
1903
"""If socketfd is set, use that file descriptor instead of
1904
creating a new one with socket.socket().
1709
interface=None, use_ipv6=True):
1906
1710
self.interface = interface
1908
1712
self.address_family = socket.AF_INET6
1909
if socketfd is not None:
1910
# Save the file descriptor
1911
self.socketfd = socketfd
1912
# Save the original socket.socket() function
1913
self.socket_socket = socket.socket
1914
# To implement --socket, we monkey patch socket.socket.
1916
# (When socketserver.TCPServer is a new-style class, we
1917
# could make self.socket into a property instead of monkey
1918
# patching socket.socket.)
1920
# Create a one-time-only replacement for socket.socket()
1921
@functools.wraps(socket.socket)
1922
def socket_wrapper(*args, **kwargs):
1923
# Restore original function so subsequent calls are
1925
socket.socket = self.socket_socket
1926
del self.socket_socket
1927
# This time only, return a new socket object from the
1928
# saved file descriptor.
1929
return socket.fromfd(self.socketfd, *args, **kwargs)
1930
# Replace socket.socket() function with wrapper
1931
socket.socket = socket_wrapper
1932
# The socketserver.TCPServer.__init__ will call
1933
# socket.socket(), which might be our replacement,
1934
# socket_wrapper(), if socketfd was set.
1935
1713
socketserver.TCPServer.__init__(self, server_address,
1936
1714
RequestHandlerClass)
1938
1715
def server_bind(self):
1939
1716
"""This overrides the normal server_bind() function
1940
1717
to bind to an interface if one was specified, and also NOT to
2438
2235
if (name != "secret" and
2439
2236
value != old_client_settings[client_name]
2441
client[name] = value
2238
setattr(client, name, value)
2442
2239
except KeyError:
2445
2242
# Clients who has passed its expire date can still be
2446
# enabled if its last checker was successful. Clients
2447
# whose checker succeeded before we stored its state is
2448
# assumed to have successfully run all checkers during
2450
if client["enabled"]:
2451
if datetime.datetime.utcnow() >= client["expires"]:
2452
if not client["last_checked_ok"]:
2454
"disabling client {0} - Client never "
2455
"performed a successful checker"
2456
.format(client_name))
2457
client["enabled"] = False
2458
elif client["last_checker_status"] != 0:
2460
"disabling client {0} - Client "
2461
"last checker failed with error code {1}"
2462
.format(client_name,
2463
client["last_checker_status"]))
2243
# enabled if its last checker was sucessful. Clients
2244
# whose checker failed before we stored its state is
2245
# assumed to have failed all checkers during downtime.
2246
if client["enabled"] and client["last_checked_ok"]:
2247
if ((datetime.datetime.utcnow()
2248
- client["last_checked_ok"])
2249
> client["interval"]):
2250
if client["last_checker_status"] != 0:
2464
2251
client["enabled"] = False
2466
2253
client["expires"] = (datetime.datetime
2468
2255
+ client["timeout"])
2469
logger.debug("Last checker succeeded,"
2470
" keeping {0} enabled"
2471
.format(client_name))
2257
client["changedstate"] = (multiprocessing_manager
2259
(multiprocessing_manager
2262
new_client = (ClientDBusTransitional.__new__
2263
(ClientDBusTransitional))
2264
tcp_server.clients[client_name] = new_client
2265
new_client.bus = bus
2266
for name, value in client.iteritems():
2267
setattr(new_client, name, value)
2268
client_object_name = unicode(client_name).translate(
2269
{ord("."): ord("_"),
2270
ord("-"): ord("_")})
2271
new_client.dbus_object_path = (dbus.ObjectPath
2273
+ client_object_name))
2274
DBusObjectWithProperties.__init__(new_client,
2279
tcp_server.clients[client_name] = (Client.__new__
2281
for name, value in client.iteritems():
2282
setattr(tcp_server.clients[client_name],
2473
client["secret"] = (
2474
pgp.decrypt(client["encrypted_secret"],
2286
tcp_server.clients[client_name].secret = (
2287
pgp.decrypt(tcp_server.clients[client_name]
2475
2289
client_settings[client_name]
2477
2291
except PGPError:
2478
2292
# If decryption fails, we use secret from new settings
2479
logger.debug("Failed to decrypt {0} old secret"
2480
.format(client_name))
2481
client["secret"] = (
2293
tcp_server.clients[client_name].secret = (
2482
2294
client_settings[client_name]["secret"])
2484
# Add/remove clients based on new changes made to config
2485
for client_name in (set(old_client_settings)
2486
- set(client_settings)):
2487
del clients_data[client_name]
2488
for client_name in (set(client_settings)
2489
- set(old_client_settings)):
2490
clients_data[client_name] = client_settings[client_name]
2492
# Create all client objects
2493
for client_name, client in clients_data.iteritems():
2494
tcp_server.clients[client_name] = client_class(
2495
name = client_name, settings = client)
2296
# Create/remove clients based on new changes made to config
2297
for clientname in set(old_client_settings) - set(client_settings):
2298
del tcp_server.clients[clientname]
2299
for clientname in set(client_settings) - set(old_client_settings):
2300
tcp_server.clients[clientname] = (client_class(name
2497
2306
if not tcp_server.clients:
2498
2307
logger.warning("No clients defined")
2611
2415
if attr not in exclude:
2612
2416
client_dict[attr] = getattr(client, attr)
2614
clients[client.name] = client_dict
2418
clients.append(client_dict)
2615
2419
del client_settings[client.name]["secret"]
2618
with (tempfile.NamedTemporaryFile
2619
(mode='wb', suffix=".pickle", prefix='clients-',
2620
dir=os.path.dirname(stored_state_path),
2621
delete=False)) as stored_state:
2422
with os.fdopen(os.open(stored_state_path,
2423
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2424
0600), "wb") as stored_state:
2622
2425
pickle.dump((clients, client_settings), stored_state)
2623
tempname=stored_state.name
2624
os.rename(tempname, stored_state_path)
2625
2426
except (IOError, OSError) as e:
2631
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2632
logger.warning("Could not save persistent state: {0}"
2633
.format(os.strerror(e.errno)))
2635
logger.warning("Could not save persistent state:",
2427
logger.warning("Could not save persistent state: {0}"
2429
if e.errno not in (errno.ENOENT, errno.EACCES):
2639
2432
# Delete all clients, and settings from config
2640
2433
while tcp_server.clients: