174
194
def password_encode(self, password):
175
195
# Passphrase can not be empty and can not contain newlines or
176
196
# NUL bytes. So we prefix it and hex encode it.
177
return b"mandos" + binascii.hexlify(password)
197
encoded = b"mandos" + binascii.hexlify(password)
198
if len(encoded) > 2048:
199
# GnuPG can't handle long passwords, so encode differently
200
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
201
.replace(b"\n", b"\\n")
202
.replace(b"\0", b"\\x00"))
179
205
def encrypt(self, data, password):
180
self.gnupg.passphrase = self.password_encode(password)
181
with open(os.devnull, "w") as devnull:
183
proc = self.gnupg.run(['--symmetric'],
184
create_fhs=['stdin', 'stdout'],
185
attach_fhs={'stderr': devnull})
186
with contextlib.closing(proc.handles['stdin']) as f:
188
with contextlib.closing(proc.handles['stdout']) as f:
189
ciphertext = f.read()
193
self.gnupg.passphrase = None
206
passphrase = self.password_encode(password)
207
with tempfile.NamedTemporaryFile(
208
dir=self.tempdir) as passfile:
209
passfile.write(passphrase)
211
proc = subprocess.Popen([self.gpg, '--symmetric',
215
stdin = subprocess.PIPE,
216
stdout = subprocess.PIPE,
217
stderr = subprocess.PIPE)
218
ciphertext, err = proc.communicate(input = data)
219
if proc.returncode != 0:
194
221
return ciphertext
196
223
def decrypt(self, data, password):
197
self.gnupg.passphrase = self.password_encode(password)
198
with open(os.devnull, "w") as devnull:
200
proc = self.gnupg.run(['--decrypt'],
201
create_fhs=['stdin', 'stdout'],
202
attach_fhs={'stderr': devnull})
203
with contextlib.closing(proc.handles['stdin']) as f:
205
with contextlib.closing(proc.handles['stdout']) as f:
206
decrypted_plaintext = f.read()
210
self.gnupg.passphrase = None
224
passphrase = self.password_encode(password)
225
with tempfile.NamedTemporaryFile(
226
dir = self.tempdir) as passfile:
227
passfile.write(passphrase)
229
proc = subprocess.Popen([self.gpg, '--decrypt',
233
stdin = subprocess.PIPE,
234
stdout = subprocess.PIPE,
235
stderr = subprocess.PIPE)
236
decrypted_plaintext, err = proc.communicate(input = data)
237
if proc.returncode != 0:
211
239
return decrypted_plaintext
214
242
class AvahiError(Exception):
215
243
def __init__(self, value, *args, **kwargs):
216
244
self.value = value
217
super(AvahiError, self).__init__(value, *args, **kwargs)
218
def __unicode__(self):
219
return unicode(repr(self.value))
245
return super(AvahiError, self).__init__(value, *args,
221
249
class AvahiServiceError(AvahiError):
224
253
class AvahiGroupError(AvahiError):
376
427
follow_name_owner_changes=True),
377
428
avahi.DBUS_INTERFACE_SERVER)
378
429
self.server.connect_to_signal("StateChanged",
379
self.server_state_changed)
430
self.server_state_changed)
380
431
self.server_state_changed(self.server.GetState())
382
434
class AvahiServiceToSyslog(AvahiService):
435
def rename(self, *args, **kwargs):
384
436
"""Add the new name to the syslog messages"""
385
ret = AvahiService.rename(self)
386
syslogger.setFormatter(logging.Formatter
387
('Mandos ({0}) [%(process)d]:'
388
' %(levelname)s: %(message)s'
437
ret = AvahiService.rename(self, *args, **kwargs)
438
syslogger.setFormatter(logging.Formatter(
439
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
392
def timedelta_to_milliseconds(td):
393
"Convert a datetime.timedelta() to milliseconds"
394
return ((td.days * 24 * 60 * 60 * 1000)
395
+ (td.seconds * 1000)
396
+ (td.microseconds // 1000))
443
# Pretend that we have a GnuTLS module
444
class GnuTLS(object):
445
"""This isn't so much a class as it is a module-like namespace.
446
It is instantiated once, and simulates having a GnuTLS module."""
448
_library = ctypes.cdll.LoadLibrary(
449
ctypes.util.find_library("gnutls"))
450
_need_version = "3.3.0"
452
# Need to use class name "GnuTLS" here, since this method is
453
# called before the assignment to the "gnutls" global variable
455
if GnuTLS.check_version(self._need_version) is None:
456
raise GnuTLS.Error("Needs GnuTLS {} or later"
457
.format(self._need_version))
459
# Unless otherwise indicated, the constants and types below are
460
# all from the gnutls/gnutls.h C header file.
470
E_NO_CERTIFICATE_FOUND = -49
471
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
474
class session_int(ctypes.Structure):
476
session_t = ctypes.POINTER(session_int)
477
class certificate_credentials_st(ctypes.Structure):
479
certificate_credentials_t = ctypes.POINTER(
480
certificate_credentials_st)
481
certificate_type_t = ctypes.c_int
482
class datum_t(ctypes.Structure):
483
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
484
('size', ctypes.c_uint)]
485
class openpgp_crt_int(ctypes.Structure):
487
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
488
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
489
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
490
credentials_type_t = ctypes.c_int #
491
transport_ptr_t = ctypes.c_void_p
492
close_request_t = ctypes.c_int
495
class Error(Exception):
496
# We need to use the class name "GnuTLS" here, since this
497
# exception might be raised from within GnuTLS.__init__,
498
# which is called before the assignment to the "gnutls"
499
# global variable has happened.
500
def __init__(self, message = None, code = None, args=()):
501
# Default usage is by a message string, but if a return
502
# code is passed, convert it to a string with
505
if message is None and code is not None:
506
message = GnuTLS.strerror(code)
507
return super(GnuTLS.Error, self).__init__(
510
class CertificateSecurityError(Error):
514
class Credentials(object):
516
self._c_object = gnutls.certificate_credentials_t()
517
gnutls.certificate_allocate_credentials(
518
ctypes.byref(self._c_object))
519
self.type = gnutls.CRD_CERTIFICATE
522
gnutls.certificate_free_credentials(self._c_object)
524
class ClientSession(object):
525
def __init__(self, socket, credentials = None):
526
self._c_object = gnutls.session_t()
527
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
528
gnutls.set_default_priority(self._c_object)
529
gnutls.transport_set_ptr(self._c_object, socket.fileno())
530
gnutls.handshake_set_private_extensions(self._c_object,
533
if credentials is None:
534
credentials = gnutls.Credentials()
535
gnutls.credentials_set(self._c_object, credentials.type,
536
ctypes.cast(credentials._c_object,
538
self.credentials = credentials
541
gnutls.deinit(self._c_object)
544
return gnutls.handshake(self._c_object)
546
def send(self, data):
550
data_len -= gnutls.record_send(self._c_object,
555
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
557
# Error handling functions
558
def _error_code(result):
559
"""A function to raise exceptions on errors, suitable
560
for the 'restype' attribute on ctypes functions"""
563
if result == gnutls.E_NO_CERTIFICATE_FOUND:
564
raise gnutls.CertificateSecurityError(code = result)
565
raise gnutls.Error(code = result)
567
def _retry_on_error(result, func, arguments):
568
"""A function to retry on some errors, suitable
569
for the 'errcheck' attribute on ctypes functions"""
571
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
572
return _error_code(result)
573
result = func(*arguments)
576
# Unless otherwise indicated, the function declarations below are
577
# all from the gnutls/gnutls.h C header file.
580
priority_set_direct = _library.gnutls_priority_set_direct
581
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
582
ctypes.POINTER(ctypes.c_char_p)]
583
priority_set_direct.restype = _error_code
585
init = _library.gnutls_init
586
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
587
init.restype = _error_code
589
set_default_priority = _library.gnutls_set_default_priority
590
set_default_priority.argtypes = [session_t]
591
set_default_priority.restype = _error_code
593
record_send = _library.gnutls_record_send
594
record_send.argtypes = [session_t, ctypes.c_void_p,
596
record_send.restype = ctypes.c_ssize_t
597
record_send.errcheck = _retry_on_error
599
certificate_allocate_credentials = (
600
_library.gnutls_certificate_allocate_credentials)
601
certificate_allocate_credentials.argtypes = [
602
ctypes.POINTER(certificate_credentials_t)]
603
certificate_allocate_credentials.restype = _error_code
605
certificate_free_credentials = (
606
_library.gnutls_certificate_free_credentials)
607
certificate_free_credentials.argtypes = [certificate_credentials_t]
608
certificate_free_credentials.restype = None
610
handshake_set_private_extensions = (
611
_library.gnutls_handshake_set_private_extensions)
612
handshake_set_private_extensions.argtypes = [session_t,
614
handshake_set_private_extensions.restype = None
616
credentials_set = _library.gnutls_credentials_set
617
credentials_set.argtypes = [session_t, credentials_type_t,
619
credentials_set.restype = _error_code
621
strerror = _library.gnutls_strerror
622
strerror.argtypes = [ctypes.c_int]
623
strerror.restype = ctypes.c_char_p
625
certificate_type_get = _library.gnutls_certificate_type_get
626
certificate_type_get.argtypes = [session_t]
627
certificate_type_get.restype = _error_code
629
certificate_get_peers = _library.gnutls_certificate_get_peers
630
certificate_get_peers.argtypes = [session_t,
631
ctypes.POINTER(ctypes.c_uint)]
632
certificate_get_peers.restype = ctypes.POINTER(datum_t)
634
global_set_log_level = _library.gnutls_global_set_log_level
635
global_set_log_level.argtypes = [ctypes.c_int]
636
global_set_log_level.restype = None
638
global_set_log_function = _library.gnutls_global_set_log_function
639
global_set_log_function.argtypes = [log_func]
640
global_set_log_function.restype = None
642
deinit = _library.gnutls_deinit
643
deinit.argtypes = [session_t]
644
deinit.restype = None
646
handshake = _library.gnutls_handshake
647
handshake.argtypes = [session_t]
648
handshake.restype = _error_code
649
handshake.errcheck = _retry_on_error
651
transport_set_ptr = _library.gnutls_transport_set_ptr
652
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
653
transport_set_ptr.restype = None
655
bye = _library.gnutls_bye
656
bye.argtypes = [session_t, close_request_t]
657
bye.restype = _error_code
658
bye.errcheck = _retry_on_error
660
check_version = _library.gnutls_check_version
661
check_version.argtypes = [ctypes.c_char_p]
662
check_version.restype = ctypes.c_char_p
664
# All the function declarations below are from gnutls/openpgp.h
666
openpgp_crt_init = _library.gnutls_openpgp_crt_init
667
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
668
openpgp_crt_init.restype = _error_code
670
openpgp_crt_import = _library.gnutls_openpgp_crt_import
671
openpgp_crt_import.argtypes = [openpgp_crt_t,
672
ctypes.POINTER(datum_t),
674
openpgp_crt_import.restype = _error_code
676
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
677
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
678
ctypes.POINTER(ctypes.c_uint)]
679
openpgp_crt_verify_self.restype = _error_code
681
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
682
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
683
openpgp_crt_deinit.restype = None
685
openpgp_crt_get_fingerprint = (
686
_library.gnutls_openpgp_crt_get_fingerprint)
687
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
691
openpgp_crt_get_fingerprint.restype = _error_code
693
# Remove non-public functions
694
del _error_code, _retry_on_error
695
# Create the global "gnutls" object, simulating a module
698
def call_pipe(connection, # : multiprocessing.Connection
699
func, *args, **kwargs):
700
"""This function is meant to be called by multiprocessing.Process
702
This function runs func(*args, **kwargs), and writes the resulting
703
return value on the provided multiprocessing.Connection.
705
connection.send(func(*args, **kwargs))
398
708
class Client(object):
399
709
"""A representation of a client host served by this server.
436
748
runtime_expansions: Allowed attributes for runtime expansion.
437
749
expires: datetime.datetime(); time (UTC) when a client will be
438
750
disabled, or None
751
server_settings: The server_settings dict from main()
441
754
runtime_expansions = ("approval_delay", "approval_duration",
442
"created", "enabled", "fingerprint",
443
"host", "interval", "last_checked_ok",
755
"created", "enabled", "expires",
756
"fingerprint", "host", "interval",
757
"last_approval_request", "last_checked_ok",
444
758
"last_enabled", "name", "timeout")
445
client_defaults = { "timeout": "5m",
446
"extended_timeout": "15m",
448
"checker": "fping -q -- %%(host)s",
450
"approval_delay": "0s",
451
"approval_duration": "1s",
452
"approved_by_default": "True",
456
def timeout_milliseconds(self):
457
"Return the 'timeout' attribute in milliseconds"
458
return timedelta_to_milliseconds(self.timeout)
460
def extended_timeout_milliseconds(self):
461
"Return the 'extended_timeout' attribute in milliseconds"
462
return timedelta_to_milliseconds(self.extended_timeout)
464
def interval_milliseconds(self):
465
"Return the 'interval' attribute in milliseconds"
466
return timedelta_to_milliseconds(self.interval)
468
def approval_delay_milliseconds(self):
469
return timedelta_to_milliseconds(self.approval_delay)
761
"extended_timeout": "PT15M",
763
"checker": "fping -q -- %%(host)s",
765
"approval_delay": "PT0S",
766
"approval_duration": "PT1S",
767
"approved_by_default": "True",
472
772
def config_parser(config):
606
906
# and every interval from then on.
607
907
if self.checker_initiator_tag is not None:
608
908
gobject.source_remove(self.checker_initiator_tag)
609
self.checker_initiator_tag = (gobject.timeout_add
610
(self.interval_milliseconds(),
909
self.checker_initiator_tag = gobject.timeout_add(
910
int(self.interval.total_seconds() * 1000),
612
912
# Schedule a disable() when 'timeout' has passed
613
913
if self.disable_initiator_tag is not None:
614
914
gobject.source_remove(self.disable_initiator_tag)
615
self.disable_initiator_tag = (gobject.timeout_add
616
(self.timeout_milliseconds(),
915
self.disable_initiator_tag = gobject.timeout_add(
916
int(self.timeout.total_seconds() * 1000), self.disable)
618
917
# Also start a new checker *right now*.
619
918
self.start_checker()
621
def checker_callback(self, pid, condition, command):
920
def checker_callback(self, source, condition, connection,
622
922
"""The checker has completed, so take appropriate actions."""
623
923
self.checker_callback_tag = None
624
924
self.checker = None
625
if os.WIFEXITED(condition):
626
self.last_checker_status = os.WEXITSTATUS(condition)
925
# Read return code from connection (see call_pipe)
926
returncode = connection.recv()
930
self.last_checker_status = returncode
931
self.last_checker_signal = None
627
932
if self.last_checker_status == 0:
628
933
logger.info("Checker for %(name)s succeeded",
630
935
self.checked_ok()
632
logger.info("Checker for %(name)s failed",
937
logger.info("Checker for %(name)s failed", vars(self))
635
939
self.last_checker_status = -1
940
self.last_checker_signal = -returncode
636
941
logger.warning("Checker for %(name)s crashed?",
639
945
def checked_ok(self):
640
946
"""Assert that the client has been seen, alive and well."""
641
947
self.last_checked_ok = datetime.datetime.utcnow()
642
948
self.last_checker_status = 0
949
self.last_checker_signal = None
643
950
self.bump_timeout()
645
952
def bump_timeout(self, timeout=None):
672
978
# than 'timeout' for the client to be disabled, which is as it
675
# If a checker exists, make sure it is not a zombie
677
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
678
except (AttributeError, OSError) as error:
679
if (isinstance(error, OSError)
680
and error.errno != errno.ECHILD):
684
logger.warning("Checker was a zombie")
685
gobject.source_remove(self.checker_callback_tag)
686
self.checker_callback(pid, status,
687
self.current_checker_command)
981
if self.checker is not None and not self.checker.is_alive():
982
logger.warning("Checker was not alive; joining")
688
985
# Start a new checker if needed
689
986
if self.checker is None:
987
# Escape attributes for the shell
989
attr: re.escape(str(getattr(self, attr)))
990
for attr in self.runtime_expansions }
691
# In case checker_command has exactly one % operator
692
command = self.checker_command % self.host
694
# Escape attributes for the shell
695
escaped_attrs = dict(
697
re.escape(unicode(str(getattr(self, attr, "")),
701
self.runtime_expansions)
704
command = self.checker_command % escaped_attrs
705
except TypeError as error:
706
logger.error('Could not format string "%s"',
707
self.checker_command, exc_info=error)
708
return True # Try again later
992
command = self.checker_command % escaped_attrs
993
except TypeError as error:
994
logger.error('Could not format string "%s"',
995
self.checker_command,
997
return True # Try again later
709
998
self.current_checker_command = command
711
logger.info("Starting checker %r for %s",
713
# We don't need to redirect stdout and stderr, since
714
# in normal mode, that is already done by daemon(),
715
# and in debug mode we don't want to. (Stdin is
716
# always replaced by /dev/null.)
717
self.checker = subprocess.Popen(command,
720
self.checker_callback_tag = (gobject.child_watch_add
722
self.checker_callback,
724
# The checker may have completed before the gobject
725
# watch was added. Check for this.
726
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
728
gobject.source_remove(self.checker_callback_tag)
729
self.checker_callback(pid, status, command)
730
except OSError as error:
731
logger.error("Failed to start subprocess",
999
logger.info("Starting checker %r for %s", command,
1001
# We don't need to redirect stdout and stderr, since
1002
# in normal mode, that is already done by daemon(),
1003
# and in debug mode we don't want to. (Stdin is
1004
# always replaced by /dev/null.)
1005
# The exception is when not debugging but nevertheless
1006
# running in the foreground; use the previously
1008
popen_args = { "close_fds": True,
1011
if (not self.server_settings["debug"]
1012
and self.server_settings["foreground"]):
1013
popen_args.update({"stdout": wnull,
1015
pipe = multiprocessing.Pipe(duplex = False)
1016
self.checker = multiprocessing.Process(
1018
args = (pipe[1], subprocess.call, command),
1019
kwargs = popen_args)
1020
self.checker.start()
1021
self.checker_callback_tag = gobject.io_add_watch(
1022
pipe[0].fileno(), gobject.IO_IN,
1023
self.checker_callback, pipe[0], command)
733
1024
# Re-run this periodically if run by gobject.timeout_add
853
1145
If called like _is_dbus_thing("method") it returns a function
854
1146
suitable for use as predicate to inspect.getmembers().
856
return lambda obj: getattr(obj, "_dbus_is_{0}".format(thing),
1148
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
859
1151
def _get_all_dbus_things(self, thing):
860
1152
"""Returns a generator of (name, attribute) pairs
862
return ((getattr(athing.__get__(self), "_dbus_name",
1154
return ((getattr(athing.__get__(self), "_dbus_name", name),
864
1155
athing.__get__(self))
865
1156
for cls in self.__class__.__mro__
866
1157
for name, athing in
867
inspect.getmembers(cls,
868
self._is_dbus_thing(thing)))
1158
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1160
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1161
out_signature = "s",
1162
path_keyword = 'object_path',
1163
connection_keyword = 'connection')
1164
def Introspect(self, object_path, connection):
1165
"""Overloading of standard D-Bus method.
1167
Inserts annotation tags on methods and signals.
1169
xmlstring = dbus.service.Object.Introspect(self, object_path,
1172
document = xml.dom.minidom.parseString(xmlstring)
1174
for if_tag in document.getElementsByTagName("interface"):
1175
# Add annotation tags
1176
for typ in ("method", "signal"):
1177
for tag in if_tag.getElementsByTagName(typ):
1179
for name, prop in (self.
1180
_get_all_dbus_things(typ)):
1181
if (name == tag.getAttribute("name")
1182
and prop._dbus_interface
1183
== if_tag.getAttribute("name")):
1184
annots.update(getattr(
1185
prop, "_dbus_annotations", {}))
1186
for name, value in annots.items():
1187
ann_tag = document.createElement(
1189
ann_tag.setAttribute("name", name)
1190
ann_tag.setAttribute("value", value)
1191
tag.appendChild(ann_tag)
1192
# Add interface annotation tags
1193
for annotation, value in dict(
1194
itertools.chain.from_iterable(
1195
annotations().items()
1196
for name, annotations
1197
in self._get_all_dbus_things("interface")
1198
if name == if_tag.getAttribute("name")
1200
ann_tag = document.createElement("annotation")
1201
ann_tag.setAttribute("name", annotation)
1202
ann_tag.setAttribute("value", value)
1203
if_tag.appendChild(ann_tag)
1204
# Fix argument name for the Introspect method itself
1205
if (if_tag.getAttribute("name")
1206
== dbus.INTROSPECTABLE_IFACE):
1207
for cn in if_tag.getElementsByTagName("method"):
1208
if cn.getAttribute("name") == "Introspect":
1209
for arg in cn.getElementsByTagName("arg"):
1210
if (arg.getAttribute("direction")
1212
arg.setAttribute("name",
1214
xmlstring = document.toxml("utf-8")
1216
except (AttributeError, xml.dom.DOMException,
1217
xml.parsers.expat.ExpatError) as error:
1218
logger.error("Failed to override Introspection method",
1223
class DBusObjectWithProperties(DBusObjectWithAnnotations):
1224
"""A D-Bus object with properties.
1226
Classes inheriting from this can use the dbus_service_property
1227
decorator to expose methods as D-Bus properties. It exposes the
1228
standard Get(), Set(), and GetAll() methods on the D-Bus.
870
1231
def _get_dbus_property(self, interface_name, property_name):
871
1232
"""Returns a bound method if one exists which is a D-Bus
872
1233
property with the specified name and interface.
874
for cls in self.__class__.__mro__:
875
for name, value in (inspect.getmembers
877
self._is_dbus_thing("property"))):
1235
for cls in self.__class__.__mro__:
1236
for name, value in inspect.getmembers(
1237
cls, self._is_dbus_thing("property")):
878
1238
if (value._dbus_name == property_name
879
1239
and value._dbus_interface == interface_name):
880
1240
return value.__get__(self)
882
1242
# No such property
883
raise DBusPropertyNotFound(self.dbus_object_path + ":"
884
+ interface_name + "."
887
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
1243
raise DBusPropertyNotFound("{}:{}.{}".format(
1244
self.dbus_object_path, interface_name, property_name))
1247
def _get_all_interface_names(cls):
1248
"""Get a sequence of all interfaces supported by an object"""
1249
return (name for name in set(getattr(getattr(x, attr),
1250
"_dbus_interface", None)
1251
for x in (inspect.getmro(cls))
1253
if name is not None)
1255
@dbus.service.method(dbus.PROPERTIES_IFACE,
888
1257
out_signature="v")
889
1258
def Get(self, interface_name, property_name):
890
1259
"""Standard D-Bus property Get() method, see D-Bus standard.
1019
1387
exc_info=error)
1020
1388
return xmlstring
1023
def datetime_to_dbus (dt, variant_level=0):
1391
dbus.OBJECT_MANAGER_IFACE
1392
except AttributeError:
1393
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1395
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1396
"""A D-Bus object with an ObjectManager.
1398
Classes inheriting from this exposes the standard
1399
GetManagedObjects call and the InterfacesAdded and
1400
InterfacesRemoved signals on the standard
1401
"org.freedesktop.DBus.ObjectManager" interface.
1403
Note: No signals are sent automatically; they must be sent
1406
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1407
out_signature = "a{oa{sa{sv}}}")
1408
def GetManagedObjects(self):
1409
"""This function must be overridden"""
1410
raise NotImplementedError()
1412
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1413
signature = "oa{sa{sv}}")
1414
def InterfacesAdded(self, object_path, interfaces_and_properties):
1417
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1418
def InterfacesRemoved(self, object_path, interfaces):
1421
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1422
out_signature = "s",
1423
path_keyword = 'object_path',
1424
connection_keyword = 'connection')
1425
def Introspect(self, object_path, connection):
1426
"""Overloading of standard D-Bus method.
1428
Override return argument name of GetManagedObjects to be
1429
"objpath_interfaces_and_properties"
1431
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1435
document = xml.dom.minidom.parseString(xmlstring)
1437
for if_tag in document.getElementsByTagName("interface"):
1438
# Fix argument name for the GetManagedObjects method
1439
if (if_tag.getAttribute("name")
1440
== dbus.OBJECT_MANAGER_IFACE):
1441
for cn in if_tag.getElementsByTagName("method"):
1442
if (cn.getAttribute("name")
1443
== "GetManagedObjects"):
1444
for arg in cn.getElementsByTagName("arg"):
1445
if (arg.getAttribute("direction")
1449
"objpath_interfaces"
1451
xmlstring = document.toxml("utf-8")
1453
except (AttributeError, xml.dom.DOMException,
1454
xml.parsers.expat.ExpatError) as error:
1455
logger.error("Failed to override Introspection method",
1459
def datetime_to_dbus(dt, variant_level=0):
1024
1460
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1026
1462
return dbus.String("", variant_level = variant_level)
1027
return dbus.String(dt.isoformat(),
1028
variant_level=variant_level)
1463
return dbus.String(dt.isoformat(), variant_level=variant_level)
1031
1466
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1061
1497
# Ignore non-D-Bus attributes, and D-Bus attributes
1062
1498
# with the wrong interface name
1063
1499
if (not hasattr(attribute, "_dbus_interface")
1064
or not attribute._dbus_interface
1065
.startswith(orig_interface_name)):
1500
or not attribute._dbus_interface.startswith(
1501
orig_interface_name)):
1067
1503
# Create an alternate D-Bus interface name based on
1068
1504
# the current name
1069
alt_interface = (attribute._dbus_interface
1070
.replace(orig_interface_name,
1071
alt_interface_name))
1505
alt_interface = attribute._dbus_interface.replace(
1506
orig_interface_name, alt_interface_name)
1072
1507
interface_names.add(alt_interface)
1073
1508
# Is this a D-Bus signal?
1074
1509
if getattr(attribute, "_dbus_is_signal", False):
1075
# Extract the original non-method function by
1077
nonmethod_func = (dict(
1510
if sys.version_info.major == 2:
1511
# Extract the original non-method undecorated
1512
# function by black magic
1513
nonmethod_func = (dict(
1078
1514
zip(attribute.func_code.co_freevars,
1079
attribute.__closure__))["func"]
1515
attribute.__closure__))
1516
["func"].cell_contents)
1518
nonmethod_func = attribute
1081
1519
# Create a new, but exactly alike, function
1082
1520
# object, and decorate it to be a new D-Bus signal
1083
1521
# with the alternate D-Bus interface name
1084
new_function = (dbus.service.signal
1086
attribute._dbus_signature)
1087
(types.FunctionType(
1088
nonmethod_func.func_code,
1089
nonmethod_func.func_globals,
1090
nonmethod_func.func_name,
1091
nonmethod_func.func_defaults,
1092
nonmethod_func.func_closure)))
1522
if sys.version_info.major == 2:
1523
new_function = types.FunctionType(
1524
nonmethod_func.func_code,
1525
nonmethod_func.func_globals,
1526
nonmethod_func.func_name,
1527
nonmethod_func.func_defaults,
1528
nonmethod_func.func_closure)
1530
new_function = types.FunctionType(
1531
nonmethod_func.__code__,
1532
nonmethod_func.__globals__,
1533
nonmethod_func.__name__,
1534
nonmethod_func.__defaults__,
1535
nonmethod_func.__closure__)
1536
new_function = (dbus.service.signal(
1538
attribute._dbus_signature)(new_function))
1093
1539
# Copy annotations, if any
1095
new_function._dbus_annotations = (
1096
dict(attribute._dbus_annotations))
1541
new_function._dbus_annotations = dict(
1542
attribute._dbus_annotations)
1097
1543
except AttributeError:
1099
1545
# Define a creator of a function to call both the
1302
1769
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1303
1770
Client.__del__(self, *args, **kwargs)
1305
def checker_callback(self, pid, condition, command,
1307
self.checker_callback_tag = None
1309
if os.WIFEXITED(condition):
1310
exitstatus = os.WEXITSTATUS(condition)
1772
def checker_callback(self, source, condition,
1773
connection, command, *args, **kwargs):
1774
ret = Client.checker_callback(self, source, condition,
1775
connection, command, *args,
1777
exitstatus = self.last_checker_status
1311
1779
# Emit D-Bus signal
1312
1780
self.CheckerCompleted(dbus.Int16(exitstatus),
1313
dbus.Int64(condition),
1781
# This is specific to GNU libC
1782
dbus.Int64(exitstatus << 8),
1314
1783
dbus.String(command))
1316
1785
# Emit D-Bus signal
1317
1786
self.CheckerCompleted(dbus.Int16(-1),
1318
dbus.Int64(condition),
1788
# This is specific to GNU libC
1790
| self.last_checker_signal),
1319
1791
dbus.String(command))
1321
return Client.checker_callback(self, pid, condition, command,
1324
1794
def start_checker(self, *args, **kwargs):
1325
old_checker = self.checker
1326
if self.checker is not None:
1327
old_checker_pid = self.checker.pid
1329
old_checker_pid = None
1795
old_checker_pid = getattr(self.checker, "pid", None)
1330
1796
r = Client.start_checker(self, *args, **kwargs)
1331
1797
# Only if new checker process was started
1332
1798
if (self.checker is not None
1448
1913
self.approved_by_default = bool(value)
1450
1915
# ApprovalDelay - property
1451
@dbus_service_property(_interface, signature="t",
1916
@dbus_service_property(_interface,
1452
1918
access="readwrite")
1453
1919
def ApprovalDelay_dbus_property(self, value=None):
1454
1920
if value is None: # get
1455
return dbus.UInt64(self.approval_delay_milliseconds())
1921
return dbus.UInt64(self.approval_delay.total_seconds()
1456
1923
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1458
1925
# ApprovalDuration - property
1459
@dbus_service_property(_interface, signature="t",
1926
@dbus_service_property(_interface,
1460
1928
access="readwrite")
1461
1929
def ApprovalDuration_dbus_property(self, value=None):
1462
1930
if value is None: # get
1463
return dbus.UInt64(timedelta_to_milliseconds(
1464
self.approval_duration))
1931
return dbus.UInt64(self.approval_duration.total_seconds()
1465
1933
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1467
1935
# Name - property
1937
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1468
1938
@dbus_service_property(_interface, signature="s", access="read")
1469
1939
def Name_dbus_property(self):
1470
1940
return dbus.String(self.name)
1472
1942
# Fingerprint - property
1944
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1473
1945
@dbus_service_property(_interface, signature="s", access="read")
1474
1946
def Fingerprint_dbus_property(self):
1475
1947
return dbus.String(self.fingerprint)
1477
1949
# Host - property
1478
@dbus_service_property(_interface, signature="s",
1950
@dbus_service_property(_interface,
1479
1952
access="readwrite")
1480
1953
def Host_dbus_property(self, value=None):
1481
1954
if value is None: # get
1482
1955
return dbus.String(self.host)
1483
self.host = unicode(value)
1956
self.host = str(value)
1485
1958
# Created - property
1960
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1486
1961
@dbus_service_property(_interface, signature="s", access="read")
1487
1962
def Created_dbus_property(self):
1488
1963
return datetime_to_dbus(self.created)
1550
2027
gobject.source_remove(self.disable_initiator_tag)
1551
self.disable_initiator_tag = (
1552
gobject.timeout_add(
1553
timedelta_to_milliseconds(self.expires - now),
2028
self.disable_initiator_tag = gobject.timeout_add(
2029
int((self.expires - now).total_seconds() * 1000),
1556
2032
# ExtendedTimeout - property
1557
@dbus_service_property(_interface, signature="t",
2033
@dbus_service_property(_interface,
1558
2035
access="readwrite")
1559
2036
def ExtendedTimeout_dbus_property(self, value=None):
1560
2037
if value is None: # get
1561
return dbus.UInt64(self.extended_timeout_milliseconds())
2038
return dbus.UInt64(self.extended_timeout.total_seconds()
1562
2040
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1564
2042
# Interval - property
1565
@dbus_service_property(_interface, signature="t",
2043
@dbus_service_property(_interface,
1566
2045
access="readwrite")
1567
2046
def Interval_dbus_property(self, value=None):
1568
2047
if value is None: # get
1569
return dbus.UInt64(self.interval_milliseconds())
2048
return dbus.UInt64(self.interval.total_seconds() * 1000)
1570
2049
self.interval = datetime.timedelta(0, 0, 0, value)
1571
2050
if getattr(self, "checker_initiator_tag", None) is None:
1573
2052
if self.enabled:
1574
2053
# Reschedule checker run
1575
2054
gobject.source_remove(self.checker_initiator_tag)
1576
self.checker_initiator_tag = (gobject.timeout_add
1577
(value, self.start_checker))
1578
self.start_checker() # Start one now, too
2055
self.checker_initiator_tag = gobject.timeout_add(
2056
value, self.start_checker)
2057
self.start_checker() # Start one now, too
1580
2059
# Checker - property
1581
@dbus_service_property(_interface, signature="s",
2060
@dbus_service_property(_interface,
1582
2062
access="readwrite")
1583
2063
def Checker_dbus_property(self, value=None):
1584
2064
if value is None: # get
1585
2065
return dbus.String(self.checker_command)
1586
self.checker_command = unicode(value)
2066
self.checker_command = str(value)
1588
2068
# CheckerRunning - property
1589
@dbus_service_property(_interface, signature="b",
2069
@dbus_service_property(_interface,
1590
2071
access="readwrite")
1591
2072
def CheckerRunning_dbus_property(self, value=None):
1592
2073
if value is None: # get
1818
2288
def fingerprint(openpgp):
1819
2289
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1820
2290
# New GnuTLS "datum" with the OpenPGP public key
1821
datum = (gnutls.library.types
1822
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1825
ctypes.c_uint(len(openpgp))))
2291
datum = gnutls.datum_t(
2292
ctypes.cast(ctypes.c_char_p(openpgp),
2293
ctypes.POINTER(ctypes.c_ubyte)),
2294
ctypes.c_uint(len(openpgp)))
1826
2295
# New empty GnuTLS certificate
1827
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1828
(gnutls.library.functions
1829
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2296
crt = gnutls.openpgp_crt_t()
2297
gnutls.openpgp_crt_init(ctypes.byref(crt))
1830
2298
# Import the OpenPGP public key into the certificate
1831
(gnutls.library.functions
1832
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1833
gnutls.library.constants
1834
.GNUTLS_OPENPGP_FMT_RAW))
2299
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2300
gnutls.OPENPGP_FMT_RAW)
1835
2301
# Verify the self signature in the key
1836
2302
crtverify = ctypes.c_uint()
1837
(gnutls.library.functions
1838
.gnutls_openpgp_crt_verify_self(crt, 0,
1839
ctypes.byref(crtverify)))
2303
gnutls.openpgp_crt_verify_self(crt, 0,
2304
ctypes.byref(crtverify))
1840
2305
if crtverify.value != 0:
1841
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1842
raise (gnutls.errors.CertificateSecurityError
2306
gnutls.openpgp_crt_deinit(crt)
2307
raise gnutls.CertificateSecurityError("Verify failed")
1844
2308
# New buffer for the fingerprint
1845
2309
buf = ctypes.create_string_buffer(20)
1846
2310
buf_len = ctypes.c_size_t()
1847
2311
# Get the fingerprint from the certificate into the buffer
1848
(gnutls.library.functions
1849
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1850
ctypes.byref(buf_len)))
2312
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2313
ctypes.byref(buf_len))
1851
2314
# Deinit the certificate
1852
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2315
gnutls.openpgp_crt_deinit(crt)
1853
2316
# Convert the buffer to a Python bytestring
1854
2317
fpr = ctypes.string_at(buf, buf_len.value)
1855
2318
# Convert the bytestring to hexadecimal notation
2572
def rfc3339_duration_to_delta(duration):
2573
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2575
>>> rfc3339_duration_to_delta("P7D")
2576
datetime.timedelta(7)
2577
>>> rfc3339_duration_to_delta("PT60S")
2578
datetime.timedelta(0, 60)
2579
>>> rfc3339_duration_to_delta("PT60M")
2580
datetime.timedelta(0, 3600)
2581
>>> rfc3339_duration_to_delta("PT24H")
2582
datetime.timedelta(1)
2583
>>> rfc3339_duration_to_delta("P1W")
2584
datetime.timedelta(7)
2585
>>> rfc3339_duration_to_delta("PT5M30S")
2586
datetime.timedelta(0, 330)
2587
>>> rfc3339_duration_to_delta("P1DT3M20S")
2588
datetime.timedelta(1, 200)
2591
# Parsing an RFC 3339 duration with regular expressions is not
2592
# possible - there would have to be multiple places for the same
2593
# values, like seconds. The current code, while more esoteric, is
2594
# cleaner without depending on a parsing library. If Python had a
2595
# built-in library for parsing we would use it, but we'd like to
2596
# avoid excessive use of external libraries.
2598
# New type for defining tokens, syntax, and semantics all-in-one
2599
Token = collections.namedtuple("Token", (
2600
"regexp", # To match token; if "value" is not None, must have
2601
# a "group" containing digits
2602
"value", # datetime.timedelta or None
2603
"followers")) # Tokens valid after this token
2604
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2605
# the "duration" ABNF definition in RFC 3339, Appendix A.
2606
token_end = Token(re.compile(r"$"), None, frozenset())
2607
token_second = Token(re.compile(r"(\d+)S"),
2608
datetime.timedelta(seconds=1),
2609
frozenset((token_end, )))
2610
token_minute = Token(re.compile(r"(\d+)M"),
2611
datetime.timedelta(minutes=1),
2612
frozenset((token_second, token_end)))
2613
token_hour = Token(re.compile(r"(\d+)H"),
2614
datetime.timedelta(hours=1),
2615
frozenset((token_minute, token_end)))
2616
token_time = Token(re.compile(r"T"),
2618
frozenset((token_hour, token_minute,
2620
token_day = Token(re.compile(r"(\d+)D"),
2621
datetime.timedelta(days=1),
2622
frozenset((token_time, token_end)))
2623
token_month = Token(re.compile(r"(\d+)M"),
2624
datetime.timedelta(weeks=4),
2625
frozenset((token_day, token_end)))
2626
token_year = Token(re.compile(r"(\d+)Y"),
2627
datetime.timedelta(weeks=52),
2628
frozenset((token_month, token_end)))
2629
token_week = Token(re.compile(r"(\d+)W"),
2630
datetime.timedelta(weeks=1),
2631
frozenset((token_end, )))
2632
token_duration = Token(re.compile(r"P"), None,
2633
frozenset((token_year, token_month,
2634
token_day, token_time,
2636
# Define starting values
2637
value = datetime.timedelta() # Value so far
2639
followers = frozenset((token_duration, )) # Following valid tokens
2640
s = duration # String left to parse
2641
# Loop until end token is found
2642
while found_token is not token_end:
2643
# Search for any currently valid tokens
2644
for token in followers:
2645
match = token.regexp.match(s)
2646
if match is not None:
2648
if token.value is not None:
2649
# Value found, parse digits
2650
factor = int(match.group(1), 10)
2651
# Add to value so far
2652
value += factor * token.value
2653
# Strip token from string
2654
s = token.regexp.sub("", s, 1)
2657
# Set valid next tokens
2658
followers = found_token.followers
2661
# No currently valid tokens were found
2662
raise ValueError("Invalid RFC 3339 duration: {!r}"
2065
2668
def string_to_delta(interval):
2066
2669
"""Parse a string and return a datetime.timedelta
2182
2799
"debug": "False",
2184
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2801
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2802
":+SIGN-DSA-SHA256",
2185
2803
"servicename": "Mandos",
2186
2804
"use_dbus": "True",
2187
2805
"use_ipv6": "True",
2188
2806
"debuglevel": "",
2189
2807
"restore": "True",
2190
"statedir": "/var/lib/mandos"
2809
"statedir": "/var/lib/mandos",
2810
"foreground": "False",
2193
2814
# Parse config file for server-global settings
2194
2815
server_config = configparser.SafeConfigParser(server_defaults)
2195
2816
del server_defaults
2196
server_config.read(os.path.join(options.configdir,
2817
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2198
2818
# Convert the SafeConfigParser object to a dict
2199
2819
server_settings = server_config.defaults()
2200
2820
# Use the appropriate methods on the non-string config options
2201
for option in ("debug", "use_dbus", "use_ipv6"):
2821
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2202
2822
server_settings[option] = server_config.getboolean("DEFAULT",
2204
2824
if server_settings["port"]:
2205
2825
server_settings["port"] = server_config.getint("DEFAULT",
2827
if server_settings["socket"]:
2828
server_settings["socket"] = server_config.getint("DEFAULT",
2830
# Later, stdin will, and stdout and stderr might, be dup'ed
2831
# over with an opened os.devnull. But we don't want this to
2832
# happen with a supplied network socket.
2833
if 0 <= server_settings["socket"] <= 2:
2834
server_settings["socket"] = os.dup(server_settings
2207
2836
del server_config
2209
2838
# Override the settings from the config file with command line
2210
2839
# options, if set.
2211
2840
for option in ("interface", "address", "port", "debug",
2212
"priority", "servicename", "configdir",
2213
"use_dbus", "use_ipv6", "debuglevel", "restore",
2841
"priority", "servicename", "configdir", "use_dbus",
2842
"use_ipv6", "debuglevel", "restore", "statedir",
2843
"socket", "foreground", "zeroconf"):
2215
2844
value = getattr(options, option)
2216
2845
if value is not None:
2217
2846
server_settings[option] = value
2219
2848
# Force all strings to be unicode
2220
2849
for option in server_settings.keys():
2221
if type(server_settings[option]) is str:
2222
server_settings[option] = unicode(server_settings[option])
2850
if isinstance(server_settings[option], bytes):
2851
server_settings[option] = (server_settings[option]
2853
# Force all boolean options to be boolean
2854
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2855
"foreground", "zeroconf"):
2856
server_settings[option] = bool(server_settings[option])
2857
# Debug implies foreground
2858
if server_settings["debug"]:
2859
server_settings["foreground"] = True
2223
2860
# Now we have our good server settings in "server_settings"
2225
2862
##################################################################
2864
if (not server_settings["zeroconf"]
2865
and not (server_settings["port"]
2866
or server_settings["socket"] != "")):
2867
parser.error("Needs port or socket to work without Zeroconf")
2227
2869
# For convenience
2228
2870
debug = server_settings["debug"]
2229
2871
debuglevel = server_settings["debuglevel"]