140
290
self.rename_count = 0
141
291
self.max_renames = max_renames
142
292
self.protocol = protocol
293
self.group = None # our entry group
296
self.entry_group_state_changed_match = None
298
def rename(self, remove=True):
144
299
"""Derived from the Avahi example code"""
145
300
if self.rename_count >= self.max_renames:
146
logger.critical(u"No suitable Zeroconf service name found"
147
u" after %i retries, exiting.",
301
logger.critical("No suitable Zeroconf service name found"
302
" after %i retries, exiting.",
148
303
self.rename_count)
149
raise AvahiServiceError(u"Too many renames")
150
self.name = server.GetAlternativeServiceName(self.name)
151
logger.info(u"Changing Zeroconf service name to %r ...",
304
raise AvahiServiceError("Too many renames")
306
self.server.GetAlternativeServiceName(self.name))
307
self.rename_count += 1
308
logger.info("Changing Zeroconf service name to %r ...",
153
syslogger.setFormatter(logging.Formatter
154
(u'Mandos (%s) [%%(process)d]:'
155
u' %%(levelname)s: %%(message)s'
159
self.rename_count += 1
314
except dbus.exceptions.DBusException as error:
315
if (error.get_dbus_name()
316
== "org.freedesktop.Avahi.CollisionError"):
317
logger.info("Local Zeroconf service name collision.")
318
return self.rename(remove=False)
320
logger.critical("D-Bus Exception", exc_info=error)
160
324
def remove(self):
161
325
"""Derived from the Avahi example code"""
162
if group is not None:
326
if self.entry_group_state_changed_match is not None:
327
self.entry_group_state_changed_match.remove()
328
self.entry_group_state_changed_match = None
329
if self.group is not None:
165
333
"""Derived from the Avahi example code"""
168
group = dbus.Interface(bus.get_object
170
server.EntryGroupNew()),
171
avahi.DBUS_INTERFACE_ENTRY_GROUP)
172
group.connect_to_signal('StateChanged',
173
entry_group_state_changed)
174
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
175
service.name, service.type)
177
self.interface, # interface
178
self.protocol, # protocol
179
dbus.UInt32(0), # flags
180
self.name, self.type,
181
self.domain, self.host,
182
dbus.UInt16(self.port),
183
avahi.string_array_to_txt_array(self.TXT))
186
# From the Avahi example code:
187
group = None # our entry group
188
# End of Avahi example code
191
def _datetime_to_dbus(dt, variant_level=0):
192
"""Convert a UTC datetime.datetime() to a D-Bus type."""
193
return dbus.String(dt.isoformat(), variant_level=variant_level)
335
if self.group is None:
336
self.group = dbus.Interface(
337
self.bus.get_object(avahi.DBUS_NAME,
338
self.server.EntryGroupNew()),
339
avahi.DBUS_INTERFACE_ENTRY_GROUP)
340
self.entry_group_state_changed_match = (
341
self.group.connect_to_signal(
342
'StateChanged', self.entry_group_state_changed))
343
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
344
self.name, self.type)
345
self.group.AddService(
348
dbus.UInt32(0), # flags
349
self.name, self.type,
350
self.domain, self.host,
351
dbus.UInt16(self.port),
352
avahi.string_array_to_txt_array(self.TXT))
355
def entry_group_state_changed(self, state, error):
356
"""Derived from the Avahi example code"""
357
logger.debug("Avahi entry group state change: %i", state)
359
if state == avahi.ENTRY_GROUP_ESTABLISHED:
360
logger.debug("Zeroconf service established.")
361
elif state == avahi.ENTRY_GROUP_COLLISION:
362
logger.info("Zeroconf service name collision.")
364
elif state == avahi.ENTRY_GROUP_FAILURE:
365
logger.critical("Avahi: Error in group state changed %s",
367
raise AvahiGroupError("State changed: {!s}".format(error))
370
"""Derived from the Avahi example code"""
371
if self.group is not None:
374
except (dbus.exceptions.UnknownMethodException,
375
dbus.exceptions.DBusException):
380
def server_state_changed(self, state, error=None):
381
"""Derived from the Avahi example code"""
382
logger.debug("Avahi server state change: %i", state)
384
avahi.SERVER_INVALID: "Zeroconf server invalid",
385
avahi.SERVER_REGISTERING: None,
386
avahi.SERVER_COLLISION: "Zeroconf server name collision",
387
avahi.SERVER_FAILURE: "Zeroconf server failure",
389
if state in bad_states:
390
if bad_states[state] is not None:
392
logger.error(bad_states[state])
394
logger.error(bad_states[state] + ": %r", error)
396
elif state == avahi.SERVER_RUNNING:
400
logger.debug("Unknown state: %r", state)
402
logger.debug("Unknown state: %r: %r", state, error)
405
"""Derived from the Avahi example code"""
406
if self.server is None:
407
self.server = dbus.Interface(
408
self.bus.get_object(avahi.DBUS_NAME,
409
avahi.DBUS_PATH_SERVER,
410
follow_name_owner_changes=True),
411
avahi.DBUS_INTERFACE_SERVER)
412
self.server.connect_to_signal("StateChanged",
413
self.server_state_changed)
414
self.server_state_changed(self.server.GetState())
417
class AvahiServiceToSyslog(AvahiService):
418
def rename(self, *args, **kwargs):
419
"""Add the new name to the syslog messages"""
420
ret = AvahiService.rename(self, *args, **kwargs)
421
syslogger.setFormatter(logging.Formatter(
422
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
426
def subprocess_call_pipe(connection, # : multiprocessing.Connection
428
"""This function is meant to be called by multiprocessing.Process
430
This function runs a synchronous subprocess.call(), and writes the
431
resulting return code on the provided multiprocessing.Connection.
433
connection.send(subprocess.call(*args, **kwargs))
196
436
class Client(object):
197
437
"""A representation of a client host served by this server.
200
name: string; from the config file, used in log messages and
202
fingerprint: string (40 or 32 hexadecimal digits); used to
203
uniquely identify the client
204
secret: bytestring; sent verbatim (over TLS) to client
205
host: string; available for use by the checker command
206
created: datetime.datetime(); (UTC) object creation
207
last_enabled: datetime.datetime(); (UTC)
209
last_checked_ok: datetime.datetime(); (UTC) or None
210
timeout: datetime.timedelta(); How long from last_checked_ok
211
until this client is invalid
212
interval: datetime.timedelta(); How often to start a new checker
213
disable_hook: If set, called by disable() as disable_hook(self)
440
approved: bool(); 'None' if not yet approved/disapproved
441
approval_delay: datetime.timedelta(); Time to wait for approval
442
approval_duration: datetime.timedelta(); Duration of one approval
214
443
checker: subprocess.Popen(); a running checker process used
215
444
to see if the client lives.
216
445
'None' if no process is running.
217
checker_initiator_tag: a gobject event source tag, or None
218
disable_initiator_tag: - '' -
219
checker_callback_tag: - '' -
220
checker_command: string; External command which is run to check if
221
client lives. %() expansions are done at
446
checker_callback_tag: a gobject event source tag, or None
447
checker_command: string; External command which is run to check
448
if client lives. %() expansions are done at
222
449
runtime with vars(self) as dict, so that for
223
450
instance %(name)s can be used in the command.
451
checker_initiator_tag: a gobject event source tag, or None
452
created: datetime.datetime(); (UTC) object creation
453
client_structure: Object describing what attributes a client has
454
and is used for storing the client at exit
224
455
current_checker_command: string; current running checker_command
456
disable_initiator_tag: a gobject event source tag, or None
458
fingerprint: string (40 or 32 hexadecimal digits); used to
459
uniquely identify the client
460
host: string; available for use by the checker command
461
interval: datetime.timedelta(); How often to start a new checker
462
last_approval_request: datetime.datetime(); (UTC) or None
463
last_checked_ok: datetime.datetime(); (UTC) or None
464
last_checker_status: integer between 0 and 255 reflecting exit
465
status of last checker. -1 reflects crashed
466
checker, -2 means no checker completed yet.
467
last_checker_signal: The signal which killed the last checker, if
468
last_checker_status is -1
469
last_enabled: datetime.datetime(); (UTC) or None
470
name: string; from the config file, used in log messages and
472
secret: bytestring; sent verbatim (over TLS) to client
473
timeout: datetime.timedelta(); How long from last_checked_ok
474
until this client is disabled
475
extended_timeout: extra long timeout when secret has been sent
476
runtime_expansions: Allowed attributes for runtime expansion.
477
expires: datetime.datetime(); time (UTC) when a client will be
479
server_settings: The server_settings dict from main()
482
runtime_expansions = ("approval_delay", "approval_duration",
483
"created", "enabled", "expires",
484
"fingerprint", "host", "interval",
485
"last_approval_request", "last_checked_ok",
486
"last_enabled", "name", "timeout")
489
"extended_timeout": "PT15M",
491
"checker": "fping -q -- %%(host)s",
493
"approval_delay": "PT0S",
494
"approval_duration": "PT1S",
495
"approved_by_default": "True",
228
def _datetime_to_milliseconds(dt):
229
"Convert a datetime.datetime() to milliseconds"
230
return ((dt.days * 24 * 60 * 60 * 1000)
231
+ (dt.seconds * 1000)
232
+ (dt.microseconds // 1000))
234
def timeout_milliseconds(self):
235
"Return the 'timeout' attribute in milliseconds"
236
return self._datetime_to_milliseconds(self.timeout)
238
def interval_milliseconds(self):
239
"Return the 'interval' attribute in milliseconds"
240
return self._datetime_to_milliseconds(self.interval)
242
def __init__(self, name = None, disable_hook=None, config=None):
243
"""Note: the 'checker' key in 'config' sets the
244
'checker_command' attribute and *not* the 'checker'
500
def config_parser(config):
501
"""Construct a new dict of client settings of this form:
502
{ client_name: {setting_name: value, ...}, ...}
503
with exceptions for any special settings as defined above.
504
NOTE: Must be a pure function. Must return the same result
505
value given the same arguments.
508
for client_name in config.sections():
509
section = dict(config.items(client_name))
510
client = settings[client_name] = {}
512
client["host"] = section["host"]
513
# Reformat values from string types to Python types
514
client["approved_by_default"] = config.getboolean(
515
client_name, "approved_by_default")
516
client["enabled"] = config.getboolean(client_name,
519
# Uppercase and remove spaces from fingerprint for later
520
# comparison purposes with return value from the
521
# fingerprint() function
522
client["fingerprint"] = (section["fingerprint"].upper()
524
if "secret" in section:
525
client["secret"] = section["secret"].decode("base64")
526
elif "secfile" in section:
527
with open(os.path.expanduser(os.path.expandvars
528
(section["secfile"])),
530
client["secret"] = secfile.read()
532
raise TypeError("No secret or secfile for section {}"
534
client["timeout"] = string_to_delta(section["timeout"])
535
client["extended_timeout"] = string_to_delta(
536
section["extended_timeout"])
537
client["interval"] = string_to_delta(section["interval"])
538
client["approval_delay"] = string_to_delta(
539
section["approval_delay"])
540
client["approval_duration"] = string_to_delta(
541
section["approval_duration"])
542
client["checker_command"] = section["checker"]
543
client["last_approval_request"] = None
544
client["last_checked_ok"] = None
545
client["last_checker_status"] = -2
549
def __init__(self, settings, name = None, server_settings=None):
249
logger.debug(u"Creating client %r", self.name)
250
# Uppercase and remove spaces from fingerprint for later
251
# comparison purposes with return value from the fingerprint()
253
self.fingerprint = (config[u"fingerprint"].upper()
255
logger.debug(u" Fingerprint: %s", self.fingerprint)
256
if u"secret" in config:
257
self.secret = config[u"secret"].decode(u"base64")
258
elif u"secfile" in config:
259
with closing(open(os.path.expanduser
261
(config[u"secfile"])))) as secfile:
262
self.secret = secfile.read()
551
if server_settings is None:
553
self.server_settings = server_settings
554
# adding all client settings
555
for setting, value in settings.items():
556
setattr(self, setting, value)
559
if not hasattr(self, "last_enabled"):
560
self.last_enabled = datetime.datetime.utcnow()
561
if not hasattr(self, "expires"):
562
self.expires = (datetime.datetime.utcnow()
264
raise TypeError(u"No secret or secfile for client %s"
266
self.host = config.get(u"host", u"")
267
self.created = datetime.datetime.utcnow()
269
self.last_enabled = None
270
self.last_checked_ok = None
271
self.timeout = string_to_delta(config[u"timeout"])
272
self.interval = string_to_delta(config[u"interval"])
273
self.disable_hook = disable_hook
565
self.last_enabled = None
568
logger.debug("Creating client %r", self.name)
569
logger.debug(" Fingerprint: %s", self.fingerprint)
570
self.created = settings.get("created",
571
datetime.datetime.utcnow())
573
# attributes specific for this server instance
274
574
self.checker = None
275
575
self.checker_initiator_tag = None
276
576
self.disable_initiator_tag = None
277
577
self.checker_callback_tag = None
278
self.checker_command = config[u"checker"]
279
578
self.current_checker_command = None
280
self.last_connect = None
580
self.approvals_pending = 0
581
self.changedstate = multiprocessing_manager.Condition(
582
multiprocessing_manager.Lock())
583
self.client_structure = [attr
584
for attr in self.__dict__.iterkeys()
585
if not attr.startswith("_")]
586
self.client_structure.append("client_structure")
588
for name, t in inspect.getmembers(
589
type(self), lambda obj: isinstance(obj, property)):
590
if not name.startswith("_"):
591
self.client_structure.append(name)
593
# Send notice to process children that client state has changed
594
def send_changedstate(self):
595
with self.changedstate:
596
self.changedstate.notify_all()
282
598
def enable(self):
283
599
"""Start this client's checker and timeout hooks"""
600
if getattr(self, "enabled", False):
603
self.expires = datetime.datetime.utcnow() + self.timeout
284
605
self.last_enabled = datetime.datetime.utcnow()
285
# Schedule a new checker to be started an 'interval' from now,
286
# and every interval from then on.
287
self.checker_initiator_tag = (gobject.timeout_add
288
(self.interval_milliseconds(),
290
# Also start a new checker *right now*.
292
# Schedule a disable() when 'timeout' has passed
293
self.disable_initiator_tag = (gobject.timeout_add
294
(self.timeout_milliseconds(),
607
self.send_changedstate()
609
def disable(self, quiet=True):
299
610
"""Disable this client."""
300
611
if not getattr(self, "enabled", False):
302
logger.info(u"Disabling client %s", self.name)
303
if getattr(self, u"disable_initiator_tag", False):
614
logger.info("Disabling client %s", self.name)
615
if getattr(self, "disable_initiator_tag", None) is not None:
304
616
gobject.source_remove(self.disable_initiator_tag)
305
617
self.disable_initiator_tag = None
306
if getattr(self, u"checker_initiator_tag", False):
619
if getattr(self, "checker_initiator_tag", None) is not None:
307
620
gobject.source_remove(self.checker_initiator_tag)
308
621
self.checker_initiator_tag = None
309
622
self.stop_checker()
310
if self.disable_hook:
311
self.disable_hook(self)
312
623
self.enabled = False
625
self.send_changedstate()
313
626
# Do not run this again if called by a gobject.timeout_add
316
629
def __del__(self):
317
self.disable_hook = None
320
def checker_callback(self, pid, condition, command):
632
def init_checker(self):
633
# Schedule a new checker to be started an 'interval' from now,
634
# and every interval from then on.
635
if self.checker_initiator_tag is not None:
636
gobject.source_remove(self.checker_initiator_tag)
637
self.checker_initiator_tag = gobject.timeout_add(
638
int(self.interval.total_seconds() * 1000),
640
# Schedule a disable() when 'timeout' has passed
641
if self.disable_initiator_tag is not None:
642
gobject.source_remove(self.disable_initiator_tag)
643
self.disable_initiator_tag = gobject.timeout_add(
644
int(self.timeout.total_seconds() * 1000), self.disable)
645
# Also start a new checker *right now*.
648
def checker_callback(self, source, condition,
649
(connection, command)):
321
650
"""The checker has completed, so take appropriate actions."""
322
651
self.checker_callback_tag = None
323
652
self.checker = None
324
if os.WIFEXITED(condition):
325
exitstatus = os.WEXITSTATUS(condition)
327
logger.info(u"Checker for %(name)s succeeded",
653
# Read return code from connection (see subprocess_call_pipe)
654
returncode = connection.recv()
658
self.last_checker_status = returncode
659
self.last_checker_signal = None
660
if self.last_checker_status == 0:
661
logger.info("Checker for %(name)s succeeded",
329
663
self.checked_ok()
331
logger.info(u"Checker for %(name)s failed",
665
logger.info("Checker for %(name)s failed", vars(self))
334
logger.warning(u"Checker for %(name)s crashed?",
667
self.last_checker_status = -1
668
self.last_checker_signal = -returncode
669
logger.warning("Checker for %(name)s crashed?",
337
673
def checked_ok(self):
338
"""Bump up the timeout for this client.
340
This should only be called when the client has been seen,
674
"""Assert that the client has been seen, alive and well."""
343
675
self.last_checked_ok = datetime.datetime.utcnow()
344
gobject.source_remove(self.disable_initiator_tag)
345
self.disable_initiator_tag = (gobject.timeout_add
346
(self.timeout_milliseconds(),
676
self.last_checker_status = 0
677
self.last_checker_signal = None
680
def bump_timeout(self, timeout=None):
681
"""Bump up the timeout for this client."""
683
timeout = self.timeout
684
if self.disable_initiator_tag is not None:
685
gobject.source_remove(self.disable_initiator_tag)
686
self.disable_initiator_tag = None
687
if getattr(self, "enabled", False):
688
self.disable_initiator_tag = gobject.timeout_add(
689
int(timeout.total_seconds() * 1000), self.disable)
690
self.expires = datetime.datetime.utcnow() + timeout
692
def need_approval(self):
693
self.last_approval_request = datetime.datetime.utcnow()
349
695
def start_checker(self):
350
696
"""Start a new checker subprocess if one is not running.
419
756
if self.checker_callback_tag:
420
757
gobject.source_remove(self.checker_callback_tag)
421
758
self.checker_callback_tag = None
422
if getattr(self, u"checker", None) is None:
759
if getattr(self, "checker", None) is None:
424
logger.debug(u"Stopping checker for %(name)s", vars(self))
761
logger.debug("Stopping checker for %(name)s", vars(self))
762
self.checker.terminate()
766
def dbus_service_property(dbus_interface,
770
"""Decorators for marking methods of a DBusObjectWithProperties to
771
become properties on the D-Bus.
773
The decorated method will be called with no arguments by "Get"
774
and with one argument by "Set".
776
The parameters, where they are supported, are the same as
777
dbus.service.method, except there is only "signature", since the
778
type from Get() and the type sent to Set() is the same.
780
# Encoding deeply encoded byte arrays is not supported yet by the
781
# "Set" method, so we fail early here:
782
if byte_arrays and signature != "ay":
783
raise ValueError("Byte arrays not supported for non-'ay'"
784
" signature {!r}".format(signature))
787
func._dbus_is_property = True
788
func._dbus_interface = dbus_interface
789
func._dbus_signature = signature
790
func._dbus_access = access
791
func._dbus_name = func.__name__
792
if func._dbus_name.endswith("_dbus_property"):
793
func._dbus_name = func._dbus_name[:-14]
794
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
800
def dbus_interface_annotations(dbus_interface):
801
"""Decorator for marking functions returning interface annotations
805
@dbus_interface_annotations("org.example.Interface")
806
def _foo(self): # Function name does not matter
807
return {"org.freedesktop.DBus.Deprecated": "true",
808
"org.freedesktop.DBus.Property.EmitsChangedSignal":
813
func._dbus_is_interface = True
814
func._dbus_interface = dbus_interface
815
func._dbus_name = dbus_interface
821
def dbus_annotations(annotations):
822
"""Decorator to annotate D-Bus methods, signals or properties
825
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
826
"org.freedesktop.DBus.Property."
827
"EmitsChangedSignal": "false"})
828
@dbus_service_property("org.example.Interface", signature="b",
830
def Property_dbus_property(self):
831
return dbus.Boolean(False)
835
func._dbus_annotations = annotations
841
class DBusPropertyException(dbus.exceptions.DBusException):
842
"""A base class for D-Bus property-related exceptions
847
class DBusPropertyAccessException(DBusPropertyException):
848
"""A property's access permissions disallows an operation.
853
class DBusPropertyNotFound(DBusPropertyException):
854
"""An attempt was made to access a non-existing property.
859
class DBusObjectWithProperties(dbus.service.Object):
860
"""A D-Bus object with properties.
862
Classes inheriting from this can use the dbus_service_property
863
decorator to expose methods as D-Bus properties. It exposes the
864
standard Get(), Set(), and GetAll() methods on the D-Bus.
868
def _is_dbus_thing(thing):
869
"""Returns a function testing if an attribute is a D-Bus thing
871
If called like _is_dbus_thing("method") it returns a function
872
suitable for use as predicate to inspect.getmembers().
874
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
877
def _get_all_dbus_things(self, thing):
878
"""Returns a generator of (name, attribute) pairs
880
return ((getattr(athing.__get__(self), "_dbus_name", name),
881
athing.__get__(self))
882
for cls in self.__class__.__mro__
884
inspect.getmembers(cls, self._is_dbus_thing(thing)))
886
def _get_dbus_property(self, interface_name, property_name):
887
"""Returns a bound method if one exists which is a D-Bus
888
property with the specified name and interface.
890
for cls in self.__class__.__mro__:
891
for name, value in inspect.getmembers(
892
cls, self._is_dbus_thing("property")):
893
if (value._dbus_name == property_name
894
and value._dbus_interface == interface_name):
895
return value.__get__(self)
898
raise DBusPropertyNotFound("{}:{}.{}".format(
899
self.dbus_object_path, interface_name, property_name))
901
@dbus.service.method(dbus.PROPERTIES_IFACE,
904
def Get(self, interface_name, property_name):
905
"""Standard D-Bus property Get() method, see D-Bus standard.
907
prop = self._get_dbus_property(interface_name, property_name)
908
if prop._dbus_access == "write":
909
raise DBusPropertyAccessException(property_name)
911
if not hasattr(value, "variant_level"):
913
return type(value)(value, variant_level=value.variant_level+1)
915
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
916
def Set(self, interface_name, property_name, value):
917
"""Standard D-Bus property Set() method, see D-Bus standard.
919
prop = self._get_dbus_property(interface_name, property_name)
920
if prop._dbus_access == "read":
921
raise DBusPropertyAccessException(property_name)
922
if prop._dbus_get_args_options["byte_arrays"]:
923
# The byte_arrays option is not supported yet on
924
# signatures other than "ay".
925
if prop._dbus_signature != "ay":
926
raise ValueError("Byte arrays not supported for non-"
927
"'ay' signature {!r}"
928
.format(prop._dbus_signature))
929
value = dbus.ByteArray(b''.join(chr(byte)
933
@dbus.service.method(dbus.PROPERTIES_IFACE,
935
out_signature="a{sv}")
936
def GetAll(self, interface_name):
937
"""Standard D-Bus property GetAll() method, see D-Bus
940
Note: Will not include properties with access="write".
943
for name, prop in self._get_all_dbus_things("property"):
945
and interface_name != prop._dbus_interface):
946
# Interface non-empty but did not match
948
# Ignore write-only properties
949
if prop._dbus_access == "write":
952
if not hasattr(value, "variant_level"):
953
properties[name] = value
955
properties[name] = type(value)(
956
value, variant_level = value.variant_level + 1)
957
return dbus.Dictionary(properties, signature="sv")
959
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
960
def PropertiesChanged(self, interface_name, changed_properties,
961
invalidated_properties):
962
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
967
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
969
path_keyword='object_path',
970
connection_keyword='connection')
971
def Introspect(self, object_path, connection):
972
"""Overloading of standard D-Bus method.
974
Inserts property tags and interface annotation tags.
976
xmlstring = dbus.service.Object.Introspect(self, object_path,
426
os.kill(self.checker.pid, signal.SIGTERM)
428
#if self.checker.poll() is None:
429
# os.kill(self.checker.pid, signal.SIGKILL)
430
except OSError, error:
431
if error.errno != errno.ESRCH: # No such process
435
def still_valid(self):
436
"""Has the timeout not yet passed for this client?"""
437
if not getattr(self, u"enabled", False):
439
now = datetime.datetime.utcnow()
440
if self.last_checked_ok is None:
441
return now < (self.created + self.timeout)
443
return now < (self.last_checked_ok + self.timeout)
446
class ClientDBus(Client, dbus.service.Object):
979
document = xml.dom.minidom.parseString(xmlstring)
981
def make_tag(document, name, prop):
982
e = document.createElement("property")
983
e.setAttribute("name", name)
984
e.setAttribute("type", prop._dbus_signature)
985
e.setAttribute("access", prop._dbus_access)
988
for if_tag in document.getElementsByTagName("interface"):
990
for tag in (make_tag(document, name, prop)
992
in self._get_all_dbus_things("property")
993
if prop._dbus_interface
994
== if_tag.getAttribute("name")):
995
if_tag.appendChild(tag)
996
# Add annotation tags
997
for typ in ("method", "signal", "property"):
998
for tag in if_tag.getElementsByTagName(typ):
1000
for name, prop in (self.
1001
_get_all_dbus_things(typ)):
1002
if (name == tag.getAttribute("name")
1003
and prop._dbus_interface
1004
== if_tag.getAttribute("name")):
1005
annots.update(getattr(
1006
prop, "_dbus_annotations", {}))
1007
for name, value in annots.items():
1008
ann_tag = document.createElement(
1010
ann_tag.setAttribute("name", name)
1011
ann_tag.setAttribute("value", value)
1012
tag.appendChild(ann_tag)
1013
# Add interface annotation tags
1014
for annotation, value in dict(
1015
itertools.chain.from_iterable(
1016
annotations().items()
1017
for name, annotations
1018
in self._get_all_dbus_things("interface")
1019
if name == if_tag.getAttribute("name")
1021
ann_tag = document.createElement("annotation")
1022
ann_tag.setAttribute("name", annotation)
1023
ann_tag.setAttribute("value", value)
1024
if_tag.appendChild(ann_tag)
1025
# Add the names to the return values for the
1026
# "org.freedesktop.DBus.Properties" methods
1027
if (if_tag.getAttribute("name")
1028
== "org.freedesktop.DBus.Properties"):
1029
for cn in if_tag.getElementsByTagName("method"):
1030
if cn.getAttribute("name") == "Get":
1031
for arg in cn.getElementsByTagName("arg"):
1032
if (arg.getAttribute("direction")
1034
arg.setAttribute("name", "value")
1035
elif cn.getAttribute("name") == "GetAll":
1036
for arg in cn.getElementsByTagName("arg"):
1037
if (arg.getAttribute("direction")
1039
arg.setAttribute("name", "props")
1040
xmlstring = document.toxml("utf-8")
1042
except (AttributeError, xml.dom.DOMException,
1043
xml.parsers.expat.ExpatError) as error:
1044
logger.error("Failed to override Introspection method",
1049
def datetime_to_dbus(dt, variant_level=0):
1050
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1052
return dbus.String("", variant_level = variant_level)
1053
return dbus.String(dt.isoformat(), variant_level=variant_level)
1056
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1057
"""A class decorator; applied to a subclass of
1058
dbus.service.Object, it will add alternate D-Bus attributes with
1059
interface names according to the "alt_interface_names" mapping.
1062
@alternate_dbus_interfaces({"org.example.Interface":
1063
"net.example.AlternateInterface"})
1064
class SampleDBusObject(dbus.service.Object):
1065
@dbus.service.method("org.example.Interface")
1066
def SampleDBusMethod():
1069
The above "SampleDBusMethod" on "SampleDBusObject" will be
1070
reachable via two interfaces: "org.example.Interface" and
1071
"net.example.AlternateInterface", the latter of which will have
1072
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1073
"true", unless "deprecate" is passed with a False value.
1075
This works for methods and signals, and also for D-Bus properties
1076
(from DBusObjectWithProperties) and interfaces (from the
1077
dbus_interface_annotations decorator).
1081
for orig_interface_name, alt_interface_name in (
1082
alt_interface_names.items()):
1084
interface_names = set()
1085
# Go though all attributes of the class
1086
for attrname, attribute in inspect.getmembers(cls):
1087
# Ignore non-D-Bus attributes, and D-Bus attributes
1088
# with the wrong interface name
1089
if (not hasattr(attribute, "_dbus_interface")
1090
or not attribute._dbus_interface.startswith(
1091
orig_interface_name)):
1093
# Create an alternate D-Bus interface name based on
1095
alt_interface = attribute._dbus_interface.replace(
1096
orig_interface_name, alt_interface_name)
1097
interface_names.add(alt_interface)
1098
# Is this a D-Bus signal?
1099
if getattr(attribute, "_dbus_is_signal", False):
1100
# Extract the original non-method undecorated
1101
# function by black magic
1102
nonmethod_func = (dict(
1103
zip(attribute.func_code.co_freevars,
1104
attribute.__closure__))
1105
["func"].cell_contents)
1106
# Create a new, but exactly alike, function
1107
# object, and decorate it to be a new D-Bus signal
1108
# with the alternate D-Bus interface name
1109
new_function = (dbus.service.signal(
1110
alt_interface, attribute._dbus_signature)
1111
(types.FunctionType(
1112
nonmethod_func.func_code,
1113
nonmethod_func.func_globals,
1114
nonmethod_func.func_name,
1115
nonmethod_func.func_defaults,
1116
nonmethod_func.func_closure)))
1117
# Copy annotations, if any
1119
new_function._dbus_annotations = dict(
1120
attribute._dbus_annotations)
1121
except AttributeError:
1123
# Define a creator of a function to call both the
1124
# original and alternate functions, so both the
1125
# original and alternate signals gets sent when
1126
# the function is called
1127
def fixscope(func1, func2):
1128
"""This function is a scope container to pass
1129
func1 and func2 to the "call_both" function
1130
outside of its arguments"""
1132
def call_both(*args, **kwargs):
1133
"""This function will emit two D-Bus
1134
signals by calling func1 and func2"""
1135
func1(*args, **kwargs)
1136
func2(*args, **kwargs)
1139
# Create the "call_both" function and add it to
1141
attr[attrname] = fixscope(attribute, new_function)
1142
# Is this a D-Bus method?
1143
elif getattr(attribute, "_dbus_is_method", False):
1144
# Create a new, but exactly alike, function
1145
# object. Decorate it to be a new D-Bus method
1146
# with the alternate D-Bus interface name. Add it
1149
dbus.service.method(
1151
attribute._dbus_in_signature,
1152
attribute._dbus_out_signature)
1153
(types.FunctionType(attribute.func_code,
1154
attribute.func_globals,
1155
attribute.func_name,
1156
attribute.func_defaults,
1157
attribute.func_closure)))
1158
# Copy annotations, if any
1160
attr[attrname]._dbus_annotations = dict(
1161
attribute._dbus_annotations)
1162
except AttributeError:
1164
# Is this a D-Bus property?
1165
elif getattr(attribute, "_dbus_is_property", False):
1166
# Create a new, but exactly alike, function
1167
# object, and decorate it to be a new D-Bus
1168
# property with the alternate D-Bus interface
1169
# name. Add it to the class.
1170
attr[attrname] = (dbus_service_property(
1171
alt_interface, attribute._dbus_signature,
1172
attribute._dbus_access,
1173
attribute._dbus_get_args_options
1175
(types.FunctionType(
1176
attribute.func_code,
1177
attribute.func_globals,
1178
attribute.func_name,
1179
attribute.func_defaults,
1180
attribute.func_closure)))
1181
# Copy annotations, if any
1183
attr[attrname]._dbus_annotations = dict(
1184
attribute._dbus_annotations)
1185
except AttributeError:
1187
# Is this a D-Bus interface?
1188
elif getattr(attribute, "_dbus_is_interface", False):
1189
# Create a new, but exactly alike, function
1190
# object. Decorate it to be a new D-Bus interface
1191
# with the alternate D-Bus interface name. Add it
1194
dbus_interface_annotations(alt_interface)
1195
(types.FunctionType(attribute.func_code,
1196
attribute.func_globals,
1197
attribute.func_name,
1198
attribute.func_defaults,
1199
attribute.func_closure)))
1201
# Deprecate all alternate interfaces
1202
iname="_AlternateDBusNames_interface_annotation{}"
1203
for interface_name in interface_names:
1205
@dbus_interface_annotations(interface_name)
1207
return { "org.freedesktop.DBus.Deprecated":
1209
# Find an unused name
1210
for aname in (iname.format(i)
1211
for i in itertools.count()):
1212
if aname not in attr:
1216
# Replace the class with a new subclass of it with
1217
# methods, signals, etc. as created above.
1218
cls = type(b"{}Alternate".format(cls.__name__),
1225
@alternate_dbus_interfaces({"se.recompile.Mandos":
1226
"se.bsnet.fukt.Mandos"})
1227
class ClientDBus(Client, DBusObjectWithProperties):
447
1228
"""A Client class using D-Bus
450
dbus_object_path: dbus.ObjectPath ; only set if self.use_dbus
1231
dbus_object_path: dbus.ObjectPath
1232
bus: dbus.SystemBus()
1235
runtime_expansions = (Client.runtime_expansions
1236
+ ("dbus_object_path", ))
1238
_interface = "se.recompile.Mandos.Client"
452
1240
# dbus.service.Object doesn't use super(), so we can't either.
454
def __init__(self, *args, **kwargs):
1242
def __init__(self, bus = None, *args, **kwargs):
455
1244
Client.__init__(self, *args, **kwargs)
456
1245
# Only now, when this client is initialized, can it show up on
458
self.dbus_object_path = (dbus.ObjectPath
460
+ self.name.replace(u".", u"_")))
461
dbus.service.Object.__init__(self, bus,
462
self.dbus_object_path)
464
oldstate = getattr(self, u"enabled", False)
465
r = Client.enable(self)
466
if oldstate != self.enabled:
468
self.PropertyChanged(dbus.String(u"enabled"),
469
dbus.Boolean(True, variant_level=1))
470
self.PropertyChanged(dbus.String(u"last_enabled"),
471
(_datetime_to_dbus(self.last_enabled,
475
def disable(self, signal = True):
476
oldstate = getattr(self, u"enabled", False)
477
r = Client.disable(self)
478
if signal and oldstate != self.enabled:
480
self.PropertyChanged(dbus.String(u"enabled"),
481
dbus.Boolean(False, variant_level=1))
1247
client_object_name = str(self.name).translate(
1248
{ord("."): ord("_"),
1249
ord("-"): ord("_")})
1250
self.dbus_object_path = dbus.ObjectPath(
1251
"/clients/" + client_object_name)
1252
DBusObjectWithProperties.__init__(self, self.bus,
1253
self.dbus_object_path)
1255
def notifychangeproperty(transform_func, dbus_name,
1256
type_func=lambda x: x,
1258
invalidate_only=False,
1259
_interface=_interface):
1260
""" Modify a variable so that it's a property which announces
1261
its changes to DBus.
1263
transform_fun: Function that takes a value and a variant_level
1264
and transforms it to a D-Bus type.
1265
dbus_name: D-Bus name of the variable
1266
type_func: Function that transform the value before sending it
1267
to the D-Bus. Default: no transform
1268
variant_level: D-Bus variant level. Default: 1
1270
attrname = "_{}".format(dbus_name)
1272
def setter(self, value):
1273
if hasattr(self, "dbus_object_path"):
1274
if (not hasattr(self, attrname) or
1275
type_func(getattr(self, attrname, None))
1276
!= type_func(value)):
1278
self.PropertiesChanged(
1279
_interface, dbus.Dictionary(),
1280
dbus.Array((dbus_name, )))
1282
dbus_value = transform_func(
1284
variant_level = variant_level)
1285
self.PropertyChanged(dbus.String(dbus_name),
1287
self.PropertiesChanged(
1289
dbus.Dictionary({ dbus.String(dbus_name):
1292
setattr(self, attrname, value)
1294
return property(lambda self: getattr(self, attrname), setter)
1296
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1297
approvals_pending = notifychangeproperty(dbus.Boolean,
1300
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1301
last_enabled = notifychangeproperty(datetime_to_dbus,
1303
checker = notifychangeproperty(
1304
dbus.Boolean, "CheckerRunning",
1305
type_func = lambda checker: checker is not None)
1306
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1308
last_checker_status = notifychangeproperty(dbus.Int16,
1309
"LastCheckerStatus")
1310
last_approval_request = notifychangeproperty(
1311
datetime_to_dbus, "LastApprovalRequest")
1312
approved_by_default = notifychangeproperty(dbus.Boolean,
1313
"ApprovedByDefault")
1314
approval_delay = notifychangeproperty(
1315
dbus.UInt64, "ApprovalDelay",
1316
type_func = lambda td: td.total_seconds() * 1000)
1317
approval_duration = notifychangeproperty(
1318
dbus.UInt64, "ApprovalDuration",
1319
type_func = lambda td: td.total_seconds() * 1000)
1320
host = notifychangeproperty(dbus.String, "Host")
1321
timeout = notifychangeproperty(
1322
dbus.UInt64, "Timeout",
1323
type_func = lambda td: td.total_seconds() * 1000)
1324
extended_timeout = notifychangeproperty(
1325
dbus.UInt64, "ExtendedTimeout",
1326
type_func = lambda td: td.total_seconds() * 1000)
1327
interval = notifychangeproperty(
1328
dbus.UInt64, "Interval",
1329
type_func = lambda td: td.total_seconds() * 1000)
1330
checker_command = notifychangeproperty(dbus.String, "Checker")
1331
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1332
invalidate_only=True)
1334
del notifychangeproperty
484
1336
def __del__(self, *args, **kwargs):
486
1338
self.remove_from_connection()
487
1339
except LookupError:
489
if hasattr(dbus.service.Object, u"__del__"):
490
dbus.service.Object.__del__(self, *args, **kwargs)
1341
if hasattr(DBusObjectWithProperties, "__del__"):
1342
DBusObjectWithProperties.__del__(self, *args, **kwargs)
491
1343
Client.__del__(self, *args, **kwargs)
493
def checker_callback(self, pid, condition, command,
495
self.checker_callback_tag = None
498
self.PropertyChanged(dbus.String(u"checker_running"),
499
dbus.Boolean(False, variant_level=1))
500
if os.WIFEXITED(condition):
501
exitstatus = os.WEXITSTATUS(condition)
1345
def checker_callback(self, source, condition,
1346
(connection, command), *args, **kwargs):
1347
ret = Client.checker_callback(self, source, condition,
1348
(connection, command), *args,
1350
exitstatus = self.last_checker_status
502
1352
# Emit D-Bus signal
503
1353
self.CheckerCompleted(dbus.Int16(exitstatus),
504
dbus.Int64(condition),
505
1355
dbus.String(command))
507
1357
# Emit D-Bus signal
508
1358
self.CheckerCompleted(dbus.Int16(-1),
509
dbus.Int64(condition),
1360
self.last_checker_signal),
510
1361
dbus.String(command))
512
return Client.checker_callback(self, pid, condition, command,
515
def checked_ok(self, *args, **kwargs):
516
r = Client.checked_ok(self, *args, **kwargs)
518
self.PropertyChanged(
519
dbus.String(u"last_checked_ok"),
520
(_datetime_to_dbus(self.last_checked_ok,
524
1364
def start_checker(self, *args, **kwargs):
525
old_checker = self.checker
526
if self.checker is not None:
527
old_checker_pid = self.checker.pid
529
old_checker_pid = None
1365
old_checker_pid = getattr(self.checker, "pid", None)
530
1366
r = Client.start_checker(self, *args, **kwargs)
531
1367
# Only if new checker process was started
532
1368
if (self.checker is not None
533
1369
and old_checker_pid != self.checker.pid):
534
1370
# Emit D-Bus signal
535
1371
self.CheckerStarted(self.current_checker_command)
536
self.PropertyChanged(
537
dbus.String(u"checker_running"),
538
dbus.Boolean(True, variant_level=1))
541
def stop_checker(self, *args, **kwargs):
542
old_checker = getattr(self, u"checker", None)
543
r = Client.stop_checker(self, *args, **kwargs)
544
if (old_checker is not None
545
and getattr(self, u"checker", None) is None):
546
self.PropertyChanged(dbus.String(u"checker_running"),
547
dbus.Boolean(False, variant_level=1))
550
## D-Bus methods & signals
551
_interface = u"se.bsnet.fukt.Mandos.Client"
554
@dbus.service.method(_interface)
556
return self.checked_ok()
1374
def _reset_approved(self):
1375
self.approved = None
1378
def approve(self, value=True):
1379
self.approved = value
1380
gobject.timeout_add(int(self.approval_duration.total_seconds()
1381
* 1000), self._reset_approved)
1382
self.send_changedstate()
1384
## D-Bus methods, signals & properties
558
1390
# CheckerCompleted - signal
559
@dbus.service.signal(_interface, signature=u"nxs")
1391
@dbus.service.signal(_interface, signature="nxs")
560
1392
def CheckerCompleted(self, exitcode, waitstatus, command):
564
1396
# CheckerStarted - signal
565
@dbus.service.signal(_interface, signature=u"s")
1397
@dbus.service.signal(_interface, signature="s")
566
1398
def CheckerStarted(self, command):
570
# GetAllProperties - method
571
@dbus.service.method(_interface, out_signature=u"a{sv}")
572
def GetAllProperties(self):
574
return dbus.Dictionary({
575
dbus.String(u"name"):
576
dbus.String(self.name, variant_level=1),
577
dbus.String(u"fingerprint"):
578
dbus.String(self.fingerprint, variant_level=1),
579
dbus.String(u"host"):
580
dbus.String(self.host, variant_level=1),
581
dbus.String(u"created"):
582
_datetime_to_dbus(self.created, variant_level=1),
583
dbus.String(u"last_enabled"):
584
(_datetime_to_dbus(self.last_enabled,
586
if self.last_enabled is not None
587
else dbus.Boolean(False, variant_level=1)),
588
dbus.String(u"enabled"):
589
dbus.Boolean(self.enabled, variant_level=1),
590
dbus.String(u"last_checked_ok"):
591
(_datetime_to_dbus(self.last_checked_ok,
593
if self.last_checked_ok is not None
594
else dbus.Boolean (False, variant_level=1)),
595
dbus.String(u"timeout"):
596
dbus.UInt64(self.timeout_milliseconds(),
598
dbus.String(u"interval"):
599
dbus.UInt64(self.interval_milliseconds(),
601
dbus.String(u"checker"):
602
dbus.String(self.checker_command,
604
dbus.String(u"checker_running"):
605
dbus.Boolean(self.checker is not None,
607
dbus.String(u"object_path"):
608
dbus.ObjectPath(self.dbus_object_path,
612
# IsStillValid - method
613
@dbus.service.method(_interface, out_signature=u"b")
614
def IsStillValid(self):
615
return self.still_valid()
617
1402
# PropertyChanged - signal
618
@dbus.service.signal(_interface, signature=u"sv")
1403
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1404
@dbus.service.signal(_interface, signature="sv")
619
1405
def PropertyChanged(self, property, value):
623
# ReceivedSecret - signal
1409
# GotSecret - signal
624
1410
@dbus.service.signal(_interface)
625
def ReceivedSecret(self):
1411
def GotSecret(self):
1413
Is sent after a successful transfer of secret from the Mandos
1414
server to mandos-client
629
1418
# Rejected - signal
630
@dbus.service.signal(_interface)
1419
@dbus.service.signal(_interface, signature="s")
1420
def Rejected(self, reason):
635
# SetChecker - method
636
@dbus.service.method(_interface, in_signature=u"s")
637
def SetChecker(self, checker):
638
"D-Bus setter method"
639
self.checker_command = checker
641
self.PropertyChanged(dbus.String(u"checker"),
642
dbus.String(self.checker_command,
646
@dbus.service.method(_interface, in_signature=u"s")
647
def SetHost(self, host):
648
"D-Bus setter method"
651
self.PropertyChanged(dbus.String(u"host"),
652
dbus.String(self.host, variant_level=1))
654
# SetInterval - method
655
@dbus.service.method(_interface, in_signature=u"t")
656
def SetInterval(self, milliseconds):
657
self.interval = datetime.timedelta(0, 0, 0, milliseconds)
659
self.PropertyChanged(dbus.String(u"interval"),
660
(dbus.UInt64(self.interval_milliseconds(),
664
@dbus.service.method(_interface, in_signature=u"ay",
666
def SetSecret(self, secret):
667
"D-Bus setter method"
668
self.secret = str(secret)
670
# SetTimeout - method
671
@dbus.service.method(_interface, in_signature=u"t")
672
def SetTimeout(self, milliseconds):
673
self.timeout = datetime.timedelta(0, 0, 0, milliseconds)
675
self.PropertyChanged(dbus.String(u"timeout"),
676
(dbus.UInt64(self.timeout_milliseconds(),
1424
# NeedApproval - signal
1425
@dbus.service.signal(_interface, signature="tb")
1426
def NeedApproval(self, timeout, default):
1428
return self.need_approval()
1433
@dbus.service.method(_interface, in_signature="b")
1434
def Approve(self, value):
1437
# CheckedOK - method
1438
@dbus.service.method(_interface)
1439
def CheckedOK(self):
679
1442
# Enable - method
680
1443
@dbus.service.method(_interface)
699
1462
def StopChecker(self):
700
1463
self.stop_checker()
1467
# ApprovalPending - property
1468
@dbus_service_property(_interface, signature="b", access="read")
1469
def ApprovalPending_dbus_property(self):
1470
return dbus.Boolean(bool(self.approvals_pending))
1472
# ApprovedByDefault - property
1473
@dbus_service_property(_interface,
1476
def ApprovedByDefault_dbus_property(self, value=None):
1477
if value is None: # get
1478
return dbus.Boolean(self.approved_by_default)
1479
self.approved_by_default = bool(value)
1481
# ApprovalDelay - property
1482
@dbus_service_property(_interface,
1485
def ApprovalDelay_dbus_property(self, value=None):
1486
if value is None: # get
1487
return dbus.UInt64(self.approval_delay.total_seconds()
1489
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1491
# ApprovalDuration - property
1492
@dbus_service_property(_interface,
1495
def ApprovalDuration_dbus_property(self, value=None):
1496
if value is None: # get
1497
return dbus.UInt64(self.approval_duration.total_seconds()
1499
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1502
@dbus_service_property(_interface, signature="s", access="read")
1503
def Name_dbus_property(self):
1504
return dbus.String(self.name)
1506
# Fingerprint - property
1507
@dbus_service_property(_interface, signature="s", access="read")
1508
def Fingerprint_dbus_property(self):
1509
return dbus.String(self.fingerprint)
1512
@dbus_service_property(_interface,
1515
def Host_dbus_property(self, value=None):
1516
if value is None: # get
1517
return dbus.String(self.host)
1518
self.host = str(value)
1520
# Created - property
1521
@dbus_service_property(_interface, signature="s", access="read")
1522
def Created_dbus_property(self):
1523
return datetime_to_dbus(self.created)
1525
# LastEnabled - property
1526
@dbus_service_property(_interface, signature="s", access="read")
1527
def LastEnabled_dbus_property(self):
1528
return datetime_to_dbus(self.last_enabled)
1530
# Enabled - property
1531
@dbus_service_property(_interface,
1534
def Enabled_dbus_property(self, value=None):
1535
if value is None: # get
1536
return dbus.Boolean(self.enabled)
1542
# LastCheckedOK - property
1543
@dbus_service_property(_interface,
1546
def LastCheckedOK_dbus_property(self, value=None):
1547
if value is not None:
1550
return datetime_to_dbus(self.last_checked_ok)
1552
# LastCheckerStatus - property
1553
@dbus_service_property(_interface, signature="n", access="read")
1554
def LastCheckerStatus_dbus_property(self):
1555
return dbus.Int16(self.last_checker_status)
1557
# Expires - property
1558
@dbus_service_property(_interface, signature="s", access="read")
1559
def Expires_dbus_property(self):
1560
return datetime_to_dbus(self.expires)
1562
# LastApprovalRequest - property
1563
@dbus_service_property(_interface, signature="s", access="read")
1564
def LastApprovalRequest_dbus_property(self):
1565
return datetime_to_dbus(self.last_approval_request)
1567
# Timeout - property
1568
@dbus_service_property(_interface,
1571
def Timeout_dbus_property(self, value=None):
1572
if value is None: # get
1573
return dbus.UInt64(self.timeout.total_seconds() * 1000)
1574
old_timeout = self.timeout
1575
self.timeout = datetime.timedelta(0, 0, 0, value)
1576
# Reschedule disabling
1578
now = datetime.datetime.utcnow()
1579
self.expires += self.timeout - old_timeout
1580
if self.expires <= now:
1581
# The timeout has passed
1584
if (getattr(self, "disable_initiator_tag", None)
1587
gobject.source_remove(self.disable_initiator_tag)
1588
self.disable_initiator_tag = gobject.timeout_add(
1589
int((self.expires - now).total_seconds() * 1000),
1592
# ExtendedTimeout - property
1593
@dbus_service_property(_interface,
1596
def ExtendedTimeout_dbus_property(self, value=None):
1597
if value is None: # get
1598
return dbus.UInt64(self.extended_timeout.total_seconds()
1600
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1602
# Interval - property
1603
@dbus_service_property(_interface,
1606
def Interval_dbus_property(self, value=None):
1607
if value is None: # get
1608
return dbus.UInt64(self.interval.total_seconds() * 1000)
1609
self.interval = datetime.timedelta(0, 0, 0, value)
1610
if getattr(self, "checker_initiator_tag", None) is None:
1613
# Reschedule checker run
1614
gobject.source_remove(self.checker_initiator_tag)
1615
self.checker_initiator_tag = gobject.timeout_add(
1616
value, self.start_checker)
1617
self.start_checker() # Start one now, too
1619
# Checker - property
1620
@dbus_service_property(_interface,
1623
def Checker_dbus_property(self, value=None):
1624
if value is None: # get
1625
return dbus.String(self.checker_command)
1626
self.checker_command = str(value)
1628
# CheckerRunning - property
1629
@dbus_service_property(_interface,
1632
def CheckerRunning_dbus_property(self, value=None):
1633
if value is None: # get
1634
return dbus.Boolean(self.checker is not None)
1636
self.start_checker()
1640
# ObjectPath - property
1641
@dbus_service_property(_interface, signature="o", access="read")
1642
def ObjectPath_dbus_property(self):
1643
return self.dbus_object_path # is already a dbus.ObjectPath
1646
@dbus_service_property(_interface,
1650
def Secret_dbus_property(self, value):
1651
self.secret = bytes(value)
705
class ClientHandler(SocketServer.BaseRequestHandler, object):
1656
class ProxyClient(object):
1657
def __init__(self, child_pipe, fpr, address):
1658
self._pipe = child_pipe
1659
self._pipe.send(('init', fpr, address))
1660
if not self._pipe.recv():
1663
def __getattribute__(self, name):
1665
return super(ProxyClient, self).__getattribute__(name)
1666
self._pipe.send(('getattr', name))
1667
data = self._pipe.recv()
1668
if data[0] == 'data':
1670
if data[0] == 'function':
1672
def func(*args, **kwargs):
1673
self._pipe.send(('funcall', name, args, kwargs))
1674
return self._pipe.recv()[1]
1678
def __setattr__(self, name, value):
1680
return super(ProxyClient, self).__setattr__(name, value)
1681
self._pipe.send(('setattr', name, value))
1684
class ClientHandler(socketserver.BaseRequestHandler, object):
706
1685
"""A class to handle client connections.
708
1687
Instantiated once for each connection to handle it.
709
1688
Note: This will run in its own forked process."""
711
1690
def handle(self):
712
logger.info(u"TCP connection from: %s",
713
unicode(self.client_address))
714
logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
715
# Open IPC pipe to parent process
716
with closing(os.fdopen(self.server.pipe[1], u"w", 1)) as ipc:
717
session = (gnutls.connection
718
.ClientSession(self.request,
1691
with contextlib.closing(self.server.child_pipe) as child_pipe:
1692
logger.info("TCP connection from: %s",
1693
str(self.client_address))
1694
logger.debug("Pipe FD: %d",
1695
self.server.child_pipe.fileno())
722
line = self.request.makefile().readline()
723
logger.debug(u"Protocol version: %r", line)
725
if int(line.strip().split()[0]) > 1:
727
except (ValueError, IndexError, RuntimeError), error:
728
logger.error(u"Unknown protocol version: %s", error)
1697
session = gnutls.connection.ClientSession(
1698
self.request, gnutls.connection .X509Credentials())
731
1700
# Note: gnutls.connection.X509Credentials is really a
732
1701
# generic GnuTLS certificate credentials object so long as
733
1702
# no X.509 keys are added to it. Therefore, we can use it
734
1703
# here despite using OpenPGP certificates.
736
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
737
# u"+AES-256-CBC", u"+SHA1",
738
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1705
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1706
# "+AES-256-CBC", "+SHA1",
1707
# "+COMP-NULL", "+CTYPE-OPENPGP",
740
1709
# Use a fallback default, since this MUST be set.
741
1710
priority = self.server.gnutls_priority
742
1711
if priority is None:
744
(gnutls.library.functions
745
.gnutls_priority_set_direct(session._c_object,
1713
gnutls.library.functions.gnutls_priority_set_direct(
1714
session._c_object, priority, None)
1716
# Start communication using the Mandos protocol
1717
# Get protocol number
1718
line = self.request.makefile().readline()
1719
logger.debug("Protocol version: %r", line)
1721
if int(line.strip().split()[0]) > 1:
1722
raise RuntimeError(line)
1723
except (ValueError, IndexError, RuntimeError) as error:
1724
logger.error("Unknown protocol version: %s", error)
1727
# Start GnuTLS connection
749
1729
session.handshake()
750
except gnutls.errors.GNUTLSError, error:
751
logger.warning(u"Handshake failed: %s", error)
1730
except gnutls.errors.GNUTLSError as error:
1731
logger.warning("Handshake failed: %s", error)
752
1732
# Do not run session.bye() here: the session is not
753
1733
# established. Just abandon the request.
755
logger.debug(u"Handshake succeeded")
1735
logger.debug("Handshake succeeded")
1737
approval_required = False
757
fpr = self.fingerprint(self.peer_certificate(session))
758
except (TypeError, gnutls.errors.GNUTLSError), error:
759
logger.warning(u"Bad certificate: %s", error)
762
logger.debug(u"Fingerprint: %s", fpr)
1740
fpr = self.fingerprint(
1741
self.peer_certificate(session))
1743
gnutls.errors.GNUTLSError) as error:
1744
logger.warning("Bad certificate: %s", error)
1746
logger.debug("Fingerprint: %s", fpr)
1749
client = ProxyClient(child_pipe, fpr,
1750
self.client_address)
1754
if client.approval_delay:
1755
delay = client.approval_delay
1756
client.approvals_pending += 1
1757
approval_required = True
1760
if not client.enabled:
1761
logger.info("Client %s is disabled",
1763
if self.server.use_dbus:
1765
client.Rejected("Disabled")
1768
if client.approved or not client.approval_delay:
1769
#We are approved or approval is disabled
1771
elif client.approved is None:
1772
logger.info("Client %s needs approval",
1774
if self.server.use_dbus:
1776
client.NeedApproval(
1777
client.approval_delay.total_seconds()
1778
* 1000, client.approved_by_default)
1780
logger.warning("Client %s was not approved",
1782
if self.server.use_dbus:
1784
client.Rejected("Denied")
1787
#wait until timeout or approved
1788
time = datetime.datetime.now()
1789
client.changedstate.acquire()
1790
client.changedstate.wait(delay.total_seconds())
1791
client.changedstate.release()
1792
time2 = datetime.datetime.now()
1793
if (time2 - time) >= delay:
1794
if not client.approved_by_default:
1795
logger.warning("Client %s timed out while"
1796
" waiting for approval",
1798
if self.server.use_dbus:
1800
client.Rejected("Approval timed out")
1805
delay -= time2 - time
1808
while sent_size < len(client.secret):
1810
sent = session.send(client.secret[sent_size:])
1811
except gnutls.errors.GNUTLSError as error:
1812
logger.warning("gnutls send failed",
1815
logger.debug("Sent: %d, remaining: %d", sent,
1816
len(client.secret) - (sent_size
1820
logger.info("Sending secret to %s", client.name)
1821
# bump the timeout using extended_timeout
1822
client.bump_timeout(client.extended_timeout)
1823
if self.server.use_dbus:
764
for c in self.server.clients:
765
if c.fingerprint == fpr:
769
ipc.write(u"NOTFOUND %s\n" % fpr)
772
# Have to check if client.still_valid(), since it is
773
# possible that the client timed out while establishing
774
# the GnuTLS session.
775
if not client.still_valid():
776
ipc.write(u"INVALID %s\n" % client.name)
779
ipc.write(u"SENDING %s\n" % client.name)
781
while sent_size < len(client.secret):
782
sent = session.send(client.secret[sent_size:])
783
logger.debug(u"Sent: %d, remaining: %d",
784
sent, len(client.secret)
785
- (sent_size + sent))
1828
if approval_required:
1829
client.approvals_pending -= 1
1832
except gnutls.errors.GNUTLSError as error:
1833
logger.warning("GnuTLS bye failed",
790
1837
def peer_certificate(session):
791
1838
"Return the peer's OpenPGP certificate as a bytestring"
792
1839
# If not an OpenPGP certificate...
793
if (gnutls.library.functions
794
.gnutls_certificate_type_get(session._c_object)
1840
if (gnutls.library.functions.gnutls_certificate_type_get(
795
1842
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
796
1843
# ...do the normal thing
797
1844
return session.peer_certificate
811
1858
def fingerprint(openpgp):
812
1859
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
813
1860
# New GnuTLS "datum" with the OpenPGP public key
814
datum = (gnutls.library.types
815
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
818
ctypes.c_uint(len(openpgp))))
1861
datum = gnutls.library.types.gnutls_datum_t(
1862
ctypes.cast(ctypes.c_char_p(openpgp),
1863
ctypes.POINTER(ctypes.c_ubyte)),
1864
ctypes.c_uint(len(openpgp)))
819
1865
# New empty GnuTLS certificate
820
1866
crt = gnutls.library.types.gnutls_openpgp_crt_t()
821
(gnutls.library.functions
822
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
1867
gnutls.library.functions.gnutls_openpgp_crt_init(
823
1869
# Import the OpenPGP public key into the certificate
824
(gnutls.library.functions
825
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
826
gnutls.library.constants
827
.GNUTLS_OPENPGP_FMT_RAW))
1870
gnutls.library.functions.gnutls_openpgp_crt_import(
1871
crt, ctypes.byref(datum),
1872
gnutls.library.constants.GNUTLS_OPENPGP_FMT_RAW)
828
1873
# Verify the self signature in the key
829
1874
crtverify = ctypes.c_uint()
830
(gnutls.library.functions
831
.gnutls_openpgp_crt_verify_self(crt, 0,
832
ctypes.byref(crtverify)))
1875
gnutls.library.functions.gnutls_openpgp_crt_verify_self(
1876
crt, 0, ctypes.byref(crtverify))
833
1877
if crtverify.value != 0:
834
1878
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
835
raise (gnutls.errors.CertificateSecurityError
1879
raise gnutls.errors.CertificateSecurityError(
837
1881
# New buffer for the fingerprint
838
1882
buf = ctypes.create_string_buffer(20)
839
1883
buf_len = ctypes.c_size_t()
840
1884
# Get the fingerprint from the certificate into the buffer
841
(gnutls.library.functions
842
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
843
ctypes.byref(buf_len)))
1885
gnutls.library.functions.gnutls_openpgp_crt_get_fingerprint(
1886
crt, ctypes.byref(buf), ctypes.byref(buf_len))
844
1887
# Deinit the certificate
845
1888
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
846
1889
# Convert the buffer to a Python bytestring
847
1890
fpr = ctypes.string_at(buf, buf_len.value)
848
1891
# Convert the bytestring to hexadecimal notation
849
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1892
hex_fpr = binascii.hexlify(fpr).upper()
853
class ForkingMixInWithPipe(SocketServer.ForkingMixIn, object):
854
"""Like SocketServer.ForkingMixIn, but also pass a pipe.
856
Assumes a gobject.MainLoop event loop.
1896
class MultiprocessingMixIn(object):
1897
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1899
def sub_process_main(self, request, address):
1901
self.finish_request(request, address)
1903
self.handle_error(request, address)
1904
self.close_request(request)
1906
def process_request(self, request, address):
1907
"""Start a new process to process the request."""
1908
proc = multiprocessing.Process(target = self.sub_process_main,
1909
args = (request, address))
1914
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1915
""" adds a pipe to the MixIn """
858
1917
def process_request(self, request, client_address):
859
1918
"""Overrides and wraps the original process_request().
861
This function creates a new pipe in self.pipe
1920
This function creates a new pipe in self.pipe
863
self.pipe = os.pipe()
864
super(ForkingMixInWithPipe,
865
self).process_request(request, client_address)
866
os.close(self.pipe[1]) # close write end
867
# Call "handle_ipc" for both data and EOF events
868
gobject.io_add_watch(self.pipe[0],
869
gobject.IO_IN | gobject.IO_HUP,
871
def handle_ipc(source, condition):
1922
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1924
proc = MultiprocessingMixIn.process_request(self, request,
1926
self.child_pipe.close()
1927
self.add_pipe(parent_pipe, proc)
1929
def add_pipe(self, parent_pipe, proc):
872
1930
"""Dummy function; override as necessary"""
877
class IPv6_TCPServer(ForkingMixInWithPipe,
878
SocketServer.TCPServer, object):
1931
raise NotImplementedError()
1934
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1935
socketserver.TCPServer, object):
879
1936
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
882
1939
enabled: Boolean; whether this server is activated yet
883
1940
interface: None or a network interface name (string)
884
1941
use_ipv6: Boolean; to use IPv6 or not
886
clients: Set() of Client objects
887
gnutls_priority GnuTLS priority string
888
use_dbus: Boolean; to emit D-Bus signals or not
890
1944
def __init__(self, server_address, RequestHandlerClass,
891
interface=None, use_ipv6=True, clients=None,
892
gnutls_priority=None, use_dbus=True):
1948
"""If socketfd is set, use that file descriptor instead of
1949
creating a new one with socket.socket().
894
1951
self.interface = interface
896
1953
self.address_family = socket.AF_INET6
897
self.clients = clients
898
self.use_dbus = use_dbus
899
self.gnutls_priority = gnutls_priority
900
SocketServer.TCPServer.__init__(self, server_address,
1954
if socketfd is not None:
1955
# Save the file descriptor
1956
self.socketfd = socketfd
1957
# Save the original socket.socket() function
1958
self.socket_socket = socket.socket
1959
# To implement --socket, we monkey patch socket.socket.
1961
# (When socketserver.TCPServer is a new-style class, we
1962
# could make self.socket into a property instead of monkey
1963
# patching socket.socket.)
1965
# Create a one-time-only replacement for socket.socket()
1966
@functools.wraps(socket.socket)
1967
def socket_wrapper(*args, **kwargs):
1968
# Restore original function so subsequent calls are
1970
socket.socket = self.socket_socket
1971
del self.socket_socket
1972
# This time only, return a new socket object from the
1973
# saved file descriptor.
1974
return socket.fromfd(self.socketfd, *args, **kwargs)
1975
# Replace socket.socket() function with wrapper
1976
socket.socket = socket_wrapper
1977
# The socketserver.TCPServer.__init__ will call
1978
# socket.socket(), which might be our replacement,
1979
# socket_wrapper(), if socketfd was set.
1980
socketserver.TCPServer.__init__(self, server_address,
901
1981
RequestHandlerClass)
902
1983
def server_bind(self):
903
1984
"""This overrides the normal server_bind() function
904
1985
to bind to an interface if one was specified, and also NOT to
905
1986
bind to an address or port if they were not specified."""
906
1987
if self.interface is not None:
908
self.socket.setsockopt(socket.SOL_SOCKET,
910
str(self.interface + u'\0'))
911
except socket.error, error:
912
if error[0] == errno.EPERM:
913
logger.error(u"No permission to"
914
u" bind to interface %s",
1988
if SO_BINDTODEVICE is None:
1989
logger.error("SO_BINDTODEVICE does not exist;"
1990
" cannot bind to interface %s",
1994
self.socket.setsockopt(
1995
socket.SOL_SOCKET, SO_BINDTODEVICE,
1996
(self.interface + "\0").encode("utf-8"))
1997
except socket.error as error:
1998
if error.errno == errno.EPERM:
1999
logger.error("No permission to bind to"
2000
" interface %s", self.interface)
2001
elif error.errno == errno.ENOPROTOOPT:
2002
logger.error("SO_BINDTODEVICE not available;"
2003
" cannot bind to interface %s",
2005
elif error.errno == errno.ENODEV:
2006
logger.error("Interface %s does not exist,"
2007
" cannot bind", self.interface)
918
2010
# Only bind(2) the socket if we really need to.
919
2011
if self.server_address[0] or self.server_address[1]:
920
2012
if not self.server_address[0]:
921
2013
if self.address_family == socket.AF_INET6:
922
any_address = u"::" # in6addr_any
2014
any_address = "::" # in6addr_any
924
any_address = socket.INADDR_ANY
2016
any_address = "0.0.0.0" # INADDR_ANY
925
2017
self.server_address = (any_address,
926
2018
self.server_address[1])
927
2019
elif not self.server_address[1]:
928
self.server_address = (self.server_address[0],
2020
self.server_address = (self.server_address[0], 0)
930
2021
# if self.interface:
931
2022
# self.server_address = (self.server_address[0],
934
2025
# if_nametoindex
935
2026
# (self.interface))
936
return SocketServer.TCPServer.server_bind(self)
2027
return socketserver.TCPServer.server_bind(self)
2030
class MandosServer(IPv6_TCPServer):
2034
clients: set of Client objects
2035
gnutls_priority GnuTLS priority string
2036
use_dbus: Boolean; to emit D-Bus signals or not
2038
Assumes a gobject.MainLoop event loop.
2041
def __init__(self, server_address, RequestHandlerClass,
2045
gnutls_priority=None,
2048
self.enabled = False
2049
self.clients = clients
2050
if self.clients is None:
2052
self.use_dbus = use_dbus
2053
self.gnutls_priority = gnutls_priority
2054
IPv6_TCPServer.__init__(self, server_address,
2055
RequestHandlerClass,
2056
interface = interface,
2057
use_ipv6 = use_ipv6,
2058
socketfd = socketfd)
937
2060
def server_activate(self):
938
2061
if self.enabled:
939
return SocketServer.TCPServer.server_activate(self)
2062
return socketserver.TCPServer.server_activate(self)
940
2064
def enable(self):
941
2065
self.enabled = True
942
def handle_ipc(self, source, condition, file_objects={}):
944
gobject.IO_IN: u"IN", # There is data to read.
945
gobject.IO_OUT: u"OUT", # Data can be written (without
947
gobject.IO_PRI: u"PRI", # There is urgent data to read.
948
gobject.IO_ERR: u"ERR", # Error condition.
949
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
950
# broken, usually for pipes and
953
conditions_string = ' | '.join(name
955
condition_names.iteritems()
957
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
960
# Turn the pipe file descriptor into a Python file object
961
if source not in file_objects:
962
file_objects[source] = os.fdopen(source, u"r", 1)
964
# Read a line from the file object
965
cmdline = file_objects[source].readline()
966
if not cmdline: # Empty line means end of file
968
file_objects[source].close()
969
del file_objects[source]
971
# Stop calling this function
974
logger.debug(u"IPC command: %r", cmdline)
976
# Parse and act on command
977
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
979
if cmd == u"NOTFOUND":
980
logger.warning(u"Client not found for fingerprint: %s",
984
mandos_dbus_service.ClientNotFound(args)
985
elif cmd == u"INVALID":
986
for client in self.clients:
987
if client.name == args:
988
logger.warning(u"Client %s is invalid", args)
994
logger.error(u"Unknown client %s is invalid", args)
995
elif cmd == u"SENDING":
996
for client in self.clients:
997
if client.name == args:
998
logger.info(u"Sending secret to %s", client.name)
1002
client.ReceivedSecret()
1005
logger.error(u"Sending secret to unknown client %s",
2067
def add_pipe(self, parent_pipe, proc):
2068
# Call "handle_ipc" for both data and EOF events
2069
gobject.io_add_watch(
2070
parent_pipe.fileno(),
2071
gobject.IO_IN | gobject.IO_HUP,
2072
functools.partial(self.handle_ipc,
2073
parent_pipe = parent_pipe,
2076
def handle_ipc(self, source, condition,
2079
client_object=None):
2080
# error, or the other end of multiprocessing.Pipe has closed
2081
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2082
# Wait for other process to exit
2086
# Read a request from the child
2087
request = parent_pipe.recv()
2088
command = request[0]
2090
if command == 'init':
2092
address = request[2]
2094
for c in self.clients.itervalues():
2095
if c.fingerprint == fpr:
2099
logger.info("Client not found for fingerprint: %s, ad"
2100
"dress: %s", fpr, address)
2103
mandos_dbus_service.ClientNotFound(fpr,
2105
parent_pipe.send(False)
2108
gobject.io_add_watch(
2109
parent_pipe.fileno(),
2110
gobject.IO_IN | gobject.IO_HUP,
2111
functools.partial(self.handle_ipc,
2112
parent_pipe = parent_pipe,
2114
client_object = client))
2115
parent_pipe.send(True)
2116
# remove the old hook in favor of the new above hook on
2119
if command == 'funcall':
2120
funcname = request[1]
2124
parent_pipe.send(('data', getattr(client_object,
2128
if command == 'getattr':
2129
attrname = request[1]
2130
if callable(client_object.__getattribute__(attrname)):
2131
parent_pipe.send(('function', ))
2134
'data', client_object.__getattribute__(attrname)))
2136
if command == 'setattr':
2137
attrname = request[1]
2139
setattr(client_object, attrname, value)
2144
def rfc3339_duration_to_delta(duration):
2145
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2147
>>> rfc3339_duration_to_delta("P7D")
2148
datetime.timedelta(7)
2149
>>> rfc3339_duration_to_delta("PT60S")
2150
datetime.timedelta(0, 60)
2151
>>> rfc3339_duration_to_delta("PT60M")
2152
datetime.timedelta(0, 3600)
2153
>>> rfc3339_duration_to_delta("PT24H")
2154
datetime.timedelta(1)
2155
>>> rfc3339_duration_to_delta("P1W")
2156
datetime.timedelta(7)
2157
>>> rfc3339_duration_to_delta("PT5M30S")
2158
datetime.timedelta(0, 330)
2159
>>> rfc3339_duration_to_delta("P1DT3M20S")
2160
datetime.timedelta(1, 200)
2163
# Parsing an RFC 3339 duration with regular expressions is not
2164
# possible - there would have to be multiple places for the same
2165
# values, like seconds. The current code, while more esoteric, is
2166
# cleaner without depending on a parsing library. If Python had a
2167
# built-in library for parsing we would use it, but we'd like to
2168
# avoid excessive use of external libraries.
2170
# New type for defining tokens, syntax, and semantics all-in-one
2171
Token = collections.namedtuple("Token",
2172
("regexp", # To match token; if
2173
# "value" is not None,
2174
# must have a "group"
2176
"value", # datetime.timedelta or
2178
"followers")) # Tokens valid after
2180
Token = collections.namedtuple("Token", (
2181
"regexp", # To match token; if "value" is not None, must have
2182
# a "group" containing digits
2183
"value", # datetime.timedelta or None
2184
"followers")) # Tokens valid after this token
2185
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2186
# the "duration" ABNF definition in RFC 3339, Appendix A.
2187
token_end = Token(re.compile(r"$"), None, frozenset())
2188
token_second = Token(re.compile(r"(\d+)S"),
2189
datetime.timedelta(seconds=1),
2190
frozenset((token_end, )))
2191
token_minute = Token(re.compile(r"(\d+)M"),
2192
datetime.timedelta(minutes=1),
2193
frozenset((token_second, token_end)))
2194
token_hour = Token(re.compile(r"(\d+)H"),
2195
datetime.timedelta(hours=1),
2196
frozenset((token_minute, token_end)))
2197
token_time = Token(re.compile(r"T"),
2199
frozenset((token_hour, token_minute,
2201
token_day = Token(re.compile(r"(\d+)D"),
2202
datetime.timedelta(days=1),
2203
frozenset((token_time, token_end)))
2204
token_month = Token(re.compile(r"(\d+)M"),
2205
datetime.timedelta(weeks=4),
2206
frozenset((token_day, token_end)))
2207
token_year = Token(re.compile(r"(\d+)Y"),
2208
datetime.timedelta(weeks=52),
2209
frozenset((token_month, token_end)))
2210
token_week = Token(re.compile(r"(\d+)W"),
2211
datetime.timedelta(weeks=1),
2212
frozenset((token_end, )))
2213
token_duration = Token(re.compile(r"P"), None,
2214
frozenset((token_year, token_month,
2215
token_day, token_time,
2217
# Define starting values
2218
value = datetime.timedelta() # Value so far
2220
followers = frozenset((token_duration,)) # Following valid tokens
2221
s = duration # String left to parse
2222
# Loop until end token is found
2223
while found_token is not token_end:
2224
# Search for any currently valid tokens
2225
for token in followers:
2226
match = token.regexp.match(s)
2227
if match is not None:
2229
if token.value is not None:
2230
# Value found, parse digits
2231
factor = int(match.group(1), 10)
2232
# Add to value so far
2233
value += factor * token.value
2234
# Strip token from string
2235
s = token.regexp.sub("", s, 1)
2238
# Set valid next tokens
2239
followers = found_token.followers
1008
logger.error(u"Unknown IPC command: %r", cmdline)
1010
# Keep calling this function
2242
# No currently valid tokens were found
2243
raise ValueError("Invalid RFC 3339 duration")
1014
2248
def string_to_delta(interval):
1015
2249
"""Parse a string and return a datetime.timedelta
1017
>>> string_to_delta(u'7d')
2251
>>> string_to_delta('7d')
1018
2252
datetime.timedelta(7)
1019
>>> string_to_delta(u'60s')
2253
>>> string_to_delta('60s')
1020
2254
datetime.timedelta(0, 60)
1021
>>> string_to_delta(u'60m')
2255
>>> string_to_delta('60m')
1022
2256
datetime.timedelta(0, 3600)
1023
>>> string_to_delta(u'24h')
2257
>>> string_to_delta('24h')
1024
2258
datetime.timedelta(1)
1025
>>> string_to_delta(u'1w')
2259
>>> string_to_delta('1w')
1026
2260
datetime.timedelta(7)
1027
>>> string_to_delta(u'5m 30s')
2261
>>> string_to_delta('5m 30s')
1028
2262
datetime.timedelta(0, 330)
2266
return rfc3339_duration_to_delta(interval)
1030
2270
timevalue = datetime.timedelta(0)
1031
2271
for s in interval.split():
1033
suffix = unicode(s[-1])
1034
2274
value = int(s[:-1])
1036
2276
delta = datetime.timedelta(value)
1037
elif suffix == u"s":
1038
2278
delta = datetime.timedelta(0, value)
1039
elif suffix == u"m":
1040
2280
delta = datetime.timedelta(0, 0, 0, 0, value)
1041
elif suffix == u"h":
1042
2282
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1043
elif suffix == u"w":
1044
2284
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1047
except (ValueError, IndexError):
2286
raise ValueError("Unknown suffix {!r}".format(suffix))
2287
except IndexError as e:
2288
raise ValueError(*(e.args))
1049
2289
timevalue += delta
1050
2290
return timevalue
1053
def server_state_changed(state):
1054
"""Derived from the Avahi example code"""
1055
if state == avahi.SERVER_COLLISION:
1056
logger.error(u"Zeroconf server name collision")
1058
elif state == avahi.SERVER_RUNNING:
1062
def entry_group_state_changed(state, error):
1063
"""Derived from the Avahi example code"""
1064
logger.debug(u"Avahi state change: %i", state)
1066
if state == avahi.ENTRY_GROUP_ESTABLISHED:
1067
logger.debug(u"Zeroconf service established.")
1068
elif state == avahi.ENTRY_GROUP_COLLISION:
1069
logger.warning(u"Zeroconf service name collision.")
1071
elif state == avahi.ENTRY_GROUP_FAILURE:
1072
logger.critical(u"Avahi: Error in group state changed %s",
1074
raise AvahiGroupError(u"State changed: %s" % unicode(error))
1076
def if_nametoindex(interface):
1077
"""Call the C function if_nametoindex(), or equivalent
1079
Note: This function cannot accept a unicode string."""
1080
global if_nametoindex
1082
if_nametoindex = (ctypes.cdll.LoadLibrary
1083
(ctypes.util.find_library(u"c"))
1085
except (OSError, AttributeError):
1086
logger.warning(u"Doing if_nametoindex the hard way")
1087
def if_nametoindex(interface):
1088
"Get an interface index the hard way, i.e. using fcntl()"
1089
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1090
with closing(socket.socket()) as s:
1091
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1092
struct.pack(str(u"16s16x"),
1094
interface_index = struct.unpack(str(u"I"),
1096
return interface_index
1097
return if_nametoindex(interface)
1100
2293
def daemon(nochdir = False, noclose = False):
1101
2294
"""See daemon(3). Standard BSD Unix function.
1126
######################################################################
2320
##################################################################
1127
2321
# Parsing of options, both command line and config file
1129
parser = optparse.OptionParser(version = "%%prog %s" % version)
1130
parser.add_option("-i", u"--interface", type=u"string",
1131
metavar="IF", help=u"Bind to interface IF")
1132
parser.add_option("-a", u"--address", type=u"string",
1133
help=u"Address to listen for requests on")
1134
parser.add_option("-p", u"--port", type=u"int",
1135
help=u"Port number to receive requests on")
1136
parser.add_option("--check", action=u"store_true",
1137
help=u"Run self-test")
1138
parser.add_option("--debug", action=u"store_true",
1139
help=u"Debug mode; run in foreground and log to"
1141
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1142
u" priority string (see GnuTLS documentation)")
1143
parser.add_option("--servicename", type=u"string",
1144
metavar=u"NAME", help=u"Zeroconf service name")
1145
parser.add_option("--configdir", type=u"string",
1146
default=u"/etc/mandos", metavar=u"DIR",
1147
help=u"Directory to search for configuration"
1149
parser.add_option("--no-dbus", action=u"store_false",
1150
dest=u"use_dbus", help=u"Do not provide D-Bus"
1151
u" system bus interface")
1152
parser.add_option("--no-ipv6", action=u"store_false",
1153
dest=u"use_ipv6", help=u"Do not use IPv6")
1154
options = parser.parse_args()[0]
2323
parser = argparse.ArgumentParser()
2324
parser.add_argument("-v", "--version", action="version",
2325
version = "%(prog)s {}".format(version),
2326
help="show version number and exit")
2327
parser.add_argument("-i", "--interface", metavar="IF",
2328
help="Bind to interface IF")
2329
parser.add_argument("-a", "--address",
2330
help="Address to listen for requests on")
2331
parser.add_argument("-p", "--port", type=int,
2332
help="Port number to receive requests on")
2333
parser.add_argument("--check", action="store_true",
2334
help="Run self-test")
2335
parser.add_argument("--debug", action="store_true",
2336
help="Debug mode; run in foreground and log"
2337
" to terminal", default=None)
2338
parser.add_argument("--debuglevel", metavar="LEVEL",
2339
help="Debug level for stdout output")
2340
parser.add_argument("--priority", help="GnuTLS"
2341
" priority string (see GnuTLS documentation)")
2342
parser.add_argument("--servicename",
2343
metavar="NAME", help="Zeroconf service name")
2344
parser.add_argument("--configdir",
2345
default="/etc/mandos", metavar="DIR",
2346
help="Directory to search for configuration"
2348
parser.add_argument("--no-dbus", action="store_false",
2349
dest="use_dbus", help="Do not provide D-Bus"
2350
" system bus interface", default=None)
2351
parser.add_argument("--no-ipv6", action="store_false",
2352
dest="use_ipv6", help="Do not use IPv6",
2354
parser.add_argument("--no-restore", action="store_false",
2355
dest="restore", help="Do not restore stored"
2356
" state", default=None)
2357
parser.add_argument("--socket", type=int,
2358
help="Specify a file descriptor to a network"
2359
" socket to use instead of creating one")
2360
parser.add_argument("--statedir", metavar="DIR",
2361
help="Directory to save/restore state in")
2362
parser.add_argument("--foreground", action="store_true",
2363
help="Run in foreground", default=None)
2364
parser.add_argument("--no-zeroconf", action="store_false",
2365
dest="zeroconf", help="Do not use Zeroconf",
2368
options = parser.parse_args()
1156
2370
if options.check:
2372
fail_count, test_count = doctest.testmod()
2373
sys.exit(os.EX_OK if fail_count == 0 else 1)
1161
2375
# Default values for config file for server-global settings
1162
server_defaults = { u"interface": u"",
1167
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1168
u"servicename": u"Mandos",
1169
u"use_dbus": u"True",
1170
u"use_ipv6": u"True",
2376
server_defaults = { "interface": "",
2381
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2382
":+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2383
"servicename": "Mandos",
2389
"statedir": "/var/lib/mandos",
2390
"foreground": "False",
1173
2394
# Parse config file for server-global settings
1174
server_config = ConfigParser.SafeConfigParser(server_defaults)
2395
server_config = configparser.SafeConfigParser(server_defaults)
1175
2396
del server_defaults
1176
server_config.read(os.path.join(options.configdir,
2397
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1178
2398
# Convert the SafeConfigParser object to a dict
1179
2399
server_settings = server_config.defaults()
1180
2400
# Use the appropriate methods on the non-string config options
1181
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1182
server_settings[option] = server_config.getboolean(u"DEFAULT",
2401
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2402
server_settings[option] = server_config.getboolean("DEFAULT",
1184
2404
if server_settings["port"]:
1185
server_settings["port"] = server_config.getint(u"DEFAULT",
2405
server_settings["port"] = server_config.getint("DEFAULT",
2407
if server_settings["socket"]:
2408
server_settings["socket"] = server_config.getint("DEFAULT",
2410
# Later, stdin will, and stdout and stderr might, be dup'ed
2411
# over with an opened os.devnull. But we don't want this to
2412
# happen with a supplied network socket.
2413
if 0 <= server_settings["socket"] <= 2:
2414
server_settings["socket"] = os.dup(server_settings
1187
2416
del server_config
1189
2418
# Override the settings from the config file with command line
1190
2419
# options, if set.
1191
for option in (u"interface", u"address", u"port", u"debug",
1192
u"priority", u"servicename", u"configdir",
1193
u"use_dbus", u"use_ipv6"):
2420
for option in ("interface", "address", "port", "debug",
2421
"priority", "servicename", "configdir", "use_dbus",
2422
"use_ipv6", "debuglevel", "restore", "statedir",
2423
"socket", "foreground", "zeroconf"):
1194
2424
value = getattr(options, option)
1195
2425
if value is not None:
1196
2426
server_settings[option] = value
1198
2428
# Force all strings to be unicode
1199
2429
for option in server_settings.keys():
1200
if type(server_settings[option]) is str:
1201
server_settings[option] = unicode(server_settings[option])
2430
if isinstance(server_settings[option], bytes):
2431
server_settings[option] = (server_settings[option]
2433
# Force all boolean options to be boolean
2434
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2435
"foreground", "zeroconf"):
2436
server_settings[option] = bool(server_settings[option])
2437
# Debug implies foreground
2438
if server_settings["debug"]:
2439
server_settings["foreground"] = True
1202
2440
# Now we have our good server settings in "server_settings"
1204
2442
##################################################################
2444
if (not server_settings["zeroconf"]
2445
and not (server_settings["port"]
2446
or server_settings["socket"] != "")):
2447
parser.error("Needs port or socket to work without Zeroconf")
1206
2449
# For convenience
1207
debug = server_settings[u"debug"]
1208
use_dbus = server_settings[u"use_dbus"]
1209
use_ipv6 = server_settings[u"use_ipv6"]
1212
syslogger.setLevel(logging.WARNING)
1213
console.setLevel(logging.WARNING)
1215
if server_settings[u"servicename"] != u"Mandos":
1216
syslogger.setFormatter(logging.Formatter
1217
(u'Mandos (%s) [%%(process)d]:'
1218
u' %%(levelname)s: %%(message)s'
1219
% server_settings[u"servicename"]))
2450
debug = server_settings["debug"]
2451
debuglevel = server_settings["debuglevel"]
2452
use_dbus = server_settings["use_dbus"]
2453
use_ipv6 = server_settings["use_ipv6"]
2454
stored_state_path = os.path.join(server_settings["statedir"],
2456
foreground = server_settings["foreground"]
2457
zeroconf = server_settings["zeroconf"]
2460
initlogger(debug, logging.DEBUG)
2465
level = getattr(logging, debuglevel.upper())
2466
initlogger(debug, level)
2468
if server_settings["servicename"] != "Mandos":
2469
syslogger.setFormatter(
2470
logging.Formatter('Mandos ({}) [%(process)d]:'
2471
' %(levelname)s: %(message)s'.format(
2472
server_settings["servicename"])))
1221
2474
# Parse config file with clients
1222
client_defaults = { u"timeout": u"1h",
1224
u"checker": u"fping -q -- %%(host)s",
1227
client_config = ConfigParser.SafeConfigParser(client_defaults)
1228
client_config.read(os.path.join(server_settings[u"configdir"],
2475
client_config = configparser.SafeConfigParser(Client
2477
client_config.read(os.path.join(server_settings["configdir"],
1231
2480
global mandos_dbus_service
1232
2481
mandos_dbus_service = None
1235
tcp_server = IPv6_TCPServer((server_settings[u"address"],
1236
server_settings[u"port"]),
1239
server_settings[u"interface"],
1243
server_settings[u"priority"],
1245
pidfilename = u"/var/run/mandos.pid"
1247
pidfile = open(pidfilename, u"w")
1249
logger.error(u"Could not open file %r", pidfilename)
2484
if server_settings["socket"] != "":
2485
socketfd = server_settings["socket"]
2486
tcp_server = MandosServer(
2487
(server_settings["address"], server_settings["port"]),
2489
interface=(server_settings["interface"] or None),
2491
gnutls_priority=server_settings["priority"],
2495
pidfilename = "/run/mandos.pid"
2496
if not os.path.isdir("/run/."):
2497
pidfilename = "/var/run/mandos.pid"
2500
pidfile = open(pidfilename, "w")
2501
except IOError as e:
2502
logger.error("Could not open file %r", pidfilename,
1252
uid = pwd.getpwnam(u"_mandos").pw_uid
1253
gid = pwd.getpwnam(u"_mandos").pw_gid
2505
for name in ("_mandos", "mandos", "nobody"):
1256
uid = pwd.getpwnam(u"mandos").pw_uid
1257
gid = pwd.getpwnam(u"mandos").pw_gid
2507
uid = pwd.getpwnam(name).pw_uid
2508
gid = pwd.getpwnam(name).pw_gid
1258
2510
except KeyError:
1260
uid = pwd.getpwnam(u"nobody").pw_uid
1261
gid = pwd.getpwnam(u"nobody").pw_gid
1268
except OSError, error:
1269
if error[0] != errno.EPERM:
2518
except OSError as error:
2519
if error.errno != errno.EPERM:
1272
# Enable all possible GnuTLS debugging
2523
# Enable all possible GnuTLS debugging
1274
2525
# "Use a log level over 10 to enable all debugging options."
1275
2526
# - GnuTLS manual
1276
2527
gnutls.library.functions.gnutls_global_set_log_level(11)
1278
2529
@gnutls.library.types.gnutls_log_func
1279
2530
def debug_gnutls(level, string):
1280
logger.debug(u"GnuTLS: %s", string[:-1])
1282
(gnutls.library.functions
1283
.gnutls_global_set_log_function(debug_gnutls))
1286
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1287
service = AvahiService(name = server_settings[u"servicename"],
1288
servicetype = u"_mandos._tcp",
1289
protocol = protocol)
1290
if server_settings["interface"]:
1291
service.interface = (if_nametoindex
1292
(str(server_settings[u"interface"])))
2531
logger.debug("GnuTLS: %s", string[:-1])
2533
gnutls.library.functions.gnutls_global_set_log_function(
2536
# Redirect stdin so all checkers get /dev/null
2537
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2538
os.dup2(null, sys.stdin.fileno())
2542
# Need to fork before connecting to D-Bus
2544
# Close all input and output, do double fork, etc.
2547
# multiprocessing will use threads, so before we use gobject we
2548
# need to inform gobject that threads will be used.
2549
gobject.threads_init()
1294
2551
global main_loop
1297
2552
# From the Avahi example code
1298
DBusGMainLoop(set_as_default=True )
2553
DBusGMainLoop(set_as_default=True)
1299
2554
main_loop = gobject.MainLoop()
1300
2555
bus = dbus.SystemBus()
1301
server = dbus.Interface(bus.get_object(avahi.DBUS_NAME,
1302
avahi.DBUS_PATH_SERVER),
1303
avahi.DBUS_INTERFACE_SERVER)
1304
2556
# End of Avahi example code
1306
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
2559
bus_name = dbus.service.BusName("se.recompile.Mandos",
2562
old_bus_name = dbus.service.BusName(
2563
"se.bsnet.fukt.Mandos", bus,
2565
except dbus.exceptions.NameExistsException as e:
2566
logger.error("Disabling D-Bus:", exc_info=e)
2568
server_settings["use_dbus"] = False
2569
tcp_server.use_dbus = False
2571
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2572
service = AvahiServiceToSyslog(
2573
name = server_settings["servicename"],
2574
servicetype = "_mandos._tcp",
2575
protocol = protocol,
2577
if server_settings["interface"]:
2578
service.interface = if_nametoindex(
2579
server_settings["interface"].encode("utf-8"))
2581
global multiprocessing_manager
2582
multiprocessing_manager = multiprocessing.Manager()
1308
2584
client_class = Client
1310
client_class = ClientDBus
1312
client_class(name = section,
1313
config= dict(client_config.items(section)))
1314
for section in client_config.sections()))
1316
logger.warning(u"No clients defined")
1319
# Redirect stdin so all checkers get /dev/null
1320
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1321
os.dup2(null, sys.stdin.fileno())
1325
# No console logging
1326
logger.removeHandler(console)
1327
# Close all input and output, do double fork, etc.
1331
with closing(pidfile):
1333
pidfile.write(str(pid) + "\n")
2586
client_class = functools.partial(ClientDBus, bus = bus)
2588
client_settings = Client.config_parser(client_config)
2589
old_client_settings = {}
2592
# This is used to redirect stdout and stderr for checker processes
2594
wnull = open(os.devnull, "w") # A writable /dev/null
2595
# Only used if server is running in foreground but not in debug
2597
if debug or not foreground:
2600
# Get client data and settings from last running state.
2601
if server_settings["restore"]:
2603
with open(stored_state_path, "rb") as stored_state:
2604
clients_data, old_client_settings = pickle.load(
2606
os.remove(stored_state_path)
2607
except IOError as e:
2608
if e.errno == errno.ENOENT:
2609
logger.warning("Could not load persistent state:"
2610
" {}".format(os.strerror(e.errno)))
2612
logger.critical("Could not load persistent state:",
2615
except EOFError as e:
2616
logger.warning("Could not load persistent state: "
2620
with PGPEngine() as pgp:
2621
for client_name, client in clients_data.items():
2622
# Skip removed clients
2623
if client_name not in client_settings:
2626
# Decide which value to use after restoring saved state.
2627
# We have three different values: Old config file,
2628
# new config file, and saved state.
2629
# New config value takes precedence if it differs from old
2630
# config value, otherwise use saved state.
2631
for name, value in client_settings[client_name].items():
2633
# For each value in new config, check if it
2634
# differs from the old config value (Except for
2635
# the "secret" attribute)
2636
if (name != "secret"
2638
old_client_settings[client_name][name])):
2639
client[name] = value
2643
# Clients who has passed its expire date can still be
2644
# enabled if its last checker was successful. A Client
2645
# whose checker succeeded before we stored its state is
2646
# assumed to have successfully run all checkers during
2648
if client["enabled"]:
2649
if datetime.datetime.utcnow() >= client["expires"]:
2650
if not client["last_checked_ok"]:
2652
"disabling client {} - Client never "
2653
"performed a successful checker".format(
2655
client["enabled"] = False
2656
elif client["last_checker_status"] != 0:
2658
"disabling client {} - Client last"
2659
" checker failed with error code"
2662
client["last_checker_status"]))
2663
client["enabled"] = False
2665
client["expires"] = (
2666
datetime.datetime.utcnow()
2667
+ client["timeout"])
2668
logger.debug("Last checker succeeded,"
2669
" keeping {} enabled".format(
2672
client["secret"] = pgp.decrypt(
2673
client["encrypted_secret"],
2674
client_settings[client_name]["secret"])
2676
# If decryption fails, we use secret from new settings
2677
logger.debug("Failed to decrypt {} old secret".format(
2679
client["secret"] = (client_settings[client_name]
2682
# Add/remove clients based on new changes made to config
2683
for client_name in (set(old_client_settings)
2684
- set(client_settings)):
2685
del clients_data[client_name]
2686
for client_name in (set(client_settings)
2687
- set(old_client_settings)):
2688
clients_data[client_name] = client_settings[client_name]
2690
# Create all client objects
2691
for client_name, client in clients_data.items():
2692
tcp_server.clients[client_name] = client_class(
2695
server_settings = server_settings)
2697
if not tcp_server.clients:
2698
logger.warning("No clients defined")
2701
if pidfile is not None:
2705
pidfile.write("{}\n".format(pid).encode("utf-8"))
2707
logger.error("Could not write to file %r with PID %d",
1336
logger.error(u"Could not write to file %r with PID %d",
1339
# "pidfile" was never created
1344
"Cleanup function; run on exit"
1346
# From the Avahi example code
1347
if not group is None:
1350
# End of Avahi example code
1353
client = clients.pop()
1354
client.disable_hook = None
1357
atexit.register(cleanup)
1360
signal.signal(signal.SIGINT, signal.SIG_IGN)
1361
2712
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1362
2713
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
1365
class MandosDBusService(dbus.service.Object):
2717
@alternate_dbus_interfaces(
2718
{ "se.recompile.Mandos": "se.bsnet.fukt.Mandos" })
2719
class MandosDBusService(DBusObjectWithProperties):
1366
2720
"""A D-Bus proxy object"""
1367
2722
def __init__(self):
1368
dbus.service.Object.__init__(self, bus, u"/")
1369
_interface = u"se.bsnet.fukt.Mandos"
1371
@dbus.service.signal(_interface, signature=u"oa{sv}")
1372
def ClientAdded(self, objpath, properties):
1376
@dbus.service.signal(_interface, signature=u"s")
1377
def ClientNotFound(self, fingerprint):
1381
@dbus.service.signal(_interface, signature=u"os")
2723
dbus.service.Object.__init__(self, bus, "/")
2725
_interface = "se.recompile.Mandos"
2727
@dbus_interface_annotations(_interface)
2730
"org.freedesktop.DBus.Property.EmitsChangedSignal":
2733
@dbus.service.signal(_interface, signature="o")
2734
def ClientAdded(self, objpath):
2738
@dbus.service.signal(_interface, signature="ss")
2739
def ClientNotFound(self, fingerprint, address):
2743
@dbus.service.signal(_interface, signature="os")
1382
2744
def ClientRemoved(self, objpath, name):
1386
@dbus.service.method(_interface, out_signature=u"ao")
2748
@dbus.service.method(_interface, out_signature="ao")
1387
2749
def GetAllClients(self):
1389
return dbus.Array(c.dbus_object_path for c in clients)
2751
return dbus.Array(c.dbus_object_path for c in
2752
tcp_server.clients.itervalues())
1391
2754
@dbus.service.method(_interface,
1392
out_signature=u"a{oa{sv}}")
2755
out_signature="a{oa{sv}}")
1393
2756
def GetAllClientsWithProperties(self):
1395
2758
return dbus.Dictionary(
1396
((c.dbus_object_path, c.GetAllProperties())
1398
signature=u"oa{sv}")
2759
{ c.dbus_object_path: c.GetAll("")
2760
for c in tcp_server.clients.itervalues() },
1400
@dbus.service.method(_interface, in_signature=u"o")
2763
@dbus.service.method(_interface, in_signature="o")
1401
2764
def RemoveClient(self, object_path):
2766
for c in tcp_server.clients.itervalues():
1404
2767
if c.dbus_object_path == object_path:
2768
del tcp_server.clients[c.name]
1406
2769
c.remove_from_connection()
1407
2770
# Don't signal anything except ClientRemoved
1408
c.disable(signal=False)
2771
c.disable(quiet=True)
1409
2772
# Emit D-Bus signal
1410
2773
self.ClientRemoved(object_path, c.name)
2775
raise KeyError(object_path)
1416
2779
mandos_dbus_service = MandosDBusService()
1418
for client in clients:
2782
"Cleanup function; run on exit"
2786
multiprocessing.active_children()
2788
if not (tcp_server.clients or client_settings):
2791
# Store client before exiting. Secrets are encrypted with key
2792
# based on what config file has. If config file is
2793
# removed/edited, old secret will thus be unrecovable.
2795
with PGPEngine() as pgp:
2796
for client in tcp_server.clients.itervalues():
2797
key = client_settings[client.name]["secret"]
2798
client.encrypted_secret = pgp.encrypt(client.secret,
2802
# A list of attributes that can not be pickled
2804
exclude = { "bus", "changedstate", "secret",
2805
"checker", "server_settings" }
2806
for name, typ in inspect.getmembers(dbus.service
2810
client_dict["encrypted_secret"] = (client
2812
for attr in client.client_structure:
2813
if attr not in exclude:
2814
client_dict[attr] = getattr(client, attr)
2816
clients[client.name] = client_dict
2817
del client_settings[client.name]["secret"]
2820
with tempfile.NamedTemporaryFile(
2824
dir=os.path.dirname(stored_state_path),
2825
delete=False) as stored_state:
2826
pickle.dump((clients, client_settings), stored_state)
2827
tempname = stored_state.name
2828
os.rename(tempname, stored_state_path)
2829
except (IOError, OSError) as e:
2835
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2836
logger.warning("Could not save persistent state: {}"
2837
.format(os.strerror(e.errno)))
2839
logger.warning("Could not save persistent state:",
2843
# Delete all clients, and settings from config
2844
while tcp_server.clients:
2845
name, client = tcp_server.clients.popitem()
2847
client.remove_from_connection()
2848
# Don't signal anything except ClientRemoved
2849
client.disable(quiet=True)
2852
mandos_dbus_service.ClientRemoved(
2853
client.dbus_object_path, client.name)
2854
client_settings.clear()
2856
atexit.register(cleanup)
2858
for client in tcp_server.clients.itervalues():
1420
2860
# Emit D-Bus signal
1421
mandos_dbus_service.ClientAdded(client.dbus_object_path,
1422
client.GetAllProperties())
2861
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2862
# Need to initiate checking of clients
2864
client.init_checker()
1425
2866
tcp_server.enable()
1426
2867
tcp_server.server_activate()
1428
2869
# Find out what port we got
1429
service.port = tcp_server.socket.getsockname()[1]
2871
service.port = tcp_server.socket.getsockname()[1]
1431
logger.info(u"Now listening on address %r, port %d,"
1432
" flowinfo %d, scope_id %d"
1433
% tcp_server.socket.getsockname())
2873
logger.info("Now listening on address %r, port %d,"
2874
" flowinfo %d, scope_id %d",
2875
*tcp_server.socket.getsockname())
1435
logger.info(u"Now listening on address %r, port %d"
1436
% tcp_server.socket.getsockname())
2877
logger.info("Now listening on address %r, port %d",
2878
*tcp_server.socket.getsockname())
1438
2880
#service.interface = tcp_server.socket.getsockname()[3]
1441
# From the Avahi example code
1442
server.connect_to_signal(u"StateChanged", server_state_changed)
1444
server_state_changed(server.GetState())
1445
except dbus.exceptions.DBusException, error:
1446
logger.critical(u"DBusException: %s", error)
1448
# End of Avahi example code
2884
# From the Avahi example code
2887
except dbus.exceptions.DBusException as error:
2888
logger.critical("D-Bus Exception", exc_info=error)
2891
# End of Avahi example code
1450
2893
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1451
2894
lambda *args, **kwargs:
1452
2895
(tcp_server.handle_request
1453
2896
(*args[2:], **kwargs) or True))
1455
logger.debug(u"Starting main loop")
2898
logger.debug("Starting main loop")
1456
2899
main_loop.run()
1457
except AvahiError, error:
1458
logger.critical(u"AvahiError: %s", error)
2900
except AvahiError as error:
2901
logger.critical("Avahi Error", exc_info=error)
1460
2904
except KeyboardInterrupt:
1463
logger.debug(u"Server received KeyboardInterrupt")
1464
logger.debug(u"Server exiting")
2906
print("", file=sys.stderr)
2907
logger.debug("Server received KeyboardInterrupt")
2908
logger.debug("Server exiting")
2909
# Must run before the D-Bus bus name gets deregistered
1466
2913
if __name__ == '__main__':