171
209
def password_encode(self, password):
172
210
# Passphrase can not be empty and can not contain newlines or
173
211
# NUL bytes. So we prefix it and hex encode it.
174
return b"mandos" + binascii.hexlify(password)
212
encoded = b"mandos" + binascii.hexlify(password)
213
if len(encoded) > 2048:
214
# GnuPG can't handle long passwords, so encode differently
215
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
216
.replace(b"\n", b"\\n")
217
.replace(b"\0", b"\\x00"))
176
220
def encrypt(self, data, password):
177
self.gnupg.passphrase = self.password_encode(password)
178
with open(os.devnull) as devnull:
180
proc = self.gnupg.run(['--symmetric'],
181
create_fhs=['stdin', 'stdout'],
182
attach_fhs={'stderr': devnull})
183
with contextlib.closing(proc.handles['stdin']) as f:
185
with contextlib.closing(proc.handles['stdout']) as f:
186
ciphertext = f.read()
190
self.gnupg.passphrase = None
221
passphrase = self.password_encode(password)
222
with tempfile.NamedTemporaryFile(
223
dir=self.tempdir) as passfile:
224
passfile.write(passphrase)
226
proc = subprocess.Popen([self.gpg, '--symmetric',
230
stdin = subprocess.PIPE,
231
stdout = subprocess.PIPE,
232
stderr = subprocess.PIPE)
233
ciphertext, err = proc.communicate(input = data)
234
if proc.returncode != 0:
191
236
return ciphertext
193
238
def decrypt(self, data, password):
194
self.gnupg.passphrase = self.password_encode(password)
195
with open(os.devnull) as devnull:
197
proc = self.gnupg.run(['--decrypt'],
198
create_fhs=['stdin', 'stdout'],
199
attach_fhs={'stderr': devnull})
200
with contextlib.closing(proc.handles['stdin'] ) as f:
202
with contextlib.closing(proc.handles['stdout']) as f:
203
decrypted_plaintext = f.read()
207
self.gnupg.passphrase = None
239
passphrase = self.password_encode(password)
240
with tempfile.NamedTemporaryFile(
241
dir = self.tempdir) as passfile:
242
passfile.write(passphrase)
244
proc = subprocess.Popen([self.gpg, '--decrypt',
248
stdin = subprocess.PIPE,
249
stdout = subprocess.PIPE,
250
stderr = subprocess.PIPE)
251
decrypted_plaintext, err = proc.communicate(input = data)
252
if proc.returncode != 0:
208
254
return decrypted_plaintext
256
# Pretend that we have an Avahi module
258
"""This isn't so much a class as it is a module-like namespace.
259
It is instantiated once, and simulates having an Avahi module."""
260
IF_UNSPEC = -1 # avahi-common/address.h
261
PROTO_UNSPEC = -1 # avahi-common/address.h
262
PROTO_INET = 0 # avahi-common/address.h
263
PROTO_INET6 = 1 # avahi-common/address.h
264
DBUS_NAME = "org.freedesktop.Avahi"
265
DBUS_INTERFACE_ENTRY_GROUP = DBUS_NAME + ".EntryGroup"
266
DBUS_INTERFACE_SERVER = DBUS_NAME + ".Server"
267
DBUS_PATH_SERVER = "/"
268
def string_array_to_txt_array(self, t):
269
return dbus.Array((dbus.ByteArray(s.encode("utf-8"))
270
for s in t), signature="ay")
271
ENTRY_GROUP_ESTABLISHED = 2 # avahi-common/defs.h
272
ENTRY_GROUP_COLLISION = 3 # avahi-common/defs.h
273
ENTRY_GROUP_FAILURE = 4 # avahi-common/defs.h
274
SERVER_INVALID = 0 # avahi-common/defs.h
275
SERVER_REGISTERING = 1 # avahi-common/defs.h
276
SERVER_RUNNING = 2 # avahi-common/defs.h
277
SERVER_COLLISION = 3 # avahi-common/defs.h
278
SERVER_FAILURE = 4 # avahi-common/defs.h
212
281
class AvahiError(Exception):
213
282
def __init__(self, value, *args, **kwargs):
214
283
self.value = value
215
super(AvahiError, self).__init__(value, *args, **kwargs)
216
def __unicode__(self):
217
return unicode(repr(self.value))
284
return super(AvahiError, self).__init__(value, *args,
219
288
class AvahiServiceError(AvahiError):
222
292
class AvahiGroupError(AvahiError):
366
466
follow_name_owner_changes=True),
367
467
avahi.DBUS_INTERFACE_SERVER)
368
468
self.server.connect_to_signal("StateChanged",
369
self.server_state_changed)
469
self.server_state_changed)
370
470
self.server_state_changed(self.server.GetState())
372
473
class AvahiServiceToSyslog(AvahiService):
474
def rename(self, *args, **kwargs):
374
475
"""Add the new name to the syslog messages"""
375
ret = AvahiService.rename(self)
376
syslogger.setFormatter(logging.Formatter
377
('Mandos (%s) [%%(process)d]:'
378
' %%(levelname)s: %%(message)s'
476
ret = AvahiService.rename(self, *args, **kwargs)
477
syslogger.setFormatter(logging.Formatter(
478
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
382
def timedelta_to_milliseconds(td):
383
"Convert a datetime.timedelta() to milliseconds"
384
return ((td.days * 24 * 60 * 60 * 1000)
385
+ (td.seconds * 1000)
386
+ (td.microseconds // 1000))
482
# Pretend that we have a GnuTLS module
483
class GnuTLS(object):
484
"""This isn't so much a class as it is a module-like namespace.
485
It is instantiated once, and simulates having a GnuTLS module."""
487
_library = ctypes.cdll.LoadLibrary(
488
ctypes.util.find_library("gnutls"))
489
_need_version = b"3.3.0"
491
# Need to use class name "GnuTLS" here, since this method is
492
# called before the assignment to the "gnutls" global variable
494
if GnuTLS.check_version(self._need_version) is None:
495
raise GnuTLS.Error("Needs GnuTLS {} or later"
496
.format(self._need_version))
498
# Unless otherwise indicated, the constants and types below are
499
# all from the gnutls/gnutls.h C header file.
509
E_NO_CERTIFICATE_FOUND = -49
510
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
513
class session_int(ctypes.Structure):
515
session_t = ctypes.POINTER(session_int)
516
class certificate_credentials_st(ctypes.Structure):
518
certificate_credentials_t = ctypes.POINTER(
519
certificate_credentials_st)
520
certificate_type_t = ctypes.c_int
521
class datum_t(ctypes.Structure):
522
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
523
('size', ctypes.c_uint)]
524
class openpgp_crt_int(ctypes.Structure):
526
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
527
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
528
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
529
credentials_type_t = ctypes.c_int
530
transport_ptr_t = ctypes.c_void_p
531
close_request_t = ctypes.c_int
534
class Error(Exception):
535
# We need to use the class name "GnuTLS" here, since this
536
# exception might be raised from within GnuTLS.__init__,
537
# which is called before the assignment to the "gnutls"
538
# global variable has happened.
539
def __init__(self, message = None, code = None, args=()):
540
# Default usage is by a message string, but if a return
541
# code is passed, convert it to a string with
544
if message is None and code is not None:
545
message = GnuTLS.strerror(code)
546
return super(GnuTLS.Error, self).__init__(
549
class CertificateSecurityError(Error):
553
class Credentials(object):
555
self._c_object = gnutls.certificate_credentials_t()
556
gnutls.certificate_allocate_credentials(
557
ctypes.byref(self._c_object))
558
self.type = gnutls.CRD_CERTIFICATE
561
gnutls.certificate_free_credentials(self._c_object)
563
class ClientSession(object):
564
def __init__(self, socket, credentials = None):
565
self._c_object = gnutls.session_t()
566
gnutls.init(ctypes.byref(self._c_object), gnutls.CLIENT)
567
gnutls.set_default_priority(self._c_object)
568
gnutls.transport_set_ptr(self._c_object, socket.fileno())
569
gnutls.handshake_set_private_extensions(self._c_object,
572
if credentials is None:
573
credentials = gnutls.Credentials()
574
gnutls.credentials_set(self._c_object, credentials.type,
575
ctypes.cast(credentials._c_object,
577
self.credentials = credentials
580
gnutls.deinit(self._c_object)
583
return gnutls.handshake(self._c_object)
585
def send(self, data):
589
data_len -= gnutls.record_send(self._c_object,
594
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
596
# Error handling functions
597
def _error_code(result):
598
"""A function to raise exceptions on errors, suitable
599
for the 'restype' attribute on ctypes functions"""
602
if result == gnutls.E_NO_CERTIFICATE_FOUND:
603
raise gnutls.CertificateSecurityError(code = result)
604
raise gnutls.Error(code = result)
606
def _retry_on_error(result, func, arguments):
607
"""A function to retry on some errors, suitable
608
for the 'errcheck' attribute on ctypes functions"""
610
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
611
return _error_code(result)
612
result = func(*arguments)
615
# Unless otherwise indicated, the function declarations below are
616
# all from the gnutls/gnutls.h C header file.
619
priority_set_direct = _library.gnutls_priority_set_direct
620
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
621
ctypes.POINTER(ctypes.c_char_p)]
622
priority_set_direct.restype = _error_code
624
init = _library.gnutls_init
625
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
626
init.restype = _error_code
628
set_default_priority = _library.gnutls_set_default_priority
629
set_default_priority.argtypes = [session_t]
630
set_default_priority.restype = _error_code
632
record_send = _library.gnutls_record_send
633
record_send.argtypes = [session_t, ctypes.c_void_p,
635
record_send.restype = ctypes.c_ssize_t
636
record_send.errcheck = _retry_on_error
638
certificate_allocate_credentials = (
639
_library.gnutls_certificate_allocate_credentials)
640
certificate_allocate_credentials.argtypes = [
641
ctypes.POINTER(certificate_credentials_t)]
642
certificate_allocate_credentials.restype = _error_code
644
certificate_free_credentials = (
645
_library.gnutls_certificate_free_credentials)
646
certificate_free_credentials.argtypes = [certificate_credentials_t]
647
certificate_free_credentials.restype = None
649
handshake_set_private_extensions = (
650
_library.gnutls_handshake_set_private_extensions)
651
handshake_set_private_extensions.argtypes = [session_t,
653
handshake_set_private_extensions.restype = None
655
credentials_set = _library.gnutls_credentials_set
656
credentials_set.argtypes = [session_t, credentials_type_t,
658
credentials_set.restype = _error_code
660
strerror = _library.gnutls_strerror
661
strerror.argtypes = [ctypes.c_int]
662
strerror.restype = ctypes.c_char_p
664
certificate_type_get = _library.gnutls_certificate_type_get
665
certificate_type_get.argtypes = [session_t]
666
certificate_type_get.restype = _error_code
668
certificate_get_peers = _library.gnutls_certificate_get_peers
669
certificate_get_peers.argtypes = [session_t,
670
ctypes.POINTER(ctypes.c_uint)]
671
certificate_get_peers.restype = ctypes.POINTER(datum_t)
673
global_set_log_level = _library.gnutls_global_set_log_level
674
global_set_log_level.argtypes = [ctypes.c_int]
675
global_set_log_level.restype = None
677
global_set_log_function = _library.gnutls_global_set_log_function
678
global_set_log_function.argtypes = [log_func]
679
global_set_log_function.restype = None
681
deinit = _library.gnutls_deinit
682
deinit.argtypes = [session_t]
683
deinit.restype = None
685
handshake = _library.gnutls_handshake
686
handshake.argtypes = [session_t]
687
handshake.restype = _error_code
688
handshake.errcheck = _retry_on_error
690
transport_set_ptr = _library.gnutls_transport_set_ptr
691
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
692
transport_set_ptr.restype = None
694
bye = _library.gnutls_bye
695
bye.argtypes = [session_t, close_request_t]
696
bye.restype = _error_code
697
bye.errcheck = _retry_on_error
699
check_version = _library.gnutls_check_version
700
check_version.argtypes = [ctypes.c_char_p]
701
check_version.restype = ctypes.c_char_p
703
# All the function declarations below are from gnutls/openpgp.h
705
openpgp_crt_init = _library.gnutls_openpgp_crt_init
706
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
707
openpgp_crt_init.restype = _error_code
709
openpgp_crt_import = _library.gnutls_openpgp_crt_import
710
openpgp_crt_import.argtypes = [openpgp_crt_t,
711
ctypes.POINTER(datum_t),
713
openpgp_crt_import.restype = _error_code
715
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
716
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
717
ctypes.POINTER(ctypes.c_uint)]
718
openpgp_crt_verify_self.restype = _error_code
720
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
721
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
722
openpgp_crt_deinit.restype = None
724
openpgp_crt_get_fingerprint = (
725
_library.gnutls_openpgp_crt_get_fingerprint)
726
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
730
openpgp_crt_get_fingerprint.restype = _error_code
732
# Remove non-public functions
733
del _error_code, _retry_on_error
734
# Create the global "gnutls" object, simulating a module
737
def call_pipe(connection, # : multiprocessing.Connection
738
func, *args, **kwargs):
739
"""This function is meant to be called by multiprocessing.Process
741
This function runs func(*args, **kwargs), and writes the resulting
742
return value on the provided multiprocessing.Connection.
744
connection.send(func(*args, **kwargs))
388
747
class Client(object):
389
748
"""A representation of a client host served by this server.
415
774
last_checked_ok: datetime.datetime(); (UTC) or None
416
775
last_checker_status: integer between 0 and 255 reflecting exit
417
776
status of last checker. -1 reflects crashed
777
checker, -2 means no checker completed yet.
778
last_checker_signal: The signal which killed the last checker, if
779
last_checker_status is -1
419
780
last_enabled: datetime.datetime(); (UTC) or None
420
781
name: string; from the config file, used in log messages and
421
782
D-Bus identifiers
422
783
secret: bytestring; sent verbatim (over TLS) to client
423
784
timeout: datetime.timedelta(); How long from last_checked_ok
424
785
until this client is disabled
425
extended_timeout: extra long timeout when password has been sent
786
extended_timeout: extra long timeout when secret has been sent
426
787
runtime_expansions: Allowed attributes for runtime expansion.
427
788
expires: datetime.datetime(); time (UTC) when a client will be
428
789
disabled, or None
790
server_settings: The server_settings dict from main()
431
793
runtime_expansions = ("approval_delay", "approval_duration",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
794
"created", "enabled", "expires",
795
"fingerprint", "host", "interval",
796
"last_approval_request", "last_checked_ok",
434
797
"last_enabled", "name", "timeout")
435
client_defaults = { "timeout": "5m",
436
"extended_timeout": "15m",
438
"checker": "fping -q -- %%(host)s",
440
"approval_delay": "0s",
441
"approval_duration": "1s",
442
"approved_by_default": "True",
446
def timeout_milliseconds(self):
447
"Return the 'timeout' attribute in milliseconds"
448
return timedelta_to_milliseconds(self.timeout)
450
def extended_timeout_milliseconds(self):
451
"Return the 'extended_timeout' attribute in milliseconds"
452
return timedelta_to_milliseconds(self.extended_timeout)
454
def interval_milliseconds(self):
455
"Return the 'interval' attribute in milliseconds"
456
return timedelta_to_milliseconds(self.interval)
458
def approval_delay_milliseconds(self):
459
return timedelta_to_milliseconds(self.approval_delay)
800
"extended_timeout": "PT15M",
802
"checker": "fping -q -- %%(host)s",
804
"approval_delay": "PT0S",
805
"approval_duration": "PT1S",
806
"approved_by_default": "True",
462
811
def config_parser(config):
463
812
"""Construct a new dict of client settings of this form:
598
945
def init_checker(self):
599
946
# Schedule a new checker to be started an 'interval' from now,
600
947
# and every interval from then on.
601
self.checker_initiator_tag = (gobject.timeout_add
602
(self.interval_milliseconds(),
948
if self.checker_initiator_tag is not None:
949
GLib.source_remove(self.checker_initiator_tag)
950
self.checker_initiator_tag = GLib.timeout_add(
951
int(self.interval.total_seconds() * 1000),
604
953
# Schedule a disable() when 'timeout' has passed
605
self.disable_initiator_tag = (gobject.timeout_add
606
(self.timeout_milliseconds(),
954
if self.disable_initiator_tag is not None:
955
GLib.source_remove(self.disable_initiator_tag)
956
self.disable_initiator_tag = GLib.timeout_add(
957
int(self.timeout.total_seconds() * 1000), self.disable)
608
958
# Also start a new checker *right now*.
609
959
self.start_checker()
611
def checker_callback(self, pid, condition, command):
961
def checker_callback(self, source, condition, connection,
612
963
"""The checker has completed, so take appropriate actions."""
613
964
self.checker_callback_tag = None
614
965
self.checker = None
615
if os.WIFEXITED(condition):
616
self.last_checker_status = os.WEXITSTATUS(condition)
966
# Read return code from connection (see call_pipe)
967
returncode = connection.recv()
971
self.last_checker_status = returncode
972
self.last_checker_signal = None
617
973
if self.last_checker_status == 0:
618
974
logger.info("Checker for %(name)s succeeded",
620
976
self.checked_ok()
622
logger.info("Checker for %(name)s failed",
978
logger.info("Checker for %(name)s failed", vars(self))
625
980
self.last_checker_status = -1
981
self.last_checker_signal = -returncode
626
982
logger.warning("Checker for %(name)s crashed?",
629
def checked_ok(self, timeout=None):
630
"""Bump up the timeout for this client.
632
This should only be called when the client has been seen,
986
def checked_ok(self):
987
"""Assert that the client has been seen, alive and well."""
988
self.last_checked_ok = datetime.datetime.utcnow()
989
self.last_checker_status = 0
990
self.last_checker_signal = None
993
def bump_timeout(self, timeout=None):
994
"""Bump up the timeout for this client."""
635
995
if timeout is None:
636
996
timeout = self.timeout
637
self.last_checked_ok = datetime.datetime.utcnow()
638
997
if self.disable_initiator_tag is not None:
639
gobject.source_remove(self.disable_initiator_tag)
998
GLib.source_remove(self.disable_initiator_tag)
999
self.disable_initiator_tag = None
640
1000
if getattr(self, "enabled", False):
641
self.disable_initiator_tag = (gobject.timeout_add
642
(timedelta_to_milliseconds
643
(timeout), self.disable))
1001
self.disable_initiator_tag = GLib.timeout_add(
1002
int(timeout.total_seconds() * 1000), self.disable)
644
1003
self.expires = datetime.datetime.utcnow() + timeout
646
1005
def need_approval(self):
652
1011
If a checker already exists, leave it running and do
654
1013
# The reason for not killing a running checker is that if we
655
# did that, then if a checker (for some reason) started
656
# running slowly and taking more than 'interval' time, the
657
# client would inevitably timeout, since no checker would get
658
# a chance to run to completion. If we instead leave running
1014
# did that, and if a checker (for some reason) started running
1015
# slowly and taking more than 'interval' time, then the client
1016
# would inevitably timeout, since no checker would get a
1017
# chance to run to completion. If we instead leave running
659
1018
# checkers alone, the checker would have to take more time
660
1019
# than 'timeout' for the client to be disabled, which is as it
663
# If a checker exists, make sure it is not a zombie
665
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
666
except (AttributeError, OSError) as error:
667
if (isinstance(error, OSError)
668
and error.errno != errno.ECHILD):
672
logger.warning("Checker was a zombie")
673
gobject.source_remove(self.checker_callback_tag)
674
self.checker_callback(pid, status,
675
self.current_checker_command)
1022
if self.checker is not None and not self.checker.is_alive():
1023
logger.warning("Checker was not alive; joining")
676
1026
# Start a new checker if needed
677
1027
if self.checker is None:
1028
# Escape attributes for the shell
1030
attr: re.escape(str(getattr(self, attr)))
1031
for attr in self.runtime_expansions }
679
# In case checker_command has exactly one % operator
680
command = self.checker_command % self.host
682
# Escape attributes for the shell
683
escaped_attrs = dict(
685
re.escape(unicode(str(getattr(self, attr, "")),
689
self.runtime_expansions)
692
command = self.checker_command % escaped_attrs
693
except TypeError as error:
694
logger.error('Could not format string "%s":'
695
' %s', self.checker_command, error)
696
return True # Try again later
1033
command = self.checker_command % escaped_attrs
1034
except TypeError as error:
1035
logger.error('Could not format string "%s"',
1036
self.checker_command,
1038
return True # Try again later
697
1039
self.current_checker_command = command
699
logger.info("Starting checker %r for %s",
701
# We don't need to redirect stdout and stderr, since
702
# in normal mode, that is already done by daemon(),
703
# and in debug mode we don't want to. (Stdin is
704
# always replaced by /dev/null.)
705
self.checker = subprocess.Popen(command,
708
self.checker_callback_tag = (gobject.child_watch_add
710
self.checker_callback,
712
# The checker may have completed before the gobject
713
# watch was added. Check for this.
714
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
716
gobject.source_remove(self.checker_callback_tag)
717
self.checker_callback(pid, status, command)
718
except OSError as error:
719
logger.error("Failed to start subprocess: %s",
721
# Re-run this periodically if run by gobject.timeout_add
1040
logger.info("Starting checker %r for %s", command,
1042
# We don't need to redirect stdout and stderr, since
1043
# in normal mode, that is already done by daemon(),
1044
# and in debug mode we don't want to. (Stdin is
1045
# always replaced by /dev/null.)
1046
# The exception is when not debugging but nevertheless
1047
# running in the foreground; use the previously
1049
popen_args = { "close_fds": True,
1052
if (not self.server_settings["debug"]
1053
and self.server_settings["foreground"]):
1054
popen_args.update({"stdout": wnull,
1056
pipe = multiprocessing.Pipe(duplex = False)
1057
self.checker = multiprocessing.Process(
1059
args = (pipe[1], subprocess.call, command),
1060
kwargs = popen_args)
1061
self.checker.start()
1062
self.checker_callback_tag = GLib.io_add_watch(
1063
pipe[0].fileno(), GLib.IO_IN,
1064
self.checker_callback, pipe[0], command)
1065
# Re-run this periodically if run by GLib.timeout_add
724
1068
def stop_checker(self):
725
1069
"""Force the checker process, if any, to stop."""
726
1070
if self.checker_callback_tag:
727
gobject.source_remove(self.checker_callback_tag)
1071
GLib.source_remove(self.checker_callback_tag)
728
1072
self.checker_callback_tag = None
729
1073
if getattr(self, "checker", None) is None:
731
1075
logger.debug("Stopping checker for %(name)s", vars(self))
733
os.kill(self.checker.pid, signal.SIGTERM)
735
#if self.checker.poll() is None:
736
# os.kill(self.checker.pid, signal.SIGKILL)
737
except OSError as error:
738
if error.errno != errno.ESRCH: # No such process
1076
self.checker.terminate()
740
1077
self.checker = None
743
def dbus_service_property(dbus_interface, signature="v",
744
access="readwrite", byte_arrays=False):
1080
def dbus_service_property(dbus_interface,
745
1084
"""Decorators for marking methods of a DBusObjectWithProperties to
746
1085
become properties on the D-Bus.
792
class DBusObjectWithProperties(dbus.service.Object):
1175
class DBusObjectWithAnnotations(dbus.service.Object):
1176
"""A D-Bus object with annotations.
1178
Classes inheriting from this can use the dbus_annotations
1179
decorator to add annotations to methods or signals.
1183
def _is_dbus_thing(thing):
1184
"""Returns a function testing if an attribute is a D-Bus thing
1186
If called like _is_dbus_thing("method") it returns a function
1187
suitable for use as predicate to inspect.getmembers().
1189
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1192
def _get_all_dbus_things(self, thing):
1193
"""Returns a generator of (name, attribute) pairs
1195
return ((getattr(athing.__get__(self), "_dbus_name", name),
1196
athing.__get__(self))
1197
for cls in self.__class__.__mro__
1199
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1201
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1202
out_signature = "s",
1203
path_keyword = 'object_path',
1204
connection_keyword = 'connection')
1205
def Introspect(self, object_path, connection):
1206
"""Overloading of standard D-Bus method.
1208
Inserts annotation tags on methods and signals.
1210
xmlstring = dbus.service.Object.Introspect(self, object_path,
1213
document = xml.dom.minidom.parseString(xmlstring)
1215
for if_tag in document.getElementsByTagName("interface"):
1216
# Add annotation tags
1217
for typ in ("method", "signal"):
1218
for tag in if_tag.getElementsByTagName(typ):
1220
for name, prop in (self.
1221
_get_all_dbus_things(typ)):
1222
if (name == tag.getAttribute("name")
1223
and prop._dbus_interface
1224
== if_tag.getAttribute("name")):
1225
annots.update(getattr(
1226
prop, "_dbus_annotations", {}))
1227
for name, value in annots.items():
1228
ann_tag = document.createElement(
1230
ann_tag.setAttribute("name", name)
1231
ann_tag.setAttribute("value", value)
1232
tag.appendChild(ann_tag)
1233
# Add interface annotation tags
1234
for annotation, value in dict(
1235
itertools.chain.from_iterable(
1236
annotations().items()
1237
for name, annotations
1238
in self._get_all_dbus_things("interface")
1239
if name == if_tag.getAttribute("name")
1241
ann_tag = document.createElement("annotation")
1242
ann_tag.setAttribute("name", annotation)
1243
ann_tag.setAttribute("value", value)
1244
if_tag.appendChild(ann_tag)
1245
# Fix argument name for the Introspect method itself
1246
if (if_tag.getAttribute("name")
1247
== dbus.INTROSPECTABLE_IFACE):
1248
for cn in if_tag.getElementsByTagName("method"):
1249
if cn.getAttribute("name") == "Introspect":
1250
for arg in cn.getElementsByTagName("arg"):
1251
if (arg.getAttribute("direction")
1253
arg.setAttribute("name",
1255
xmlstring = document.toxml("utf-8")
1257
except (AttributeError, xml.dom.DOMException,
1258
xml.parsers.expat.ExpatError) as error:
1259
logger.error("Failed to override Introspection method",
1264
class DBusObjectWithProperties(DBusObjectWithAnnotations):
793
1265
"""A D-Bus object with properties.
795
1267
Classes inheriting from this can use the dbus_service_property
875
1347
if not hasattr(value, "variant_level"):
876
1348
properties[name] = value
878
properties[name] = type(value)(value, variant_level=
879
value.variant_level+1)
1350
properties[name] = type(value)(
1351
value, variant_level = value.variant_level + 1)
880
1352
return dbus.Dictionary(properties, signature="sv")
1354
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1355
def PropertiesChanged(self, interface_name, changed_properties,
1356
invalidated_properties):
1357
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
882
1362
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
883
1363
out_signature="s",
884
1364
path_keyword='object_path',
885
1365
connection_keyword='connection')
886
1366
def Introspect(self, object_path, connection):
887
"""Standard D-Bus method, overloaded to insert property tags.
1367
"""Overloading of standard D-Bus method.
1369
Inserts property tags and interface annotation tags.
889
xmlstring = dbus.service.Object.Introspect(self, object_path,
1371
xmlstring = DBusObjectWithAnnotations.Introspect(self,
892
1375
document = xml.dom.minidom.parseString(xmlstring)
893
1377
def make_tag(document, name, prop):
894
1378
e = document.createElement("property")
895
1379
e.setAttribute("name", name)
896
1380
e.setAttribute("type", prop._dbus_signature)
897
1381
e.setAttribute("access", prop._dbus_access)
899
1384
for if_tag in document.getElementsByTagName("interface"):
900
1386
for tag in (make_tag(document, name, prop)
902
in self._get_all_dbus_properties()
1388
in self._get_all_dbus_things("property")
903
1389
if prop._dbus_interface
904
1390
== if_tag.getAttribute("name")):
905
1391
if_tag.appendChild(tag)
1392
# Add annotation tags for properties
1393
for tag in if_tag.getElementsByTagName("property"):
1395
for name, prop in self._get_all_dbus_things(
1397
if (name == tag.getAttribute("name")
1398
and prop._dbus_interface
1399
== if_tag.getAttribute("name")):
1400
annots.update(getattr(
1401
prop, "_dbus_annotations", {}))
1402
for name, value in annots.items():
1403
ann_tag = document.createElement(
1405
ann_tag.setAttribute("name", name)
1406
ann_tag.setAttribute("value", value)
1407
tag.appendChild(ann_tag)
906
1408
# Add the names to the return values for the
907
1409
# "org.freedesktop.DBus.Properties" methods
908
1410
if (if_tag.getAttribute("name")
923
1425
except (AttributeError, xml.dom.DOMException,
924
1426
xml.parsers.expat.ExpatError) as error:
925
1427
logger.error("Failed to override Introspection method",
930
def datetime_to_dbus (dt, variant_level=0):
1432
dbus.OBJECT_MANAGER_IFACE
1433
except AttributeError:
1434
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1436
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1437
"""A D-Bus object with an ObjectManager.
1439
Classes inheriting from this exposes the standard
1440
GetManagedObjects call and the InterfacesAdded and
1441
InterfacesRemoved signals on the standard
1442
"org.freedesktop.DBus.ObjectManager" interface.
1444
Note: No signals are sent automatically; they must be sent
1447
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1448
out_signature = "a{oa{sa{sv}}}")
1449
def GetManagedObjects(self):
1450
"""This function must be overridden"""
1451
raise NotImplementedError()
1453
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1454
signature = "oa{sa{sv}}")
1455
def InterfacesAdded(self, object_path, interfaces_and_properties):
1458
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature = "oas")
1459
def InterfacesRemoved(self, object_path, interfaces):
1462
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1463
out_signature = "s",
1464
path_keyword = 'object_path',
1465
connection_keyword = 'connection')
1466
def Introspect(self, object_path, connection):
1467
"""Overloading of standard D-Bus method.
1469
Override return argument name of GetManagedObjects to be
1470
"objpath_interfaces_and_properties"
1472
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1476
document = xml.dom.minidom.parseString(xmlstring)
1478
for if_tag in document.getElementsByTagName("interface"):
1479
# Fix argument name for the GetManagedObjects method
1480
if (if_tag.getAttribute("name")
1481
== dbus.OBJECT_MANAGER_IFACE):
1482
for cn in if_tag.getElementsByTagName("method"):
1483
if (cn.getAttribute("name")
1484
== "GetManagedObjects"):
1485
for arg in cn.getElementsByTagName("arg"):
1486
if (arg.getAttribute("direction")
1490
"objpath_interfaces"
1492
xmlstring = document.toxml("utf-8")
1494
except (AttributeError, xml.dom.DOMException,
1495
xml.parsers.expat.ExpatError) as error:
1496
logger.error("Failed to override Introspection method",
1500
def datetime_to_dbus(dt, variant_level=0):
931
1501
"""Convert a UTC datetime.datetime() to a D-Bus type."""
933
1503
return dbus.String("", variant_level = variant_level)
934
return dbus.String(dt.isoformat(),
935
variant_level=variant_level)
938
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
940
"""Applied to an empty subclass of a D-Bus object, this metaclass
941
will add additional D-Bus attributes matching a certain pattern.
1504
return dbus.String(dt.isoformat(), variant_level=variant_level)
1507
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1508
"""A class decorator; applied to a subclass of
1509
dbus.service.Object, it will add alternate D-Bus attributes with
1510
interface names according to the "alt_interface_names" mapping.
1513
@alternate_dbus_interfaces({"org.example.Interface":
1514
"net.example.AlternateInterface"})
1515
class SampleDBusObject(dbus.service.Object):
1516
@dbus.service.method("org.example.Interface")
1517
def SampleDBusMethod():
1520
The above "SampleDBusMethod" on "SampleDBusObject" will be
1521
reachable via two interfaces: "org.example.Interface" and
1522
"net.example.AlternateInterface", the latter of which will have
1523
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1524
"true", unless "deprecate" is passed with a False value.
1526
This works for methods and signals, and also for D-Bus properties
1527
(from DBusObjectWithProperties) and interfaces (from the
1528
dbus_interface_annotations decorator).
943
def __new__(mcs, name, bases, attr):
944
# Go through all the base classes which could have D-Bus
945
# methods, signals, or properties in them
946
for base in (b for b in bases
947
if issubclass(b, dbus.service.Object)):
948
# Go though all attributes of the base class
949
for attrname, attribute in inspect.getmembers(base):
1532
for orig_interface_name, alt_interface_name in (
1533
alt_interface_names.items()):
1535
interface_names = set()
1536
# Go though all attributes of the class
1537
for attrname, attribute in inspect.getmembers(cls):
950
1538
# Ignore non-D-Bus attributes, and D-Bus attributes
951
1539
# with the wrong interface name
952
1540
if (not hasattr(attribute, "_dbus_interface")
953
or not attribute._dbus_interface
954
.startswith("se.recompile.Mandos")):
1541
or not attribute._dbus_interface.startswith(
1542
orig_interface_name)):
956
1544
# Create an alternate D-Bus interface name based on
957
1545
# the current name
958
alt_interface = (attribute._dbus_interface
959
.replace("se.recompile.Mandos",
960
"se.bsnet.fukt.Mandos"))
1546
alt_interface = attribute._dbus_interface.replace(
1547
orig_interface_name, alt_interface_name)
1548
interface_names.add(alt_interface)
961
1549
# Is this a D-Bus signal?
962
1550
if getattr(attribute, "_dbus_is_signal", False):
963
# Extract the original non-method function by
965
nonmethod_func = (dict(
1551
# Extract the original non-method undecorated
1552
# function by black magic
1553
if sys.version_info.major == 2:
1554
nonmethod_func = (dict(
966
1555
zip(attribute.func_code.co_freevars,
967
attribute.__closure__))["func"]
1556
attribute.__closure__))
1557
["func"].cell_contents)
1559
nonmethod_func = (dict(
1560
zip(attribute.__code__.co_freevars,
1561
attribute.__closure__))
1562
["func"].cell_contents)
969
1563
# Create a new, but exactly alike, function
970
1564
# object, and decorate it to be a new D-Bus signal
971
1565
# with the alternate D-Bus interface name
972
new_function = (dbus.service.signal
974
attribute._dbus_signature)
976
nonmethod_func.func_code,
977
nonmethod_func.func_globals,
978
nonmethod_func.func_name,
979
nonmethod_func.func_defaults,
980
nonmethod_func.func_closure)))
1566
new_function = copy_function(nonmethod_func)
1567
new_function = (dbus.service.signal(
1569
attribute._dbus_signature)(new_function))
1570
# Copy annotations, if any
1572
new_function._dbus_annotations = dict(
1573
attribute._dbus_annotations)
1574
except AttributeError:
981
1576
# Define a creator of a function to call both the
982
# old and new functions, so both the old and new
983
# signals gets sent when the function is called
1577
# original and alternate functions, so both the
1578
# original and alternate signals gets sent when
1579
# the function is called
984
1580
def fixscope(func1, func2):
985
1581
"""This function is a scope container to pass
986
1582
func1 and func2 to the "call_both" function
987
1583
outside of its arguments"""
1585
@functools.wraps(func2)
988
1586
def call_both(*args, **kwargs):
989
1587
"""This function will emit two D-Bus
990
1588
signals by calling func1 and func2"""
991
1589
func1(*args, **kwargs)
992
1590
func2(*args, **kwargs)
1591
# Make wrapper function look like a D-Bus signal
1592
for name, attr in inspect.getmembers(func2):
1593
if name.startswith("_dbus_"):
1594
setattr(call_both, name, attr)
993
1596
return call_both
994
1597
# Create the "call_both" function and add it to
996
attr[attrname] = fixscope(attribute,
1599
attr[attrname] = fixscope(attribute, new_function)
998
1600
# Is this a D-Bus method?
999
1601
elif getattr(attribute, "_dbus_is_method", False):
1000
1602
# Create a new, but exactly alike, function
1001
1603
# object. Decorate it to be a new D-Bus method
1002
1604
# with the alternate D-Bus interface name. Add it
1003
1605
# to the class.
1004
attr[attrname] = (dbus.service.method
1006
attribute._dbus_in_signature,
1007
attribute._dbus_out_signature)
1009
(attribute.func_code,
1010
attribute.func_globals,
1011
attribute.func_name,
1012
attribute.func_defaults,
1013
attribute.func_closure)))
1607
dbus.service.method(
1609
attribute._dbus_in_signature,
1610
attribute._dbus_out_signature)
1611
(copy_function(attribute)))
1612
# Copy annotations, if any
1614
attr[attrname]._dbus_annotations = dict(
1615
attribute._dbus_annotations)
1616
except AttributeError:
1014
1618
# Is this a D-Bus property?
1015
1619
elif getattr(attribute, "_dbus_is_property", False):
1016
1620
# Create a new, but exactly alike, function
1017
1621
# object, and decorate it to be a new D-Bus
1018
1622
# property with the alternate D-Bus interface
1019
1623
# name. Add it to the class.
1020
attr[attrname] = (dbus_service_property
1022
attribute._dbus_signature,
1023
attribute._dbus_access,
1025
._dbus_get_args_options
1028
(attribute.func_code,
1029
attribute.func_globals,
1030
attribute.func_name,
1031
attribute.func_defaults,
1032
attribute.func_closure)))
1033
return type.__new__(mcs, name, bases, attr)
1624
attr[attrname] = (dbus_service_property(
1625
alt_interface, attribute._dbus_signature,
1626
attribute._dbus_access,
1627
attribute._dbus_get_args_options
1629
(copy_function(attribute)))
1630
# Copy annotations, if any
1632
attr[attrname]._dbus_annotations = dict(
1633
attribute._dbus_annotations)
1634
except AttributeError:
1636
# Is this a D-Bus interface?
1637
elif getattr(attribute, "_dbus_is_interface", False):
1638
# Create a new, but exactly alike, function
1639
# object. Decorate it to be a new D-Bus interface
1640
# with the alternate D-Bus interface name. Add it
1643
dbus_interface_annotations(alt_interface)
1644
(copy_function(attribute)))
1646
# Deprecate all alternate interfaces
1647
iname="_AlternateDBusNames_interface_annotation{}"
1648
for interface_name in interface_names:
1650
@dbus_interface_annotations(interface_name)
1652
return { "org.freedesktop.DBus.Deprecated":
1654
# Find an unused name
1655
for aname in (iname.format(i)
1656
for i in itertools.count()):
1657
if aname not in attr:
1661
# Replace the class with a new subclass of it with
1662
# methods, signals, etc. as created above.
1663
if sys.version_info.major == 2:
1664
cls = type(b"{}Alternate".format(cls.__name__),
1667
cls = type("{}Alternate".format(cls.__name__),
1674
@alternate_dbus_interfaces({"se.recompile.Mandos":
1675
"se.bsnet.fukt.Mandos"})
1036
1676
class ClientDBus(Client, DBusObjectWithProperties):
1037
1677
"""A Client class using D-Bus
1098
1749
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1099
1750
last_enabled = notifychangeproperty(datetime_to_dbus,
1101
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1102
type_func = lambda checker:
1103
checker is not None)
1752
checker = notifychangeproperty(
1753
dbus.Boolean, "CheckerRunning",
1754
type_func = lambda checker: checker is not None)
1104
1755
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1105
1756
"LastCheckedOK")
1757
last_checker_status = notifychangeproperty(dbus.Int16,
1758
"LastCheckerStatus")
1106
1759
last_approval_request = notifychangeproperty(
1107
1760
datetime_to_dbus, "LastApprovalRequest")
1108
1761
approved_by_default = notifychangeproperty(dbus.Boolean,
1109
1762
"ApprovedByDefault")
1110
approval_delay = notifychangeproperty(dbus.UInt64,
1113
timedelta_to_milliseconds)
1763
approval_delay = notifychangeproperty(
1764
dbus.UInt64, "ApprovalDelay",
1765
type_func = lambda td: td.total_seconds() * 1000)
1114
1766
approval_duration = notifychangeproperty(
1115
1767
dbus.UInt64, "ApprovalDuration",
1116
type_func = timedelta_to_milliseconds)
1768
type_func = lambda td: td.total_seconds() * 1000)
1117
1769
host = notifychangeproperty(dbus.String, "Host")
1118
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1120
timedelta_to_milliseconds)
1770
timeout = notifychangeproperty(
1771
dbus.UInt64, "Timeout",
1772
type_func = lambda td: td.total_seconds() * 1000)
1121
1773
extended_timeout = notifychangeproperty(
1122
1774
dbus.UInt64, "ExtendedTimeout",
1123
type_func = timedelta_to_milliseconds)
1124
interval = notifychangeproperty(dbus.UInt64,
1127
timedelta_to_milliseconds)
1775
type_func = lambda td: td.total_seconds() * 1000)
1776
interval = notifychangeproperty(
1777
dbus.UInt64, "Interval",
1778
type_func = lambda td: td.total_seconds() * 1000)
1128
1779
checker_command = notifychangeproperty(dbus.String, "Checker")
1780
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1781
invalidate_only=True)
1130
1783
del notifychangeproperty
1286
1935
self.approved_by_default = bool(value)
1288
1937
# ApprovalDelay - property
1289
@dbus_service_property(_interface, signature="t",
1938
@dbus_service_property(_interface,
1290
1940
access="readwrite")
1291
1941
def ApprovalDelay_dbus_property(self, value=None):
1292
1942
if value is None: # get
1293
return dbus.UInt64(self.approval_delay_milliseconds())
1943
return dbus.UInt64(self.approval_delay.total_seconds()
1294
1945
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1296
1947
# ApprovalDuration - property
1297
@dbus_service_property(_interface, signature="t",
1948
@dbus_service_property(_interface,
1298
1950
access="readwrite")
1299
1951
def ApprovalDuration_dbus_property(self, value=None):
1300
1952
if value is None: # get
1301
return dbus.UInt64(timedelta_to_milliseconds(
1302
self.approval_duration))
1953
return dbus.UInt64(self.approval_duration.total_seconds()
1303
1955
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1305
1957
# Name - property
1959
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1306
1960
@dbus_service_property(_interface, signature="s", access="read")
1307
1961
def Name_dbus_property(self):
1308
1962
return dbus.String(self.name)
1310
1964
# Fingerprint - property
1966
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1311
1967
@dbus_service_property(_interface, signature="s", access="read")
1312
1968
def Fingerprint_dbus_property(self):
1313
1969
return dbus.String(self.fingerprint)
1315
1971
# Host - property
1316
@dbus_service_property(_interface, signature="s",
1972
@dbus_service_property(_interface,
1317
1974
access="readwrite")
1318
1975
def Host_dbus_property(self, value=None):
1319
1976
if value is None: # get
1320
1977
return dbus.String(self.host)
1321
self.host = unicode(value)
1978
self.host = str(value)
1323
1980
# Created - property
1982
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
1324
1983
@dbus_service_property(_interface, signature="s", access="read")
1325
1984
def Created_dbus_property(self):
1326
1985
return datetime_to_dbus(self.created)
1361
2027
return datetime_to_dbus(self.last_approval_request)
1363
2029
# Timeout - property
1364
@dbus_service_property(_interface, signature="t",
2030
@dbus_service_property(_interface,
1365
2032
access="readwrite")
1366
2033
def Timeout_dbus_property(self, value=None):
1367
2034
if value is None: # get
1368
return dbus.UInt64(self.timeout_milliseconds())
2035
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2036
old_timeout = self.timeout
1369
2037
self.timeout = datetime.timedelta(0, 0, 0, value)
1370
# Reschedule timeout
2038
# Reschedule disabling
1371
2039
if self.enabled:
1372
2040
now = datetime.datetime.utcnow()
1373
time_to_die = timedelta_to_milliseconds(
1374
(self.last_checked_ok + self.timeout) - now)
1375
if time_to_die <= 0:
2041
self.expires += self.timeout - old_timeout
2042
if self.expires <= now:
1376
2043
# The timeout has passed
1379
self.expires = (now +
1380
datetime.timedelta(milliseconds =
1382
2046
if (getattr(self, "disable_initiator_tag", None)
1385
gobject.source_remove(self.disable_initiator_tag)
1386
self.disable_initiator_tag = (gobject.timeout_add
2049
GLib.source_remove(self.disable_initiator_tag)
2050
self.disable_initiator_tag = GLib.timeout_add(
2051
int((self.expires - now).total_seconds() * 1000),
1390
2054
# ExtendedTimeout - property
1391
@dbus_service_property(_interface, signature="t",
2055
@dbus_service_property(_interface,
1392
2057
access="readwrite")
1393
2058
def ExtendedTimeout_dbus_property(self, value=None):
1394
2059
if value is None: # get
1395
return dbus.UInt64(self.extended_timeout_milliseconds())
2060
return dbus.UInt64(self.extended_timeout.total_seconds()
1396
2062
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1398
2064
# Interval - property
1399
@dbus_service_property(_interface, signature="t",
2065
@dbus_service_property(_interface,
1400
2067
access="readwrite")
1401
2068
def Interval_dbus_property(self, value=None):
1402
2069
if value is None: # get
1403
return dbus.UInt64(self.interval_milliseconds())
2070
return dbus.UInt64(self.interval.total_seconds() * 1000)
1404
2071
self.interval = datetime.timedelta(0, 0, 0, value)
1405
2072
if getattr(self, "checker_initiator_tag", None) is None:
1407
2074
if self.enabled:
1408
2075
# Reschedule checker run
1409
gobject.source_remove(self.checker_initiator_tag)
1410
self.checker_initiator_tag = (gobject.timeout_add
1411
(value, self.start_checker))
1412
self.start_checker() # Start one now, too
2076
GLib.source_remove(self.checker_initiator_tag)
2077
self.checker_initiator_tag = GLib.timeout_add(
2078
value, self.start_checker)
2079
self.start_checker() # Start one now, too
1414
2081
# Checker - property
1415
@dbus_service_property(_interface, signature="s",
2082
@dbus_service_property(_interface,
1416
2084
access="readwrite")
1417
2085
def Checker_dbus_property(self, value=None):
1418
2086
if value is None: # get
1419
2087
return dbus.String(self.checker_command)
1420
self.checker_command = unicode(value)
2088
self.checker_command = str(value)
1422
2090
# CheckerRunning - property
1423
@dbus_service_property(_interface, signature="b",
2091
@dbus_service_property(_interface,
1424
2093
access="readwrite")
1425
2094
def CheckerRunning_dbus_property(self, value=None):
1426
2095
if value is None: # get
1658
2310
def fingerprint(openpgp):
1659
2311
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1660
2312
# New GnuTLS "datum" with the OpenPGP public key
1661
datum = (gnutls.library.types
1662
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1665
ctypes.c_uint(len(openpgp))))
2313
datum = gnutls.datum_t(
2314
ctypes.cast(ctypes.c_char_p(openpgp),
2315
ctypes.POINTER(ctypes.c_ubyte)),
2316
ctypes.c_uint(len(openpgp)))
1666
2317
# New empty GnuTLS certificate
1667
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1668
(gnutls.library.functions
1669
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2318
crt = gnutls.openpgp_crt_t()
2319
gnutls.openpgp_crt_init(ctypes.byref(crt))
1670
2320
# Import the OpenPGP public key into the certificate
1671
(gnutls.library.functions
1672
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1673
gnutls.library.constants
1674
.GNUTLS_OPENPGP_FMT_RAW))
2321
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2322
gnutls.OPENPGP_FMT_RAW)
1675
2323
# Verify the self signature in the key
1676
2324
crtverify = ctypes.c_uint()
1677
(gnutls.library.functions
1678
.gnutls_openpgp_crt_verify_self(crt, 0,
1679
ctypes.byref(crtverify)))
2325
gnutls.openpgp_crt_verify_self(crt, 0,
2326
ctypes.byref(crtverify))
1680
2327
if crtverify.value != 0:
1681
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1682
raise (gnutls.errors.CertificateSecurityError
2328
gnutls.openpgp_crt_deinit(crt)
2329
raise gnutls.CertificateSecurityError("Verify failed")
1684
2330
# New buffer for the fingerprint
1685
2331
buf = ctypes.create_string_buffer(20)
1686
2332
buf_len = ctypes.c_size_t()
1687
2333
# Get the fingerprint from the certificate into the buffer
1688
(gnutls.library.functions
1689
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1690
ctypes.byref(buf_len)))
2334
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2335
ctypes.byref(buf_len))
1691
2336
# Deinit the certificate
1692
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2337
gnutls.openpgp_crt_deinit(crt)
1693
2338
# Convert the buffer to a Python bytestring
1694
2339
fpr = ctypes.string_at(buf, buf_len.value)
1695
2340
# Convert the bytestring to hexadecimal notation
2594
def rfc3339_duration_to_delta(duration):
2595
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2597
>>> rfc3339_duration_to_delta("P7D")
2598
datetime.timedelta(7)
2599
>>> rfc3339_duration_to_delta("PT60S")
2600
datetime.timedelta(0, 60)
2601
>>> rfc3339_duration_to_delta("PT60M")
2602
datetime.timedelta(0, 3600)
2603
>>> rfc3339_duration_to_delta("PT24H")
2604
datetime.timedelta(1)
2605
>>> rfc3339_duration_to_delta("P1W")
2606
datetime.timedelta(7)
2607
>>> rfc3339_duration_to_delta("PT5M30S")
2608
datetime.timedelta(0, 330)
2609
>>> rfc3339_duration_to_delta("P1DT3M20S")
2610
datetime.timedelta(1, 200)
2613
# Parsing an RFC 3339 duration with regular expressions is not
2614
# possible - there would have to be multiple places for the same
2615
# values, like seconds. The current code, while more esoteric, is
2616
# cleaner without depending on a parsing library. If Python had a
2617
# built-in library for parsing we would use it, but we'd like to
2618
# avoid excessive use of external libraries.
2620
# New type for defining tokens, syntax, and semantics all-in-one
2621
Token = collections.namedtuple("Token", (
2622
"regexp", # To match token; if "value" is not None, must have
2623
# a "group" containing digits
2624
"value", # datetime.timedelta or None
2625
"followers")) # Tokens valid after this token
2626
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2627
# the "duration" ABNF definition in RFC 3339, Appendix A.
2628
token_end = Token(re.compile(r"$"), None, frozenset())
2629
token_second = Token(re.compile(r"(\d+)S"),
2630
datetime.timedelta(seconds=1),
2631
frozenset((token_end, )))
2632
token_minute = Token(re.compile(r"(\d+)M"),
2633
datetime.timedelta(minutes=1),
2634
frozenset((token_second, token_end)))
2635
token_hour = Token(re.compile(r"(\d+)H"),
2636
datetime.timedelta(hours=1),
2637
frozenset((token_minute, token_end)))
2638
token_time = Token(re.compile(r"T"),
2640
frozenset((token_hour, token_minute,
2642
token_day = Token(re.compile(r"(\d+)D"),
2643
datetime.timedelta(days=1),
2644
frozenset((token_time, token_end)))
2645
token_month = Token(re.compile(r"(\d+)M"),
2646
datetime.timedelta(weeks=4),
2647
frozenset((token_day, token_end)))
2648
token_year = Token(re.compile(r"(\d+)Y"),
2649
datetime.timedelta(weeks=52),
2650
frozenset((token_month, token_end)))
2651
token_week = Token(re.compile(r"(\d+)W"),
2652
datetime.timedelta(weeks=1),
2653
frozenset((token_end, )))
2654
token_duration = Token(re.compile(r"P"), None,
2655
frozenset((token_year, token_month,
2656
token_day, token_time,
2658
# Define starting values
2659
value = datetime.timedelta() # Value so far
2661
followers = frozenset((token_duration, )) # Following valid tokens
2662
s = duration # String left to parse
2663
# Loop until end token is found
2664
while found_token is not token_end:
2665
# Search for any currently valid tokens
2666
for token in followers:
2667
match = token.regexp.match(s)
2668
if match is not None:
2670
if token.value is not None:
2671
# Value found, parse digits
2672
factor = int(match.group(1), 10)
2673
# Add to value so far
2674
value += factor * token.value
2675
# Strip token from string
2676
s = token.regexp.sub("", s, 1)
2679
# Set valid next tokens
2680
followers = found_token.followers
2683
# No currently valid tokens were found
2684
raise ValueError("Invalid RFC 3339 duration: {!r}"
1920
2690
def string_to_delta(interval):
1921
2691
"""Parse a string and return a datetime.timedelta
2036
2821
"debug": "False",
2038
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
2823
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2824
":+SIGN-DSA-SHA256",
2039
2825
"servicename": "Mandos",
2040
2826
"use_dbus": "True",
2041
2827
"use_ipv6": "True",
2042
2828
"debuglevel": "",
2043
2829
"restore": "True",
2044
"statedir": "/var/lib/mandos"
2831
"statedir": "/var/lib/mandos",
2832
"foreground": "False",
2047
2836
# Parse config file for server-global settings
2048
2837
server_config = configparser.SafeConfigParser(server_defaults)
2049
2838
del server_defaults
2050
server_config.read(os.path.join(options.configdir,
2839
server_config.read(os.path.join(options.configdir, "mandos.conf"))
2052
2840
# Convert the SafeConfigParser object to a dict
2053
2841
server_settings = server_config.defaults()
2054
2842
# Use the appropriate methods on the non-string config options
2055
for option in ("debug", "use_dbus", "use_ipv6"):
2843
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2056
2844
server_settings[option] = server_config.getboolean("DEFAULT",
2058
2846
if server_settings["port"]:
2059
2847
server_settings["port"] = server_config.getint("DEFAULT",
2849
if server_settings["socket"]:
2850
server_settings["socket"] = server_config.getint("DEFAULT",
2852
# Later, stdin will, and stdout and stderr might, be dup'ed
2853
# over with an opened os.devnull. But we don't want this to
2854
# happen with a supplied network socket.
2855
if 0 <= server_settings["socket"] <= 2:
2856
server_settings["socket"] = os.dup(server_settings
2061
2858
del server_config
2063
2860
# Override the settings from the config file with command line
2064
2861
# options, if set.
2065
2862
for option in ("interface", "address", "port", "debug",
2066
"priority", "servicename", "configdir",
2067
"use_dbus", "use_ipv6", "debuglevel", "restore",
2863
"priority", "servicename", "configdir", "use_dbus",
2864
"use_ipv6", "debuglevel", "restore", "statedir",
2865
"socket", "foreground", "zeroconf"):
2069
2866
value = getattr(options, option)
2070
2867
if value is not None:
2071
2868
server_settings[option] = value
2073
2870
# Force all strings to be unicode
2074
2871
for option in server_settings.keys():
2075
if type(server_settings[option]) is str:
2076
server_settings[option] = unicode(server_settings[option])
2872
if isinstance(server_settings[option], bytes):
2873
server_settings[option] = (server_settings[option]
2875
# Force all boolean options to be boolean
2876
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2877
"foreground", "zeroconf"):
2878
server_settings[option] = bool(server_settings[option])
2879
# Debug implies foreground
2880
if server_settings["debug"]:
2881
server_settings["foreground"] = True
2077
2882
# Now we have our good server settings in "server_settings"
2079
2884
##################################################################
2886
if (not server_settings["zeroconf"]
2887
and not (server_settings["port"]
2888
or server_settings["socket"] != "")):
2889
parser.error("Needs port or socket to work without Zeroconf")
2081
2891
# For convenience
2082
2892
debug = server_settings["debug"]
2083
2893
debuglevel = server_settings["debuglevel"]
2110
2922
global mandos_dbus_service
2111
2923
mandos_dbus_service = None
2113
tcp_server = MandosServer((server_settings["address"],
2114
server_settings["port"]),
2116
interface=(server_settings["interface"]
2120
server_settings["priority"],
2123
pidfilename = "/var/run/mandos.pid"
2926
if server_settings["socket"] != "":
2927
socketfd = server_settings["socket"]
2928
tcp_server = MandosServer(
2929
(server_settings["address"], server_settings["port"]),
2931
interface=(server_settings["interface"] or None),
2933
gnutls_priority=server_settings["priority"],
2937
pidfilename = "/run/mandos.pid"
2938
if not os.path.isdir("/run/."):
2939
pidfilename = "/var/run/mandos.pid"
2125
pidfile = open(pidfilename, "w")
2127
logger.error("Could not open file %r", pidfilename)
2942
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
2943
except IOError as e:
2944
logger.error("Could not open file %r", pidfilename,
2130
uid = pwd.getpwnam("_mandos").pw_uid
2131
gid = pwd.getpwnam("_mandos").pw_gid
2947
for name, group in (("_mandos", "_mandos"),
2948
("mandos", "mandos"),
2949
("nobody", "nogroup")):
2134
uid = pwd.getpwnam("mandos").pw_uid
2135
gid = pwd.getpwnam("mandos").pw_gid
2951
uid = pwd.getpwnam(name).pw_uid
2952
gid = pwd.getpwnam(group).pw_gid
2136
2954
except KeyError:
2138
uid = pwd.getpwnam("nobody").pw_uid
2139
gid = pwd.getpwnam("nobody").pw_gid
2963
logger.debug("Did setuid/setgid to {}:{}".format(uid,
2146
2965
except OSError as error:
2147
if error[0] != errno.EPERM:
2966
logger.warning("Failed to setuid/setgid to {}:{}: {}"
2967
.format(uid, gid, os.strerror(error.errno)))
2968
if error.errno != errno.EPERM:
2151
2972
# Enable all possible GnuTLS debugging
2153
2974
# "Use a log level over 10 to enable all debugging options."
2154
2975
# - GnuTLS manual
2155
gnutls.library.functions.gnutls_global_set_log_level(11)
2976
gnutls.global_set_log_level(11)
2157
@gnutls.library.types.gnutls_log_func
2158
2979
def debug_gnutls(level, string):
2159
2980
logger.debug("GnuTLS: %s", string[:-1])
2161
(gnutls.library.functions
2162
.gnutls_global_set_log_function(debug_gnutls))
2982
gnutls.global_set_log_function(debug_gnutls)
2164
2984
# Redirect stdin so all checkers get /dev/null
2165
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2985
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2166
2986
os.dup2(null, sys.stdin.fileno())
2170
2990
# Need to fork before connecting to D-Bus
2172
2992
# Close all input and output, do double fork, etc.
2175
gobject.threads_init()
2995
# multiprocessing will use threads, so before we use GLib we need
2996
# to inform GLib that threads will be used.
2177
2999
global main_loop
2178
3000
# From the Avahi example code
2179
DBusGMainLoop(set_as_default=True )
2180
main_loop = gobject.MainLoop()
3001
DBusGMainLoop(set_as_default=True)
3002
main_loop = GLib.MainLoop()
2181
3003
bus = dbus.SystemBus()
2182
3004
# End of Avahi example code
2185
3007
bus_name = dbus.service.BusName("se.recompile.Mandos",
2186
bus, do_not_queue=True)
2187
old_bus_name = (dbus.service.BusName
2188
("se.bsnet.fukt.Mandos", bus,
2190
except dbus.exceptions.NameExistsException as e:
2191
logger.error(unicode(e) + ", disabling D-Bus")
3010
old_bus_name = dbus.service.BusName(
3011
"se.bsnet.fukt.Mandos", bus,
3013
except dbus.exceptions.DBusException as e:
3014
logger.error("Disabling D-Bus:", exc_info=e)
2192
3015
use_dbus = False
2193
3016
server_settings["use_dbus"] = False
2194
3017
tcp_server.use_dbus = False
2195
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2196
service = AvahiServiceToSyslog(name =
2197
server_settings["servicename"],
2198
servicetype = "_mandos._tcp",
2199
protocol = protocol, bus = bus)
2200
if server_settings["interface"]:
2201
service.interface = (if_nametoindex
2202
(str(server_settings["interface"])))
3019
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3020
service = AvahiServiceToSyslog(
3021
name = server_settings["servicename"],
3022
servicetype = "_mandos._tcp",
3023
protocol = protocol,
3025
if server_settings["interface"]:
3026
service.interface = if_nametoindex(
3027
server_settings["interface"].encode("utf-8"))
2204
3029
global multiprocessing_manager
2205
3030
multiprocessing_manager = multiprocessing.Manager()
2207
3032
client_class = Client
2209
client_class = functools.partial(ClientDBusTransitional,
3034
client_class = functools.partial(ClientDBus, bus = bus)
2212
3036
client_settings = Client.config_parser(client_config)
2213
3037
old_client_settings = {}
2214
3038
clients_data = {}
3040
# This is used to redirect stdout and stderr for checker processes
3042
wnull = open(os.devnull, "w") # A writable /dev/null
3043
# Only used if server is running in foreground but not in debug
3045
if debug or not foreground:
2216
3048
# Get client data and settings from last running state.
2217
3049
if server_settings["restore"]:
2219
3051
with open(stored_state_path, "rb") as stored_state:
2220
clients_data, old_client_settings = (pickle.load
3052
if sys.version_info.major == 2:
3053
clients_data, old_client_settings = pickle.load(
3056
bytes_clients_data, bytes_old_client_settings = (
3057
pickle.load(stored_state, encoding = "bytes"))
3058
### Fix bytes to strings
3061
clients_data = { (key.decode("utf-8")
3062
if isinstance(key, bytes)
3065
bytes_clients_data.items() }
3066
del bytes_clients_data
3067
for key in clients_data:
3068
value = { (k.decode("utf-8")
3069
if isinstance(k, bytes) else k): v
3071
clients_data[key].items() }
3072
clients_data[key] = value
3074
value["client_structure"] = [
3076
if isinstance(s, bytes)
3078
value["client_structure"] ]
3080
for k in ("name", "host"):
3081
if isinstance(value[k], bytes):
3082
value[k] = value[k].decode("utf-8")
3083
## old_client_settings
3085
old_client_settings = {
3086
(key.decode("utf-8")
3087
if isinstance(key, bytes)
3090
bytes_old_client_settings.items() }
3091
del bytes_old_client_settings
3093
for value in old_client_settings.values():
3094
if isinstance(value["host"], bytes):
3095
value["host"] = (value["host"]
2222
3097
os.remove(stored_state_path)
2223
3098
except IOError as e:
2224
logger.warning("Could not load persistent state: {0}"
2226
if e.errno != errno.ENOENT:
3099
if e.errno == errno.ENOENT:
3100
logger.warning("Could not load persistent state:"
3101
" {}".format(os.strerror(e.errno)))
3103
logger.critical("Could not load persistent state:",
2228
3106
except EOFError as e:
2229
3107
logger.warning("Could not load persistent state: "
2230
"EOFError: {0}".format(e))
2232
3111
with PGPEngine() as pgp:
2233
for client_name, client in clients_data.iteritems():
3112
for client_name, client in clients_data.items():
3113
# Skip removed clients
3114
if client_name not in client_settings:
2234
3117
# Decide which value to use after restoring saved state.
2235
3118
# We have three different values: Old config file,
2236
3119
# new config file, and saved state.
2241
3124
# For each value in new config, check if it
2242
3125
# differs from the old config value (Except for
2243
3126
# the "secret" attribute)
2244
if (name != "secret" and
2245
value != old_client_settings[client_name]
3127
if (name != "secret"
3129
old_client_settings[client_name][name])):
2247
3130
client[name] = value
2248
3131
except KeyError:
2251
3134
# Clients who has passed its expire date can still be
2252
# enabled if its last checker was successful. Clients
2253
# whose checker failed before we stored its state is
2254
# assumed to have failed all checkers during downtime.
3135
# enabled if its last checker was successful. A Client
3136
# whose checker succeeded before we stored its state is
3137
# assumed to have successfully run all checkers during
2255
3139
if client["enabled"]:
2256
3140
if datetime.datetime.utcnow() >= client["expires"]:
2257
3141
if not client["last_checked_ok"]:
2258
3142
logger.warning(
2259
"disabling client {0} - Client never "
2260
"performed a successfull checker"
2261
.format(client["name"]))
3143
"disabling client {} - Client never "
3144
"performed a successful checker".format(
2262
3146
client["enabled"] = False
2263
3147
elif client["last_checker_status"] != 0:
2264
3148
logger.warning(
2265
"disabling client {0} - Client "
2266
"last checker failed with error code {1}"
2267
.format(client["name"],
2268
client["last_checker_status"]))
3149
"disabling client {} - Client last"
3150
" checker failed with error code"
3153
client["last_checker_status"]))
2269
3154
client["enabled"] = False
2271
client["expires"] = (datetime.datetime
2273
+ client["timeout"])
3156
client["expires"] = (
3157
datetime.datetime.utcnow()
3158
+ client["timeout"])
2274
3159
logger.debug("Last checker succeeded,"
2275
" keeping {0} enabled"
2276
.format(client["name"]))
3160
" keeping {} enabled".format(
2278
client["secret"] = (
2279
pgp.decrypt(client["encrypted_secret"],
2280
client_settings[client_name]
3163
client["secret"] = pgp.decrypt(
3164
client["encrypted_secret"],
3165
client_settings[client_name]["secret"])
2282
3166
except PGPError:
2283
3167
# If decryption fails, we use secret from new settings
2284
logger.debug("Failed to decrypt {0} old secret"
2285
.format(client_name))
2286
client["secret"] = (
2287
client_settings[client_name]["secret"])
3168
logger.debug("Failed to decrypt {} old secret".format(
3170
client["secret"] = (client_settings[client_name]
2290
3173
# Add/remove clients based on new changes made to config
2291
3174
for client_name in (set(old_client_settings)
3229
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2341
3231
@dbus.service.signal(_interface, signature="os")
2342
3232
def ClientRemoved(self, objpath, name):
3236
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2346
3238
@dbus.service.method(_interface, out_signature="ao")
2347
3239
def GetAllClients(self):
2349
return dbus.Array(c.dbus_object_path
2351
tcp_server.clients.itervalues())
3241
return dbus.Array(c.dbus_object_path for c in
3242
tcp_server.clients.values())
3244
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2353
3246
@dbus.service.method(_interface,
2354
3247
out_signature="a{oa{sv}}")
2355
3248
def GetAllClientsWithProperties(self):
2357
3250
return dbus.Dictionary(
2358
((c.dbus_object_path, c.GetAll(""))
2359
for c in tcp_server.clients.itervalues()),
3251
{ c.dbus_object_path: c.GetAll(
3252
"se.recompile.Mandos.Client")
3253
for c in tcp_server.clients.values() },
2360
3254
signature="oa{sv}")
2362
3256
@dbus.service.method(_interface, in_signature="o")
2363
3257
def RemoveClient(self, object_path):
2365
for c in tcp_server.clients.itervalues():
3259
for c in tcp_server.clients.values():
2366
3260
if c.dbus_object_path == object_path:
2367
3261
del tcp_server.clients[c.name]
2368
3262
c.remove_from_connection()
2369
# Don't signal anything except ClientRemoved
3263
# Don't signal the disabling
2370
3264
c.disable(quiet=True)
2372
self.ClientRemoved(object_path, c.name)
3265
# Emit D-Bus signal for removal
3266
self.client_removed_signal(c)
2374
3268
raise KeyError(object_path)
3272
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3273
out_signature = "a{oa{sa{sv}}}")
3274
def GetManagedObjects(self):
3276
return dbus.Dictionary(
3277
{ client.dbus_object_path:
3279
{ interface: client.GetAll(interface)
3281
client._get_all_interface_names()})
3282
for client in tcp_server.clients.values()})
3284
def client_added_signal(self, client):
3285
"""Send the new standard signal and the old signal"""
3287
# New standard signal
3288
self.InterfacesAdded(
3289
client.dbus_object_path,
3291
{ interface: client.GetAll(interface)
3293
client._get_all_interface_names()}))
3295
self.ClientAdded(client.dbus_object_path)
3297
def client_removed_signal(self, client):
3298
"""Send the new standard signal and the old signal"""
3300
# New standard signal
3301
self.InterfacesRemoved(
3302
client.dbus_object_path,
3303
client._get_all_interface_names())
3305
self.ClientRemoved(client.dbus_object_path,
2378
class MandosDBusServiceTransitional(MandosDBusService):
2379
__metaclass__ = AlternateDBusNamesMetaclass
2380
mandos_dbus_service = MandosDBusServiceTransitional()
3308
mandos_dbus_service = MandosDBusService()
2383
3311
"Cleanup function; run on exit"
2386
3315
multiprocessing.active_children()
2387
3317
if not (tcp_server.clients or client_settings):