414
412
interval: datetime.timedelta(); How often to start a new checker
415
413
last_approval_request: datetime.datetime(); (UTC) or None
416
414
last_checked_ok: datetime.datetime(); (UTC) or None
417
416
last_checker_status: integer between 0 and 255 reflecting exit
418
417
status of last checker. -1 reflects crashed
419
checker, -2 means no checker completed yet.
420
419
last_enabled: datetime.datetime(); (UTC) or None
421
420
name: string; from the config file, used in log messages and
422
421
D-Bus identifiers
423
422
secret: bytestring; sent verbatim (over TLS) to client
424
423
timeout: datetime.timedelta(); How long from last_checked_ok
425
424
until this client is disabled
426
extended_timeout: extra long timeout when secret has been sent
425
extended_timeout: extra long timeout when password has been sent
427
426
runtime_expansions: Allowed attributes for runtime expansion.
428
427
expires: datetime.datetime(); time (UTC) when a client will be
429
428
disabled, or None
433
432
"created", "enabled", "fingerprint",
434
433
"host", "interval", "last_checked_ok",
435
434
"last_enabled", "name", "timeout")
436
client_defaults = { "timeout": "5m",
437
"extended_timeout": "15m",
439
"checker": "fping -q -- %%(host)s",
441
"approval_delay": "0s",
442
"approval_duration": "1s",
443
"approved_by_default": "True",
447
436
def timeout_milliseconds(self):
448
437
"Return the 'timeout' attribute in milliseconds"
459
448
def approval_delay_milliseconds(self):
460
449
return timedelta_to_milliseconds(self.approval_delay)
463
def config_parser(config):
464
"""Construct a new dict of client settings of this form:
465
{ client_name: {setting_name: value, ...}, ...}
466
with exceptions for any special settings as defined above.
467
NOTE: Must be a pure function. Must return the same result
468
value given the same arguments.
471
for client_name in config.sections():
472
section = dict(config.items(client_name))
473
client = settings[client_name] = {}
475
client["host"] = section["host"]
476
# Reformat values from string types to Python types
477
client["approved_by_default"] = config.getboolean(
478
client_name, "approved_by_default")
479
client["enabled"] = config.getboolean(client_name,
482
client["fingerprint"] = (section["fingerprint"].upper()
484
if "secret" in section:
485
client["secret"] = section["secret"].decode("base64")
486
elif "secfile" in section:
487
with open(os.path.expanduser(os.path.expandvars
488
(section["secfile"])),
490
client["secret"] = secfile.read()
492
raise TypeError("No secret or secfile for section %s"
494
client["timeout"] = string_to_delta(section["timeout"])
495
client["extended_timeout"] = string_to_delta(
496
section["extended_timeout"])
497
client["interval"] = string_to_delta(section["interval"])
498
client["approval_delay"] = string_to_delta(
499
section["approval_delay"])
500
client["approval_duration"] = string_to_delta(
501
section["approval_duration"])
502
client["checker_command"] = section["checker"]
503
client["last_approval_request"] = None
504
client["last_checked_ok"] = None
505
client["last_checker_status"] = -2
510
def __init__(self, settings, name = None):
451
def __init__(self, name = None, config=None):
511
452
"""Note: the 'checker' key in 'config' sets the
512
453
'checker_command' attribute and *not* the 'checker'
515
# adding all client settings
516
for setting, value in settings.iteritems():
517
setattr(self, setting, value)
520
if not hasattr(self, "last_enabled"):
521
self.last_enabled = datetime.datetime.utcnow()
522
if not hasattr(self, "expires"):
523
self.expires = (datetime.datetime.utcnow()
526
self.last_enabled = None
529
458
logger.debug("Creating client %r", self.name)
530
459
# Uppercase and remove spaces from fingerprint for later
531
460
# comparison purposes with return value from the fingerprint()
462
self.fingerprint = (config["fingerprint"].upper()
533
464
logger.debug(" Fingerprint: %s", self.fingerprint)
534
self.created = settings.get("created",
535
datetime.datetime.utcnow())
537
# 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"])
538
489
self.checker = None
539
490
self.checker_initiator_tag = None
540
491
self.disable_initiator_tag = None
493
self.expires = datetime.datetime.utcnow() + self.timeout
541
496
self.checker_callback_tag = None
497
self.checker_command = config["checker"]
542
498
self.current_checker_command = None
543
499
self.approved = None
500
self.approved_by_default = config.get("approved_by_default",
544
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"])
545
507
self.changedstate = (multiprocessing_manager
546
508
.Condition(multiprocessing_manager
627
589
logger.warning("Checker for %(name)s crashed?",
630
def checked_ok(self):
631
"""Assert that the client has been seen, alive and well."""
632
self.last_checked_ok = datetime.datetime.utcnow()
633
self.last_checker_status = 0
636
def bump_timeout(self, timeout=None):
637
"""Bump up the timeout for this client."""
592
def checked_ok(self, timeout=None):
593
"""Bump up the timeout for this client.
595
This should only be called when the client has been seen,
638
598
if timeout is None:
639
599
timeout = self.timeout
600
self.last_checked_ok = datetime.datetime.utcnow()
640
601
if self.disable_initiator_tag is not None:
641
602
gobject.source_remove(self.disable_initiator_tag)
642
603
if getattr(self, "enabled", False):
775
def dbus_interface_annotations(dbus_interface):
776
"""Decorator for marking functions returning interface annotations.
780
@dbus_interface_annotations("org.example.Interface")
781
def _foo(self): # Function name does not matter
782
return {"org.freedesktop.DBus.Deprecated": "true",
783
"org.freedesktop.DBus.Property.EmitsChangedSignal":
787
func._dbus_is_interface = True
788
func._dbus_interface = dbus_interface
789
func._dbus_name = dbus_interface
794
def dbus_annotations(annotations):
795
"""Decorator to annotate D-Bus methods, signals or properties
798
@dbus_service_property("org.example.Interface", signature="b",
800
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
801
"org.freedesktop.DBus.Property."
802
"EmitsChangedSignal": "false"})
803
def Property_dbus_property(self):
804
return dbus.Boolean(False)
807
func._dbus_annotations = annotations
812
736
class DBusPropertyException(dbus.exceptions.DBusException):
813
737
"""A base class for D-Bus property-related exceptions
840
def _is_dbus_thing(thing):
841
"""Returns a function testing if an attribute is a D-Bus thing
843
If called like _is_dbus_thing("method") it returns a function
844
suitable for use as predicate to inspect.getmembers().
846
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
764
def _is_dbus_property(obj):
765
return getattr(obj, "_dbus_is_property", False)
849
def _get_all_dbus_things(self, thing):
767
def _get_all_dbus_properties(self):
850
768
"""Returns a generator of (name, attribute) pairs
852
return ((getattr(athing.__get__(self), "_dbus_name",
854
athing.__get__(self))
770
return ((prop.__get__(self)._dbus_name, prop.__get__(self))
855
771
for cls in self.__class__.__mro__
857
inspect.getmembers(cls,
858
self._is_dbus_thing(thing)))
773
inspect.getmembers(cls, self._is_dbus_property))
860
775
def _get_dbus_property(self, interface_name, property_name):
861
776
"""Returns a bound method if one exists which is a D-Bus
948
860
e.setAttribute("access", prop._dbus_access)
950
862
for if_tag in document.getElementsByTagName("interface"):
952
863
for tag in (make_tag(document, name, prop)
954
in self._get_all_dbus_things("property")
865
in self._get_all_dbus_properties()
955
866
if prop._dbus_interface
956
867
== if_tag.getAttribute("name")):
957
868
if_tag.appendChild(tag)
958
# Add annotation tags
959
for typ in ("method", "signal", "property"):
960
for tag in if_tag.getElementsByTagName(typ):
962
for name, prop in (self.
963
_get_all_dbus_things(typ)):
964
if (name == tag.getAttribute("name")
965
and prop._dbus_interface
966
== if_tag.getAttribute("name")):
967
annots.update(getattr
971
for name, value in annots.iteritems():
972
ann_tag = document.createElement(
974
ann_tag.setAttribute("name", name)
975
ann_tag.setAttribute("value", value)
976
tag.appendChild(ann_tag)
977
# Add interface annotation tags
978
for annotation, value in dict(
980
*(annotations().iteritems()
981
for name, annotations in
982
self._get_all_dbus_things("interface")
983
if name == if_tag.getAttribute("name")
985
ann_tag = document.createElement("annotation")
986
ann_tag.setAttribute("name", annotation)
987
ann_tag.setAttribute("value", value)
988
if_tag.appendChild(ann_tag)
989
869
# Add the names to the return values for the
990
870
# "org.freedesktop.DBus.Properties" methods
991
871
if (if_tag.getAttribute("name")
1128
993
attribute.func_name,
1129
994
attribute.func_defaults,
1130
995
attribute.func_closure)))
1131
# Copy annotations, if any
1133
attr[attrname]._dbus_annotations = (
1134
dict(attribute._dbus_annotations))
1135
except AttributeError:
1137
# Is this a D-Bus interface?
1138
elif getattr(attribute, "_dbus_is_interface", False):
1139
# Create a new, but exactly alike, function
1140
# object. Decorate it to be a new D-Bus interface
1141
# with the alternate D-Bus interface name. Add it
1143
attr[attrname] = (dbus_interface_annotations
1146
(attribute.func_code,
1147
attribute.func_globals,
1148
attribute.func_name,
1149
attribute.func_defaults,
1150
attribute.func_closure)))
1151
# Deprecate all old interfaces
1152
basename="_AlternateDBusNamesMetaclass_interface_annotation{0}"
1153
for old_interface_name in old_interface_names:
1154
@dbus_interface_annotations(old_interface_name)
1156
return { "org.freedesktop.DBus.Deprecated": "true" }
1157
# Find an unused name
1158
for aname in (basename.format(i) for i in
1160
if aname not in attr:
1163
996
return type.__new__(mcs, name, bases, attr)
1501
1329
if value is None: # get
1502
1330
return dbus.UInt64(self.timeout_milliseconds())
1503
1331
self.timeout = datetime.timedelta(0, 0, 0, value)
1332
if getattr(self, "disable_initiator_tag", None) is None:
1504
1334
# Reschedule timeout
1506
now = datetime.datetime.utcnow()
1507
time_to_die = timedelta_to_milliseconds(
1508
(self.last_checked_ok + self.timeout) - now)
1509
if time_to_die <= 0:
1510
# The timeout has passed
1513
self.expires = (now +
1514
datetime.timedelta(milliseconds =
1516
if (getattr(self, "disable_initiator_tag", None)
1519
gobject.source_remove(self.disable_initiator_tag)
1520
self.disable_initiator_tag = (gobject.timeout_add
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))
1524
1353
# ExtendedTimeout - property
1525
1354
@dbus_service_property(_interface, signature="t",
2288
2132
.gnutls_global_set_log_function(debug_gnutls))
2290
2134
# Redirect stdin so all checkers get /dev/null
2291
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2135
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2292
2136
os.dup2(null, sys.stdin.fileno())
2140
# No console logging
2141
logger.removeHandler(console)
2296
2143
# Need to fork before connecting to D-Bus
2298
2145
# Close all input and output, do double fork, etc.
2301
gobject.threads_init()
2303
2148
global main_loop
2304
2149
# From the Avahi example code
2305
DBusGMainLoop(set_as_default=True)
2150
DBusGMainLoop(set_as_default=True )
2306
2151
main_loop = gobject.MainLoop()
2307
2152
bus = dbus.SystemBus()
2308
2153
# End of Avahi example code
2335
2180
client_class = functools.partial(ClientDBusTransitional,
2338
client_settings = Client.config_parser(client_config)
2183
special_settings = {
2184
# Some settings need to be accessd by special methods;
2185
# booleans need .getboolean(), etc. Here is a list of them:
2186
"approved_by_default":
2188
client_config.getboolean(section, "approved_by_default"),
2191
client_config.getboolean(section, "enabled"),
2193
# Construct a new dict of client settings of this form:
2194
# { client_name: {setting_name: value, ...}, ...}
2195
# with exceptions for any special settings as defined above
2196
client_settings = dict((clientname,
2199
if setting not in special_settings
2200
else special_settings[setting]
2202
for setting, value in
2203
client_config.items(clientname)))
2204
for clientname in client_config.sections())
2339
2206
old_client_settings = {}
2342
2209
# Get client data and settings from last running state.
2343
2210
if server_settings["restore"]:
2377
2243
# Clients who has passed its expire date can still be
2378
# enabled if its last checker was successful. Clients
2379
# whose checker succeeded before we stored its state is
2380
# assumed to have successfully run all checkers during
2244
# enabled if its last checker was sucessful. Clients
2245
# whose checker failed before we stored its state is
2246
# assumed to have failed all checkers during downtime.
2382
2247
if client["enabled"]:
2383
if datetime.datetime.utcnow() >= client["expires"]:
2384
if not client["last_checked_ok"]:
2386
"disabling client {0} - Client never "
2387
"performed a successful checker"
2388
.format(client_name))
2389
client["enabled"] = False
2390
elif client["last_checker_status"] != 0:
2392
"disabling client {0} - Client "
2393
"last checker failed with error code {1}"
2394
.format(client_name,
2395
client["last_checker_status"]))
2248
if client["expires"] <= (datetime.datetime
2250
# Client has expired
2251
if client["last_checker_status"] != 0:
2396
2252
client["enabled"] = False
2398
2254
client["expires"] = (datetime.datetime
2400
2256
+ client["timeout"])
2401
logger.debug("Last checker succeeded,"
2402
" keeping {0} enabled"
2403
.format(client_name))
2258
client["changedstate"] = (multiprocessing_manager
2260
(multiprocessing_manager
2263
new_client = (ClientDBusTransitional.__new__
2264
(ClientDBusTransitional))
2265
tcp_server.clients[client_name] = new_client
2266
new_client.bus = bus
2267
for name, value in client.iteritems():
2268
setattr(new_client, name, value)
2269
client_object_name = unicode(client_name).translate(
2270
{ord("."): ord("_"),
2271
ord("-"): ord("_")})
2272
new_client.dbus_object_path = (dbus.ObjectPath
2274
+ client_object_name))
2275
DBusObjectWithProperties.__init__(new_client,
2280
tcp_server.clients[client_name] = (Client.__new__
2282
for name, value in client.iteritems():
2283
setattr(tcp_server.clients[client_name],
2405
client["secret"] = (
2406
pgp.decrypt(client["encrypted_secret"],
2287
tcp_server.clients[client_name].secret = (
2288
pgp.decrypt(tcp_server.clients[client_name]
2407
2290
client_settings[client_name]
2409
2292
except PGPError:
2410
2293
# If decryption fails, we use secret from new settings
2411
2294
logger.debug("Failed to decrypt {0} old secret"
2412
2295
.format(client_name))
2413
client["secret"] = (
2296
tcp_server.clients[client_name].secret = (
2414
2297
client_settings[client_name]["secret"])
2417
# Add/remove clients based on new changes made to config
2418
for client_name in (set(old_client_settings)
2419
- set(client_settings)):
2420
del clients_data[client_name]
2421
for client_name in (set(client_settings)
2422
- set(old_client_settings)):
2423
clients_data[client_name] = client_settings[client_name]
2425
# Create all client objects
2426
for client_name, client in clients_data.iteritems():
2427
tcp_server.clients[client_name] = client_class(
2428
name = client_name, settings = client)
2299
# Create/remove clients based on new changes made to config
2300
for clientname in set(old_client_settings) - set(client_settings):
2301
del tcp_server.clients[clientname]
2302
for clientname in set(client_settings) - set(old_client_settings):
2303
tcp_server.clients[clientname] = (client_class(name
2430
2309
if not tcp_server.clients:
2431
2310
logger.warning("No clients defined")
2443
2322
# "pidfile" was never created
2445
2324
del pidfilename
2446
2326
signal.signal(signal.SIGINT, signal.SIG_IGN)
2448
2328
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2449
2329
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2452
class MandosDBusService(DBusObjectWithProperties):
2332
class MandosDBusService(dbus.service.Object):
2453
2333
"""A D-Bus proxy object"""
2454
2334
def __init__(self):
2455
2335
dbus.service.Object.__init__(self, bus, "/")
2456
2336
_interface = "se.recompile.Mandos"
2458
@dbus_interface_annotations(_interface)
2460
return { "org.freedesktop.DBus.Property"
2461
".EmitsChangedSignal":
2464
2338
@dbus.service.signal(_interface, signature="o")
2465
2339
def ClientAdded(self, objpath):
2545
2418
if attr not in exclude:
2546
2419
client_dict[attr] = getattr(client, attr)
2548
clients[client.name] = client_dict
2421
clients.append(client_dict)
2549
2422
del client_settings[client.name]["secret"]
2552
tempfd, tempname = tempfile.mkstemp(suffix=".pickle",
2555
(stored_state_path))
2556
with os.fdopen(tempfd, "wb") as stored_state:
2425
with os.fdopen(os.open(stored_state_path,
2426
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2427
0600), "wb") as stored_state:
2557
2428
pickle.dump((clients, client_settings), stored_state)
2558
os.rename(tempname, stored_state_path)
2559
2429
except (IOError, OSError) as e:
2560
2430
logger.warning("Could not save persistent state: {0}"
2567
if e.errno not in set((errno.ENOENT, errno.EACCES,
2432
if e.errno not in (errno.ENOENT, errno.EACCES):
2571
2435
# Delete all clients, and settings from config
2572
2436
while tcp_server.clients: