186
352
dbus.UInt16(self.port),
187
353
avahi.string_array_to_txt_array(self.TXT))
188
354
self.group.Commit()
189
356
def entry_group_state_changed(self, state, error):
190
357
"""Derived from the Avahi example code"""
191
logger.debug(u"Avahi state change: %i", state)
358
logger.debug("Avahi entry group state change: %i", state)
193
360
if state == avahi.ENTRY_GROUP_ESTABLISHED:
194
logger.debug(u"Zeroconf service established.")
361
logger.debug("Zeroconf service established.")
195
362
elif state == avahi.ENTRY_GROUP_COLLISION:
196
logger.warning(u"Zeroconf service name collision.")
363
logger.info("Zeroconf service name collision.")
198
365
elif state == avahi.ENTRY_GROUP_FAILURE:
199
logger.critical(u"Avahi: Error in group state changed %s",
201
raise AvahiGroupError(u"State changed: %s"
366
logger.critical("Avahi: Error in group state changed %s",
368
raise AvahiGroupError("State changed: {!s}".format(error))
203
370
def cleanup(self):
204
371
"""Derived from the Avahi example code"""
205
372
if self.group is not None:
375
except (dbus.exceptions.UnknownMethodException,
376
dbus.exceptions.DBusException):
207
378
self.group = None
208
def server_state_changed(self, state):
381
def server_state_changed(self, state, error=None):
209
382
"""Derived from the Avahi example code"""
210
if state == avahi.SERVER_COLLISION:
211
logger.error(u"Zeroconf server name collision")
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)
213
397
elif state == avahi.SERVER_RUNNING:
401
logger.debug("Unknown state: %r", state)
403
logger.debug("Unknown state: %r: %r", state, error)
215
405
def activate(self):
216
406
"""Derived from the Avahi example code"""
217
407
if self.server is None:
218
408
self.server = dbus.Interface(
219
409
self.bus.get_object(avahi.DBUS_NAME,
220
avahi.DBUS_PATH_SERVER),
410
avahi.DBUS_PATH_SERVER,
411
follow_name_owner_changes=True),
221
412
avahi.DBUS_INTERFACE_SERVER)
222
self.server.connect_to_signal(u"StateChanged",
223
self.server_state_changed)
413
self.server.connect_to_signal("StateChanged",
414
self.server_state_changed)
224
415
self.server_state_changed(self.server.GetState())
418
class AvahiServiceToSyslog(AvahiService):
419
def rename(self, *args, **kwargs):
420
"""Add the new name to the syslog messages"""
421
ret = AvahiService.rename(self, *args, **kwargs)
422
syslogger.setFormatter(logging.Formatter(
423
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
227
428
class Client(object):
228
429
"""A representation of a client host served by this server.
231
name: string; from the config file, used in log messages and
233
fingerprint: string (40 or 32 hexadecimal digits); used to
234
uniquely identify the client
235
secret: bytestring; sent verbatim (over TLS) to client
236
host: string; available for use by the checker command
237
created: datetime.datetime(); (UTC) object creation
238
last_enabled: datetime.datetime(); (UTC)
240
last_checked_ok: datetime.datetime(); (UTC) or None
241
timeout: datetime.timedelta(); How long from last_checked_ok
242
until this client is invalid
243
interval: datetime.timedelta(); How often to start a new checker
244
disable_hook: If set, called by disable() as disable_hook(self)
432
approved: bool(); 'None' if not yet approved/disapproved
433
approval_delay: datetime.timedelta(); Time to wait for approval
434
approval_duration: datetime.timedelta(); Duration of one approval
245
435
checker: subprocess.Popen(); a running checker process used
246
436
to see if the client lives.
247
437
'None' if no process is running.
248
checker_initiator_tag: a gobject event source tag, or None
249
disable_initiator_tag: - '' -
250
checker_callback_tag: - '' -
251
checker_command: string; External command which is run to check if
252
client lives. %() expansions are done at
438
checker_callback_tag: a gobject event source tag, or None
439
checker_command: string; External command which is run to check
440
if client lives. %() expansions are done at
253
441
runtime with vars(self) as dict, so that for
254
442
instance %(name)s can be used in the command.
443
checker_initiator_tag: a gobject event source tag, or None
444
created: datetime.datetime(); (UTC) object creation
445
client_structure: Object describing what attributes a client has
446
and is used for storing the client at exit
255
447
current_checker_command: string; current running checker_command
448
disable_initiator_tag: a gobject event source tag, or None
450
fingerprint: string (40 or 32 hexadecimal digits); used to
451
uniquely identify the client
452
host: string; available for use by the checker command
453
interval: datetime.timedelta(); How often to start a new checker
454
last_approval_request: datetime.datetime(); (UTC) or None
455
last_checked_ok: datetime.datetime(); (UTC) or None
456
last_checker_status: integer between 0 and 255 reflecting exit
457
status of last checker. -1 reflects crashed
458
checker, -2 means no checker completed yet.
459
last_enabled: datetime.datetime(); (UTC) or None
460
name: string; from the config file, used in log messages and
462
secret: bytestring; sent verbatim (over TLS) to client
463
timeout: datetime.timedelta(); How long from last_checked_ok
464
until this client is disabled
465
extended_timeout: extra long timeout when secret has been sent
466
runtime_expansions: Allowed attributes for runtime expansion.
467
expires: datetime.datetime(); time (UTC) when a client will be
469
server_settings: The server_settings dict from main()
472
runtime_expansions = ("approval_delay", "approval_duration",
473
"created", "enabled", "expires",
474
"fingerprint", "host", "interval",
475
"last_approval_request", "last_checked_ok",
476
"last_enabled", "name", "timeout")
479
"extended_timeout": "PT15M",
481
"checker": "fping -q -- %%(host)s",
483
"approval_delay": "PT0S",
484
"approval_duration": "PT1S",
485
"approved_by_default": "True",
259
def _datetime_to_milliseconds(dt):
260
"Convert a datetime.datetime() to milliseconds"
261
return ((dt.days * 24 * 60 * 60 * 1000)
262
+ (dt.seconds * 1000)
263
+ (dt.microseconds // 1000))
265
def timeout_milliseconds(self):
266
"Return the 'timeout' attribute in milliseconds"
267
return self._datetime_to_milliseconds(self.timeout)
269
def interval_milliseconds(self):
270
"Return the 'interval' attribute in milliseconds"
271
return self._datetime_to_milliseconds(self.interval)
273
def __init__(self, name = None, disable_hook=None, config=None):
274
"""Note: the 'checker' key in 'config' sets the
275
'checker_command' attribute and *not* the 'checker'
490
def config_parser(config):
491
"""Construct a new dict of client settings of this form:
492
{ client_name: {setting_name: value, ...}, ...}
493
with exceptions for any special settings as defined above.
494
NOTE: Must be a pure function. Must return the same result
495
value given the same arguments.
498
for client_name in config.sections():
499
section = dict(config.items(client_name))
500
client = settings[client_name] = {}
502
client["host"] = section["host"]
503
# Reformat values from string types to Python types
504
client["approved_by_default"] = config.getboolean(
505
client_name, "approved_by_default")
506
client["enabled"] = config.getboolean(client_name,
509
# Uppercase and remove spaces from fingerprint for later
510
# comparison purposes with return value from the
511
# fingerprint() function
512
client["fingerprint"] = (section["fingerprint"].upper()
514
if "secret" in section:
515
client["secret"] = section["secret"].decode("base64")
516
elif "secfile" in section:
517
with open(os.path.expanduser(os.path.expandvars
518
(section["secfile"])),
520
client["secret"] = secfile.read()
522
raise TypeError("No secret or secfile for section {}"
524
client["timeout"] = string_to_delta(section["timeout"])
525
client["extended_timeout"] = string_to_delta(
526
section["extended_timeout"])
527
client["interval"] = string_to_delta(section["interval"])
528
client["approval_delay"] = string_to_delta(
529
section["approval_delay"])
530
client["approval_duration"] = string_to_delta(
531
section["approval_duration"])
532
client["checker_command"] = section["checker"]
533
client["last_approval_request"] = None
534
client["last_checked_ok"] = None
535
client["last_checker_status"] = -2
539
def __init__(self, settings, name = None, server_settings=None):
280
logger.debug(u"Creating client %r", self.name)
281
# Uppercase and remove spaces from fingerprint for later
282
# comparison purposes with return value from the fingerprint()
284
self.fingerprint = (config[u"fingerprint"].upper()
286
logger.debug(u" Fingerprint: %s", self.fingerprint)
287
if u"secret" in config:
288
self.secret = config[u"secret"].decode(u"base64")
289
elif u"secfile" in config:
290
with closing(open(os.path.expanduser
292
(config[u"secfile"])))) as secfile:
293
self.secret = secfile.read()
541
if server_settings is None:
543
self.server_settings = server_settings
544
# adding all client settings
545
for setting, value in settings.items():
546
setattr(self, setting, value)
549
if not hasattr(self, "last_enabled"):
550
self.last_enabled = datetime.datetime.utcnow()
551
if not hasattr(self, "expires"):
552
self.expires = (datetime.datetime.utcnow()
295
raise TypeError(u"No secret or secfile for client %s"
297
self.host = config.get(u"host", u"")
298
self.created = datetime.datetime.utcnow()
300
self.last_enabled = None
301
self.last_checked_ok = None
302
self.timeout = string_to_delta(config[u"timeout"])
303
self.interval = string_to_delta(config[u"interval"])
304
self.disable_hook = disable_hook
555
self.last_enabled = None
558
logger.debug("Creating client %r", self.name)
559
logger.debug(" Fingerprint: %s", self.fingerprint)
560
self.created = settings.get("created",
561
datetime.datetime.utcnow())
563
# attributes specific for this server instance
305
564
self.checker = None
306
565
self.checker_initiator_tag = None
307
566
self.disable_initiator_tag = None
308
567
self.checker_callback_tag = None
309
self.checker_command = config[u"checker"]
310
568
self.current_checker_command = None
311
self.last_connect = None
570
self.approvals_pending = 0
571
self.changedstate = multiprocessing_manager.Condition(
572
multiprocessing_manager.Lock())
573
self.client_structure = [attr
574
for attr in self.__dict__.iterkeys()
575
if not attr.startswith("_")]
576
self.client_structure.append("client_structure")
578
for name, t in inspect.getmembers(
579
type(self), lambda obj: isinstance(obj, property)):
580
if not name.startswith("_"):
581
self.client_structure.append(name)
583
# Send notice to process children that client state has changed
584
def send_changedstate(self):
585
with self.changedstate:
586
self.changedstate.notify_all()
313
588
def enable(self):
314
589
"""Start this client's checker and timeout hooks"""
315
if getattr(self, u"enabled", False):
590
if getattr(self, "enabled", False):
316
591
# Already enabled
593
self.expires = datetime.datetime.utcnow() + self.timeout
318
595
self.last_enabled = datetime.datetime.utcnow()
319
# Schedule a new checker to be started an 'interval' from now,
320
# and every interval from then on.
321
self.checker_initiator_tag = (gobject.timeout_add
322
(self.interval_milliseconds(),
324
# Also start a new checker *right now*.
326
# Schedule a disable() when 'timeout' has passed
327
self.disable_initiator_tag = (gobject.timeout_add
328
(self.timeout_milliseconds(),
597
self.send_changedstate()
599
def disable(self, quiet=True):
333
600
"""Disable this client."""
334
601
if not getattr(self, "enabled", False):
336
logger.info(u"Disabling client %s", self.name)
337
if getattr(self, u"disable_initiator_tag", False):
604
logger.info("Disabling client %s", self.name)
605
if getattr(self, "disable_initiator_tag", None) is not None:
338
606
gobject.source_remove(self.disable_initiator_tag)
339
607
self.disable_initiator_tag = None
340
if getattr(self, u"checker_initiator_tag", False):
609
if getattr(self, "checker_initiator_tag", None) is not None:
341
610
gobject.source_remove(self.checker_initiator_tag)
342
611
self.checker_initiator_tag = None
343
612
self.stop_checker()
344
if self.disable_hook:
345
self.disable_hook(self)
346
613
self.enabled = False
615
self.send_changedstate()
347
616
# Do not run this again if called by a gobject.timeout_add
350
619
def __del__(self):
351
self.disable_hook = None
622
def init_checker(self):
623
# Schedule a new checker to be started an 'interval' from now,
624
# and every interval from then on.
625
if self.checker_initiator_tag is not None:
626
gobject.source_remove(self.checker_initiator_tag)
627
self.checker_initiator_tag = gobject.timeout_add(
628
int(self.interval.total_seconds() * 1000),
630
# Schedule a disable() when 'timeout' has passed
631
if self.disable_initiator_tag is not None:
632
gobject.source_remove(self.disable_initiator_tag)
633
self.disable_initiator_tag = gobject.timeout_add(
634
int(self.timeout.total_seconds() * 1000), self.disable)
635
# Also start a new checker *right now*.
354
638
def checker_callback(self, pid, condition, command):
355
639
"""The checker has completed, so take appropriate actions."""
356
640
self.checker_callback_tag = None
357
641
self.checker = None
358
642
if os.WIFEXITED(condition):
359
exitstatus = os.WEXITSTATUS(condition)
361
logger.info(u"Checker for %(name)s succeeded",
643
self.last_checker_status = os.WEXITSTATUS(condition)
644
if self.last_checker_status == 0:
645
logger.info("Checker for %(name)s succeeded",
363
647
self.checked_ok()
365
logger.info(u"Checker for %(name)s failed",
649
logger.info("Checker for %(name)s failed", vars(self))
368
logger.warning(u"Checker for %(name)s crashed?",
651
self.last_checker_status = -1
652
logger.warning("Checker for %(name)s crashed?",
371
655
def checked_ok(self):
372
"""Bump up the timeout for this client.
374
This should only be called when the client has been seen,
656
"""Assert that the client has been seen, alive and well."""
377
657
self.last_checked_ok = datetime.datetime.utcnow()
378
gobject.source_remove(self.disable_initiator_tag)
379
self.disable_initiator_tag = (gobject.timeout_add
380
(self.timeout_milliseconds(),
658
self.last_checker_status = 0
661
def bump_timeout(self, timeout=None):
662
"""Bump up the timeout for this client."""
664
timeout = self.timeout
665
if self.disable_initiator_tag is not None:
666
gobject.source_remove(self.disable_initiator_tag)
667
self.disable_initiator_tag = None
668
if getattr(self, "enabled", False):
669
self.disable_initiator_tag = gobject.timeout_add(
670
int(timeout.total_seconds() * 1000), self.disable)
671
self.expires = datetime.datetime.utcnow() + timeout
673
def need_approval(self):
674
self.last_approval_request = datetime.datetime.utcnow()
383
676
def start_checker(self):
384
677
"""Start a new checker subprocess if one is not running.
453
763
if self.checker_callback_tag:
454
764
gobject.source_remove(self.checker_callback_tag)
455
765
self.checker_callback_tag = None
456
if getattr(self, u"checker", None) is None:
766
if getattr(self, "checker", None) is None:
458
logger.debug(u"Stopping checker for %(name)s", vars(self))
768
logger.debug("Stopping checker for %(name)s", vars(self))
460
os.kill(self.checker.pid, signal.SIGTERM)
770
self.checker.terminate()
462
772
#if self.checker.poll() is None:
463
# os.kill(self.checker.pid, signal.SIGKILL)
464
except OSError, error:
773
# self.checker.kill()
774
except OSError as error:
465
775
if error.errno != errno.ESRCH: # No such process
467
777
self.checker = None
469
def still_valid(self):
470
"""Has the timeout not yet passed for this client?"""
471
if not getattr(self, u"enabled", False):
473
now = datetime.datetime.utcnow()
474
if self.last_checked_ok is None:
475
return now < (self.created + self.timeout)
477
return now < (self.last_checked_ok + self.timeout)
480
class ClientDBus(Client, dbus.service.Object):
780
def dbus_service_property(dbus_interface,
784
"""Decorators for marking methods of a DBusObjectWithProperties to
785
become properties on the D-Bus.
787
The decorated method will be called with no arguments by "Get"
788
and with one argument by "Set".
790
The parameters, where they are supported, are the same as
791
dbus.service.method, except there is only "signature", since the
792
type from Get() and the type sent to Set() is the same.
794
# Encoding deeply encoded byte arrays is not supported yet by the
795
# "Set" method, so we fail early here:
796
if byte_arrays and signature != "ay":
797
raise ValueError("Byte arrays not supported for non-'ay'"
798
" signature {!r}".format(signature))
801
func._dbus_is_property = True
802
func._dbus_interface = dbus_interface
803
func._dbus_signature = signature
804
func._dbus_access = access
805
func._dbus_name = func.__name__
806
if func._dbus_name.endswith("_dbus_property"):
807
func._dbus_name = func._dbus_name[:-14]
808
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
814
def dbus_interface_annotations(dbus_interface):
815
"""Decorator for marking functions returning interface annotations
819
@dbus_interface_annotations("org.example.Interface")
820
def _foo(self): # Function name does not matter
821
return {"org.freedesktop.DBus.Deprecated": "true",
822
"org.freedesktop.DBus.Property.EmitsChangedSignal":
827
func._dbus_is_interface = True
828
func._dbus_interface = dbus_interface
829
func._dbus_name = dbus_interface
835
def dbus_annotations(annotations):
836
"""Decorator to annotate D-Bus methods, signals or properties
839
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
840
"org.freedesktop.DBus.Property."
841
"EmitsChangedSignal": "false"})
842
@dbus_service_property("org.example.Interface", signature="b",
844
def Property_dbus_property(self):
845
return dbus.Boolean(False)
849
func._dbus_annotations = annotations
855
class DBusPropertyException(dbus.exceptions.DBusException):
856
"""A base class for D-Bus property-related exceptions
861
class DBusPropertyAccessException(DBusPropertyException):
862
"""A property's access permissions disallows an operation.
867
class DBusPropertyNotFound(DBusPropertyException):
868
"""An attempt was made to access a non-existing property.
873
class DBusObjectWithProperties(dbus.service.Object):
874
"""A D-Bus object with properties.
876
Classes inheriting from this can use the dbus_service_property
877
decorator to expose methods as D-Bus properties. It exposes the
878
standard Get(), Set(), and GetAll() methods on the D-Bus.
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
def _get_dbus_property(self, interface_name, property_name):
901
"""Returns a bound method if one exists which is a D-Bus
902
property with the specified name and interface.
904
for cls in self.__class__.__mro__:
905
for name, value in inspect.getmembers(
906
cls, self._is_dbus_thing("property")):
907
if (value._dbus_name == property_name
908
and value._dbus_interface == interface_name):
909
return value.__get__(self)
912
raise DBusPropertyNotFound("{}:{}.{}".format(
913
self.dbus_object_path, interface_name, property_name))
915
@dbus.service.method(dbus.PROPERTIES_IFACE,
918
def Get(self, interface_name, property_name):
919
"""Standard D-Bus property Get() method, see D-Bus standard.
921
prop = self._get_dbus_property(interface_name, property_name)
922
if prop._dbus_access == "write":
923
raise DBusPropertyAccessException(property_name)
925
if not hasattr(value, "variant_level"):
927
return type(value)(value, variant_level=value.variant_level+1)
929
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
930
def Set(self, interface_name, property_name, value):
931
"""Standard D-Bus property Set() method, see D-Bus standard.
933
prop = self._get_dbus_property(interface_name, property_name)
934
if prop._dbus_access == "read":
935
raise DBusPropertyAccessException(property_name)
936
if prop._dbus_get_args_options["byte_arrays"]:
937
# The byte_arrays option is not supported yet on
938
# signatures other than "ay".
939
if prop._dbus_signature != "ay":
940
raise ValueError("Byte arrays not supported for non-"
941
"'ay' signature {!r}"
942
.format(prop._dbus_signature))
943
value = dbus.ByteArray(b''.join(chr(byte)
947
@dbus.service.method(dbus.PROPERTIES_IFACE,
949
out_signature="a{sv}")
950
def GetAll(self, interface_name):
951
"""Standard D-Bus property GetAll() method, see D-Bus
954
Note: Will not include properties with access="write".
957
for name, prop in self._get_all_dbus_things("property"):
959
and interface_name != prop._dbus_interface):
960
# Interface non-empty but did not match
962
# Ignore write-only properties
963
if prop._dbus_access == "write":
966
if not hasattr(value, "variant_level"):
967
properties[name] = value
969
properties[name] = type(value)(
970
value, variant_level = value.variant_level + 1)
971
return dbus.Dictionary(properties, signature="sv")
973
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
974
def PropertiesChanged(self, interface_name, changed_properties,
975
invalidated_properties):
976
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
981
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
983
path_keyword='object_path',
984
connection_keyword='connection')
985
def Introspect(self, object_path, connection):
986
"""Overloading of standard D-Bus method.
988
Inserts property tags and interface annotation tags.
990
xmlstring = dbus.service.Object.Introspect(self, object_path,
993
document = xml.dom.minidom.parseString(xmlstring)
995
def make_tag(document, name, prop):
996
e = document.createElement("property")
997
e.setAttribute("name", name)
998
e.setAttribute("type", prop._dbus_signature)
999
e.setAttribute("access", prop._dbus_access)
1002
for if_tag in document.getElementsByTagName("interface"):
1004
for tag in (make_tag(document, name, prop)
1006
in self._get_all_dbus_things("property")
1007
if prop._dbus_interface
1008
== if_tag.getAttribute("name")):
1009
if_tag.appendChild(tag)
1010
# Add annotation tags
1011
for typ in ("method", "signal", "property"):
1012
for tag in if_tag.getElementsByTagName(typ):
1014
for name, prop in (self.
1015
_get_all_dbus_things(typ)):
1016
if (name == tag.getAttribute("name")
1017
and prop._dbus_interface
1018
== if_tag.getAttribute("name")):
1019
annots.update(getattr(
1020
prop, "_dbus_annotations", {}))
1021
for name, value in annots.items():
1022
ann_tag = document.createElement(
1024
ann_tag.setAttribute("name", name)
1025
ann_tag.setAttribute("value", value)
1026
tag.appendChild(ann_tag)
1027
# Add interface annotation tags
1028
for annotation, value in dict(
1029
itertools.chain.from_iterable(
1030
annotations().items()
1031
for name, annotations
1032
in self._get_all_dbus_things("interface")
1033
if name == if_tag.getAttribute("name")
1035
ann_tag = document.createElement("annotation")
1036
ann_tag.setAttribute("name", annotation)
1037
ann_tag.setAttribute("value", value)
1038
if_tag.appendChild(ann_tag)
1039
# Add the names to the return values for the
1040
# "org.freedesktop.DBus.Properties" methods
1041
if (if_tag.getAttribute("name")
1042
== "org.freedesktop.DBus.Properties"):
1043
for cn in if_tag.getElementsByTagName("method"):
1044
if cn.getAttribute("name") == "Get":
1045
for arg in cn.getElementsByTagName("arg"):
1046
if (arg.getAttribute("direction")
1048
arg.setAttribute("name", "value")
1049
elif cn.getAttribute("name") == "GetAll":
1050
for arg in cn.getElementsByTagName("arg"):
1051
if (arg.getAttribute("direction")
1053
arg.setAttribute("name", "props")
1054
xmlstring = document.toxml("utf-8")
1056
except (AttributeError, xml.dom.DOMException,
1057
xml.parsers.expat.ExpatError) as error:
1058
logger.error("Failed to override Introspection method",
1063
def datetime_to_dbus(dt, variant_level=0):
1064
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1066
return dbus.String("", variant_level = variant_level)
1067
return dbus.String(dt.isoformat(), variant_level=variant_level)
1070
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1071
"""A class decorator; applied to a subclass of
1072
dbus.service.Object, it will add alternate D-Bus attributes with
1073
interface names according to the "alt_interface_names" mapping.
1076
@alternate_dbus_interfaces({"org.example.Interface":
1077
"net.example.AlternateInterface"})
1078
class SampleDBusObject(dbus.service.Object):
1079
@dbus.service.method("org.example.Interface")
1080
def SampleDBusMethod():
1083
The above "SampleDBusMethod" on "SampleDBusObject" will be
1084
reachable via two interfaces: "org.example.Interface" and
1085
"net.example.AlternateInterface", the latter of which will have
1086
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1087
"true", unless "deprecate" is passed with a False value.
1089
This works for methods and signals, and also for D-Bus properties
1090
(from DBusObjectWithProperties) and interfaces (from the
1091
dbus_interface_annotations decorator).
1095
for orig_interface_name, alt_interface_name in (
1096
alt_interface_names.items()):
1098
interface_names = set()
1099
# Go though all attributes of the class
1100
for attrname, attribute in inspect.getmembers(cls):
1101
# Ignore non-D-Bus attributes, and D-Bus attributes
1102
# with the wrong interface name
1103
if (not hasattr(attribute, "_dbus_interface")
1104
or not attribute._dbus_interface.startswith(
1105
orig_interface_name)):
1107
# Create an alternate D-Bus interface name based on
1109
alt_interface = attribute._dbus_interface.replace(
1110
orig_interface_name, alt_interface_name)
1111
interface_names.add(alt_interface)
1112
# Is this a D-Bus signal?
1113
if getattr(attribute, "_dbus_is_signal", False):
1114
# Extract the original non-method undecorated
1115
# function by black magic
1116
nonmethod_func = (dict(
1117
zip(attribute.func_code.co_freevars,
1118
attribute.__closure__))
1119
["func"].cell_contents)
1120
# Create a new, but exactly alike, function
1121
# object, and decorate it to be a new D-Bus signal
1122
# with the alternate D-Bus interface name
1123
new_function = (dbus.service.signal(
1124
alt_interface, attribute._dbus_signature)
1125
(types.FunctionType(
1126
nonmethod_func.func_code,
1127
nonmethod_func.func_globals,
1128
nonmethod_func.func_name,
1129
nonmethod_func.func_defaults,
1130
nonmethod_func.func_closure)))
1131
# Copy annotations, if any
1133
new_function._dbus_annotations = dict(
1134
attribute._dbus_annotations)
1135
except AttributeError:
1137
# Define a creator of a function to call both the
1138
# original and alternate functions, so both the
1139
# original and alternate signals gets sent when
1140
# the function is called
1141
def fixscope(func1, func2):
1142
"""This function is a scope container to pass
1143
func1 and func2 to the "call_both" function
1144
outside of its arguments"""
1146
def call_both(*args, **kwargs):
1147
"""This function will emit two D-Bus
1148
signals by calling func1 and func2"""
1149
func1(*args, **kwargs)
1150
func2(*args, **kwargs)
1153
# Create the "call_both" function and add it to
1155
attr[attrname] = fixscope(attribute, new_function)
1156
# Is this a D-Bus method?
1157
elif getattr(attribute, "_dbus_is_method", False):
1158
# Create a new, but exactly alike, function
1159
# object. Decorate it to be a new D-Bus method
1160
# with the alternate D-Bus interface name. Add it
1163
dbus.service.method(
1165
attribute._dbus_in_signature,
1166
attribute._dbus_out_signature)
1167
(types.FunctionType(attribute.func_code,
1168
attribute.func_globals,
1169
attribute.func_name,
1170
attribute.func_defaults,
1171
attribute.func_closure)))
1172
# Copy annotations, if any
1174
attr[attrname]._dbus_annotations = dict(
1175
attribute._dbus_annotations)
1176
except AttributeError:
1178
# Is this a D-Bus property?
1179
elif getattr(attribute, "_dbus_is_property", False):
1180
# Create a new, but exactly alike, function
1181
# object, and decorate it to be a new D-Bus
1182
# property with the alternate D-Bus interface
1183
# name. Add it to the class.
1184
attr[attrname] = (dbus_service_property(
1185
alt_interface, attribute._dbus_signature,
1186
attribute._dbus_access,
1187
attribute._dbus_get_args_options
1189
(types.FunctionType(
1190
attribute.func_code,
1191
attribute.func_globals,
1192
attribute.func_name,
1193
attribute.func_defaults,
1194
attribute.func_closure)))
1195
# Copy annotations, if any
1197
attr[attrname]._dbus_annotations = dict(
1198
attribute._dbus_annotations)
1199
except AttributeError:
1201
# Is this a D-Bus interface?
1202
elif getattr(attribute, "_dbus_is_interface", False):
1203
# Create a new, but exactly alike, function
1204
# object. Decorate it to be a new D-Bus interface
1205
# with the alternate D-Bus interface name. Add it
1208
dbus_interface_annotations(alt_interface)
1209
(types.FunctionType(attribute.func_code,
1210
attribute.func_globals,
1211
attribute.func_name,
1212
attribute.func_defaults,
1213
attribute.func_closure)))
1215
# Deprecate all alternate interfaces
1216
iname="_AlternateDBusNames_interface_annotation{}"
1217
for interface_name in interface_names:
1219
@dbus_interface_annotations(interface_name)
1221
return { "org.freedesktop.DBus.Deprecated":
1223
# Find an unused name
1224
for aname in (iname.format(i)
1225
for i in itertools.count()):
1226
if aname not in attr:
1230
# Replace the class with a new subclass of it with
1231
# methods, signals, etc. as created above.
1232
cls = type(b"{}Alternate".format(cls.__name__),
1239
@alternate_dbus_interfaces({"se.recompile.Mandos":
1240
"se.bsnet.fukt.Mandos"})
1241
class ClientDBus(Client, DBusObjectWithProperties):
481
1242
"""A Client class using D-Bus
484
1245
dbus_object_path: dbus.ObjectPath
485
1246
bus: dbus.SystemBus()
1249
runtime_expansions = (Client.runtime_expansions
1250
+ ("dbus_object_path", ))
1252
_interface = "se.recompile.Mandos.Client"
487
1254
# dbus.service.Object doesn't use super(), so we can't either.
489
1256
def __init__(self, bus = None, *args, **kwargs):
491
1258
Client.__init__(self, *args, **kwargs)
492
1259
# Only now, when this client is initialized, can it show up on
494
self.dbus_object_path = (dbus.ObjectPath
496
+ self.name.replace(u".", u"_")))
497
dbus.service.Object.__init__(self, self.bus,
498
self.dbus_object_path)
501
def _datetime_to_dbus(dt, variant_level=0):
502
"""Convert a UTC datetime.datetime() to a D-Bus type."""
503
return dbus.String(dt.isoformat(),
504
variant_level=variant_level)
507
oldstate = getattr(self, u"enabled", False)
508
r = Client.enable(self)
509
if oldstate != self.enabled:
511
self.PropertyChanged(dbus.String(u"enabled"),
512
dbus.Boolean(True, variant_level=1))
513
self.PropertyChanged(
514
dbus.String(u"last_enabled"),
515
self._datetime_to_dbus(self.last_enabled,
519
def disable(self, signal = True):
520
oldstate = getattr(self, u"enabled", False)
521
r = Client.disable(self)
522
if signal and oldstate != self.enabled:
524
self.PropertyChanged(dbus.String(u"enabled"),
525
dbus.Boolean(False, variant_level=1))
1261
client_object_name = str(self.name).translate(
1262
{ord("."): ord("_"),
1263
ord("-"): ord("_")})
1264
self.dbus_object_path = dbus.ObjectPath(
1265
"/clients/" + client_object_name)
1266
DBusObjectWithProperties.__init__(self, self.bus,
1267
self.dbus_object_path)
1269
def notifychangeproperty(transform_func, dbus_name,
1270
type_func=lambda x: x,
1272
invalidate_only=False,
1273
_interface=_interface):
1274
""" Modify a variable so that it's a property which announces
1275
its changes to DBus.
1277
transform_fun: Function that takes a value and a variant_level
1278
and transforms it to a D-Bus type.
1279
dbus_name: D-Bus name of the variable
1280
type_func: Function that transform the value before sending it
1281
to the D-Bus. Default: no transform
1282
variant_level: D-Bus variant level. Default: 1
1284
attrname = "_{}".format(dbus_name)
1286
def setter(self, value):
1287
if hasattr(self, "dbus_object_path"):
1288
if (not hasattr(self, attrname) or
1289
type_func(getattr(self, attrname, None))
1290
!= type_func(value)):
1292
self.PropertiesChanged(
1293
_interface, dbus.Dictionary(),
1294
dbus.Array((dbus_name, )))
1296
dbus_value = transform_func(
1298
variant_level = variant_level)
1299
self.PropertyChanged(dbus.String(dbus_name),
1301
self.PropertiesChanged(
1303
dbus.Dictionary({ dbus.String(dbus_name):
1306
setattr(self, attrname, value)
1308
return property(lambda self: getattr(self, attrname), setter)
1310
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1311
approvals_pending = notifychangeproperty(dbus.Boolean,
1314
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1315
last_enabled = notifychangeproperty(datetime_to_dbus,
1317
checker = notifychangeproperty(
1318
dbus.Boolean, "CheckerRunning",
1319
type_func = lambda checker: checker is not None)
1320
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1322
last_checker_status = notifychangeproperty(dbus.Int16,
1323
"LastCheckerStatus")
1324
last_approval_request = notifychangeproperty(
1325
datetime_to_dbus, "LastApprovalRequest")
1326
approved_by_default = notifychangeproperty(dbus.Boolean,
1327
"ApprovedByDefault")
1328
approval_delay = notifychangeproperty(
1329
dbus.UInt64, "ApprovalDelay",
1330
type_func = lambda td: td.total_seconds() * 1000)
1331
approval_duration = notifychangeproperty(
1332
dbus.UInt64, "ApprovalDuration",
1333
type_func = lambda td: td.total_seconds() * 1000)
1334
host = notifychangeproperty(dbus.String, "Host")
1335
timeout = notifychangeproperty(
1336
dbus.UInt64, "Timeout",
1337
type_func = lambda td: td.total_seconds() * 1000)
1338
extended_timeout = notifychangeproperty(
1339
dbus.UInt64, "ExtendedTimeout",
1340
type_func = lambda td: td.total_seconds() * 1000)
1341
interval = notifychangeproperty(
1342
dbus.UInt64, "Interval",
1343
type_func = lambda td: td.total_seconds() * 1000)
1344
checker_command = notifychangeproperty(dbus.String, "Checker")
1345
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1346
invalidate_only=True)
1348
del notifychangeproperty
528
1350
def __del__(self, *args, **kwargs):
530
1352
self.remove_from_connection()
531
1353
except LookupError:
533
if hasattr(dbus.service.Object, u"__del__"):
534
dbus.service.Object.__del__(self, *args, **kwargs)
1355
if hasattr(DBusObjectWithProperties, "__del__"):
1356
DBusObjectWithProperties.__del__(self, *args, **kwargs)
535
1357
Client.__del__(self, *args, **kwargs)
537
1359
def checker_callback(self, pid, condition, command,
538
1360
*args, **kwargs):
539
1361
self.checker_callback_tag = None
540
1362
self.checker = None
542
self.PropertyChanged(dbus.String(u"checker_running"),
543
dbus.Boolean(False, variant_level=1))
544
1363
if os.WIFEXITED(condition):
545
1364
exitstatus = os.WEXITSTATUS(condition)
546
1365
# Emit D-Bus signal
556
1375
return Client.checker_callback(self, pid, condition, command,
557
1376
*args, **kwargs)
559
def checked_ok(self, *args, **kwargs):
560
r = Client.checked_ok(self, *args, **kwargs)
562
self.PropertyChanged(
563
dbus.String(u"last_checked_ok"),
564
(self._datetime_to_dbus(self.last_checked_ok,
568
1378
def start_checker(self, *args, **kwargs):
569
old_checker = self.checker
570
if self.checker is not None:
571
old_checker_pid = self.checker.pid
573
old_checker_pid = None
1379
old_checker_pid = getattr(self.checker, "pid", None)
574
1380
r = Client.start_checker(self, *args, **kwargs)
575
1381
# Only if new checker process was started
576
1382
if (self.checker is not None
577
1383
and old_checker_pid != self.checker.pid):
578
1384
# Emit D-Bus signal
579
1385
self.CheckerStarted(self.current_checker_command)
580
self.PropertyChanged(
581
dbus.String(u"checker_running"),
582
dbus.Boolean(True, variant_level=1))
585
def stop_checker(self, *args, **kwargs):
586
old_checker = getattr(self, u"checker", None)
587
r = Client.stop_checker(self, *args, **kwargs)
588
if (old_checker is not None
589
and getattr(self, u"checker", None) is None):
590
self.PropertyChanged(dbus.String(u"checker_running"),
591
dbus.Boolean(False, variant_level=1))
594
## D-Bus methods & signals
595
_interface = u"se.bsnet.fukt.Mandos.Client"
598
@dbus.service.method(_interface)
600
return self.checked_ok()
1388
def _reset_approved(self):
1389
self.approved = None
1392
def approve(self, value=True):
1393
self.approved = value
1394
gobject.timeout_add(int(self.approval_duration.total_seconds()
1395
* 1000), self._reset_approved)
1396
self.send_changedstate()
1398
## D-Bus methods, signals & properties
602
1404
# CheckerCompleted - signal
603
@dbus.service.signal(_interface, signature=u"nxs")
1405
@dbus.service.signal(_interface, signature="nxs")
604
1406
def CheckerCompleted(self, exitcode, waitstatus, command):
608
1410
# CheckerStarted - signal
609
@dbus.service.signal(_interface, signature=u"s")
1411
@dbus.service.signal(_interface, signature="s")
610
1412
def CheckerStarted(self, command):
614
# GetAllProperties - method
615
@dbus.service.method(_interface, out_signature=u"a{sv}")
616
def GetAllProperties(self):
618
return dbus.Dictionary({
619
dbus.String(u"name"):
620
dbus.String(self.name, variant_level=1),
621
dbus.String(u"fingerprint"):
622
dbus.String(self.fingerprint, variant_level=1),
623
dbus.String(u"host"):
624
dbus.String(self.host, variant_level=1),
625
dbus.String(u"created"):
626
self._datetime_to_dbus(self.created,
628
dbus.String(u"last_enabled"):
629
(self._datetime_to_dbus(self.last_enabled,
631
if self.last_enabled is not None
632
else dbus.Boolean(False, variant_level=1)),
633
dbus.String(u"enabled"):
634
dbus.Boolean(self.enabled, variant_level=1),
635
dbus.String(u"last_checked_ok"):
636
(self._datetime_to_dbus(self.last_checked_ok,
638
if self.last_checked_ok is not None
639
else dbus.Boolean (False, variant_level=1)),
640
dbus.String(u"timeout"):
641
dbus.UInt64(self.timeout_milliseconds(),
643
dbus.String(u"interval"):
644
dbus.UInt64(self.interval_milliseconds(),
646
dbus.String(u"checker"):
647
dbus.String(self.checker_command,
649
dbus.String(u"checker_running"):
650
dbus.Boolean(self.checker is not None,
652
dbus.String(u"object_path"):
653
dbus.ObjectPath(self.dbus_object_path,
657
# IsStillValid - method
658
@dbus.service.method(_interface, out_signature=u"b")
659
def IsStillValid(self):
660
return self.still_valid()
662
1416
# PropertyChanged - signal
663
@dbus.service.signal(_interface, signature=u"sv")
1417
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1418
@dbus.service.signal(_interface, signature="sv")
664
1419
def PropertyChanged(self, property, value):
668
# ReceivedSecret - signal
1423
# GotSecret - signal
669
1424
@dbus.service.signal(_interface)
670
def ReceivedSecret(self):
1425
def GotSecret(self):
1427
Is sent after a successful transfer of secret from the Mandos
1428
server to mandos-client
674
1432
# Rejected - signal
675
@dbus.service.signal(_interface)
1433
@dbus.service.signal(_interface, signature="s")
1434
def Rejected(self, reason):
680
# SetChecker - method
681
@dbus.service.method(_interface, in_signature=u"s")
682
def SetChecker(self, checker):
683
"D-Bus setter method"
684
self.checker_command = checker
686
self.PropertyChanged(dbus.String(u"checker"),
687
dbus.String(self.checker_command,
691
@dbus.service.method(_interface, in_signature=u"s")
692
def SetHost(self, host):
693
"D-Bus setter method"
696
self.PropertyChanged(dbus.String(u"host"),
697
dbus.String(self.host, variant_level=1))
699
# SetInterval - method
700
@dbus.service.method(_interface, in_signature=u"t")
701
def SetInterval(self, milliseconds):
702
self.interval = datetime.timedelta(0, 0, 0, milliseconds)
704
self.PropertyChanged(dbus.String(u"interval"),
705
(dbus.UInt64(self.interval_milliseconds(),
709
@dbus.service.method(_interface, in_signature=u"ay",
711
def SetSecret(self, secret):
712
"D-Bus setter method"
713
self.secret = str(secret)
715
# SetTimeout - method
716
@dbus.service.method(_interface, in_signature=u"t")
717
def SetTimeout(self, milliseconds):
718
self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
720
self.PropertyChanged(dbus.String(u"timeout"),
721
(dbus.UInt64(self.timeout_milliseconds(),
1438
# NeedApproval - signal
1439
@dbus.service.signal(_interface, signature="tb")
1440
def NeedApproval(self, timeout, default):
1442
return self.need_approval()
1447
@dbus.service.method(_interface, in_signature="b")
1448
def Approve(self, value):
1451
# CheckedOK - method
1452
@dbus.service.method(_interface)
1453
def CheckedOK(self):
724
1456
# Enable - method
725
1457
@dbus.service.method(_interface)
744
1476
def StopChecker(self):
745
1477
self.stop_checker()
1481
# ApprovalPending - property
1482
@dbus_service_property(_interface, signature="b", access="read")
1483
def ApprovalPending_dbus_property(self):
1484
return dbus.Boolean(bool(self.approvals_pending))
1486
# ApprovedByDefault - property
1487
@dbus_service_property(_interface,
1490
def ApprovedByDefault_dbus_property(self, value=None):
1491
if value is None: # get
1492
return dbus.Boolean(self.approved_by_default)
1493
self.approved_by_default = bool(value)
1495
# ApprovalDelay - property
1496
@dbus_service_property(_interface,
1499
def ApprovalDelay_dbus_property(self, value=None):
1500
if value is None: # get
1501
return dbus.UInt64(self.approval_delay.total_seconds()
1503
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1505
# ApprovalDuration - property
1506
@dbus_service_property(_interface,
1509
def ApprovalDuration_dbus_property(self, value=None):
1510
if value is None: # get
1511
return dbus.UInt64(self.approval_duration.total_seconds()
1513
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1516
@dbus_service_property(_interface, signature="s", access="read")
1517
def Name_dbus_property(self):
1518
return dbus.String(self.name)
1520
# Fingerprint - property
1521
@dbus_service_property(_interface, signature="s", access="read")
1522
def Fingerprint_dbus_property(self):
1523
return dbus.String(self.fingerprint)
1526
@dbus_service_property(_interface,
1529
def Host_dbus_property(self, value=None):
1530
if value is None: # get
1531
return dbus.String(self.host)
1532
self.host = str(value)
1534
# Created - property
1535
@dbus_service_property(_interface, signature="s", access="read")
1536
def Created_dbus_property(self):
1537
return datetime_to_dbus(self.created)
1539
# LastEnabled - property
1540
@dbus_service_property(_interface, signature="s", access="read")
1541
def LastEnabled_dbus_property(self):
1542
return datetime_to_dbus(self.last_enabled)
1544
# Enabled - property
1545
@dbus_service_property(_interface,
1548
def Enabled_dbus_property(self, value=None):
1549
if value is None: # get
1550
return dbus.Boolean(self.enabled)
1556
# LastCheckedOK - property
1557
@dbus_service_property(_interface,
1560
def LastCheckedOK_dbus_property(self, value=None):
1561
if value is not None:
1564
return datetime_to_dbus(self.last_checked_ok)
1566
# LastCheckerStatus - property
1567
@dbus_service_property(_interface, signature="n", access="read")
1568
def LastCheckerStatus_dbus_property(self):
1569
return dbus.Int16(self.last_checker_status)
1571
# Expires - property
1572
@dbus_service_property(_interface, signature="s", access="read")
1573
def Expires_dbus_property(self):
1574
return datetime_to_dbus(self.expires)
1576
# LastApprovalRequest - property
1577
@dbus_service_property(_interface, signature="s", access="read")
1578
def LastApprovalRequest_dbus_property(self):
1579
return datetime_to_dbus(self.last_approval_request)
1581
# Timeout - property
1582
@dbus_service_property(_interface,
1585
def Timeout_dbus_property(self, value=None):
1586
if value is None: # get
1587
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1588
old_timeout = self.timeout
1589
self.timeout = datetime.timedelta(0, 0, 0, value)
1590
# Reschedule disabling
1592
now = datetime.datetime.utcnow()
1593
self.expires += self.timeout - old_timeout
1594
if self.expires <= now:
1595
# The timeout has passed
1598
if (getattr(self, "disable_initiator_tag", None)
1601
gobject.source_remove(self.disable_initiator_tag)
1602
self.disable_initiator_tag = gobject.timeout_add(
1603
int((self.expires - now).total_seconds() * 1000),
1606
# ExtendedTimeout - property
1607
@dbus_service_property(_interface,
1610
def ExtendedTimeout_dbus_property(self, value=None):
1611
if value is None: # get
1612
return dbus.UInt64(self.extended_timeout.total_seconds()
1614
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1616
# Interval - property
1617
@dbus_service_property(_interface,
1620
def Interval_dbus_property(self, value=None):
1621
if value is None: # get
1622
return dbus.UInt64(self.interval.total_seconds() * 1000)
1623
self.interval = datetime.timedelta(0, 0, 0, value)
1624
if getattr(self, "checker_initiator_tag", None) is None:
1627
# Reschedule checker run
1628
gobject.source_remove(self.checker_initiator_tag)
1629
self.checker_initiator_tag = gobject.timeout_add(
1630
value, self.start_checker)
1631
self.start_checker() # Start one now, too
1633
# Checker - property
1634
@dbus_service_property(_interface,
1637
def Checker_dbus_property(self, value=None):
1638
if value is None: # get
1639
return dbus.String(self.checker_command)
1640
self.checker_command = str(value)
1642
# CheckerRunning - property
1643
@dbus_service_property(_interface,
1646
def CheckerRunning_dbus_property(self, value=None):
1647
if value is None: # get
1648
return dbus.Boolean(self.checker is not None)
1650
self.start_checker()
1654
# ObjectPath - property
1655
@dbus_service_property(_interface, signature="o", access="read")
1656
def ObjectPath_dbus_property(self):
1657
return self.dbus_object_path # is already a dbus.ObjectPath
1660
@dbus_service_property(_interface,
1664
def Secret_dbus_property(self, value):
1665
self.secret = bytes(value)
1670
class ProxyClient(object):
1671
def __init__(self, child_pipe, fpr, address):
1672
self._pipe = child_pipe
1673
self._pipe.send(('init', fpr, address))
1674
if not self._pipe.recv():
1677
def __getattribute__(self, name):
1679
return super(ProxyClient, self).__getattribute__(name)
1680
self._pipe.send(('getattr', name))
1681
data = self._pipe.recv()
1682
if data[0] == 'data':
1684
if data[0] == 'function':
1686
def func(*args, **kwargs):
1687
self._pipe.send(('funcall', name, args, kwargs))
1688
return self._pipe.recv()[1]
1692
def __setattr__(self, name, value):
1694
return super(ProxyClient, self).__setattr__(name, value)
1695
self._pipe.send(('setattr', name, value))
750
1698
class ClientHandler(socketserver.BaseRequestHandler, object):
751
1699
"""A class to handle client connections.
754
1702
Note: This will run in its own forked process."""
756
1704
def handle(self):
757
logger.info(u"TCP connection from: %s",
758
unicode(self.client_address))
759
logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
760
# Open IPC pipe to parent process
761
with closing(os.fdopen(self.server.pipe[1], u"w", 1)) as ipc:
762
session = (gnutls.connection
763
.ClientSession(self.request,
1705
with contextlib.closing(self.server.child_pipe) as child_pipe:
1706
logger.info("TCP connection from: %s",
1707
str(self.client_address))
1708
logger.debug("Pipe FD: %d",
1709
self.server.child_pipe.fileno())
767
line = self.request.makefile().readline()
768
logger.debug(u"Protocol version: %r", line)
770
if int(line.strip().split()[0]) > 1:
772
except (ValueError, IndexError, RuntimeError), error:
773
logger.error(u"Unknown protocol version: %s", error)
1711
session = gnutls.connection.ClientSession(
1712
self.request, gnutls.connection .X509Credentials())
776
1714
# Note: gnutls.connection.X509Credentials is really a
777
1715
# generic GnuTLS certificate credentials object so long as
778
1716
# no X.509 keys are added to it. Therefore, we can use it
779
1717
# here despite using OpenPGP certificates.
781
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
782
# u"+AES-256-CBC", u"+SHA1",
783
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1719
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1720
# "+AES-256-CBC", "+SHA1",
1721
# "+COMP-NULL", "+CTYPE-OPENPGP",
785
1723
# Use a fallback default, since this MUST be set.
786
1724
priority = self.server.gnutls_priority
787
1725
if priority is None:
789
(gnutls.library.functions
790
.gnutls_priority_set_direct(session._c_object,
1727
gnutls.library.functions.gnutls_priority_set_direct(
1728
session._c_object, priority, None)
1730
# Start communication using the Mandos protocol
1731
# Get protocol number
1732
line = self.request.makefile().readline()
1733
logger.debug("Protocol version: %r", line)
1735
if int(line.strip().split()[0]) > 1:
1736
raise RuntimeError(line)
1737
except (ValueError, IndexError, RuntimeError) as error:
1738
logger.error("Unknown protocol version: %s", error)
1741
# Start GnuTLS connection
794
1743
session.handshake()
795
except gnutls.errors.GNUTLSError, error:
796
logger.warning(u"Handshake failed: %s", error)
1744
except gnutls.errors.GNUTLSError as error:
1745
logger.warning("Handshake failed: %s", error)
797
1746
# Do not run session.bye() here: the session is not
798
1747
# established. Just abandon the request.
800
logger.debug(u"Handshake succeeded")
1749
logger.debug("Handshake succeeded")
1751
approval_required = False
802
fpr = self.fingerprint(self.peer_certificate(session))
803
except (TypeError, gnutls.errors.GNUTLSError), error:
804
logger.warning(u"Bad certificate: %s", error)
807
logger.debug(u"Fingerprint: %s", fpr)
1754
fpr = self.fingerprint(
1755
self.peer_certificate(session))
1757
gnutls.errors.GNUTLSError) as error:
1758
logger.warning("Bad certificate: %s", error)
1760
logger.debug("Fingerprint: %s", fpr)
1763
client = ProxyClient(child_pipe, fpr,
1764
self.client_address)
1768
if client.approval_delay:
1769
delay = client.approval_delay
1770
client.approvals_pending += 1
1771
approval_required = True
1774
if not client.enabled:
1775
logger.info("Client %s is disabled",
1777
if self.server.use_dbus:
1779
client.Rejected("Disabled")
1782
if client.approved or not client.approval_delay:
1783
#We are approved or approval is disabled
1785
elif client.approved is None:
1786
logger.info("Client %s needs approval",
1788
if self.server.use_dbus:
1790
client.NeedApproval(
1791
client.approval_delay.total_seconds()
1792
* 1000, client.approved_by_default)
1794
logger.warning("Client %s was not approved",
1796
if self.server.use_dbus:
1798
client.Rejected("Denied")
1801
#wait until timeout or approved
1802
time = datetime.datetime.now()
1803
client.changedstate.acquire()
1804
client.changedstate.wait(delay.total_seconds())
1805
client.changedstate.release()
1806
time2 = datetime.datetime.now()
1807
if (time2 - time) >= delay:
1808
if not client.approved_by_default:
1809
logger.warning("Client %s timed out while"
1810
" waiting for approval",
1812
if self.server.use_dbus:
1814
client.Rejected("Approval timed out")
1819
delay -= time2 - time
1822
while sent_size < len(client.secret):
1824
sent = session.send(client.secret[sent_size:])
1825
except gnutls.errors.GNUTLSError as error:
1826
logger.warning("gnutls send failed",
1829
logger.debug("Sent: %d, remaining: %d", sent,
1830
len(client.secret) - (sent_size
1834
logger.info("Sending secret to %s", client.name)
1835
# bump the timeout using extended_timeout
1836
client.bump_timeout(client.extended_timeout)
1837
if self.server.use_dbus:
809
for c in self.server.clients:
810
if c.fingerprint == fpr:
814
ipc.write(u"NOTFOUND %s %s\n"
815
% (fpr, unicode(self.client_address)))
818
# Have to check if client.still_valid(), since it is
819
# possible that the client timed out while establishing
820
# the GnuTLS session.
821
if not client.still_valid():
822
ipc.write(u"INVALID %s\n" % client.name)
825
ipc.write(u"SENDING %s\n" % client.name)
827
while sent_size < len(client.secret):
828
sent = session.send(client.secret[sent_size:])
829
logger.debug(u"Sent: %d, remaining: %d",
830
sent, len(client.secret)
831
- (sent_size + sent))
1842
if approval_required:
1843
client.approvals_pending -= 1
1846
except gnutls.errors.GNUTLSError as error:
1847
logger.warning("GnuTLS bye failed",
836
1851
def peer_certificate(session):
837
1852
"Return the peer's OpenPGP certificate as a bytestring"
838
1853
# If not an OpenPGP certificate...
839
if (gnutls.library.functions
840
.gnutls_certificate_type_get(session._c_object)
1854
if (gnutls.library.functions.gnutls_certificate_type_get(
841
1856
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
842
1857
# ...do the normal thing
843
1858
return session.peer_certificate
983
2048
clients: set of Client objects
984
2049
gnutls_priority GnuTLS priority string
985
2050
use_dbus: Boolean; to emit D-Bus signals or not
986
clients: set of Client objects
987
gnutls_priority GnuTLS priority string
988
use_dbus: Boolean; to emit D-Bus signals or not
990
2052
Assumes a gobject.MainLoop event loop.
992
2055
def __init__(self, server_address, RequestHandlerClass,
993
interface=None, use_ipv6=True, clients=None,
994
gnutls_priority=None, use_dbus=True):
2059
gnutls_priority=None,
995
2062
self.enabled = False
996
2063
self.clients = clients
997
2064
if self.clients is None:
999
2066
self.use_dbus = use_dbus
1000
2067
self.gnutls_priority = gnutls_priority
1001
2068
IPv6_TCPServer.__init__(self, server_address,
1002
2069
RequestHandlerClass,
1003
2070
interface = interface,
1004
use_ipv6 = use_ipv6)
2071
use_ipv6 = use_ipv6,
2072
socketfd = socketfd)
1005
2074
def server_activate(self):
1006
2075
if self.enabled:
1007
2076
return socketserver.TCPServer.server_activate(self)
1008
2078
def enable(self):
1009
2079
self.enabled = True
1010
def add_pipe(self, pipe):
2081
def add_pipe(self, parent_pipe, proc):
1011
2082
# Call "handle_ipc" for both data and EOF events
1012
gobject.io_add_watch(pipe, gobject.IO_IN | gobject.IO_HUP,
1014
def handle_ipc(self, source, condition, file_objects={}):
1016
gobject.IO_IN: u"IN", # There is data to read.
1017
gobject.IO_OUT: u"OUT", # Data can be written (without
1019
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1020
gobject.IO_ERR: u"ERR", # Error condition.
1021
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1022
# broken, usually for pipes and
1025
conditions_string = ' | '.join(name
1027
condition_names.iteritems()
1028
if cond & condition)
1029
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1032
# Turn the pipe file descriptor into a Python file object
1033
if source not in file_objects:
1034
file_objects[source] = os.fdopen(source, u"r", 1)
1036
# Read a line from the file object
1037
cmdline = file_objects[source].readline()
1038
if not cmdline: # Empty line means end of file
1039
# close the IPC pipe
1040
file_objects[source].close()
1041
del file_objects[source]
1043
# Stop calling this function
1046
logger.debug(u"IPC command: %r", cmdline)
1048
# Parse and act on command
1049
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1051
if cmd == u"NOTFOUND":
1052
logger.warning(u"Client not found for fingerprint: %s",
1056
mandos_dbus_service.ClientNotFound(args)
1057
elif cmd == u"INVALID":
1058
for client in self.clients:
1059
if client.name == args:
1060
logger.warning(u"Client %s is invalid", args)
1066
logger.error(u"Unknown client %s is invalid", args)
1067
elif cmd == u"SENDING":
1068
for client in self.clients:
1069
if client.name == args:
1070
logger.info(u"Sending secret to %s", client.name)
1074
client.ReceivedSecret()
1077
logger.error(u"Sending secret to unknown client %s",
2083
gobject.io_add_watch(
2084
parent_pipe.fileno(),
2085
gobject.IO_IN | gobject.IO_HUP,
2086
functools.partial(self.handle_ipc,
2087
parent_pipe = parent_pipe,
2090
def handle_ipc(self, source, condition,
2093
client_object=None):
2094
# error, or the other end of multiprocessing.Pipe has closed
2095
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2096
# Wait for other process to exit
2100
# Read a request from the child
2101
request = parent_pipe.recv()
2102
command = request[0]
2104
if command == 'init':
2106
address = request[2]
2108
for c in self.clients.itervalues():
2109
if c.fingerprint == fpr:
2113
logger.info("Client not found for fingerprint: %s, ad"
2114
"dress: %s", fpr, address)
2117
mandos_dbus_service.ClientNotFound(fpr,
2119
parent_pipe.send(False)
2122
gobject.io_add_watch(
2123
parent_pipe.fileno(),
2124
gobject.IO_IN | gobject.IO_HUP,
2125
functools.partial(self.handle_ipc,
2126
parent_pipe = parent_pipe,
2128
client_object = client))
2129
parent_pipe.send(True)
2130
# remove the old hook in favor of the new above hook on
2133
if command == 'funcall':
2134
funcname = request[1]
2138
parent_pipe.send(('data', getattr(client_object,
2142
if command == 'getattr':
2143
attrname = request[1]
2144
if callable(client_object.__getattribute__(attrname)):
2145
parent_pipe.send(('function', ))
2148
'data', client_object.__getattribute__(attrname)))
2150
if command == 'setattr':
2151
attrname = request[1]
2153
setattr(client_object, attrname, value)
2158
def rfc3339_duration_to_delta(duration):
2159
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2161
>>> rfc3339_duration_to_delta("P7D")
2162
datetime.timedelta(7)
2163
>>> rfc3339_duration_to_delta("PT60S")
2164
datetime.timedelta(0, 60)
2165
>>> rfc3339_duration_to_delta("PT60M")
2166
datetime.timedelta(0, 3600)
2167
>>> rfc3339_duration_to_delta("PT24H")
2168
datetime.timedelta(1)
2169
>>> rfc3339_duration_to_delta("P1W")
2170
datetime.timedelta(7)
2171
>>> rfc3339_duration_to_delta("PT5M30S")
2172
datetime.timedelta(0, 330)
2173
>>> rfc3339_duration_to_delta("P1DT3M20S")
2174
datetime.timedelta(1, 200)
2177
# Parsing an RFC 3339 duration with regular expressions is not
2178
# possible - there would have to be multiple places for the same
2179
# values, like seconds. The current code, while more esoteric, is
2180
# cleaner without depending on a parsing library. If Python had a
2181
# built-in library for parsing we would use it, but we'd like to
2182
# avoid excessive use of external libraries.
2184
# New type for defining tokens, syntax, and semantics all-in-one
2185
Token = collections.namedtuple("Token", (
2186
"regexp", # To match token; if "value" is not None, must have
2187
# a "group" containing digits
2188
"value", # datetime.timedelta or None
2189
"followers")) # Tokens valid after this token
2190
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2191
# the "duration" ABNF definition in RFC 3339, Appendix A.
2192
token_end = Token(re.compile(r"$"), None, frozenset())
2193
token_second = Token(re.compile(r"(\d+)S"),
2194
datetime.timedelta(seconds=1),
2195
frozenset((token_end, )))
2196
token_minute = Token(re.compile(r"(\d+)M"),
2197
datetime.timedelta(minutes=1),
2198
frozenset((token_second, token_end)))
2199
token_hour = Token(re.compile(r"(\d+)H"),
2200
datetime.timedelta(hours=1),
2201
frozenset((token_minute, token_end)))
2202
token_time = Token(re.compile(r"T"),
2204
frozenset((token_hour, token_minute,
2206
token_day = Token(re.compile(r"(\d+)D"),
2207
datetime.timedelta(days=1),
2208
frozenset((token_time, token_end)))
2209
token_month = Token(re.compile(r"(\d+)M"),
2210
datetime.timedelta(weeks=4),
2211
frozenset((token_day, token_end)))
2212
token_year = Token(re.compile(r"(\d+)Y"),
2213
datetime.timedelta(weeks=52),
2214
frozenset((token_month, token_end)))
2215
token_week = Token(re.compile(r"(\d+)W"),
2216
datetime.timedelta(weeks=1),
2217
frozenset((token_end, )))
2218
token_duration = Token(re.compile(r"P"), None,
2219
frozenset((token_year, token_month,
2220
token_day, token_time,
2222
# Define starting values
2223
value = datetime.timedelta() # Value so far
2225
followers = frozenset((token_duration, )) # Following valid tokens
2226
s = duration # String left to parse
2227
# Loop until end token is found
2228
while found_token is not token_end:
2229
# Search for any currently valid tokens
2230
for token in followers:
2231
match = token.regexp.match(s)
2232
if match is not None:
2234
if token.value is not None:
2235
# Value found, parse digits
2236
factor = int(match.group(1), 10)
2237
# Add to value so far
2238
value += factor * token.value
2239
# Strip token from string
2240
s = token.regexp.sub("", s, 1)
2243
# Set valid next tokens
2244
followers = found_token.followers
1080
logger.error(u"Unknown IPC command: %r", cmdline)
1082
# Keep calling this function
2247
# No currently valid tokens were found
2248
raise ValueError("Invalid RFC 3339 duration: {!r}"
1086
2254
def string_to_delta(interval):
1087
2255
"""Parse a string and return a datetime.timedelta
1089
>>> string_to_delta(u'7d')
2257
>>> string_to_delta('7d')
1090
2258
datetime.timedelta(7)
1091
>>> string_to_delta(u'60s')
2259
>>> string_to_delta('60s')
1092
2260
datetime.timedelta(0, 60)
1093
>>> string_to_delta(u'60m')
2261
>>> string_to_delta('60m')
1094
2262
datetime.timedelta(0, 3600)
1095
>>> string_to_delta(u'24h')
2263
>>> string_to_delta('24h')
1096
2264
datetime.timedelta(1)
1097
>>> string_to_delta(u'1w')
2265
>>> string_to_delta('1w')
1098
2266
datetime.timedelta(7)
1099
>>> string_to_delta(u'5m 30s')
2267
>>> string_to_delta('5m 30s')
1100
2268
datetime.timedelta(0, 330)
2272
return rfc3339_duration_to_delta(interval)
1102
2276
timevalue = datetime.timedelta(0)
1103
2277
for s in interval.split():
1105
suffix = unicode(s[-1])
1106
2280
value = int(s[:-1])
1108
2282
delta = datetime.timedelta(value)
1109
elif suffix == u"s":
1110
2284
delta = datetime.timedelta(0, value)
1111
elif suffix == u"m":
1112
2286
delta = datetime.timedelta(0, 0, 0, 0, value)
1113
elif suffix == u"h":
1114
2288
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1115
elif suffix == u"w":
1116
2290
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1119
except (ValueError, IndexError):
2292
raise ValueError("Unknown suffix {!r}".format(suffix))
2293
except IndexError as e:
2294
raise ValueError(*(e.args))
1121
2295
timevalue += delta
1122
2296
return timevalue
1125
def if_nametoindex(interface):
1126
"""Call the C function if_nametoindex(), or equivalent
1128
Note: This function cannot accept a unicode string."""
1129
global if_nametoindex
1131
if_nametoindex = (ctypes.cdll.LoadLibrary
1132
(ctypes.util.find_library(u"c"))
1134
except (OSError, AttributeError):
1135
logger.warning(u"Doing if_nametoindex the hard way")
1136
def if_nametoindex(interface):
1137
"Get an interface index the hard way, i.e. using fcntl()"
1138
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1139
with closing(socket.socket()) as s:
1140
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1141
struct.pack(str(u"16s16x"),
1143
interface_index = struct.unpack(str(u"I"),
1145
return interface_index
1146
return if_nametoindex(interface)
1149
2299
def daemon(nochdir = False, noclose = False):
1150
2300
"""See daemon(3). Standard BSD Unix function.
1175
######################################################################
2326
##################################################################
1176
2327
# Parsing of options, both command line and config file
1178
parser = optparse.OptionParser(version = "%%prog %s" % version)
1179
parser.add_option("-i", u"--interface", type=u"string",
1180
metavar="IF", help=u"Bind to interface IF")
1181
parser.add_option("-a", u"--address", type=u"string",
1182
help=u"Address to listen for requests on")
1183
parser.add_option("-p", u"--port", type=u"int",
1184
help=u"Port number to receive requests on")
1185
parser.add_option("--check", action=u"store_true",
1186
help=u"Run self-test")
1187
parser.add_option("--debug", action=u"store_true",
1188
help=u"Debug mode; run in foreground and log to"
1190
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1191
u" priority string (see GnuTLS documentation)")
1192
parser.add_option("--servicename", type=u"string",
1193
metavar=u"NAME", help=u"Zeroconf service name")
1194
parser.add_option("--configdir", type=u"string",
1195
default=u"/etc/mandos", metavar=u"DIR",
1196
help=u"Directory to search for configuration"
1198
parser.add_option("--no-dbus", action=u"store_false",
1199
dest=u"use_dbus", help=u"Do not provide D-Bus"
1200
u" system bus interface")
1201
parser.add_option("--no-ipv6", action=u"store_false",
1202
dest=u"use_ipv6", help=u"Do not use IPv6")
1203
options = parser.parse_args()[0]
2329
parser = argparse.ArgumentParser()
2330
parser.add_argument("-v", "--version", action="version",
2331
version = "%(prog)s {}".format(version),
2332
help="show version number and exit")
2333
parser.add_argument("-i", "--interface", metavar="IF",
2334
help="Bind to interface IF")
2335
parser.add_argument("-a", "--address",
2336
help="Address to listen for requests on")
2337
parser.add_argument("-p", "--port", type=int,
2338
help="Port number to receive requests on")
2339
parser.add_argument("--check", action="store_true",
2340
help="Run self-test")
2341
parser.add_argument("--debug", action="store_true",
2342
help="Debug mode; run in foreground and log"
2343
" to terminal", default=None)
2344
parser.add_argument("--debuglevel", metavar="LEVEL",
2345
help="Debug level for stdout output")
2346
parser.add_argument("--priority", help="GnuTLS"
2347
" priority string (see GnuTLS documentation)")
2348
parser.add_argument("--servicename",
2349
metavar="NAME", help="Zeroconf service name")
2350
parser.add_argument("--configdir",
2351
default="/etc/mandos", metavar="DIR",
2352
help="Directory to search for configuration"
2354
parser.add_argument("--no-dbus", action="store_false",
2355
dest="use_dbus", help="Do not provide D-Bus"
2356
" system bus interface", default=None)
2357
parser.add_argument("--no-ipv6", action="store_false",
2358
dest="use_ipv6", help="Do not use IPv6",
2360
parser.add_argument("--no-restore", action="store_false",
2361
dest="restore", help="Do not restore stored"
2362
" state", default=None)
2363
parser.add_argument("--socket", type=int,
2364
help="Specify a file descriptor to a network"
2365
" socket to use instead of creating one")
2366
parser.add_argument("--statedir", metavar="DIR",
2367
help="Directory to save/restore state in")
2368
parser.add_argument("--foreground", action="store_true",
2369
help="Run in foreground", default=None)
2370
parser.add_argument("--no-zeroconf", action="store_false",
2371
dest="zeroconf", help="Do not use Zeroconf",
2374
options = parser.parse_args()
1205
2376
if options.check:
2378
fail_count, test_count = doctest.testmod()
2379
sys.exit(os.EX_OK if fail_count == 0 else 1)
1210
2381
# Default values for config file for server-global settings
1211
server_defaults = { u"interface": u"",
1216
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1217
u"servicename": u"Mandos",
1218
u"use_dbus": u"True",
1219
u"use_ipv6": u"True",
2382
server_defaults = { "interface": "",
2387
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2388
":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2389
"servicename": "Mandos",
2395
"statedir": "/var/lib/mandos",
2396
"foreground": "False",
1222
2400
# Parse config file for server-global settings
1223
2401
server_config = configparser.SafeConfigParser(server_defaults)
1224
2402
del server_defaults
1225
server_config.read(os.path.join(options.configdir,
2403
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1227
2404
# Convert the SafeConfigParser object to a dict
1228
2405
server_settings = server_config.defaults()
1229
2406
# Use the appropriate methods on the non-string config options
1230
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1231
server_settings[option] = server_config.getboolean(u"DEFAULT",
2407
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2408
server_settings[option] = server_config.getboolean("DEFAULT",
1233
2410
if server_settings["port"]:
1234
server_settings["port"] = server_config.getint(u"DEFAULT",
2411
server_settings["port"] = server_config.getint("DEFAULT",
2413
if server_settings["socket"]:
2414
server_settings["socket"] = server_config.getint("DEFAULT",
2416
# Later, stdin will, and stdout and stderr might, be dup'ed
2417
# over with an opened os.devnull. But we don't want this to
2418
# happen with a supplied network socket.
2419
if 0 <= server_settings["socket"] <= 2:
2420
server_settings["socket"] = os.dup(server_settings
1236
2422
del server_config
1238
2424
# Override the settings from the config file with command line
1239
2425
# options, if set.
1240
for option in (u"interface", u"address", u"port", u"debug",
1241
u"priority", u"servicename", u"configdir",
1242
u"use_dbus", u"use_ipv6"):
2426
for option in ("interface", "address", "port", "debug",
2427
"priority", "servicename", "configdir", "use_dbus",
2428
"use_ipv6", "debuglevel", "restore", "statedir",
2429
"socket", "foreground", "zeroconf"):
1243
2430
value = getattr(options, option)
1244
2431
if value is not None:
1245
2432
server_settings[option] = value
1247
2434
# Force all strings to be unicode
1248
2435
for option in server_settings.keys():
1249
if type(server_settings[option]) is str:
1250
server_settings[option] = unicode(server_settings[option])
2436
if isinstance(server_settings[option], bytes):
2437
server_settings[option] = (server_settings[option]
2439
# Force all boolean options to be boolean
2440
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2441
"foreground", "zeroconf"):
2442
server_settings[option] = bool(server_settings[option])
2443
# Debug implies foreground
2444
if server_settings["debug"]:
2445
server_settings["foreground"] = True
1251
2446
# Now we have our good server settings in "server_settings"
1253
2448
##################################################################
2450
if (not server_settings["zeroconf"]
2451
and not (server_settings["port"]
2452
or server_settings["socket"] != "")):
2453
parser.error("Needs port or socket to work without Zeroconf")
1255
2455
# For convenience
1256
debug = server_settings[u"debug"]
1257
use_dbus = server_settings[u"use_dbus"]
1258
use_ipv6 = server_settings[u"use_ipv6"]
1261
syslogger.setLevel(logging.WARNING)
1262
console.setLevel(logging.WARNING)
1264
if server_settings[u"servicename"] != u"Mandos":
1265
syslogger.setFormatter(logging.Formatter
1266
(u'Mandos (%s) [%%(process)d]:'
1267
u' %%(levelname)s: %%(message)s'
1268
% server_settings[u"servicename"]))
2456
debug = server_settings["debug"]
2457
debuglevel = server_settings["debuglevel"]
2458
use_dbus = server_settings["use_dbus"]
2459
use_ipv6 = server_settings["use_ipv6"]
2460
stored_state_path = os.path.join(server_settings["statedir"],
2462
foreground = server_settings["foreground"]
2463
zeroconf = server_settings["zeroconf"]
2466
initlogger(debug, logging.DEBUG)
2471
level = getattr(logging, debuglevel.upper())
2472
initlogger(debug, level)
2474
if server_settings["servicename"] != "Mandos":
2475
syslogger.setFormatter(
2476
logging.Formatter('Mandos ({}) [%(process)d]:'
2477
' %(levelname)s: %(message)s'.format(
2478
server_settings["servicename"])))
1270
2480
# Parse config file with clients
1271
client_defaults = { u"timeout": u"1h",
1273
u"checker": u"fping -q -- %%(host)s",
1276
client_config = configparser.SafeConfigParser(client_defaults)
1277
client_config.read(os.path.join(server_settings[u"configdir"],
2481
client_config = configparser.SafeConfigParser(Client
2483
client_config.read(os.path.join(server_settings["configdir"],
1280
2486
global mandos_dbus_service
1281
2487
mandos_dbus_service = None
1283
tcp_server = MandosServer((server_settings[u"address"],
1284
server_settings[u"port"]),
1286
interface=server_settings[u"interface"],
1289
server_settings[u"priority"],
1291
pidfilename = u"/var/run/mandos.pid"
1293
pidfile = open(pidfilename, u"w")
1295
logger.error(u"Could not open file %r", pidfilename)
2490
if server_settings["socket"] != "":
2491
socketfd = server_settings["socket"]
2492
tcp_server = MandosServer(
2493
(server_settings["address"], server_settings["port"]),
2495
interface=(server_settings["interface"] or None),
2497
gnutls_priority=server_settings["priority"],
2501
pidfilename = "/run/mandos.pid"
2502
if not os.path.isdir("/run/."):
2503
pidfilename = "/var/run/mandos.pid"
2506
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2507
except IOError as e:
2508
logger.error("Could not open file %r", pidfilename,
1298
uid = pwd.getpwnam(u"_mandos").pw_uid
1299
gid = pwd.getpwnam(u"_mandos").pw_gid
2511
for name in ("_mandos", "mandos", "nobody"):
1302
uid = pwd.getpwnam(u"mandos").pw_uid
1303
gid = pwd.getpwnam(u"mandos").pw_gid
2513
uid = pwd.getpwnam(name).pw_uid
2514
gid = pwd.getpwnam(name).pw_gid
1304
2516
except KeyError:
1306
uid = pwd.getpwnam(u"nobody").pw_uid
1307
gid = pwd.getpwnam(u"nobody").pw_gid
1314
except OSError, error:
1315
if error[0] != errno.EPERM:
2524
except OSError as error:
2525
if error.errno != errno.EPERM:
1318
# Enable all possible GnuTLS debugging
2529
# Enable all possible GnuTLS debugging
1320
2531
# "Use a log level over 10 to enable all debugging options."
1321
2532
# - GnuTLS manual
1322
2533
gnutls.library.functions.gnutls_global_set_log_level(11)
1324
2535
@gnutls.library.types.gnutls_log_func
1325
2536
def debug_gnutls(level, string):
1326
logger.debug(u"GnuTLS: %s", string[:-1])
1328
(gnutls.library.functions
1329
.gnutls_global_set_log_function(debug_gnutls))
2537
logger.debug("GnuTLS: %s", string[:-1])
2539
gnutls.library.functions.gnutls_global_set_log_function(
2542
# Redirect stdin so all checkers get /dev/null
2543
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2544
os.dup2(null, sys.stdin.fileno())
2548
# Need to fork before connecting to D-Bus
2550
# Close all input and output, do double fork, etc.
2553
# multiprocessing will use threads, so before we use gobject we
2554
# need to inform gobject that threads will be used.
2555
gobject.threads_init()
1331
2557
global main_loop
1332
2558
# From the Avahi example code
1333
DBusGMainLoop(set_as_default=True )
2559
DBusGMainLoop(set_as_default=True)
1334
2560
main_loop = gobject.MainLoop()
1335
2561
bus = dbus.SystemBus()
1336
2562
# End of Avahi example code
1338
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
1339
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1340
service = AvahiService(name = server_settings[u"servicename"],
1341
servicetype = u"_mandos._tcp",
1342
protocol = protocol, bus = bus)
1343
if server_settings["interface"]:
1344
service.interface = (if_nametoindex
1345
(str(server_settings[u"interface"])))
2565
bus_name = dbus.service.BusName("se.recompile.Mandos",
2568
old_bus_name = dbus.service.BusName(
2569
"se.bsnet.fukt.Mandos", bus,
2571
except dbus.exceptions.DBusException as e:
2572
logger.error("Disabling D-Bus:", exc_info=e)
2574
server_settings["use_dbus"] = False
2575
tcp_server.use_dbus = False
2577
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2578
service = AvahiServiceToSyslog(
2579
name = server_settings["servicename"],
2580
servicetype = "_mandos._tcp",
2581
protocol = protocol,
2583
if server_settings["interface"]:
2584
service.interface = if_nametoindex(
2585
server_settings["interface"].encode("utf-8"))
2587
global multiprocessing_manager
2588
multiprocessing_manager = multiprocessing.Manager()
1347
2590
client_class = Client
1349
2592
client_class = functools.partial(ClientDBus, bus = bus)
1350
tcp_server.clients.update(set(
1351
client_class(name = section,
1352
config= dict(client_config.items(section)))
1353
for section in client_config.sections()))
2594
client_settings = Client.config_parser(client_config)
2595
old_client_settings = {}
2598
# This is used to redirect stdout and stderr for checker processes
2600
wnull = open(os.devnull, "w") # A writable /dev/null
2601
# Only used if server is running in foreground but not in debug
2603
if debug or not foreground:
2606
# Get client data and settings from last running state.
2607
if server_settings["restore"]:
2609
with open(stored_state_path, "rb") as stored_state:
2610
clients_data, old_client_settings = pickle.load(
2612
os.remove(stored_state_path)
2613
except IOError as e:
2614
if e.errno == errno.ENOENT:
2615
logger.warning("Could not load persistent state:"
2616
" {}".format(os.strerror(e.errno)))
2618
logger.critical("Could not load persistent state:",
2621
except EOFError as e:
2622
logger.warning("Could not load persistent state: "
2626
with PGPEngine() as pgp:
2627
for client_name, client in clients_data.items():
2628
# Skip removed clients
2629
if client_name not in client_settings:
2632
# Decide which value to use after restoring saved state.
2633
# We have three different values: Old config file,
2634
# new config file, and saved state.
2635
# New config value takes precedence if it differs from old
2636
# config value, otherwise use saved state.
2637
for name, value in client_settings[client_name].items():
2639
# For each value in new config, check if it
2640
# differs from the old config value (Except for
2641
# the "secret" attribute)
2642
if (name != "secret"
2644
old_client_settings[client_name][name])):
2645
client[name] = value
2649
# Clients who has passed its expire date can still be
2650
# enabled if its last checker was successful. Clients
2651
# whose checker succeeded before we stored its state is
2652
# assumed to have successfully run all checkers during
2654
if client["enabled"]:
2655
if datetime.datetime.utcnow() >= client["expires"]:
2656
if not client["last_checked_ok"]:
2658
"disabling client {} - Client never "
2659
"performed a successful checker".format(
2661
client["enabled"] = False
2662
elif client["last_checker_status"] != 0:
2664
"disabling client {} - Client last"
2665
" checker failed with error code"
2668
client["last_checker_status"]))
2669
client["enabled"] = False
2671
client["expires"] = (
2672
datetime.datetime.utcnow()
2673
+ client["timeout"])
2674
logger.debug("Last checker succeeded,"
2675
" keeping {} enabled".format(
2678
client["secret"] = pgp.decrypt(
2679
client["encrypted_secret"],
2680
client_settings[client_name]["secret"])
2682
# If decryption fails, we use secret from new settings
2683
logger.debug("Failed to decrypt {} old secret".format(
2685
client["secret"] = (client_settings[client_name]
2688
# Add/remove clients based on new changes made to config
2689
for client_name in (set(old_client_settings)
2690
- set(client_settings)):
2691
del clients_data[client_name]
2692
for client_name in (set(client_settings)
2693
- set(old_client_settings)):
2694
clients_data[client_name] = client_settings[client_name]
2696
# Create all client objects
2697
for client_name, client in clients_data.items():
2698
tcp_server.clients[client_name] = client_class(
2701
server_settings = server_settings)
1354
2703
if not tcp_server.clients:
1355
logger.warning(u"No clients defined")
1358
# Redirect stdin so all checkers get /dev/null
1359
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1360
os.dup2(null, sys.stdin.fileno())
1364
# No console logging
1365
logger.removeHandler(console)
1366
# Close all input and output, do double fork, etc.
1370
with closing(pidfile):
2704
logger.warning("No clients defined")
2707
if pidfile is not None:
1371
2708
pid = os.getpid()
1372
pidfile.write(str(pid) + "\n")
2711
print(pid, file=pidfile)
2713
logger.error("Could not write to file %r with PID %d",
1375
logger.error(u"Could not write to file %r with PID %d",
1378
# "pidfile" was never created
1383
"Cleanup function; run on exit"
1386
while tcp_server.clients:
1387
client = tcp_server.clients.pop()
1388
client.disable_hook = None
1391
atexit.register(cleanup)
1394
signal.signal(signal.SIGINT, signal.SIG_IGN)
1395
2718
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1396
2719
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1399
class MandosDBusService(dbus.service.Object):
2723
@alternate_dbus_interfaces(
2724
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2725
class MandosDBusService(DBusObjectWithProperties):
1400
2726
"""A D-Bus proxy object"""
1401
2728
def __init__(self):
1402
dbus.service.Object.__init__(self, bus, u"/")
1403
_interface = u"se.bsnet.fukt.Mandos"
1405
@dbus.service.signal(_interface, signature=u"oa{sv}")
1406
def ClientAdded(self, objpath, properties):
1410
@dbus.service.signal(_interface, signature=u"s")
1411
def ClientNotFound(self, fingerprint):
1415
@dbus.service.signal(_interface, signature=u"os")
2729
dbus.service.Object.__init__(self, bus, "/")
2731
_interface = "se.recompile.Mandos"
2733
@dbus_interface_annotations(_interface)
2736
"org.freedesktop.DBus.Property.EmitsChangedSignal":
2739
@dbus.service.signal(_interface, signature="o")
2740
def ClientAdded(self, objpath):
2744
@dbus.service.signal(_interface, signature="ss")
2745
def ClientNotFound(self, fingerprint, address):
2749
@dbus.service.signal(_interface, signature="os")
1416
2750
def ClientRemoved(self, objpath, name):
1420
@dbus.service.method(_interface, out_signature=u"ao")
2754
@dbus.service.method(_interface, out_signature="ao")
1421
2755
def GetAllClients(self):
1423
return dbus.Array(c.dbus_object_path
1424
for c in tcp_server.clients)
2757
return dbus.Array(c.dbus_object_path for c in
2758
tcp_server.clients.itervalues())
1426
2760
@dbus.service.method(_interface,
1427
out_signature=u"a{oa{sv}}")
2761
out_signature="a{oa{sv}}")
1428
2762
def GetAllClientsWithProperties(self):
1430
2764
return dbus.Dictionary(
1431
((c.dbus_object_path, c.GetAllProperties())
1432
for c in tcp_server.clients),
1433
signature=u"oa{sv}")
2765
{ c.dbus_object_path: c.GetAll("")
2766
for c in tcp_server.clients.itervalues() },
1435
@dbus.service.method(_interface, in_signature=u"o")
2769
@dbus.service.method(_interface, in_signature="o")
1436
2770
def RemoveClient(self, object_path):
1438
for c in tcp_server.clients:
2772
for c in tcp_server.clients.itervalues():
1439
2773
if c.dbus_object_path == object_path:
1440
tcp_server.clients.remove(c)
2774
del tcp_server.clients[c.name]
1441
2775
c.remove_from_connection()
1442
2776
# Don't signal anything except ClientRemoved
1443
c.disable(signal=False)
2777
c.disable(quiet=True)
1444
2778
# Emit D-Bus signal
1445
2779
self.ClientRemoved(object_path, c.name)
2781
raise KeyError(object_path)
1451
2785
mandos_dbus_service = MandosDBusService()
1453
for client in tcp_server.clients:
2788
"Cleanup function; run on exit"
2792
multiprocessing.active_children()
2794
if not (tcp_server.clients or client_settings):
2797
# Store client before exiting. Secrets are encrypted with key
2798
# based on what config file has. If config file is
2799
# removed/edited, old secret will thus be unrecovable.
2801
with PGPEngine() as pgp:
2802
for client in tcp_server.clients.itervalues():
2803
key = client_settings[client.name]["secret"]
2804
client.encrypted_secret = pgp.encrypt(client.secret,
2808
# A list of attributes that can not be pickled
2810
exclude = { "bus", "changedstate", "secret",
2811
"checker", "server_settings" }
2812
for name, typ in inspect.getmembers(dbus.service
2816
client_dict["encrypted_secret"] = (client
2818
for attr in client.client_structure:
2819
if attr not in exclude:
2820
client_dict[attr] = getattr(client, attr)
2822
clients[client.name] = client_dict
2823
del client_settings[client.name]["secret"]
2826
with tempfile.NamedTemporaryFile(
2830
dir=os.path.dirname(stored_state_path),
2831
delete=False) as stored_state:
2832
pickle.dump((clients, client_settings), stored_state)
2833
tempname = stored_state.name
2834
os.rename(tempname, stored_state_path)
2835
except (IOError, OSError) as e:
2841
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2842
logger.warning("Could not save persistent state: {}"
2843
.format(os.strerror(e.errno)))
2845
logger.warning("Could not save persistent state:",
2849
# Delete all clients, and settings from config
2850
while tcp_server.clients:
2851
name, client = tcp_server.clients.popitem()
2853
client.remove_from_connection()
2854
# Don't signal anything except ClientRemoved
2855
client.disable(quiet=True)
2858
mandos_dbus_service.ClientRemoved(
2859
client.dbus_object_path, client.name)
2860
client_settings.clear()
2862
atexit.register(cleanup)
2864
for client in tcp_server.clients.itervalues():
1455
2866
# Emit D-Bus signal
1456
mandos_dbus_service.ClientAdded(client.dbus_object_path,
1457
client.GetAllProperties())
2867
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2868
# Need to initiate checking of clients
2870
client.init_checker()
1460
2872
tcp_server.enable()
1461
2873
tcp_server.server_activate()
1463
2875
# Find out what port we got
1464
service.port = tcp_server.socket.getsockname()[1]
2877
service.port = tcp_server.socket.getsockname()[1]
1466
logger.info(u"Now listening on address %r, port %d,"
1467
" flowinfo %d, scope_id %d"
1468
% tcp_server.socket.getsockname())
2879
logger.info("Now listening on address %r, port %d,"
2880
" flowinfo %d, scope_id %d",
2881
*tcp_server.socket.getsockname())
1470
logger.info(u"Now listening on address %r, port %d"
1471
% tcp_server.socket.getsockname())
2883
logger.info("Now listening on address %r, port %d",
2884
*tcp_server.socket.getsockname())
1473
2886
#service.interface = tcp_server.socket.getsockname()[3]
1476
# From the Avahi example code
1479
except dbus.exceptions.DBusException, error:
1480
logger.critical(u"DBusException: %s", error)
1482
# End of Avahi example code
2890
# From the Avahi example code
2893
except dbus.exceptions.DBusException as error:
2894
logger.critical("D-Bus Exception", exc_info=error)
2897
# End of Avahi example code
1484
2899
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1485
2900
lambda *args, **kwargs:
1486
2901
(tcp_server.handle_request
1487
2902
(*args[2:], **kwargs) or True))
1489
logger.debug(u"Starting main loop")
2904
logger.debug("Starting main loop")
1490
2905
main_loop.run()
1491
except AvahiError, error:
1492
logger.critical(u"AvahiError: %s", error)
2906
except AvahiError as error:
2907
logger.critical("Avahi Error", exc_info=error)
1494
2910
except KeyboardInterrupt:
1497
logger.debug(u"Server received KeyboardInterrupt")
1498
logger.debug(u"Server exiting")
2912
print("", file=sys.stderr)
2913
logger.debug("Server received KeyboardInterrupt")
2914
logger.debug("Server exiting")
2915
# Must run before the D-Bus bus name gets deregistered
1500
2919
if __name__ == '__main__':