352
193
dbus.UInt16(self.port),
353
194
avahi.string_array_to_txt_array(self.TXT))
354
195
self.group.Commit()
356
196
def entry_group_state_changed(self, state, error):
357
197
"""Derived from the Avahi example code"""
358
logger.debug("Avahi entry group state change: %i", state)
198
logger.debug(u"Avahi state change: %i", state)
360
200
if state == avahi.ENTRY_GROUP_ESTABLISHED:
361
logger.debug("Zeroconf service established.")
201
logger.debug(u"Zeroconf service established.")
362
202
elif state == avahi.ENTRY_GROUP_COLLISION:
363
logger.info("Zeroconf service name collision.")
203
logger.warning(u"Zeroconf service name collision.")
365
205
elif state == avahi.ENTRY_GROUP_FAILURE:
366
logger.critical("Avahi: Error in group state changed %s",
368
raise AvahiGroupError("State changed: {!s}".format(error))
206
logger.critical(u"Avahi: Error in group state changed %s",
208
raise AvahiGroupError(u"State changed: %s"
370
210
def cleanup(self):
371
211
"""Derived from the Avahi example code"""
372
212
if self.group is not None:
375
except (dbus.exceptions.UnknownMethodException,
376
dbus.exceptions.DBusException):
378
214
self.group = None
381
def server_state_changed(self, state, error=None):
215
def server_state_changed(self, state):
382
216
"""Derived from the Avahi example code"""
383
logger.debug("Avahi server state change: %i", state)
385
avahi.SERVER_INVALID: "Zeroconf server invalid",
386
avahi.SERVER_REGISTERING: None,
387
avahi.SERVER_COLLISION: "Zeroconf server name collision",
388
avahi.SERVER_FAILURE: "Zeroconf server failure",
390
if state in bad_states:
391
if bad_states[state] is not None:
393
logger.error(bad_states[state])
395
logger.error(bad_states[state] + ": %r", error)
217
if state == avahi.SERVER_COLLISION:
218
logger.error(u"Zeroconf server name collision")
397
220
elif state == avahi.SERVER_RUNNING:
400
except dbus.exceptions.DBusException as error:
401
if (error.get_dbus_name()
402
== "org.freedesktop.Avahi.CollisionError"):
403
logger.info("Local Zeroconf service name"
405
return self.rename(remove=False)
407
logger.critical("D-Bus Exception", exc_info=error)
412
logger.debug("Unknown state: %r", state)
414
logger.debug("Unknown state: %r: %r", state, error)
416
222
def activate(self):
417
223
"""Derived from the Avahi example code"""
418
224
if self.server is None:
419
225
self.server = dbus.Interface(
420
226
self.bus.get_object(avahi.DBUS_NAME,
421
avahi.DBUS_PATH_SERVER,
422
follow_name_owner_changes=True),
227
avahi.DBUS_PATH_SERVER),
423
228
avahi.DBUS_INTERFACE_SERVER)
424
self.server.connect_to_signal("StateChanged",
425
self.server_state_changed)
229
self.server.connect_to_signal(u"StateChanged",
230
self.server_state_changed)
426
231
self.server_state_changed(self.server.GetState())
429
class AvahiServiceToSyslog(AvahiService):
430
def rename(self, *args, **kwargs):
431
"""Add the new name to the syslog messages"""
432
ret = AvahiService.rename(self, *args, **kwargs)
433
syslogger.setFormatter(logging.Formatter(
434
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
438
def call_pipe(connection, # : multiprocessing.Connection
439
func, *args, **kwargs):
440
"""This function is meant to be called by multiprocessing.Process
442
This function runs func(*args, **kwargs), and writes the resulting
443
return value on the provided multiprocessing.Connection.
445
connection.send(func(*args, **kwargs))
448
234
class Client(object):
449
235
"""A representation of a client host served by this server.
452
approved: bool(); 'None' if not yet approved/disapproved
453
approval_delay: datetime.timedelta(); Time to wait for approval
454
approval_duration: datetime.timedelta(); Duration of one approval
238
name: string; from the config file, used in log messages and
240
fingerprint: string (40 or 32 hexadecimal digits); used to
241
uniquely identify the client
242
secret: bytestring; sent verbatim (over TLS) to client
243
host: string; available for use by the checker command
244
created: datetime.datetime(); (UTC) object creation
245
last_enabled: datetime.datetime(); (UTC)
247
last_checked_ok: datetime.datetime(); (UTC) or None
248
timeout: datetime.timedelta(); How long from last_checked_ok
249
until this client is disabled
250
interval: datetime.timedelta(); How often to start a new checker
251
disable_hook: If set, called by disable() as disable_hook(self)
455
252
checker: subprocess.Popen(); a running checker process used
456
253
to see if the client lives.
457
254
'None' if no process is running.
458
checker_callback_tag: a gobject event source tag, or None
459
checker_command: string; External command which is run to check
460
if client lives. %() expansions are done at
255
checker_initiator_tag: a gobject event source tag, or None
256
disable_initiator_tag: - '' -
257
checker_callback_tag: - '' -
258
checker_command: string; External command which is run to check if
259
client lives. %() expansions are done at
461
260
runtime with vars(self) as dict, so that for
462
261
instance %(name)s can be used in the command.
463
checker_initiator_tag: a gobject event source tag, or None
464
created: datetime.datetime(); (UTC) object creation
465
client_structure: Object describing what attributes a client has
466
and is used for storing the client at exit
467
262
current_checker_command: string; current running checker_command
468
disable_initiator_tag: a gobject event source tag, or None
470
fingerprint: string (40 or 32 hexadecimal digits); used to
471
uniquely identify the client
472
host: string; available for use by the checker command
473
interval: datetime.timedelta(); How often to start a new checker
474
last_approval_request: datetime.datetime(); (UTC) or None
475
last_checked_ok: datetime.datetime(); (UTC) or None
476
last_checker_status: integer between 0 and 255 reflecting exit
477
status of last checker. -1 reflects crashed
478
checker, -2 means no checker completed yet.
479
last_checker_signal: The signal which killed the last checker, if
480
last_checker_status is -1
481
last_enabled: datetime.datetime(); (UTC) or None
482
name: string; from the config file, used in log messages and
484
secret: bytestring; sent verbatim (over TLS) to client
485
timeout: datetime.timedelta(); How long from last_checked_ok
486
until this client is disabled
487
extended_timeout: extra long timeout when secret has been sent
488
runtime_expansions: Allowed attributes for runtime expansion.
489
expires: datetime.datetime(); time (UTC) when a client will be
491
server_settings: The server_settings dict from main()
263
approved_delay: datetime.timedelta(); Time to wait for approval
264
_approved: bool(); 'None' if not yet approved/disapproved
265
approved_duration: datetime.timedelta(); Duration of one approval
494
runtime_expansions = ("approval_delay", "approval_duration",
495
"created", "enabled", "expires",
496
"fingerprint", "host", "interval",
497
"last_approval_request", "last_checked_ok",
498
"last_enabled", "name", "timeout")
501
"extended_timeout": "PT15M",
503
"checker": "fping -q -- %%(host)s",
505
"approval_delay": "PT0S",
506
"approval_duration": "PT1S",
507
"approved_by_default": "True",
512
def config_parser(config):
513
"""Construct a new dict of client settings of this form:
514
{ client_name: {setting_name: value, ...}, ...}
515
with exceptions for any special settings as defined above.
516
NOTE: Must be a pure function. Must return the same result
517
value given the same arguments.
520
for client_name in config.sections():
521
section = dict(config.items(client_name))
522
client = settings[client_name] = {}
524
client["host"] = section["host"]
525
# Reformat values from string types to Python types
526
client["approved_by_default"] = config.getboolean(
527
client_name, "approved_by_default")
528
client["enabled"] = config.getboolean(client_name,
531
# Uppercase and remove spaces from fingerprint for later
532
# comparison purposes with return value from the
533
# fingerprint() function
534
client["fingerprint"] = (section["fingerprint"].upper()
536
if "secret" in section:
537
client["secret"] = section["secret"].decode("base64")
538
elif "secfile" in section:
539
with open(os.path.expanduser(os.path.expandvars
540
(section["secfile"])),
542
client["secret"] = secfile.read()
544
raise TypeError("No secret or secfile for section {}"
546
client["timeout"] = string_to_delta(section["timeout"])
547
client["extended_timeout"] = string_to_delta(
548
section["extended_timeout"])
549
client["interval"] = string_to_delta(section["interval"])
550
client["approval_delay"] = string_to_delta(
551
section["approval_delay"])
552
client["approval_duration"] = string_to_delta(
553
section["approval_duration"])
554
client["checker_command"] = section["checker"]
555
client["last_approval_request"] = None
556
client["last_checked_ok"] = None
557
client["last_checker_status"] = -2
561
def __init__(self, settings, name = None, server_settings=None):
269
def _timedelta_to_milliseconds(td):
270
"Convert a datetime.timedelta() to milliseconds"
271
return ((td.days * 24 * 60 * 60 * 1000)
272
+ (td.seconds * 1000)
273
+ (td.microseconds // 1000))
275
def timeout_milliseconds(self):
276
"Return the 'timeout' attribute in milliseconds"
277
return self._timedelta_to_milliseconds(self.timeout)
279
def interval_milliseconds(self):
280
"Return the 'interval' attribute in milliseconds"
281
return self._timedelta_to_milliseconds(self.interval)
283
def approved_delay_milliseconds(self):
284
return self._timedelta_to_milliseconds(self.approved_delay)
286
def __init__(self, name = None, disable_hook=None, config=None):
287
"""Note: the 'checker' key in 'config' sets the
288
'checker_command' attribute and *not* the 'checker'
563
if server_settings is None:
565
self.server_settings = server_settings
566
# adding all client settings
567
for setting, value in settings.items():
568
setattr(self, setting, value)
571
if not hasattr(self, "last_enabled"):
572
self.last_enabled = datetime.datetime.utcnow()
573
if not hasattr(self, "expires"):
574
self.expires = (datetime.datetime.utcnow()
293
logger.debug(u"Creating client %r", self.name)
294
# Uppercase and remove spaces from fingerprint for later
295
# comparison purposes with return value from the fingerprint()
297
self.fingerprint = (config[u"fingerprint"].upper()
299
logger.debug(u" Fingerprint: %s", self.fingerprint)
300
if u"secret" in config:
301
self.secret = config[u"secret"].decode(u"base64")
302
elif u"secfile" in config:
303
with open(os.path.expanduser(os.path.expandvars
304
(config[u"secfile"])),
306
self.secret = secfile.read()
577
self.last_enabled = None
580
logger.debug("Creating client %r", self.name)
581
logger.debug(" Fingerprint: %s", self.fingerprint)
582
self.created = settings.get("created",
583
datetime.datetime.utcnow())
585
# attributes specific for this server instance
308
#XXX Need to allow secret on demand!
309
raise TypeError(u"No secret or secfile for client %s"
311
self.host = config.get(u"host", u"")
312
self.created = datetime.datetime.utcnow()
314
self.last_enabled = None
315
self.last_checked_ok = None
316
self.timeout = string_to_delta(config[u"timeout"])
317
self.interval = string_to_delta(config[u"interval"])
318
self.disable_hook = disable_hook
586
319
self.checker = None
587
320
self.checker_initiator_tag = None
588
321
self.disable_initiator_tag = None
589
322
self.checker_callback_tag = None
323
self.checker_command = config[u"checker"]
590
324
self.current_checker_command = None
325
self.last_connect = None
592
326
self.approvals_pending = 0
593
self.changedstate = multiprocessing_manager.Condition(
594
multiprocessing_manager.Lock())
595
self.client_structure = [attr
596
for attr in self.__dict__.iterkeys()
597
if not attr.startswith("_")]
598
self.client_structure.append("client_structure")
600
for name, t in inspect.getmembers(
601
type(self), lambda obj: isinstance(obj, property)):
602
if not name.startswith("_"):
603
self.client_structure.append(name)
327
self._approved = None
328
self.approved_by_default = config.get(u"approved_by_default",
330
self.approved_delay = string_to_delta(
331
config[u"approved_delay"])
332
self.approved_duration = string_to_delta(
333
config[u"approved_duration"])
334
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
605
# Send notice to process children that client state has changed
606
336
def send_changedstate(self):
607
with self.changedstate:
608
self.changedstate.notify_all()
337
self.changedstate.acquire()
338
self.changedstate.notify_all()
339
self.changedstate.release()
610
341
def enable(self):
611
342
"""Start this client's checker and timeout hooks"""
612
if getattr(self, "enabled", False):
343
if getattr(self, u"enabled", False):
613
344
# Already enabled
615
self.expires = datetime.datetime.utcnow() + self.timeout
346
self.send_changedstate()
617
347
self.last_enabled = datetime.datetime.utcnow()
619
self.send_changedstate()
348
# Schedule a new checker to be started an 'interval' from now,
349
# and every interval from then on.
350
self.checker_initiator_tag = (gobject.timeout_add
351
(self.interval_milliseconds(),
353
# Schedule a disable() when 'timeout' has passed
354
self.disable_initiator_tag = (gobject.timeout_add
355
(self.timeout_milliseconds(),
358
# Also start a new checker *right now*.
621
361
def disable(self, quiet=True):
622
362
"""Disable this client."""
623
363
if not getattr(self, "enabled", False):
626
logger.info("Disabling client %s", self.name)
627
if getattr(self, "disable_initiator_tag", None) is not None:
366
self.send_changedstate()
368
logger.info(u"Disabling client %s", self.name)
369
if getattr(self, u"disable_initiator_tag", False):
628
370
gobject.source_remove(self.disable_initiator_tag)
629
371
self.disable_initiator_tag = None
631
if getattr(self, "checker_initiator_tag", None) is not None:
372
if getattr(self, u"checker_initiator_tag", False):
632
373
gobject.source_remove(self.checker_initiator_tag)
633
374
self.checker_initiator_tag = None
634
375
self.stop_checker()
376
if self.disable_hook:
377
self.disable_hook(self)
635
378
self.enabled = False
637
self.send_changedstate()
638
379
# Do not run this again if called by a gobject.timeout_add
641
382
def __del__(self):
383
self.disable_hook = None
644
def init_checker(self):
645
# Schedule a new checker to be started an 'interval' from now,
646
# and every interval from then on.
647
if self.checker_initiator_tag is not None:
648
gobject.source_remove(self.checker_initiator_tag)
649
self.checker_initiator_tag = gobject.timeout_add(
650
int(self.interval.total_seconds() * 1000),
652
# Schedule a disable() when 'timeout' has passed
653
if self.disable_initiator_tag is not None:
654
gobject.source_remove(self.disable_initiator_tag)
655
self.disable_initiator_tag = gobject.timeout_add(
656
int(self.timeout.total_seconds() * 1000), self.disable)
657
# Also start a new checker *right now*.
660
def checker_callback(self, source, condition, connection,
386
def checker_callback(self, pid, condition, command):
662
387
"""The checker has completed, so take appropriate actions."""
663
388
self.checker_callback_tag = None
664
389
self.checker = None
665
# Read return code from connection (see call_pipe)
666
returncode = connection.recv()
670
self.last_checker_status = returncode
671
self.last_checker_signal = None
672
if self.last_checker_status == 0:
673
logger.info("Checker for %(name)s succeeded",
390
if os.WIFEXITED(condition):
391
exitstatus = os.WEXITSTATUS(condition)
393
logger.info(u"Checker for %(name)s succeeded",
675
395
self.checked_ok()
677
logger.info("Checker for %(name)s failed", vars(self))
397
logger.info(u"Checker for %(name)s failed",
679
self.last_checker_status = -1
680
self.last_checker_signal = -returncode
681
logger.warning("Checker for %(name)s crashed?",
400
logger.warning(u"Checker for %(name)s crashed?",
685
403
def checked_ok(self):
686
"""Assert that the client has been seen, alive and well."""
404
"""Bump up the timeout for this client.
406
This should only be called when the client has been seen,
687
409
self.last_checked_ok = datetime.datetime.utcnow()
688
self.last_checker_status = 0
689
self.last_checker_signal = None
692
def bump_timeout(self, timeout=None):
693
"""Bump up the timeout for this client."""
695
timeout = self.timeout
696
if self.disable_initiator_tag is not None:
697
gobject.source_remove(self.disable_initiator_tag)
698
self.disable_initiator_tag = None
699
if getattr(self, "enabled", False):
700
self.disable_initiator_tag = gobject.timeout_add(
701
int(timeout.total_seconds() * 1000), self.disable)
702
self.expires = datetime.datetime.utcnow() + timeout
704
def need_approval(self):
705
self.last_approval_request = datetime.datetime.utcnow()
410
gobject.source_remove(self.disable_initiator_tag)
411
self.disable_initiator_tag = (gobject.timeout_add
412
(self.timeout_milliseconds(),
707
415
def start_checker(self):
708
416
"""Start a new checker subprocess if one is not running.
874
class DBusObjectWithAnnotations(dbus.service.Object):
875
"""A D-Bus object with annotations.
877
Classes inheriting from this can use the dbus_annotations
878
decorator to add annotations to methods or signals.
882
def _is_dbus_thing(thing):
883
"""Returns a function testing if an attribute is a D-Bus thing
885
If called like _is_dbus_thing("method") it returns a function
886
suitable for use as predicate to inspect.getmembers().
888
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
891
def _get_all_dbus_things(self, thing):
892
"""Returns a generator of (name, attribute) pairs
894
return ((getattr(athing.__get__(self), "_dbus_name", name),
895
athing.__get__(self))
896
for cls in self.__class__.__mro__
898
inspect.getmembers(cls, self._is_dbus_thing(thing)))
900
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
902
path_keyword = 'object_path',
903
connection_keyword = 'connection')
904
def Introspect(self, object_path, connection):
905
"""Overloading of standard D-Bus method.
907
Inserts annotation tags on methods and signals.
909
xmlstring = dbus.service.Object.Introspect(self, object_path,
912
document = xml.dom.minidom.parseString(xmlstring)
914
for if_tag in document.getElementsByTagName("interface"):
915
# Add annotation tags
916
for typ in ("method", "signal"):
917
for tag in if_tag.getElementsByTagName(typ):
919
for name, prop in (self.
920
_get_all_dbus_things(typ)):
921
if (name == tag.getAttribute("name")
922
and prop._dbus_interface
923
== if_tag.getAttribute("name")):
924
annots.update(getattr(
925
prop, "_dbus_annotations", {}))
926
for name, value in annots.items():
927
ann_tag = document.createElement(
929
ann_tag.setAttribute("name", name)
930
ann_tag.setAttribute("value", value)
931
tag.appendChild(ann_tag)
932
# Add interface annotation tags
933
for annotation, value in dict(
934
itertools.chain.from_iterable(
935
annotations().items()
936
for name, annotations
937
in self._get_all_dbus_things("interface")
938
if name == if_tag.getAttribute("name")
940
ann_tag = document.createElement("annotation")
941
ann_tag.setAttribute("name", annotation)
942
ann_tag.setAttribute("value", value)
943
if_tag.appendChild(ann_tag)
944
# Fix argument name for the Introspect method itself
945
if (if_tag.getAttribute("name")
946
== dbus.INTROSPECTABLE_IFACE):
947
for cn in if_tag.getElementsByTagName("method"):
948
if cn.getAttribute("name") == "Introspect":
949
for arg in cn.getElementsByTagName("arg"):
950
if (arg.getAttribute("direction")
952
arg.setAttribute("name",
954
xmlstring = document.toxml("utf-8")
956
except (AttributeError, xml.dom.DOMException,
957
xml.parsers.expat.ExpatError) as error:
958
logger.error("Failed to override Introspection method",
963
class DBusObjectWithProperties(DBusObjectWithAnnotations):
555
class DBusObjectWithProperties(dbus.service.Object):
964
556
"""A D-Bus object with properties.
966
558
Classes inheriting from this can use the dbus_service_property
967
559
decorator to expose methods as D-Bus properties. It exposes the
968
560
standard Get(), Set(), and GetAll() methods on the D-Bus.
564
def _is_dbus_property(obj):
565
return getattr(obj, u"_dbus_is_property", False)
567
def _get_all_dbus_properties(self):
568
"""Returns a generator of (name, attribute) pairs
570
return ((prop._dbus_name, prop)
572
inspect.getmembers(self, self._is_dbus_property))
971
574
def _get_dbus_property(self, interface_name, property_name):
972
575
"""Returns a bound method if one exists which is a D-Bus
973
576
property with the specified name and interface.
975
for cls in self.__class__.__mro__:
976
for name, value in inspect.getmembers(
977
cls, self._is_dbus_thing("property")):
978
if (value._dbus_name == property_name
979
and value._dbus_interface == interface_name):
980
return value.__get__(self)
578
for name in (property_name,
579
property_name + u"_dbus_property"):
580
prop = getattr(self, name, None)
582
or not self._is_dbus_property(prop)
583
or prop._dbus_name != property_name
584
or (interface_name and prop._dbus_interface
585
and interface_name != prop._dbus_interface)):
982
588
# No such property
983
raise DBusPropertyNotFound("{}:{}.{}".format(
984
self.dbus_object_path, interface_name, property_name))
987
def _get_all_interface_names(cls):
988
"""Get a sequence of all interfaces supported by an object"""
989
return (name for name in set(getattr(getattr(x, attr),
990
"_dbus_interface", None)
991
for x in (inspect.getmro(cls))
995
@dbus.service.method(dbus.PROPERTIES_IFACE,
589
raise DBusPropertyNotFound(self.dbus_object_path + u":"
590
+ interface_name + u"."
593
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
998
595
def Get(self, interface_name, property_name):
999
596
"""Standard D-Bus property Get() method, see D-Bus standard.
1001
598
prop = self._get_dbus_property(interface_name, property_name)
1002
if prop._dbus_access == "write":
599
if prop._dbus_access == u"write":
1003
600
raise DBusPropertyAccessException(property_name)
1005
if not hasattr(value, "variant_level"):
602
if not hasattr(value, u"variant_level"):
1007
604
return type(value)(value, variant_level=value.variant_level+1)
1009
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
606
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1010
607
def Set(self, interface_name, property_name, value):
1011
608
"""Standard D-Bus property Set() method, see D-Bus standard.
1013
610
prop = self._get_dbus_property(interface_name, property_name)
1014
if prop._dbus_access == "read":
611
if prop._dbus_access == u"read":
1015
612
raise DBusPropertyAccessException(property_name)
1016
if prop._dbus_get_args_options["byte_arrays"]:
613
if prop._dbus_get_args_options[u"byte_arrays"]:
1017
614
# The byte_arrays option is not supported yet on
1018
615
# signatures other than "ay".
1019
if prop._dbus_signature != "ay":
1020
raise ValueError("Byte arrays not supported for non-"
1021
"'ay' signature {!r}"
1022
.format(prop._dbus_signature))
1023
value = dbus.ByteArray(b''.join(chr(byte)
616
if prop._dbus_signature != u"ay":
618
value = dbus.ByteArray(''.join(unichr(byte)
1027
@dbus.service.method(dbus.PROPERTIES_IFACE,
1029
out_signature="a{sv}")
622
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
623
out_signature=u"a{sv}")
1030
624
def GetAll(self, interface_name):
1031
625
"""Standard D-Bus property GetAll() method, see D-Bus
1034
628
Note: Will not include properties with access="write".
1037
for name, prop in self._get_all_dbus_things("property"):
631
for name, prop in self._get_all_dbus_properties():
1038
632
if (interface_name
1039
633
and interface_name != prop._dbus_interface):
1040
634
# Interface non-empty but did not match
1042
636
# Ignore write-only properties
1043
if prop._dbus_access == "write":
637
if prop._dbus_access == u"write":
1046
if not hasattr(value, "variant_level"):
1047
properties[name] = value
640
if not hasattr(value, u"variant_level"):
1049
properties[name] = type(value)(
1050
value, variant_level = value.variant_level + 1)
1051
return dbus.Dictionary(properties, signature="sv")
1053
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1054
def PropertiesChanged(self, interface_name, changed_properties,
1055
invalidated_properties):
1056
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
643
all[name] = type(value)(value, variant_level=
644
value.variant_level+1)
645
return dbus.Dictionary(all, signature=u"sv")
1061
647
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1063
649
path_keyword='object_path',
1064
650
connection_keyword='connection')
1065
651
def Introspect(self, object_path, connection):
1066
"""Overloading of standard D-Bus method.
1068
Inserts property tags and interface annotation tags.
652
"""Standard D-Bus method, overloaded to insert property tags.
1070
xmlstring = DBusObjectWithAnnotations.Introspect(self,
654
xmlstring = dbus.service.Object.Introspect(self, object_path,
1074
657
document = xml.dom.minidom.parseString(xmlstring)
1076
658
def make_tag(document, name, prop):
1077
e = document.createElement("property")
1078
e.setAttribute("name", name)
1079
e.setAttribute("type", prop._dbus_signature)
1080
e.setAttribute("access", prop._dbus_access)
659
e = document.createElement(u"property")
660
e.setAttribute(u"name", name)
661
e.setAttribute(u"type", prop._dbus_signature)
662
e.setAttribute(u"access", prop._dbus_access)
1083
for if_tag in document.getElementsByTagName("interface"):
664
for if_tag in document.getElementsByTagName(u"interface"):
1085
665
for tag in (make_tag(document, name, prop)
1087
in self._get_all_dbus_things("property")
667
in self._get_all_dbus_properties()
1088
668
if prop._dbus_interface
1089
== if_tag.getAttribute("name")):
669
== if_tag.getAttribute(u"name")):
1090
670
if_tag.appendChild(tag)
1091
# Add annotation tags for properties
1092
for tag in if_tag.getElementsByTagName("property"):
1094
for name, prop in self._get_all_dbus_things(
1096
if (name == tag.getAttribute("name")
1097
and prop._dbus_interface
1098
== if_tag.getAttribute("name")):
1099
annots.update(getattr(
1100
prop, "_dbus_annotations", {}))
1101
for name, value in annots.items():
1102
ann_tag = document.createElement(
1104
ann_tag.setAttribute("name", name)
1105
ann_tag.setAttribute("value", value)
1106
tag.appendChild(ann_tag)
1107
671
# Add the names to the return values for the
1108
672
# "org.freedesktop.DBus.Properties" methods
1109
if (if_tag.getAttribute("name")
1110
== "org.freedesktop.DBus.Properties"):
1111
for cn in if_tag.getElementsByTagName("method"):
1112
if cn.getAttribute("name") == "Get":
1113
for arg in cn.getElementsByTagName("arg"):
1114
if (arg.getAttribute("direction")
1116
arg.setAttribute("name", "value")
1117
elif cn.getAttribute("name") == "GetAll":
1118
for arg in cn.getElementsByTagName("arg"):
1119
if (arg.getAttribute("direction")
1121
arg.setAttribute("name", "props")
1122
xmlstring = document.toxml("utf-8")
1124
except (AttributeError, xml.dom.DOMException,
1125
xml.parsers.expat.ExpatError) as error:
1126
logger.error("Failed to override Introspection method",
1131
dbus.OBJECT_MANAGER_IFACE
1132
except AttributeError:
1133
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1135
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1136
"""A D-Bus object with an ObjectManager.
1138
Classes inheriting from this exposes the standard
1139
GetManagedObjects call and the InterfacesAdded and
1140
InterfacesRemoved signals on the standard
1141
"org.freedesktop.DBus.ObjectManager" interface.
1143
Note: No signals are sent automatically; they must be sent
1146
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1147
out_signature = "a{oa{sa{sv}}}")
1148
def GetManagedObjects(self):
1149
"""This function must be overridden"""
1150
raise NotImplementedError()
1152
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1153
signature = "oa{sa{sv}}")
1154
def InterfacesAdded(self, object_path, interfaces_and_properties):
1157
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1159
def InterfacesRemoved(self, object_path, interfaces):
1162
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1163
out_signature = "s",
1164
path_keyword = 'object_path',
1165
connection_keyword = 'connection')
1166
def Introspect(self, object_path, connection):
1167
"""Overloading of standard D-Bus method.
1169
Override return argument name of GetManagedObjects to be
1170
"objpath_interfaces_and_properties"
1172
xmlstring = DBusObjectWithAnnotations(self, object_path,
1175
document = xml.dom.minidom.parseString(xmlstring)
1177
for if_tag in document.getElementsByTagName("interface"):
1178
# Fix argument name for the GetManagedObjects method
1179
if (if_tag.getAttribute("name")
1180
== dbus.OBJECT_MANAGER_IFACE):
1181
for cn in if_tag.getElementsByTagName("method"):
1182
if (cn.getAttribute("name")
1183
== "GetManagedObjects"):
1184
for arg in cn.getElementsByTagName("arg"):
1185
if (arg.getAttribute("direction")
1189
"objpath_interfaces"
1191
xmlstring = document.toxml("utf-8")
1193
except (AttributeError, xml.dom.DOMException,
1194
xml.parsers.expat.ExpatError) as error:
1195
logger.error("Failed to override Introspection method",
1199
def datetime_to_dbus(dt, variant_level=0):
1200
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1202
return dbus.String("", variant_level = variant_level)
1203
return dbus.String(dt.isoformat(), variant_level=variant_level)
1206
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1207
"""A class decorator; applied to a subclass of
1208
dbus.service.Object, it will add alternate D-Bus attributes with
1209
interface names according to the "alt_interface_names" mapping.
1212
@alternate_dbus_interfaces({"org.example.Interface":
1213
"net.example.AlternateInterface"})
1214
class SampleDBusObject(dbus.service.Object):
1215
@dbus.service.method("org.example.Interface")
1216
def SampleDBusMethod():
1219
The above "SampleDBusMethod" on "SampleDBusObject" will be
1220
reachable via two interfaces: "org.example.Interface" and
1221
"net.example.AlternateInterface", the latter of which will have
1222
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1223
"true", unless "deprecate" is passed with a False value.
1225
This works for methods and signals, and also for D-Bus properties
1226
(from DBusObjectWithProperties) and interfaces (from the
1227
dbus_interface_annotations decorator).
1231
for orig_interface_name, alt_interface_name in (
1232
alt_interface_names.items()):
1234
interface_names = set()
1235
# Go though all attributes of the class
1236
for attrname, attribute in inspect.getmembers(cls):
1237
# Ignore non-D-Bus attributes, and D-Bus attributes
1238
# with the wrong interface name
1239
if (not hasattr(attribute, "_dbus_interface")
1240
or not attribute._dbus_interface.startswith(
1241
orig_interface_name)):
1243
# Create an alternate D-Bus interface name based on
1245
alt_interface = attribute._dbus_interface.replace(
1246
orig_interface_name, alt_interface_name)
1247
interface_names.add(alt_interface)
1248
# Is this a D-Bus signal?
1249
if getattr(attribute, "_dbus_is_signal", False):
1250
if sys.version_info.major == 2:
1251
# Extract the original non-method undecorated
1252
# function by black magic
1253
nonmethod_func = (dict(
1254
zip(attribute.func_code.co_freevars,
1255
attribute.__closure__))
1256
["func"].cell_contents)
1258
nonmethod_func = attribute
1259
# Create a new, but exactly alike, function
1260
# object, and decorate it to be a new D-Bus signal
1261
# with the alternate D-Bus interface name
1262
if sys.version_info.major == 2:
1263
new_function = types.FunctionType(
1264
nonmethod_func.func_code,
1265
nonmethod_func.func_globals,
1266
nonmethod_func.func_name,
1267
nonmethod_func.func_defaults,
1268
nonmethod_func.func_closure)
1270
new_function = types.FunctionType(
1271
nonmethod_func.__code__,
1272
nonmethod_func.__globals__,
1273
nonmethod_func.__name__,
1274
nonmethod_func.__defaults__,
1275
nonmethod_func.__closure__)
1276
new_function = (dbus.service.signal(
1278
attribute._dbus_signature)(new_function))
1279
# Copy annotations, if any
1281
new_function._dbus_annotations = dict(
1282
attribute._dbus_annotations)
1283
except AttributeError:
1285
# Define a creator of a function to call both the
1286
# original and alternate functions, so both the
1287
# original and alternate signals gets sent when
1288
# the function is called
1289
def fixscope(func1, func2):
1290
"""This function is a scope container to pass
1291
func1 and func2 to the "call_both" function
1292
outside of its arguments"""
1294
def call_both(*args, **kwargs):
1295
"""This function will emit two D-Bus
1296
signals by calling func1 and func2"""
1297
func1(*args, **kwargs)
1298
func2(*args, **kwargs)
1301
# Create the "call_both" function and add it to
1303
attr[attrname] = fixscope(attribute, new_function)
1304
# Is this a D-Bus method?
1305
elif getattr(attribute, "_dbus_is_method", False):
1306
# Create a new, but exactly alike, function
1307
# object. Decorate it to be a new D-Bus method
1308
# with the alternate D-Bus interface name. Add it
1311
dbus.service.method(
1313
attribute._dbus_in_signature,
1314
attribute._dbus_out_signature)
1315
(types.FunctionType(attribute.func_code,
1316
attribute.func_globals,
1317
attribute.func_name,
1318
attribute.func_defaults,
1319
attribute.func_closure)))
1320
# Copy annotations, if any
1322
attr[attrname]._dbus_annotations = dict(
1323
attribute._dbus_annotations)
1324
except AttributeError:
1326
# Is this a D-Bus property?
1327
elif getattr(attribute, "_dbus_is_property", False):
1328
# Create a new, but exactly alike, function
1329
# object, and decorate it to be a new D-Bus
1330
# property with the alternate D-Bus interface
1331
# name. Add it to the class.
1332
attr[attrname] = (dbus_service_property(
1333
alt_interface, attribute._dbus_signature,
1334
attribute._dbus_access,
1335
attribute._dbus_get_args_options
1337
(types.FunctionType(
1338
attribute.func_code,
1339
attribute.func_globals,
1340
attribute.func_name,
1341
attribute.func_defaults,
1342
attribute.func_closure)))
1343
# Copy annotations, if any
1345
attr[attrname]._dbus_annotations = dict(
1346
attribute._dbus_annotations)
1347
except AttributeError:
1349
# Is this a D-Bus interface?
1350
elif getattr(attribute, "_dbus_is_interface", False):
1351
# Create a new, but exactly alike, function
1352
# object. Decorate it to be a new D-Bus interface
1353
# with the alternate D-Bus interface name. Add it
1356
dbus_interface_annotations(alt_interface)
1357
(types.FunctionType(attribute.func_code,
1358
attribute.func_globals,
1359
attribute.func_name,
1360
attribute.func_defaults,
1361
attribute.func_closure)))
1363
# Deprecate all alternate interfaces
1364
iname="_AlternateDBusNames_interface_annotation{}"
1365
for interface_name in interface_names:
1367
@dbus_interface_annotations(interface_name)
1369
return { "org.freedesktop.DBus.Deprecated":
1371
# Find an unused name
1372
for aname in (iname.format(i)
1373
for i in itertools.count()):
1374
if aname not in attr:
1378
# Replace the class with a new subclass of it with
1379
# methods, signals, etc. as created above.
1380
cls = type(b"{}Alternate".format(cls.__name__),
1387
@alternate_dbus_interfaces({"se.recompile.Mandos":
1388
"se.bsnet.fukt.Mandos"})
673
if (if_tag.getAttribute(u"name")
674
== u"org.freedesktop.DBus.Properties"):
675
for cn in if_tag.getElementsByTagName(u"method"):
676
if cn.getAttribute(u"name") == u"Get":
677
for arg in cn.getElementsByTagName(u"arg"):
678
if (arg.getAttribute(u"direction")
680
arg.setAttribute(u"name", u"value")
681
elif cn.getAttribute(u"name") == u"GetAll":
682
for arg in cn.getElementsByTagName(u"arg"):
683
if (arg.getAttribute(u"direction")
685
arg.setAttribute(u"name", u"props")
686
xmlstring = document.toxml(u"utf-8")
688
except (AttributeError, xml.dom.DOMException,
689
xml.parsers.expat.ExpatError), error:
690
logger.error(u"Failed to override Introspection method",
1389
695
class ClientDBus(Client, DBusObjectWithProperties):
1390
696
"""A Client class using D-Bus
1393
699
dbus_object_path: dbus.ObjectPath
1394
700
bus: dbus.SystemBus()
1397
runtime_expansions = (Client.runtime_expansions
1398
+ ("dbus_object_path", ))
1400
_interface = "se.recompile.Mandos.Client"
1402
702
# dbus.service.Object doesn't use super(), so we can't either.
1404
704
def __init__(self, bus = None, *args, **kwargs):
705
self._approvals_pending = 0
1406
707
Client.__init__(self, *args, **kwargs)
1407
708
# Only now, when this client is initialized, can it show up on
1409
client_object_name = str(self.name).translate(
1410
{ord("."): ord("_"),
1411
ord("-"): ord("_")})
1412
self.dbus_object_path = dbus.ObjectPath(
1413
"/clients/" + client_object_name)
710
self.dbus_object_path = (dbus.ObjectPath
712
+ self.name.replace(u".", u"_")))
1414
713
DBusObjectWithProperties.__init__(self, self.bus,
1415
714
self.dbus_object_path)
1417
def notifychangeproperty(transform_func, dbus_name,
1418
type_func=lambda x: x,
1420
invalidate_only=False,
1421
_interface=_interface):
1422
""" Modify a variable so that it's a property which announces
1423
its changes to DBus.
1425
transform_fun: Function that takes a value and a variant_level
1426
and transforms it to a D-Bus type.
1427
dbus_name: D-Bus name of the variable
1428
type_func: Function that transform the value before sending it
1429
to the D-Bus. Default: no transform
1430
variant_level: D-Bus variant level. Default: 1
1432
attrname = "_{}".format(dbus_name)
1434
def setter(self, value):
1435
if hasattr(self, "dbus_object_path"):
1436
if (not hasattr(self, attrname) or
1437
type_func(getattr(self, attrname, None))
1438
!= type_func(value)):
1440
self.PropertiesChanged(
1441
_interface, dbus.Dictionary(),
1442
dbus.Array((dbus_name, )))
1444
dbus_value = transform_func(
1446
variant_level = variant_level)
1447
self.PropertyChanged(dbus.String(dbus_name),
1449
self.PropertiesChanged(
1451
dbus.Dictionary({ dbus.String(dbus_name):
1454
setattr(self, attrname, value)
1456
return property(lambda self: getattr(self, attrname), setter)
1458
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1459
approvals_pending = notifychangeproperty(dbus.Boolean,
1462
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1463
last_enabled = notifychangeproperty(datetime_to_dbus,
1465
checker = notifychangeproperty(
1466
dbus.Boolean, "CheckerRunning",
1467
type_func = lambda checker: checker is not None)
1468
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1470
last_checker_status = notifychangeproperty(dbus.Int16,
1471
"LastCheckerStatus")
1472
last_approval_request = notifychangeproperty(
1473
datetime_to_dbus, "LastApprovalRequest")
1474
approved_by_default = notifychangeproperty(dbus.Boolean,
1475
"ApprovedByDefault")
1476
approval_delay = notifychangeproperty(
1477
dbus.UInt64, "ApprovalDelay",
1478
type_func = lambda td: td.total_seconds() * 1000)
1479
approval_duration = notifychangeproperty(
1480
dbus.UInt64, "ApprovalDuration",
1481
type_func = lambda td: td.total_seconds() * 1000)
1482
host = notifychangeproperty(dbus.String, "Host")
1483
timeout = notifychangeproperty(
1484
dbus.UInt64, "Timeout",
1485
type_func = lambda td: td.total_seconds() * 1000)
1486
extended_timeout = notifychangeproperty(
1487
dbus.UInt64, "ExtendedTimeout",
1488
type_func = lambda td: td.total_seconds() * 1000)
1489
interval = notifychangeproperty(
1490
dbus.UInt64, "Interval",
1491
type_func = lambda td: td.total_seconds() * 1000)
1492
checker_command = notifychangeproperty(dbus.String, "Checker")
1493
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1494
invalidate_only=True)
1496
del notifychangeproperty
716
def _get_approvals_pending(self, value):
717
return self._approvals_pending
718
def _set_approvals_pending(self, value):
719
old_value = self._approvals_pending
720
self._approvals_pending = value
722
if (hasattr(self, "dbus_object_path")
723
and bval is bool(old_value)):
724
dbus_bool = dbus.Boolean(bval, variant_level=1)
725
self.PropertyChanged(dbus.String(u"approved_pending"),
728
approvals_pending = property(_get_approvals_pending,
729
_set_approvals_pending)
730
del _get_approvals_pending, _set_approvals_pending
733
def _datetime_to_dbus(dt, variant_level=0):
734
"""Convert a UTC datetime.datetime() to a D-Bus type."""
735
return dbus.String(dt.isoformat(),
736
variant_level=variant_level)
739
oldstate = getattr(self, u"enabled", False)
740
r = Client.enable(self)
741
if oldstate != self.enabled:
743
self.PropertyChanged(dbus.String(u"enabled"),
744
dbus.Boolean(True, variant_level=1))
745
self.PropertyChanged(
746
dbus.String(u"last_enabled"),
747
self._datetime_to_dbus(self.last_enabled,
751
def disable(self, quiet = False):
752
oldstate = getattr(self, u"enabled", False)
753
r = Client.disable(self, quiet=quiet)
754
if not quiet and oldstate != self.enabled:
756
self.PropertyChanged(dbus.String(u"enabled"),
757
dbus.Boolean(False, variant_level=1))
1498
760
def __del__(self, *args, **kwargs):
1500
762
self.remove_from_connection()
1501
763
except LookupError:
1503
if hasattr(DBusObjectWithProperties, "__del__"):
765
if hasattr(DBusObjectWithProperties, u"__del__"):
1504
766
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1505
767
Client.__del__(self, *args, **kwargs)
1507
def checker_callback(self, source, condition,
1508
connection, command, *args, **kwargs):
1509
ret = Client.checker_callback(self, source, condition,
1510
connection, command, *args,
1512
exitstatus = self.last_checker_status
769
def checker_callback(self, pid, condition, command,
771
self.checker_callback_tag = None
774
self.PropertyChanged(dbus.String(u"checker_running"),
775
dbus.Boolean(False, variant_level=1))
776
if os.WIFEXITED(condition):
777
exitstatus = os.WEXITSTATUS(condition)
1514
778
# Emit D-Bus signal
1515
779
self.CheckerCompleted(dbus.Int16(exitstatus),
1516
# This is specific to GNU libC
1517
dbus.Int64(exitstatus << 8),
780
dbus.Int64(condition),
1518
781
dbus.String(command))
1520
783
# Emit D-Bus signal
1521
784
self.CheckerCompleted(dbus.Int16(-1),
1523
# This is specific to GNU libC
1525
| self.last_checker_signal),
785
dbus.Int64(condition),
1526
786
dbus.String(command))
788
return Client.checker_callback(self, pid, condition, command,
791
def checked_ok(self, *args, **kwargs):
792
r = Client.checked_ok(self, *args, **kwargs)
794
self.PropertyChanged(
795
dbus.String(u"last_checked_ok"),
796
(self._datetime_to_dbus(self.last_checked_ok,
1529
800
def start_checker(self, *args, **kwargs):
1530
old_checker_pid = getattr(self.checker, "pid", None)
801
old_checker = self.checker
802
if self.checker is not None:
803
old_checker_pid = self.checker.pid
805
old_checker_pid = None
1531
806
r = Client.start_checker(self, *args, **kwargs)
1532
807
# Only if new checker process was started
1533
808
if (self.checker is not None
1534
809
and old_checker_pid != self.checker.pid):
1535
810
# Emit D-Bus signal
1536
811
self.CheckerStarted(self.current_checker_command)
812
self.PropertyChanged(
813
dbus.String(u"checker_running"),
814
dbus.Boolean(True, variant_level=1))
817
def stop_checker(self, *args, **kwargs):
818
old_checker = getattr(self, u"checker", None)
819
r = Client.stop_checker(self, *args, **kwargs)
820
if (old_checker is not None
821
and getattr(self, u"checker", None) is None):
822
self.PropertyChanged(dbus.String(u"checker_running"),
823
dbus.Boolean(False, variant_level=1))
1539
826
def _reset_approved(self):
1540
self.approved = None
827
self._approved = None
1543
830
def approve(self, value=True):
1544
self.approved = value
1545
gobject.timeout_add(int(self.approval_duration.total_seconds()
1546
* 1000), self._reset_approved)
1547
self.send_changedstate()
831
self._approved = value
832
gobject.timeout_add(self._timedelta_to_milliseconds(self.approved_duration, self._reset_approved))
1549
835
## D-Bus methods, signals & properties
836
_interface = u"se.bsnet.fukt.Mandos.Client"
1555
840
# CheckerCompleted - signal
1556
@dbus.service.signal(_interface, signature="nxs")
841
@dbus.service.signal(_interface, signature=u"nxs")
1557
842
def CheckerCompleted(self, exitcode, waitstatus, command):
1561
846
# CheckerStarted - signal
1562
@dbus.service.signal(_interface, signature="s")
847
@dbus.service.signal(_interface, signature=u"s")
1563
848
def CheckerStarted(self, command):
1567
852
# PropertyChanged - signal
1568
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1569
@dbus.service.signal(_interface, signature="sv")
853
@dbus.service.signal(_interface, signature=u"sv")
1570
854
def PropertyChanged(self, property, value):
1574
858
# GotSecret - signal
1575
859
@dbus.service.signal(_interface)
1576
860
def GotSecret(self):
1578
Is sent after a successful transfer of secret from the Mandos
1579
server to mandos-client
1583
864
# Rejected - signal
1584
@dbus.service.signal(_interface, signature="s")
865
@dbus.service.signal(_interface, signature=u"s")
1585
866
def Rejected(self, reason):
1589
870
# NeedApproval - signal
1590
@dbus.service.signal(_interface, signature="tb")
871
@dbus.service.signal(_interface, signature=u"db")
1591
872
def NeedApproval(self, timeout, default):
1593
return self.need_approval()
1597
878
# Approve - method
1598
@dbus.service.method(_interface, in_signature="b")
879
@dbus.service.method(_interface, in_signature=u"b")
1599
880
def Approve(self, value):
1600
881
self.approve(value)
1602
883
# CheckedOK - method
1603
884
@dbus.service.method(_interface)
1604
885
def CheckedOK(self):
886
return self.checked_ok()
1607
888
# Enable - method
1608
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1609
889
@dbus.service.method(_interface)
1610
890
def Enable(self):
1614
894
# StartChecker - method
1615
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1616
895
@dbus.service.method(_interface)
1617
896
def StartChecker(self):
1619
898
self.start_checker()
1621
900
# Disable - method
1622
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1623
901
@dbus.service.method(_interface)
1624
902
def Disable(self):
1628
906
# StopChecker - method
1629
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1630
907
@dbus.service.method(_interface)
1631
908
def StopChecker(self):
1632
909
self.stop_checker()
1636
# ApprovalPending - property
1637
@dbus_service_property(_interface, signature="b", access="read")
1638
def ApprovalPending_dbus_property(self):
913
# approved_pending - property
914
@dbus_service_property(_interface, signature=u"b", access=u"read")
915
def approved_pending_dbus_property(self):
1639
916
return dbus.Boolean(bool(self.approvals_pending))
1641
# ApprovedByDefault - property
1642
@dbus_service_property(_interface,
1645
def ApprovedByDefault_dbus_property(self, value=None):
1646
if value is None: # get
1647
return dbus.Boolean(self.approved_by_default)
1648
self.approved_by_default = bool(value)
1650
# ApprovalDelay - property
1651
@dbus_service_property(_interface,
1654
def ApprovalDelay_dbus_property(self, value=None):
1655
if value is None: # get
1656
return dbus.UInt64(self.approval_delay.total_seconds()
1658
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1660
# ApprovalDuration - property
1661
@dbus_service_property(_interface,
1664
def ApprovalDuration_dbus_property(self, value=None):
1665
if value is None: # get
1666
return dbus.UInt64(self.approval_duration.total_seconds()
1668
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1672
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1673
@dbus_service_property(_interface, signature="s", access="read")
1674
def Name_dbus_property(self):
918
# approved_by_default - property
919
@dbus_service_property(_interface, signature=u"b",
921
def approved_by_default_dbus_property(self):
922
return dbus.Boolean(self.approved_by_default)
924
# approved_delay - property
925
@dbus_service_property(_interface, signature=u"t",
927
def approved_delay_dbus_property(self):
928
return dbus.UInt64(self.approved_delay_milliseconds())
930
# approved_duration - property
931
@dbus_service_property(_interface, signature=u"t",
933
def approved_duration_dbus_property(self):
934
return dbus.UInt64(self._timedelta_to_milliseconds(
935
self.approved_duration))
938
@dbus_service_property(_interface, signature=u"s", access=u"read")
939
def name_dbus_property(self):
1675
940
return dbus.String(self.name)
1677
# Fingerprint - property
1679
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1680
@dbus_service_property(_interface, signature="s", access="read")
1681
def Fingerprint_dbus_property(self):
942
# fingerprint - property
943
@dbus_service_property(_interface, signature=u"s", access=u"read")
944
def fingerprint_dbus_property(self):
1682
945
return dbus.String(self.fingerprint)
1685
@dbus_service_property(_interface,
1688
def Host_dbus_property(self, value=None):
948
@dbus_service_property(_interface, signature=u"s",
950
def host_dbus_property(self, value=None):
1689
951
if value is None: # get
1690
952
return dbus.String(self.host)
1691
self.host = str(value)
1693
# Created - property
1695
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1696
@dbus_service_property(_interface, signature="s", access="read")
1697
def Created_dbus_property(self):
1698
return datetime_to_dbus(self.created)
1700
# LastEnabled - property
1701
@dbus_service_property(_interface, signature="s", access="read")
1702
def LastEnabled_dbus_property(self):
1703
return datetime_to_dbus(self.last_enabled)
1705
# Enabled - property
1706
@dbus_service_property(_interface,
1709
def Enabled_dbus_property(self, value=None):
955
self.PropertyChanged(dbus.String(u"host"),
956
dbus.String(value, variant_level=1))
959
@dbus_service_property(_interface, signature=u"s", access=u"read")
960
def created_dbus_property(self):
961
return dbus.String(self._datetime_to_dbus(self.created))
963
# last_enabled - property
964
@dbus_service_property(_interface, signature=u"s", access=u"read")
965
def last_enabled_dbus_property(self):
966
if self.last_enabled is None:
967
return dbus.String(u"")
968
return dbus.String(self._datetime_to_dbus(self.last_enabled))
971
@dbus_service_property(_interface, signature=u"b",
973
def enabled_dbus_property(self, value=None):
1710
974
if value is None: # get
1711
975
return dbus.Boolean(self.enabled)
2326
def rfc3339_duration_to_delta(duration):
2327
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2329
>>> rfc3339_duration_to_delta("P7D")
2330
datetime.timedelta(7)
2331
>>> rfc3339_duration_to_delta("PT60S")
2332
datetime.timedelta(0, 60)
2333
>>> rfc3339_duration_to_delta("PT60M")
2334
datetime.timedelta(0, 3600)
2335
>>> rfc3339_duration_to_delta("PT24H")
2336
datetime.timedelta(1)
2337
>>> rfc3339_duration_to_delta("P1W")
2338
datetime.timedelta(7)
2339
>>> rfc3339_duration_to_delta("PT5M30S")
2340
datetime.timedelta(0, 330)
2341
>>> rfc3339_duration_to_delta("P1DT3M20S")
2342
datetime.timedelta(1, 200)
2345
# Parsing an RFC 3339 duration with regular expressions is not
2346
# possible - there would have to be multiple places for the same
2347
# values, like seconds. The current code, while more esoteric, is
2348
# cleaner without depending on a parsing library. If Python had a
2349
# built-in library for parsing we would use it, but we'd like to
2350
# avoid excessive use of external libraries.
2352
# New type for defining tokens, syntax, and semantics all-in-one
2353
Token = collections.namedtuple("Token", (
2354
"regexp", # To match token; if "value" is not None, must have
2355
# a "group" containing digits
2356
"value", # datetime.timedelta or None
2357
"followers")) # Tokens valid after this token
2358
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2359
# the "duration" ABNF definition in RFC 3339, Appendix A.
2360
token_end = Token(re.compile(r"$"), None, frozenset())
2361
token_second = Token(re.compile(r"(\d+)S"),
2362
datetime.timedelta(seconds=1),
2363
frozenset((token_end, )))
2364
token_minute = Token(re.compile(r"(\d+)M"),
2365
datetime.timedelta(minutes=1),
2366
frozenset((token_second, token_end)))
2367
token_hour = Token(re.compile(r"(\d+)H"),
2368
datetime.timedelta(hours=1),
2369
frozenset((token_minute, token_end)))
2370
token_time = Token(re.compile(r"T"),
2372
frozenset((token_hour, token_minute,
2374
token_day = Token(re.compile(r"(\d+)D"),
2375
datetime.timedelta(days=1),
2376
frozenset((token_time, token_end)))
2377
token_month = Token(re.compile(r"(\d+)M"),
2378
datetime.timedelta(weeks=4),
2379
frozenset((token_day, token_end)))
2380
token_year = Token(re.compile(r"(\d+)Y"),
2381
datetime.timedelta(weeks=52),
2382
frozenset((token_month, token_end)))
2383
token_week = Token(re.compile(r"(\d+)W"),
2384
datetime.timedelta(weeks=1),
2385
frozenset((token_end, )))
2386
token_duration = Token(re.compile(r"P"), None,
2387
frozenset((token_year, token_month,
2388
token_day, token_time,
2390
# Define starting values
2391
value = datetime.timedelta() # Value so far
2393
followers = frozenset((token_duration, )) # Following valid tokens
2394
s = duration # String left to parse
2395
# Loop until end token is found
2396
while found_token is not token_end:
2397
# Search for any currently valid tokens
2398
for token in followers:
2399
match = token.regexp.match(s)
2400
if match is not None:
2402
if token.value is not None:
2403
# Value found, parse digits
2404
factor = int(match.group(1), 10)
2405
# Add to value so far
2406
value += factor * token.value
2407
# Strip token from string
2408
s = token.regexp.sub("", s, 1)
2411
# Set valid next tokens
2412
followers = found_token.followers
2415
# No currently valid tokens were found
2416
raise ValueError("Invalid RFC 3339 duration: {!r}"
2422
1511
def string_to_delta(interval):
2423
1512
"""Parse a string and return a datetime.timedelta
2425
>>> string_to_delta('7d')
1514
>>> string_to_delta(u'7d')
2426
1515
datetime.timedelta(7)
2427
>>> string_to_delta('60s')
1516
>>> string_to_delta(u'60s')
2428
1517
datetime.timedelta(0, 60)
2429
>>> string_to_delta('60m')
1518
>>> string_to_delta(u'60m')
2430
1519
datetime.timedelta(0, 3600)
2431
>>> string_to_delta('24h')
1520
>>> string_to_delta(u'24h')
2432
1521
datetime.timedelta(1)
2433
>>> string_to_delta('1w')
1522
>>> string_to_delta(u'1w')
2434
1523
datetime.timedelta(7)
2435
>>> string_to_delta('5m 30s')
1524
>>> string_to_delta(u'5m 30s')
2436
1525
datetime.timedelta(0, 330)
2440
return rfc3339_duration_to_delta(interval)
2444
1527
timevalue = datetime.timedelta(0)
2445
1528
for s in interval.split():
1530
suffix = unicode(s[-1])
2448
1531
value = int(s[:-1])
2450
1533
delta = datetime.timedelta(value)
1534
elif suffix == u"s":
2452
1535
delta = datetime.timedelta(0, value)
1536
elif suffix == u"m":
2454
1537
delta = datetime.timedelta(0, 0, 0, 0, value)
1538
elif suffix == u"h":
2456
1539
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1540
elif suffix == u"w":
2458
1541
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2460
raise ValueError("Unknown suffix {!r}".format(suffix))
2461
except IndexError as e:
2462
raise ValueError(*(e.args))
1543
raise ValueError(u"Unknown suffix %r" % suffix)
1544
except (ValueError, IndexError), e:
1545
raise ValueError(e.message)
2463
1546
timevalue += delta
2464
1547
return timevalue
1550
def if_nametoindex(interface):
1551
"""Call the C function if_nametoindex(), or equivalent
1553
Note: This function cannot accept a unicode string."""
1554
global if_nametoindex
1556
if_nametoindex = (ctypes.cdll.LoadLibrary
1557
(ctypes.util.find_library(u"c"))
1559
except (OSError, AttributeError):
1560
logger.warning(u"Doing if_nametoindex the hard way")
1561
def if_nametoindex(interface):
1562
"Get an interface index the hard way, i.e. using fcntl()"
1563
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1564
with contextlib.closing(socket.socket()) as s:
1565
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1566
struct.pack(str(u"16s16x"),
1568
interface_index = struct.unpack(str(u"I"),
1570
return interface_index
1571
return if_nametoindex(interface)
2467
1574
def daemon(nochdir = False, noclose = False):
2468
1575
"""See daemon(3). Standard BSD Unix function.
2494
1601
##################################################################
2495
1602
# Parsing of options, both command line and config file
2497
parser = argparse.ArgumentParser()
2498
parser.add_argument("-v", "--version", action="version",
2499
version = "%(prog)s {}".format(version),
2500
help="show version number and exit")
2501
parser.add_argument("-i", "--interface", metavar="IF",
2502
help="Bind to interface IF")
2503
parser.add_argument("-a", "--address",
2504
help="Address to listen for requests on")
2505
parser.add_argument("-p", "--port", type=int,
2506
help="Port number to receive requests on")
2507
parser.add_argument("--check", action="store_true",
2508
help="Run self-test")
2509
parser.add_argument("--debug", action="store_true",
2510
help="Debug mode; run in foreground and log"
2511
" to terminal", default=None)
2512
parser.add_argument("--debuglevel", metavar="LEVEL",
2513
help="Debug level for stdout output")
2514
parser.add_argument("--priority", help="GnuTLS"
2515
" priority string (see GnuTLS documentation)")
2516
parser.add_argument("--servicename",
2517
metavar="NAME", help="Zeroconf service name")
2518
parser.add_argument("--configdir",
2519
default="/etc/mandos", metavar="DIR",
2520
help="Directory to search for configuration"
2522
parser.add_argument("--no-dbus", action="store_false",
2523
dest="use_dbus", help="Do not provide D-Bus"
2524
" system bus interface", default=None)
2525
parser.add_argument("--no-ipv6", action="store_false",
2526
dest="use_ipv6", help="Do not use IPv6",
2528
parser.add_argument("--no-restore", action="store_false",
2529
dest="restore", help="Do not restore stored"
2530
" state", default=None)
2531
parser.add_argument("--socket", type=int,
2532
help="Specify a file descriptor to a network"
2533
" socket to use instead of creating one")
2534
parser.add_argument("--statedir", metavar="DIR",
2535
help="Directory to save/restore state in")
2536
parser.add_argument("--foreground", action="store_true",
2537
help="Run in foreground", default=None)
2538
parser.add_argument("--no-zeroconf", action="store_false",
2539
dest="zeroconf", help="Do not use Zeroconf",
2542
options = parser.parse_args()
1604
parser = optparse.OptionParser(version = "%%prog %s" % version)
1605
parser.add_option("-i", u"--interface", type=u"string",
1606
metavar="IF", help=u"Bind to interface IF")
1607
parser.add_option("-a", u"--address", type=u"string",
1608
help=u"Address to listen for requests on")
1609
parser.add_option("-p", u"--port", type=u"int",
1610
help=u"Port number to receive requests on")
1611
parser.add_option("--check", action=u"store_true",
1612
help=u"Run self-test")
1613
parser.add_option("--debug", action=u"store_true",
1614
help=u"Debug mode; run in foreground and log to"
1616
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1617
u" priority string (see GnuTLS documentation)")
1618
parser.add_option("--servicename", type=u"string",
1619
metavar=u"NAME", help=u"Zeroconf service name")
1620
parser.add_option("--configdir", type=u"string",
1621
default=u"/etc/mandos", metavar=u"DIR",
1622
help=u"Directory to search for configuration"
1624
parser.add_option("--no-dbus", action=u"store_false",
1625
dest=u"use_dbus", help=u"Do not provide D-Bus"
1626
u" system bus interface")
1627
parser.add_option("--no-ipv6", action=u"store_false",
1628
dest=u"use_ipv6", help=u"Do not use IPv6")
1629
options = parser.parse_args()[0]
2544
1631
if options.check:
2546
fail_count, test_count = doctest.testmod()
2547
sys.exit(os.EX_OK if fail_count == 0 else 1)
2549
1636
# Default values for config file for server-global settings
2550
server_defaults = { "interface": "",
2555
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2556
":+SIGN-DSA-SHA256",
2557
"servicename": "Mandos",
2563
"statedir": "/var/lib/mandos",
2564
"foreground": "False",
1637
server_defaults = { u"interface": u"",
1642
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1643
u"servicename": u"Mandos",
1644
u"use_dbus": u"True",
1645
u"use_ipv6": u"True",
2568
1648
# Parse config file for server-global settings
2569
1649
server_config = configparser.SafeConfigParser(server_defaults)
2570
1650
del server_defaults
2571
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1651
server_config.read(os.path.join(options.configdir,
2572
1653
# Convert the SafeConfigParser object to a dict
2573
1654
server_settings = server_config.defaults()
2574
1655
# Use the appropriate methods on the non-string config options
2575
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2576
server_settings[option] = server_config.getboolean("DEFAULT",
1656
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1657
server_settings[option] = server_config.getboolean(u"DEFAULT",
2578
1659
if server_settings["port"]:
2579
server_settings["port"] = server_config.getint("DEFAULT",
2581
if server_settings["socket"]:
2582
server_settings["socket"] = server_config.getint("DEFAULT",
2584
# Later, stdin will, and stdout and stderr might, be dup'ed
2585
# over with an opened os.devnull. But we don't want this to
2586
# happen with a supplied network socket.
2587
if 0 <= server_settings["socket"] <= 2:
2588
server_settings["socket"] = os.dup(server_settings
1660
server_settings["port"] = server_config.getint(u"DEFAULT",
2590
1662
del server_config
2592
1664
# Override the settings from the config file with command line
2593
1665
# options, if set.
2594
for option in ("interface", "address", "port", "debug",
2595
"priority", "servicename", "configdir", "use_dbus",
2596
"use_ipv6", "debuglevel", "restore", "statedir",
2597
"socket", "foreground", "zeroconf"):
1666
for option in (u"interface", u"address", u"port", u"debug",
1667
u"priority", u"servicename", u"configdir",
1668
u"use_dbus", u"use_ipv6"):
2598
1669
value = getattr(options, option)
2599
1670
if value is not None:
2600
1671
server_settings[option] = value
2602
1673
# Force all strings to be unicode
2603
1674
for option in server_settings.keys():
2604
if isinstance(server_settings[option], bytes):
2605
server_settings[option] = (server_settings[option]
2607
# Force all boolean options to be boolean
2608
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2609
"foreground", "zeroconf"):
2610
server_settings[option] = bool(server_settings[option])
2611
# Debug implies foreground
2612
if server_settings["debug"]:
2613
server_settings["foreground"] = True
1675
if type(server_settings[option]) is str:
1676
server_settings[option] = unicode(server_settings[option])
2614
1677
# Now we have our good server settings in "server_settings"
2616
1679
##################################################################
2618
if (not server_settings["zeroconf"]
2619
and not (server_settings["port"]
2620
or server_settings["socket"] != "")):
2621
parser.error("Needs port or socket to work without Zeroconf")
2623
1681
# For convenience
2624
debug = server_settings["debug"]
2625
debuglevel = server_settings["debuglevel"]
2626
use_dbus = server_settings["use_dbus"]
2627
use_ipv6 = server_settings["use_ipv6"]
2628
stored_state_path = os.path.join(server_settings["statedir"],
2630
foreground = server_settings["foreground"]
2631
zeroconf = server_settings["zeroconf"]
2634
initlogger(debug, logging.DEBUG)
2639
level = getattr(logging, debuglevel.upper())
2640
initlogger(debug, level)
2642
if server_settings["servicename"] != "Mandos":
2643
syslogger.setFormatter(
2644
logging.Formatter('Mandos ({}) [%(process)d]:'
2645
' %(levelname)s: %(message)s'.format(
2646
server_settings["servicename"])))
1682
debug = server_settings[u"debug"]
1683
use_dbus = server_settings[u"use_dbus"]
1684
use_ipv6 = server_settings[u"use_ipv6"]
1687
syslogger.setLevel(logging.WARNING)
1688
console.setLevel(logging.WARNING)
1690
if server_settings[u"servicename"] != u"Mandos":
1691
syslogger.setFormatter(logging.Formatter
1692
(u'Mandos (%s) [%%(process)d]:'
1693
u' %%(levelname)s: %%(message)s'
1694
% server_settings[u"servicename"]))
2648
1696
# Parse config file with clients
2649
client_config = configparser.SafeConfigParser(Client
2651
client_config.read(os.path.join(server_settings["configdir"],
1697
client_defaults = { u"timeout": u"1h",
1699
u"checker": u"fping -q -- %%(host)s",
1701
u"approved_delay": u"0s",
1702
u"approved_duration": u"1s",
1704
client_config = configparser.SafeConfigParser(client_defaults)
1705
client_config.read(os.path.join(server_settings[u"configdir"],
2654
1708
global mandos_dbus_service
2655
1709
mandos_dbus_service = None
2658
if server_settings["socket"] != "":
2659
socketfd = server_settings["socket"]
2660
tcp_server = MandosServer(
2661
(server_settings["address"], server_settings["port"]),
2663
interface=(server_settings["interface"] or None),
2665
gnutls_priority=server_settings["priority"],
2669
pidfilename = "/run/mandos.pid"
2670
if not os.path.isdir("/run/."):
2671
pidfilename = "/var/run/mandos.pid"
2674
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2675
except IOError as e:
2676
logger.error("Could not open file %r", pidfilename,
1711
tcp_server = MandosServer((server_settings[u"address"],
1712
server_settings[u"port"]),
1714
interface=server_settings[u"interface"],
1717
server_settings[u"priority"],
1719
pidfilename = u"/var/run/mandos.pid"
1721
pidfile = open(pidfilename, u"w")
1723
logger.error(u"Could not open file %r", pidfilename)
2679
for name in ("_mandos", "mandos", "nobody"):
1726
uid = pwd.getpwnam(u"_mandos").pw_uid
1727
gid = pwd.getpwnam(u"_mandos").pw_gid
2681
uid = pwd.getpwnam(name).pw_uid
2682
gid = pwd.getpwnam(name).pw_gid
1730
uid = pwd.getpwnam(u"mandos").pw_uid
1731
gid = pwd.getpwnam(u"mandos").pw_gid
2684
1732
except KeyError:
1734
uid = pwd.getpwnam(u"nobody").pw_uid
1735
gid = pwd.getpwnam(u"nobody").pw_gid
2692
except OSError as error:
2693
if error.errno != errno.EPERM:
1742
except OSError, error:
1743
if error[0] != errno.EPERM:
1746
# Enable all possible GnuTLS debugging
2697
# Enable all possible GnuTLS debugging
2699
1748
# "Use a log level over 10 to enable all debugging options."
2700
1749
# - GnuTLS manual
2701
1750
gnutls.library.functions.gnutls_global_set_log_level(11)
2703
1752
@gnutls.library.types.gnutls_log_func
2704
1753
def debug_gnutls(level, string):
2705
logger.debug("GnuTLS: %s", string[:-1])
2707
gnutls.library.functions.gnutls_global_set_log_function(
2710
# Redirect stdin so all checkers get /dev/null
2711
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2712
os.dup2(null, sys.stdin.fileno())
2716
# Need to fork before connecting to D-Bus
2718
# Close all input and output, do double fork, etc.
2721
# multiprocessing will use threads, so before we use gobject we
2722
# need to inform gobject that threads will be used.
2723
gobject.threads_init()
1754
logger.debug(u"GnuTLS: %s", string[:-1])
1756
(gnutls.library.functions
1757
.gnutls_global_set_log_function(debug_gnutls))
2725
1759
global main_loop
2726
1760
# From the Avahi example code
2727
DBusGMainLoop(set_as_default=True)
1761
DBusGMainLoop(set_as_default=True )
2728
1762
main_loop = gobject.MainLoop()
2729
1763
bus = dbus.SystemBus()
2730
1764
# End of Avahi example code
2733
bus_name = dbus.service.BusName("se.recompile.Mandos",
2736
old_bus_name = dbus.service.BusName(
2737
"se.bsnet.fukt.Mandos", bus,
2739
except dbus.exceptions.DBusException as e:
2740
logger.error("Disabling D-Bus:", exc_info=e)
1767
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1768
bus, do_not_queue=True)
1769
except dbus.exceptions.NameExistsException, e:
1770
logger.error(unicode(e) + u", disabling D-Bus")
2741
1771
use_dbus = False
2742
server_settings["use_dbus"] = False
1772
server_settings[u"use_dbus"] = False
2743
1773
tcp_server.use_dbus = False
2745
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2746
service = AvahiServiceToSyslog(
2747
name = server_settings["servicename"],
2748
servicetype = "_mandos._tcp",
2749
protocol = protocol,
2751
if server_settings["interface"]:
2752
service.interface = if_nametoindex(
2753
server_settings["interface"].encode("utf-8"))
2755
global multiprocessing_manager
2756
multiprocessing_manager = multiprocessing.Manager()
1774
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1775
service = AvahiService(name = server_settings[u"servicename"],
1776
servicetype = u"_mandos._tcp",
1777
protocol = protocol, bus = bus)
1778
if server_settings["interface"]:
1779
service.interface = (if_nametoindex
1780
(str(server_settings[u"interface"])))
2758
1782
client_class = Client
2760
1784
client_class = functools.partial(ClientDBus, bus = bus)
2762
client_settings = Client.config_parser(client_config)
2763
old_client_settings = {}
2766
# This is used to redirect stdout and stderr for checker processes
2768
wnull = open(os.devnull, "w") # A writable /dev/null
2769
# Only used if server is running in foreground but not in debug
2771
if debug or not foreground:
2774
# Get client data and settings from last running state.
2775
if server_settings["restore"]:
2777
with open(stored_state_path, "rb") as stored_state:
2778
clients_data, old_client_settings = pickle.load(
2780
os.remove(stored_state_path)
2781
except IOError as e:
2782
if e.errno == errno.ENOENT:
2783
logger.warning("Could not load persistent state:"
2784
" {}".format(os.strerror(e.errno)))
2786
logger.critical("Could not load persistent state:",
2789
except EOFError as e:
2790
logger.warning("Could not load persistent state: "
2794
with PGPEngine() as pgp:
2795
for client_name, client in clients_data.items():
2796
# Skip removed clients
2797
if client_name not in client_settings:
2800
# Decide which value to use after restoring saved state.
2801
# We have three different values: Old config file,
2802
# new config file, and saved state.
2803
# New config value takes precedence if it differs from old
2804
# config value, otherwise use saved state.
2805
for name, value in client_settings[client_name].items():
2807
# For each value in new config, check if it
2808
# differs from the old config value (Except for
2809
# the "secret" attribute)
2810
if (name != "secret"
2812
old_client_settings[client_name][name])):
2813
client[name] = value
2817
# Clients who has passed its expire date can still be
2818
# enabled if its last checker was successful. A Client
2819
# whose checker succeeded before we stored its state is
2820
# assumed to have successfully run all checkers during
2822
if client["enabled"]:
2823
if datetime.datetime.utcnow() >= client["expires"]:
2824
if not client["last_checked_ok"]:
2826
"disabling client {} - Client never "
2827
"performed a successful checker".format(
2829
client["enabled"] = False
2830
elif client["last_checker_status"] != 0:
2832
"disabling client {} - Client last"
2833
" checker failed with error code"
2836
client["last_checker_status"]))
2837
client["enabled"] = False
2839
client["expires"] = (
2840
datetime.datetime.utcnow()
2841
+ client["timeout"])
2842
logger.debug("Last checker succeeded,"
2843
" keeping {} enabled".format(
1785
def client_config_items(config, section):
1786
special_settings = {
1787
"approved_by_default":
1788
lambda: config.getboolean(section,
1789
"approved_by_default"),
1791
for name, value in config.items(section):
2846
client["secret"] = pgp.decrypt(
2847
client["encrypted_secret"],
2848
client_settings[client_name]["secret"])
2850
# If decryption fails, we use secret from new settings
2851
logger.debug("Failed to decrypt {} old secret".format(
2853
client["secret"] = (client_settings[client_name]
2856
# Add/remove clients based on new changes made to config
2857
for client_name in (set(old_client_settings)
2858
- set(client_settings)):
2859
del clients_data[client_name]
2860
for client_name in (set(client_settings)
2861
- set(old_client_settings)):
2862
clients_data[client_name] = client_settings[client_name]
2864
# Create all client objects
2865
for client_name, client in clients_data.items():
2866
tcp_server.clients[client_name] = client_class(
2869
server_settings = server_settings)
1793
yield (name, special_settings[name]())
1797
tcp_server.clients.update(set(
1798
client_class(name = section,
1799
config= dict(client_config_items(
1800
client_config, section)))
1801
for section in client_config.sections()))
2871
1802
if not tcp_server.clients:
2872
logger.warning("No clients defined")
2875
if pidfile is not None:
1803
logger.warning(u"No clients defined")
1806
# Redirect stdin so all checkers get /dev/null
1807
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1808
os.dup2(null, sys.stdin.fileno())
1812
# No console logging
1813
logger.removeHandler(console)
1814
# Close all input and output, do double fork, etc.
2876
1819
pid = os.getpid()
2879
print(pid, file=pidfile)
2881
logger.error("Could not write to file %r with PID %d",
1820
pidfile.write(str(pid) + "\n")
1823
logger.error(u"Could not write to file %r with PID %d",
1826
# "pidfile" was never created
1831
signal.signal(signal.SIGINT, signal.SIG_IGN)
2886
1832
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2887
1833
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2891
@alternate_dbus_interfaces(
2892
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2893
class MandosDBusService(DBusObjectWithObjectManager):
1836
class MandosDBusService(dbus.service.Object):
2894
1837
"""A D-Bus proxy object"""
2896
1838
def __init__(self):
2897
dbus.service.Object.__init__(self, bus, "/")
2899
_interface = "se.recompile.Mandos"
2901
@dbus.service.signal(_interface, signature="o")
1839
dbus.service.Object.__init__(self, bus, u"/")
1840
_interface = u"se.bsnet.fukt.Mandos"
1842
@dbus.service.signal(_interface, signature=u"o")
2902
1843
def ClientAdded(self, objpath):
2906
@dbus.service.signal(_interface, signature="ss")
1847
@dbus.service.signal(_interface, signature=u"ss")
2907
1848
def ClientNotFound(self, fingerprint, address):
2911
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2913
@dbus.service.signal(_interface, signature="os")
1852
@dbus.service.signal(_interface, signature=u"os")
2914
1853
def ClientRemoved(self, objpath, name):
2918
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2920
@dbus.service.method(_interface, out_signature="ao")
1857
@dbus.service.method(_interface, out_signature=u"ao")
2921
1858
def GetAllClients(self):
2923
return dbus.Array(c.dbus_object_path for c in
2924
tcp_server.clients.itervalues())
1860
return dbus.Array(c.dbus_object_path
1861
for c in tcp_server.clients)
2926
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2928
1863
@dbus.service.method(_interface,
2929
out_signature="a{oa{sv}}")
1864
out_signature=u"a{oa{sv}}")
2930
1865
def GetAllClientsWithProperties(self):
2932
1867
return dbus.Dictionary(
2933
{ c.dbus_object_path: c.GetAll(
2934
"se.recompile.Mandos.Client")
2935
for c in tcp_server.clients.itervalues() },
1868
((c.dbus_object_path, c.GetAll(u""))
1869
for c in tcp_server.clients),
1870
signature=u"oa{sv}")
2938
@dbus.service.method(_interface, in_signature="o")
1872
@dbus.service.method(_interface, in_signature=u"o")
2939
1873
def RemoveClient(self, object_path):
2941
for c in tcp_server.clients.itervalues():
1875
for c in tcp_server.clients:
2942
1876
if c.dbus_object_path == object_path:
2943
del tcp_server.clients[c.name]
1877
tcp_server.clients.remove(c)
2944
1878
c.remove_from_connection()
2945
# Don't signal the disabling
1879
# Don't signal anything except ClientRemoved
2946
1880
c.disable(quiet=True)
2947
# Emit D-Bus signal for removal
2948
self.client_removed_signal(c)
1882
self.ClientRemoved(object_path, c.name)
2950
1884
raise KeyError(object_path)
2954
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
2955
out_signature = "a{oa{sa{sv}}}")
2956
def GetManagedObjects(self):
2958
return dbus.Dictionary(
2959
{ client.dbus_object_path:
2961
{ interface: client.GetAll(interface)
2963
client._get_all_interface_names()})
2964
for client in tcp_server.clients.values()})
2966
def client_added_signal(self, client):
2967
"""Send the new standard signal and the old signal"""
2969
# New standard signal
2970
self.InterfacesAdded(
2971
client.dbus_object_path,
2973
{ interface: client.GetAll(interface)
2975
client._get_all_interface_names()}))
2977
self.ClientAdded(client.dbus_object_path)
2979
def client_removed_signal(self, client):
2980
"""Send the new standard signal and the old signal"""
2982
# New standard signal
2983
self.InterfacesRemoved(
2984
client.dbus_object_path,
2985
client._get_all_interface_names())
2987
self.ClientRemoved(client.dbus_object_path,
2990
1888
mandos_dbus_service = MandosDBusService()
2993
1891
"Cleanup function; run on exit"
2997
multiprocessing.active_children()
2999
if not (tcp_server.clients or client_settings):
3002
# Store client before exiting. Secrets are encrypted with key
3003
# based on what config file has. If config file is
3004
# removed/edited, old secret will thus be unrecovable.
3006
with PGPEngine() as pgp:
3007
for client in tcp_server.clients.itervalues():
3008
key = client_settings[client.name]["secret"]
3009
client.encrypted_secret = pgp.encrypt(client.secret,
3013
# A list of attributes that can not be pickled
3015
exclude = { "bus", "changedstate", "secret",
3016
"checker", "server_settings" }
3017
for name, typ in inspect.getmembers(dbus.service
3021
client_dict["encrypted_secret"] = (client
3023
for attr in client.client_structure:
3024
if attr not in exclude:
3025
client_dict[attr] = getattr(client, attr)
3027
clients[client.name] = client_dict
3028
del client_settings[client.name]["secret"]
3031
with tempfile.NamedTemporaryFile(
3035
dir=os.path.dirname(stored_state_path),
3036
delete=False) as stored_state:
3037
pickle.dump((clients, client_settings), stored_state)
3038
tempname = stored_state.name
3039
os.rename(tempname, stored_state_path)
3040
except (IOError, OSError) as e:
3046
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3047
logger.warning("Could not save persistent state: {}"
3048
.format(os.strerror(e.errno)))
3050
logger.warning("Could not save persistent state:",
3054
# Delete all clients, and settings from config
3055
1894
while tcp_server.clients:
3056
name, client = tcp_server.clients.popitem()
1895
client = tcp_server.clients.pop()
3058
1897
client.remove_from_connection()
3059
# Don't signal the disabling
1898
client.disable_hook = None
1899
# Don't signal anything except ClientRemoved
3060
1900
client.disable(quiet=True)
3061
# Emit D-Bus signal for removal
3062
mandos_dbus_service.client_removed_signal(client)
3063
client_settings.clear()
1903
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3065
1906
atexit.register(cleanup)
3067
for client in tcp_server.clients.itervalues():
1908
for client in tcp_server.clients:
3069
# Emit D-Bus signal for adding
3070
mandos_dbus_service.client_added_signal(client)
3071
# Need to initiate checking of clients
3073
client.init_checker()
1911
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3075
1914
tcp_server.enable()
3076
1915
tcp_server.server_activate()
3078
1917
# Find out what port we got
3080
service.port = tcp_server.socket.getsockname()[1]
1918
service.port = tcp_server.socket.getsockname()[1]
3082
logger.info("Now listening on address %r, port %d,"
3083
" flowinfo %d, scope_id %d",
3084
*tcp_server.socket.getsockname())
1920
logger.info(u"Now listening on address %r, port %d,"
1921
" flowinfo %d, scope_id %d"
1922
% tcp_server.socket.getsockname())
3086
logger.info("Now listening on address %r, port %d",
3087
*tcp_server.socket.getsockname())
1924
logger.info(u"Now listening on address %r, port %d"
1925
% tcp_server.socket.getsockname())
3089
1927
#service.interface = tcp_server.socket.getsockname()[3]
3093
# From the Avahi example code
3096
except dbus.exceptions.DBusException as error:
3097
logger.critical("D-Bus Exception", exc_info=error)
3100
# End of Avahi example code
1930
# From the Avahi example code
1933
except dbus.exceptions.DBusException, error:
1934
logger.critical(u"DBusException: %s", error)
1937
# End of Avahi example code
3102
1939
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
3103
1940
lambda *args, **kwargs:
3104
1941
(tcp_server.handle_request
3105
1942
(*args[2:], **kwargs) or True))
3107
logger.debug("Starting main loop")
1944
logger.debug(u"Starting main loop")
3108
1945
main_loop.run()
3109
except AvahiError as error:
3110
logger.critical("Avahi Error", exc_info=error)
1946
except AvahiError, error:
1947
logger.critical(u"AvahiError: %s", error)
3113
1950
except KeyboardInterrupt:
3115
print("", file=sys.stderr)
3116
logger.debug("Server received KeyboardInterrupt")
3117
logger.debug("Server exiting")
1953
logger.debug(u"Server received KeyboardInterrupt")
1954
logger.debug(u"Server exiting")
3118
1955
# Must run before the D-Bus bus name gets deregistered
3122
1958
if __name__ == '__main__':