189
447
dbus.UInt16(self.port),
190
448
avahi.string_array_to_txt_array(self.TXT))
191
449
self.group.Commit()
192
451
def entry_group_state_changed(self, state, error):
193
452
"""Derived from the Avahi example code"""
194
logger.debug(u"Avahi state change: %i", state)
453
log.debug("Avahi entry group state change: %i", state)
196
455
if state == avahi.ENTRY_GROUP_ESTABLISHED:
197
logger.debug(u"Zeroconf service established.")
456
log.debug("Zeroconf service established.")
198
457
elif state == avahi.ENTRY_GROUP_COLLISION:
199
logger.warning(u"Zeroconf service name collision.")
458
log.info("Zeroconf service name collision.")
201
460
elif state == avahi.ENTRY_GROUP_FAILURE:
202
logger.critical(u"Avahi: Error in group state changed %s",
204
raise AvahiGroupError(u"State changed: %s"
461
log.critical("Avahi: Error in group state changed %s",
463
raise AvahiGroupError("State changed: {!s}".format(error))
206
465
def cleanup(self):
207
466
"""Derived from the Avahi example code"""
208
467
if self.group is not None:
470
except (dbus.exceptions.UnknownMethodException,
471
dbus.exceptions.DBusException):
210
473
self.group = None
211
def server_state_changed(self, state):
476
def server_state_changed(self, state, error=None):
212
477
"""Derived from the Avahi example code"""
213
if state == avahi.SERVER_COLLISION:
214
logger.error(u"Zeroconf server name collision")
478
log.debug("Avahi server state change: %i", state)
480
avahi.SERVER_INVALID: "Zeroconf server invalid",
481
avahi.SERVER_REGISTERING: None,
482
avahi.SERVER_COLLISION: "Zeroconf server name collision",
483
avahi.SERVER_FAILURE: "Zeroconf server failure",
485
if state in bad_states:
486
if bad_states[state] is not None:
488
log.error(bad_states[state])
490
log.error(bad_states[state] + ": %r", error)
216
492
elif state == avahi.SERVER_RUNNING:
495
except dbus.exceptions.DBusException as error:
496
if (error.get_dbus_name()
497
== "org.freedesktop.Avahi.CollisionError"):
498
log.info("Local Zeroconf service name collision.")
499
return self.rename(remove=False)
501
log.critical("D-Bus Exception", exc_info=error)
506
log.debug("Unknown state: %r", state)
508
log.debug("Unknown state: %r: %r", state, error)
218
510
def activate(self):
219
511
"""Derived from the Avahi example code"""
220
512
if self.server is None:
221
513
self.server = dbus.Interface(
222
514
self.bus.get_object(avahi.DBUS_NAME,
223
avahi.DBUS_PATH_SERVER),
515
avahi.DBUS_PATH_SERVER,
516
follow_name_owner_changes=True),
224
517
avahi.DBUS_INTERFACE_SERVER)
225
self.server.connect_to_signal(u"StateChanged",
226
self.server_state_changed)
518
self.server.connect_to_signal("StateChanged",
519
self.server_state_changed)
227
520
self.server_state_changed(self.server.GetState())
230
class Client(object):
523
class AvahiServiceToSyslog(AvahiService):
524
def rename(self, *args, **kwargs):
525
"""Add the new name to the syslog messages"""
526
ret = super(AvahiServiceToSyslog, self).rename(*args,
528
syslogger.setFormatter(logging.Formatter(
529
"Mandos ({}) [%(process)d]: %(levelname)s: %(message)s"
534
# Pretend that we have a GnuTLS module
536
"""This isn't so much a class as it is a module-like namespace."""
538
library = ctypes.util.find_library("gnutls")
540
library = ctypes.util.find_library("gnutls-deb0")
541
_library = ctypes.cdll.LoadLibrary(library)
544
# Unless otherwise indicated, the constants and types below are
545
# all from the gnutls/gnutls.h C header file.
556
E_NO_CERTIFICATE_FOUND = -49
561
KEYID_USE_SHA256 = 1 # gnutls/x509.h
562
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
565
class _session_int(ctypes.Structure):
567
session_t = ctypes.POINTER(_session_int)
569
class certificate_credentials_st(ctypes.Structure):
571
certificate_credentials_t = ctypes.POINTER(
572
certificate_credentials_st)
573
certificate_type_t = ctypes.c_int
575
class datum_t(ctypes.Structure):
576
_fields_ = [("data", ctypes.POINTER(ctypes.c_ubyte)),
577
("size", ctypes.c_uint)]
579
class _openpgp_crt_int(ctypes.Structure):
581
openpgp_crt_t = ctypes.POINTER(_openpgp_crt_int)
582
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
583
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
584
credentials_type_t = ctypes.c_int
585
transport_ptr_t = ctypes.c_void_p
586
close_request_t = ctypes.c_int
589
class Error(Exception):
590
def __init__(self, message=None, code=None, args=()):
591
# Default usage is by a message string, but if a return
592
# code is passed, convert it to a string with
595
if message is None and code is not None:
596
message = gnutls.strerror(code).decode(
597
"utf-8", errors="replace")
598
return super(gnutls.Error, self).__init__(
601
class CertificateSecurityError(Error):
605
def __init__(self, cls):
608
def from_param(self, obj):
609
if not isinstance(obj, self.cls):
610
raise TypeError("Not of type {}: {!r}"
611
.format(self.cls.__name__, obj))
612
return ctypes.byref(obj.from_param(obj))
614
class CastToVoidPointer:
615
def __init__(self, cls):
618
def from_param(self, obj):
619
if not isinstance(obj, self.cls):
620
raise TypeError("Not of type {}: {!r}"
621
.format(self.cls.__name__, obj))
622
return ctypes.cast(obj.from_param(obj), ctypes.c_void_p)
624
class With_from_param:
626
def from_param(cls, obj):
627
return obj._as_parameter_
630
class Credentials(With_from_param):
632
self._as_parameter_ = gnutls.certificate_credentials_t()
633
gnutls.certificate_allocate_credentials(self)
634
self.type = gnutls.CRD_CERTIFICATE
637
gnutls.certificate_free_credentials(self)
639
class ClientSession(With_from_param):
640
def __init__(self, socket, credentials=None):
641
self._as_parameter_ = gnutls.session_t()
642
gnutls_flags = gnutls.CLIENT
643
if gnutls.check_version(b"3.5.6"):
644
gnutls_flags |= gnutls.NO_TICKETS
646
gnutls_flags |= gnutls.ENABLE_RAWPK
647
gnutls.init(self, gnutls_flags)
649
gnutls.set_default_priority(self)
650
gnutls.transport_set_ptr(self, socket.fileno())
651
gnutls.handshake_set_private_extensions(self, True)
653
if credentials is None:
654
credentials = gnutls.Credentials()
655
gnutls.credentials_set(self, credentials.type,
657
self.credentials = credentials
663
return gnutls.handshake(self)
665
def send(self, data):
669
data_len -= gnutls.record_send(self, data[-data_len:],
673
return gnutls.bye(self, gnutls.SHUT_RDWR)
675
# Error handling functions
676
def _error_code(result):
677
"""A function to raise exceptions on errors, suitable
678
for the "restype" attribute on ctypes functions"""
679
if result >= gnutls.E_SUCCESS:
681
if result == gnutls.E_NO_CERTIFICATE_FOUND:
682
raise gnutls.CertificateSecurityError(code=result)
683
raise gnutls.Error(code=result)
685
def _retry_on_error(result, func, arguments,
686
_error_code=_error_code):
687
"""A function to retry on some errors, suitable
688
for the "errcheck" attribute on ctypes functions"""
689
while result < gnutls.E_SUCCESS:
690
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
691
return _error_code(result)
692
result = func(*arguments)
695
# Unless otherwise indicated, the function declarations below are
696
# all from the gnutls/gnutls.h C header file.
699
priority_set_direct = _library.gnutls_priority_set_direct
700
priority_set_direct.argtypes = [ClientSession, ctypes.c_char_p,
701
ctypes.POINTER(ctypes.c_char_p)]
702
priority_set_direct.restype = _error_code
704
init = _library.gnutls_init
705
init.argtypes = [PointerTo(ClientSession), ctypes.c_int]
706
init.restype = _error_code
708
set_default_priority = _library.gnutls_set_default_priority
709
set_default_priority.argtypes = [ClientSession]
710
set_default_priority.restype = _error_code
712
record_send = _library.gnutls_record_send
713
record_send.argtypes = [ClientSession, ctypes.c_void_p,
715
record_send.restype = ctypes.c_ssize_t
716
record_send.errcheck = _retry_on_error
718
certificate_allocate_credentials = (
719
_library.gnutls_certificate_allocate_credentials)
720
certificate_allocate_credentials.argtypes = [
721
PointerTo(Credentials)]
722
certificate_allocate_credentials.restype = _error_code
724
certificate_free_credentials = (
725
_library.gnutls_certificate_free_credentials)
726
certificate_free_credentials.argtypes = [Credentials]
727
certificate_free_credentials.restype = None
729
handshake_set_private_extensions = (
730
_library.gnutls_handshake_set_private_extensions)
731
handshake_set_private_extensions.argtypes = [ClientSession,
733
handshake_set_private_extensions.restype = None
735
credentials_set = _library.gnutls_credentials_set
736
credentials_set.argtypes = [ClientSession, credentials_type_t,
737
CastToVoidPointer(Credentials)]
738
credentials_set.restype = _error_code
740
strerror = _library.gnutls_strerror
741
strerror.argtypes = [ctypes.c_int]
742
strerror.restype = ctypes.c_char_p
744
certificate_type_get = _library.gnutls_certificate_type_get
745
certificate_type_get.argtypes = [ClientSession]
746
certificate_type_get.restype = _error_code
748
certificate_get_peers = _library.gnutls_certificate_get_peers
749
certificate_get_peers.argtypes = [ClientSession,
750
ctypes.POINTER(ctypes.c_uint)]
751
certificate_get_peers.restype = ctypes.POINTER(datum_t)
753
global_set_log_level = _library.gnutls_global_set_log_level
754
global_set_log_level.argtypes = [ctypes.c_int]
755
global_set_log_level.restype = None
757
global_set_log_function = _library.gnutls_global_set_log_function
758
global_set_log_function.argtypes = [log_func]
759
global_set_log_function.restype = None
761
deinit = _library.gnutls_deinit
762
deinit.argtypes = [ClientSession]
763
deinit.restype = None
765
handshake = _library.gnutls_handshake
766
handshake.argtypes = [ClientSession]
767
handshake.restype = ctypes.c_int
768
handshake.errcheck = _retry_on_error
770
transport_set_ptr = _library.gnutls_transport_set_ptr
771
transport_set_ptr.argtypes = [ClientSession, transport_ptr_t]
772
transport_set_ptr.restype = None
774
bye = _library.gnutls_bye
775
bye.argtypes = [ClientSession, close_request_t]
776
bye.restype = ctypes.c_int
777
bye.errcheck = _retry_on_error
779
check_version = _library.gnutls_check_version
780
check_version.argtypes = [ctypes.c_char_p]
781
check_version.restype = ctypes.c_char_p
783
_need_version = b"3.3.0"
784
if check_version(_need_version) is None:
785
raise self.Error("Needs GnuTLS {} or later"
786
.format(_need_version))
788
_tls_rawpk_version = b"3.6.6"
789
has_rawpk = bool(check_version(_tls_rawpk_version))
793
class pubkey_st(ctypes.Structure):
795
pubkey_t = ctypes.POINTER(pubkey_st)
797
x509_crt_fmt_t = ctypes.c_int
799
# All the function declarations below are from
801
pubkey_init = _library.gnutls_pubkey_init
802
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
803
pubkey_init.restype = _error_code
805
pubkey_import = _library.gnutls_pubkey_import
806
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
808
pubkey_import.restype = _error_code
810
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
811
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
812
ctypes.POINTER(ctypes.c_ubyte),
813
ctypes.POINTER(ctypes.c_size_t)]
814
pubkey_get_key_id.restype = _error_code
816
pubkey_deinit = _library.gnutls_pubkey_deinit
817
pubkey_deinit.argtypes = [pubkey_t]
818
pubkey_deinit.restype = None
820
# All the function declarations below are from
823
openpgp_crt_init = _library.gnutls_openpgp_crt_init
824
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
825
openpgp_crt_init.restype = _error_code
827
openpgp_crt_import = _library.gnutls_openpgp_crt_import
828
openpgp_crt_import.argtypes = [openpgp_crt_t,
829
ctypes.POINTER(datum_t),
831
openpgp_crt_import.restype = _error_code
833
openpgp_crt_verify_self = \
834
_library.gnutls_openpgp_crt_verify_self
835
openpgp_crt_verify_self.argtypes = [
838
ctypes.POINTER(ctypes.c_uint),
840
openpgp_crt_verify_self.restype = _error_code
842
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
843
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
844
openpgp_crt_deinit.restype = None
846
openpgp_crt_get_fingerprint = (
847
_library.gnutls_openpgp_crt_get_fingerprint)
848
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
852
openpgp_crt_get_fingerprint.restype = _error_code
854
if check_version(b"3.6.4"):
855
certificate_type_get2 = _library.gnutls_certificate_type_get2
856
certificate_type_get2.argtypes = [ClientSession, ctypes.c_int]
857
certificate_type_get2.restype = _error_code
859
# Remove non-public functions
860
del _error_code, _retry_on_error
863
def call_pipe(connection, # : multiprocessing.Connection
864
func, *args, **kwargs):
865
"""This function is meant to be called by multiprocessing.Process
867
This function runs func(*args, **kwargs), and writes the resulting
868
return value on the provided multiprocessing.Connection.
870
connection.send(func(*args, **kwargs))
231
875
"""A representation of a client host served by this server.
878
approved: bool(); None if not yet approved/disapproved
879
approval_delay: datetime.timedelta(); Time to wait for approval
880
approval_duration: datetime.timedelta(); Duration of one approval
881
checker: multiprocessing.Process(); a running checker process used
882
to see if the client lives. None if no process is
884
checker_callback_tag: a GLib event source tag, or None
885
checker_command: string; External command which is run to check
886
if client lives. %() expansions are done at
887
runtime with vars(self) as dict, so that for
888
instance %(name)s can be used in the command.
889
checker_initiator_tag: a GLib event source tag, or None
890
created: datetime.datetime(); (UTC) object creation
891
client_structure: Object describing what attributes a client has
892
and is used for storing the client at exit
893
current_checker_command: string; current running checker_command
894
disable_initiator_tag: a GLib event source tag, or None
896
fingerprint: string (40 or 32 hexadecimal digits); used to
897
uniquely identify an OpenPGP client
898
key_id: string (64 hexadecimal digits); used to uniquely identify
899
a client using raw public keys
900
host: string; available for use by the checker command
901
interval: datetime.timedelta(); How often to start a new checker
902
last_approval_request: datetime.datetime(); (UTC) or None
903
last_checked_ok: datetime.datetime(); (UTC) or None
904
last_checker_status: integer between 0 and 255 reflecting exit
905
status of last checker. -1 reflects crashed
906
checker, -2 means no checker completed yet.
907
last_checker_signal: The signal which killed the last checker, if
908
last_checker_status is -1
909
last_enabled: datetime.datetime(); (UTC) or None
234
910
name: string; from the config file, used in log messages and
235
911
D-Bus identifiers
236
fingerprint: string (40 or 32 hexadecimal digits); used to
237
uniquely identify the client
238
912
secret: bytestring; sent verbatim (over TLS) to client
239
host: string; available for use by the checker command
240
created: datetime.datetime(); (UTC) object creation
241
last_enabled: datetime.datetime(); (UTC)
243
last_checked_ok: datetime.datetime(); (UTC) or None
244
913
timeout: datetime.timedelta(); How long from last_checked_ok
245
until this client is invalid
246
interval: datetime.timedelta(); How often to start a new checker
247
disable_hook: If set, called by disable() as disable_hook(self)
248
checker: subprocess.Popen(); a running checker process used
249
to see if the client lives.
250
'None' if no process is running.
251
checker_initiator_tag: a gobject event source tag, or None
252
disable_initiator_tag: - '' -
253
checker_callback_tag: - '' -
254
checker_command: string; External command which is run to check if
255
client lives. %() expansions are done at
256
runtime with vars(self) as dict, so that for
257
instance %(name)s can be used in the command.
258
current_checker_command: string; current running checker_command
914
until this client is disabled
915
extended_timeout: extra long timeout when secret has been sent
916
runtime_expansions: Allowed attributes for runtime expansion.
917
expires: datetime.datetime(); time (UTC) when a client will be
919
server_settings: The server_settings dict from main()
922
runtime_expansions = ("approval_delay", "approval_duration",
923
"created", "enabled", "expires", "key_id",
924
"fingerprint", "host", "interval",
925
"last_approval_request", "last_checked_ok",
926
"last_enabled", "name", "timeout")
929
"extended_timeout": "PT15M",
931
"checker": "fping -q -- %%(host)s",
933
"approval_delay": "PT0S",
934
"approval_duration": "PT1S",
935
"approved_by_default": "True",
262
def _timedelta_to_milliseconds(td):
263
"Convert a datetime.timedelta() to milliseconds"
264
return ((td.days * 24 * 60 * 60 * 1000)
265
+ (td.seconds * 1000)
266
+ (td.microseconds // 1000))
268
def timeout_milliseconds(self):
269
"Return the 'timeout' attribute in milliseconds"
270
return self._timedelta_to_milliseconds(self.timeout)
272
def interval_milliseconds(self):
273
"Return the 'interval' attribute in milliseconds"
274
return self._timedelta_to_milliseconds(self.interval)
276
def __init__(self, name = None, disable_hook=None, config=None):
277
"""Note: the 'checker' key in 'config' sets the
278
'checker_command' attribute and *not* the 'checker'
940
def config_parser(config):
941
"""Construct a new dict of client settings of this form:
942
{ client_name: {setting_name: value, ...}, ...}
943
with exceptions for any special settings as defined above.
944
NOTE: Must be a pure function. Must return the same result
945
value given the same arguments.
948
for client_name in config.sections():
949
section = dict(config.items(client_name))
950
client = settings[client_name] = {}
952
client["host"] = section["host"]
953
# Reformat values from string types to Python types
954
client["approved_by_default"] = config.getboolean(
955
client_name, "approved_by_default")
956
client["enabled"] = config.getboolean(client_name,
959
# Uppercase and remove spaces from key_id and fingerprint
960
# for later comparison purposes with return value from the
961
# key_id() and fingerprint() functions
962
client["key_id"] = (section.get("key_id", "").upper()
964
client["fingerprint"] = (section["fingerprint"].upper()
966
if "secret" in section:
967
client["secret"] = codecs.decode(section["secret"]
970
elif "secfile" in section:
971
with open(os.path.expanduser(os.path.expandvars
972
(section["secfile"])),
974
client["secret"] = secfile.read()
976
raise TypeError("No secret or secfile for section {}"
978
client["timeout"] = string_to_delta(section["timeout"])
979
client["extended_timeout"] = string_to_delta(
980
section["extended_timeout"])
981
client["interval"] = string_to_delta(section["interval"])
982
client["approval_delay"] = string_to_delta(
983
section["approval_delay"])
984
client["approval_duration"] = string_to_delta(
985
section["approval_duration"])
986
client["checker_command"] = section["checker"]
987
client["last_approval_request"] = None
988
client["last_checked_ok"] = None
989
client["last_checker_status"] = -2
993
def __init__(self, settings, name=None, server_settings=None):
283
logger.debug(u"Creating client %r", self.name)
284
# Uppercase and remove spaces from fingerprint for later
285
# comparison purposes with return value from the fingerprint()
287
self.fingerprint = (config[u"fingerprint"].upper()
289
logger.debug(u" Fingerprint: %s", self.fingerprint)
290
if u"secret" in config:
291
self.secret = config[u"secret"].decode(u"base64")
292
elif u"secfile" in config:
293
with closing(open(os.path.expanduser
295
(config[u"secfile"])))) as secfile:
296
self.secret = secfile.read()
995
if server_settings is None:
997
self.server_settings = server_settings
998
# adding all client settings
999
for setting, value in settings.items():
1000
setattr(self, setting, value)
1003
if not hasattr(self, "last_enabled"):
1004
self.last_enabled = datetime.datetime.utcnow()
1005
if not hasattr(self, "expires"):
1006
self.expires = (datetime.datetime.utcnow()
298
raise TypeError(u"No secret or secfile for client %s"
300
self.host = config.get(u"host", u"")
301
self.created = datetime.datetime.utcnow()
303
self.last_enabled = None
304
self.last_checked_ok = None
305
self.timeout = string_to_delta(config[u"timeout"])
306
self.interval = string_to_delta(config[u"interval"])
307
self.disable_hook = disable_hook
1009
self.last_enabled = None
1012
log.debug("Creating client %r", self.name)
1013
log.debug(" Key ID: %s", self.key_id)
1014
log.debug(" Fingerprint: %s", self.fingerprint)
1015
self.created = settings.get("created",
1016
datetime.datetime.utcnow())
1018
# attributes specific for this server instance
308
1019
self.checker = None
309
1020
self.checker_initiator_tag = None
310
1021
self.disable_initiator_tag = None
311
1022
self.checker_callback_tag = None
312
self.checker_command = config[u"checker"]
313
1023
self.current_checker_command = None
314
self.last_connect = None
1024
self.approved = None
1025
self.approvals_pending = 0
1026
self.changedstate = multiprocessing_manager.Condition(
1027
multiprocessing_manager.Lock())
1028
self.client_structure = [attr
1029
for attr in self.__dict__.keys()
1030
if not attr.startswith("_")]
1031
self.client_structure.append("client_structure")
1033
for name, t in inspect.getmembers(
1034
type(self), lambda obj: isinstance(obj, property)):
1035
if not name.startswith("_"):
1036
self.client_structure.append(name)
1038
# Send notice to process children that client state has changed
1039
def send_changedstate(self):
1040
with self.changedstate:
1041
self.changedstate.notify_all()
316
1043
def enable(self):
317
1044
"""Start this client's checker and timeout hooks"""
318
if getattr(self, u"enabled", False):
1045
if getattr(self, "enabled", False):
319
1046
# Already enabled
1048
self.expires = datetime.datetime.utcnow() + self.timeout
321
1050
self.last_enabled = datetime.datetime.utcnow()
1052
self.send_changedstate()
1054
def disable(self, quiet=True):
1055
"""Disable this client."""
1056
if not getattr(self, "enabled", False):
1059
log.info("Disabling client %s", self.name)
1060
if getattr(self, "disable_initiator_tag", None) is not None:
1061
GLib.source_remove(self.disable_initiator_tag)
1062
self.disable_initiator_tag = None
1064
if getattr(self, "checker_initiator_tag", None) is not None:
1065
GLib.source_remove(self.checker_initiator_tag)
1066
self.checker_initiator_tag = None
1068
self.enabled = False
1070
self.send_changedstate()
1071
# Do not run this again if called by a GLib.timeout_add
1077
def init_checker(self):
322
1078
# Schedule a new checker to be started an 'interval' from now,
323
1079
# and every interval from then on.
324
self.checker_initiator_tag = (gobject.timeout_add
325
(self.interval_milliseconds(),
1080
if self.checker_initiator_tag is not None:
1081
GLib.source_remove(self.checker_initiator_tag)
1082
self.checker_initiator_tag = GLib.timeout_add(
1083
random.randrange(int(self.interval.total_seconds() * 1000
1086
# Schedule a disable() when 'timeout' has passed
1087
if self.disable_initiator_tag is not None:
1088
GLib.source_remove(self.disable_initiator_tag)
1089
self.disable_initiator_tag = GLib.timeout_add(
1090
int(self.timeout.total_seconds() * 1000), self.disable)
327
1091
# Also start a new checker *right now*.
328
1092
self.start_checker()
329
# Schedule a disable() when 'timeout' has passed
330
self.disable_initiator_tag = (gobject.timeout_add
331
(self.timeout_milliseconds(),
336
"""Disable this client."""
337
if not getattr(self, "enabled", False):
339
logger.info(u"Disabling client %s", self.name)
340
if getattr(self, u"disable_initiator_tag", False):
341
gobject.source_remove(self.disable_initiator_tag)
342
self.disable_initiator_tag = None
343
if getattr(self, u"checker_initiator_tag", False):
344
gobject.source_remove(self.checker_initiator_tag)
345
self.checker_initiator_tag = None
347
if self.disable_hook:
348
self.disable_hook(self)
350
# Do not run this again if called by a gobject.timeout_add
354
self.disable_hook = None
357
def checker_callback(self, pid, condition, command):
1094
def checker_callback(self, source, condition, connection,
358
1096
"""The checker has completed, so take appropriate actions."""
1097
# Read return code from connection (see call_pipe)
1098
returncode = connection.recv()
1100
if self.checker is not None:
359
1102
self.checker_callback_tag = None
360
1103
self.checker = None
361
if os.WIFEXITED(condition):
362
exitstatus = os.WEXITSTATUS(condition)
364
logger.info(u"Checker for %(name)s succeeded",
1106
self.last_checker_status = returncode
1107
self.last_checker_signal = None
1108
if self.last_checker_status == 0:
1109
log.info("Checker for %(name)s succeeded", vars(self))
366
1110
self.checked_ok()
368
logger.info(u"Checker for %(name)s failed",
1112
log.info("Checker for %(name)s failed", vars(self))
371
logger.warning(u"Checker for %(name)s crashed?",
1114
self.last_checker_status = -1
1115
self.last_checker_signal = -returncode
1116
log.warning("Checker for %(name)s crashed?", vars(self))
374
1119
def checked_ok(self):
375
"""Bump up the timeout for this client.
377
This should only be called when the client has been seen,
1120
"""Assert that the client has been seen, alive and well."""
380
1121
self.last_checked_ok = datetime.datetime.utcnow()
381
gobject.source_remove(self.disable_initiator_tag)
382
self.disable_initiator_tag = (gobject.timeout_add
383
(self.timeout_milliseconds(),
1122
self.last_checker_status = 0
1123
self.last_checker_signal = None
1126
def bump_timeout(self, timeout=None):
1127
"""Bump up the timeout for this client."""
1129
timeout = self.timeout
1130
if self.disable_initiator_tag is not None:
1131
GLib.source_remove(self.disable_initiator_tag)
1132
self.disable_initiator_tag = None
1133
if getattr(self, "enabled", False):
1134
self.disable_initiator_tag = GLib.timeout_add(
1135
int(timeout.total_seconds() * 1000), self.disable)
1136
self.expires = datetime.datetime.utcnow() + timeout
1138
def need_approval(self):
1139
self.last_approval_request = datetime.datetime.utcnow()
386
1141
def start_checker(self):
387
1142
"""Start a new checker subprocess if one is not running.
389
1144
If a checker already exists, leave it running and do
391
1146
# The reason for not killing a running checker is that if we
392
# did that, then if a checker (for some reason) started
393
# running slowly and taking more than 'interval' time, the
394
# client would inevitably timeout, since no checker would get
395
# a chance to run to completion. If we instead leave running
1147
# did that, and if a checker (for some reason) started running
1148
# slowly and taking more than 'interval' time, then the client
1149
# would inevitably timeout, since no checker would get a
1150
# chance to run to completion. If we instead leave running
396
1151
# checkers alone, the checker would have to take more time
397
# than 'timeout' for the client to be declared invalid, which
398
# is as it should be.
400
# If a checker exists, make sure it is not a zombie
401
if self.checker is not None:
402
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
404
logger.warning(u"Checker was a zombie")
405
gobject.source_remove(self.checker_callback_tag)
406
self.checker_callback(pid, status,
407
self.current_checker_command)
1152
# than 'timeout' for the client to be disabled, which is as it
1155
if self.checker is not None and not self.checker.is_alive():
1156
log.warning("Checker was not alive; joining")
408
1159
# Start a new checker if needed
409
1160
if self.checker is None:
1161
# Escape attributes for the shell
1163
attr: shlex.quote(str(getattr(self, attr)))
1164
for attr in self.runtime_expansions}
411
# In case checker_command has exactly one % operator
412
command = self.checker_command % self.host
414
# Escape attributes for the shell
415
escaped_attrs = dict((key,
416
re.escape(unicode(str(val),
420
vars(self).iteritems())
422
command = self.checker_command % escaped_attrs
423
except TypeError, error:
424
logger.error(u'Could not format string "%s":'
425
u' %s', self.checker_command, error)
426
return True # Try again later
1166
command = self.checker_command % escaped_attrs
1167
except TypeError as error:
1168
log.error('Could not format string "%s"',
1169
self.checker_command, exc_info=error)
1170
return True # Try again later
427
1171
self.current_checker_command = command
429
logger.info(u"Starting checker %r for %s",
431
# We don't need to redirect stdout and stderr, since
432
# in normal mode, that is already done by daemon(),
433
# and in debug mode we don't want to. (Stdin is
434
# always replaced by /dev/null.)
435
self.checker = subprocess.Popen(command,
437
shell=True, cwd=u"/")
438
self.checker_callback_tag = (gobject.child_watch_add
440
self.checker_callback,
442
# The checker may have completed before the gobject
443
# watch was added. Check for this.
444
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
446
gobject.source_remove(self.checker_callback_tag)
447
self.checker_callback(pid, status, command)
448
except OSError, error:
449
logger.error(u"Failed to start subprocess: %s",
451
# Re-run this periodically if run by gobject.timeout_add
1172
log.info("Starting checker %r for %s", command, self.name)
1173
# We don't need to redirect stdout and stderr, since
1174
# in normal mode, that is already done by daemon(),
1175
# and in debug mode we don't want to. (Stdin is
1176
# always replaced by /dev/null.)
1177
# The exception is when not debugging but nevertheless
1178
# running in the foreground; use the previously
1180
popen_args = {"close_fds": True,
1183
if (not self.server_settings["debug"]
1184
and self.server_settings["foreground"]):
1185
popen_args.update({"stdout": wnull,
1187
pipe = multiprocessing.Pipe(duplex=False)
1188
self.checker = multiprocessing.Process(
1190
args=(pipe[1], subprocess.call, command),
1192
self.checker.start()
1193
self.checker_callback_tag = GLib.io_add_watch(
1194
GLib.IOChannel.unix_new(pipe[0].fileno()),
1195
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1196
self.checker_callback, pipe[0], command)
1197
# Re-run this periodically if run by GLib.timeout_add
454
1200
def stop_checker(self):
455
1201
"""Force the checker process, if any, to stop."""
456
1202
if self.checker_callback_tag:
457
gobject.source_remove(self.checker_callback_tag)
1203
GLib.source_remove(self.checker_callback_tag)
458
1204
self.checker_callback_tag = None
459
if getattr(self, u"checker", None) is None:
1205
if getattr(self, "checker", None) is None:
461
logger.debug(u"Stopping checker for %(name)s", vars(self))
463
os.kill(self.checker.pid, signal.SIGTERM)
465
#if self.checker.poll() is None:
466
# os.kill(self.checker.pid, signal.SIGKILL)
467
except OSError, error:
468
if error.errno != errno.ESRCH: # No such process
1207
log.debug("Stopping checker for %(name)s", vars(self))
1208
self.checker.terminate()
470
1209
self.checker = None
472
def still_valid(self):
473
"""Has the timeout not yet passed for this client?"""
474
if not getattr(self, u"enabled", False):
476
now = datetime.datetime.utcnow()
477
if self.last_checked_ok is None:
478
return now < (self.created + self.timeout)
480
return now < (self.last_checked_ok + self.timeout)
483
def dbus_service_property(dbus_interface, signature=u"v",
484
access=u"readwrite", byte_arrays=False):
1212
def dbus_service_property(dbus_interface,
485
1216
"""Decorators for marking methods of a DBusObjectWithProperties to
486
1217
become properties on the D-Bus.
488
1219
The decorated method will be called with no arguments by "Get"
489
1220
and with one argument by "Set".
491
1222
The parameters, where they are supported, are the same as
492
1223
dbus.service.method, except there is only "signature", since the
493
1224
type from Get() and the type sent to Set() is the same.
1226
# Encoding deeply encoded byte arrays is not supported yet by the
1227
# "Set" method, so we fail early here:
1228
if byte_arrays and signature != "ay":
1229
raise ValueError("Byte arrays not supported for non-'ay'"
1230
" signature {!r}".format(signature))
495
1232
def decorator(func):
496
1233
func._dbus_is_property = True
497
1234
func._dbus_interface = dbus_interface
498
1235
func._dbus_signature = signature
499
1236
func._dbus_access = access
500
1237
func._dbus_name = func.__name__
501
if func._dbus_name.endswith(u"_dbus_property"):
1238
if func._dbus_name.endswith("_dbus_property"):
502
1239
func._dbus_name = func._dbus_name[:-14]
503
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
1240
func._dbus_get_args_options = {"byte_arrays": byte_arrays}
1246
def dbus_interface_annotations(dbus_interface):
1247
"""Decorator for marking functions returning interface annotations
1251
@dbus_interface_annotations("org.example.Interface")
1252
def _foo(self): # Function name does not matter
1253
return {"org.freedesktop.DBus.Deprecated": "true",
1254
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1258
def decorator(func):
1259
func._dbus_is_interface = True
1260
func._dbus_interface = dbus_interface
1261
func._dbus_name = dbus_interface
1267
def dbus_annotations(annotations):
1268
"""Decorator to annotate D-Bus methods, signals or properties
1271
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1272
"org.freedesktop.DBus.Property."
1273
"EmitsChangedSignal": "false"})
1274
@dbus_service_property("org.example.Interface", signature="b",
1276
def Property_dbus_property(self):
1277
return dbus.Boolean(False)
1279
See also the DBusObjectWithAnnotations class.
1282
def decorator(func):
1283
func._dbus_annotations = annotations
505
1286
return decorator
508
1289
class DBusPropertyException(dbus.exceptions.DBusException):
509
1290
"""A base class for D-Bus property-related exceptions
511
def __unicode__(self):
512
return unicode(str(self))
515
1295
class DBusPropertyAccessException(DBusPropertyException):
527
class DBusObjectWithProperties(dbus.service.Object):
1307
class DBusObjectWithAnnotations(dbus.service.Object):
1308
"""A D-Bus object with annotations.
1310
Classes inheriting from this can use the dbus_annotations
1311
decorator to add annotations to methods or signals.
1315
def _is_dbus_thing(thing):
1316
"""Returns a function testing if an attribute is a D-Bus thing
1318
If called like _is_dbus_thing("method") it returns a function
1319
suitable for use as predicate to inspect.getmembers().
1321
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1324
def _get_all_dbus_things(self, thing):
1325
"""Returns a generator of (name, attribute) pairs
1327
return ((getattr(athing.__get__(self), "_dbus_name", name),
1328
athing.__get__(self))
1329
for cls in self.__class__.__mro__
1331
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1333
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1335
path_keyword="object_path",
1336
connection_keyword="connection")
1337
def Introspect(self, object_path, connection):
1338
"""Overloading of standard D-Bus method.
1340
Inserts annotation tags on methods and signals.
1342
xmlstring = dbus.service.Object.Introspect(self, object_path,
1345
document = xml.dom.minidom.parseString(xmlstring)
1347
for if_tag in document.getElementsByTagName("interface"):
1348
# Add annotation tags
1349
for typ in ("method", "signal"):
1350
for tag in if_tag.getElementsByTagName(typ):
1352
for name, prop in (self.
1353
_get_all_dbus_things(typ)):
1354
if (name == tag.getAttribute("name")
1355
and prop._dbus_interface
1356
== if_tag.getAttribute("name")):
1357
annots.update(getattr(
1358
prop, "_dbus_annotations", {}))
1359
for name, value in annots.items():
1360
ann_tag = document.createElement(
1362
ann_tag.setAttribute("name", name)
1363
ann_tag.setAttribute("value", value)
1364
tag.appendChild(ann_tag)
1365
# Add interface annotation tags
1366
for annotation, value in dict(
1367
itertools.chain.from_iterable(
1368
annotations().items()
1369
for name, annotations
1370
in self._get_all_dbus_things("interface")
1371
if name == if_tag.getAttribute("name")
1373
ann_tag = document.createElement("annotation")
1374
ann_tag.setAttribute("name", annotation)
1375
ann_tag.setAttribute("value", value)
1376
if_tag.appendChild(ann_tag)
1377
# Fix argument name for the Introspect method itself
1378
if (if_tag.getAttribute("name")
1379
== dbus.INTROSPECTABLE_IFACE):
1380
for cn in if_tag.getElementsByTagName("method"):
1381
if cn.getAttribute("name") == "Introspect":
1382
for arg in cn.getElementsByTagName("arg"):
1383
if (arg.getAttribute("direction")
1385
arg.setAttribute("name",
1387
xmlstring = document.toxml("utf-8")
1389
except (AttributeError, xml.dom.DOMException,
1390
xml.parsers.expat.ExpatError) as error:
1391
log.error("Failed to override Introspection method",
1396
class DBusObjectWithProperties(DBusObjectWithAnnotations):
528
1397
"""A D-Bus object with properties.
530
1399
Classes inheriting from this can use the dbus_service_property
531
1400
decorator to expose methods as D-Bus properties. It exposes the
532
1401
standard Get(), Set(), and GetAll() methods on the D-Bus.
536
def _is_dbus_property(obj):
537
return getattr(obj, u"_dbus_is_property", False)
539
def _get_all_dbus_properties(self):
540
"""Returns a generator of (name, attribute) pairs
542
return ((prop._dbus_name, prop)
544
inspect.getmembers(self, self._is_dbus_property))
546
1404
def _get_dbus_property(self, interface_name, property_name):
547
1405
"""Returns a bound method if one exists which is a D-Bus
548
1406
property with the specified name and interface.
550
for name in (property_name,
551
property_name + u"_dbus_property"):
552
prop = getattr(self, name, None)
554
or not self._is_dbus_property(prop)
555
or prop._dbus_name != property_name
556
or (interface_name and prop._dbus_interface
557
and interface_name != prop._dbus_interface)):
1408
for cls in self.__class__.__mro__:
1409
for name, value in inspect.getmembers(
1410
cls, self._is_dbus_thing("property")):
1411
if (value._dbus_name == property_name
1412
and value._dbus_interface == interface_name):
1413
return value.__get__(self)
560
1415
# No such property
561
raise DBusPropertyNotFound(self.dbus_object_path + u":"
562
+ interface_name + u"."
565
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
1416
raise DBusPropertyNotFound("{}:{}.{}".format(
1417
self.dbus_object_path, interface_name, property_name))
1420
def _get_all_interface_names(cls):
1421
"""Get a sequence of all interfaces supported by an object"""
1422
return (name for name in set(getattr(getattr(x, attr),
1423
"_dbus_interface", None)
1424
for x in (inspect.getmro(cls))
1426
if name is not None)
1428
@dbus.service.method(dbus.PROPERTIES_IFACE,
567
1431
def Get(self, interface_name, property_name):
568
1432
"""Standard D-Bus property Get() method, see D-Bus standard.
570
1434
prop = self._get_dbus_property(interface_name, property_name)
571
if prop._dbus_access == u"write":
1435
if prop._dbus_access == "write":
572
1436
raise DBusPropertyAccessException(property_name)
574
if not hasattr(value, u"variant_level"):
1438
if not hasattr(value, "variant_level"):
576
1440
return type(value)(value, variant_level=value.variant_level+1)
578
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1442
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
579
1443
def Set(self, interface_name, property_name, value):
580
1444
"""Standard D-Bus property Set() method, see D-Bus standard.
582
1446
prop = self._get_dbus_property(interface_name, property_name)
583
if prop._dbus_access == u"read":
1447
if prop._dbus_access == "read":
584
1448
raise DBusPropertyAccessException(property_name)
585
if prop._dbus_get_args_options[u"byte_arrays"]:
586
value = dbus.ByteArray(''.join(unichr(byte)
1449
if prop._dbus_get_args_options["byte_arrays"]:
1450
# The byte_arrays option is not supported yet on
1451
# signatures other than "ay".
1452
if prop._dbus_signature != "ay":
1453
raise ValueError("Byte arrays not supported for non-"
1454
"'ay' signature {!r}"
1455
.format(prop._dbus_signature))
1456
value = dbus.ByteArray(bytes(value))
590
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
591
out_signature=u"a{sv}")
1459
@dbus.service.method(dbus.PROPERTIES_IFACE,
1461
out_signature="a{sv}")
592
1462
def GetAll(self, interface_name):
593
1463
"""Standard D-Bus property GetAll() method, see D-Bus
596
1466
Note: Will not include properties with access="write".
599
for name, prop in self._get_all_dbus_properties():
1469
for name, prop in self._get_all_dbus_things("property"):
600
1470
if (interface_name
601
1471
and interface_name != prop._dbus_interface):
602
1472
# Interface non-empty but did not match
604
1474
# Ignore write-only properties
605
if prop._dbus_access == u"write":
1475
if prop._dbus_access == "write":
608
if not hasattr(value, u"variant_level"):
1478
if not hasattr(value, "variant_level"):
1479
properties[name] = value
611
all[name] = type(value)(value, variant_level=
612
value.variant_level+1)
613
return dbus.Dictionary(all, signature=u"sv")
615
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
617
path_keyword='object_path',
618
connection_keyword='connection')
619
def Introspect(self, object_path, connection):
620
"""Standard D-Bus method, overloaded to insert property tags.
622
xmlstring = dbus.service.Object.Introspect(self, object_path,
624
document = xml.dom.minidom.parseString(xmlstring)
626
def make_tag(document, name, prop):
627
e = document.createElement(u"property")
628
e.setAttribute(u"name", name)
629
e.setAttribute(u"type", prop._dbus_signature)
630
e.setAttribute(u"access", prop._dbus_access)
632
for if_tag in document.getElementsByTagName(u"interface"):
633
for tag in (make_tag(document, name, prop)
635
in self._get_all_dbus_properties()
636
if prop._dbus_interface
637
== if_tag.getAttribute(u"name")):
638
if_tag.appendChild(tag)
639
xmlstring = document.toxml(u"utf-8")
1481
properties[name] = type(value)(
1482
value, variant_level=value.variant_level + 1)
1483
return dbus.Dictionary(properties, signature="sv")
1485
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1486
def PropertiesChanged(self, interface_name, changed_properties,
1487
invalidated_properties):
1488
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1493
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1495
path_keyword="object_path",
1496
connection_keyword="connection")
1497
def Introspect(self, object_path, connection):
1498
"""Overloading of standard D-Bus method.
1500
Inserts property tags and interface annotation tags.
1502
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1506
document = xml.dom.minidom.parseString(xmlstring)
1508
def make_tag(document, name, prop):
1509
e = document.createElement("property")
1510
e.setAttribute("name", name)
1511
e.setAttribute("type", prop._dbus_signature)
1512
e.setAttribute("access", prop._dbus_access)
1515
for if_tag in document.getElementsByTagName("interface"):
1517
for tag in (make_tag(document, name, prop)
1519
in self._get_all_dbus_things("property")
1520
if prop._dbus_interface
1521
== if_tag.getAttribute("name")):
1522
if_tag.appendChild(tag)
1523
# Add annotation tags for properties
1524
for tag in if_tag.getElementsByTagName("property"):
1526
for name, prop in self._get_all_dbus_things(
1528
if (name == tag.getAttribute("name")
1529
and prop._dbus_interface
1530
== if_tag.getAttribute("name")):
1531
annots.update(getattr(
1532
prop, "_dbus_annotations", {}))
1533
for name, value in annots.items():
1534
ann_tag = document.createElement(
1536
ann_tag.setAttribute("name", name)
1537
ann_tag.setAttribute("value", value)
1538
tag.appendChild(ann_tag)
1539
# Add the names to the return values for the
1540
# "org.freedesktop.DBus.Properties" methods
1541
if (if_tag.getAttribute("name")
1542
== "org.freedesktop.DBus.Properties"):
1543
for cn in if_tag.getElementsByTagName("method"):
1544
if cn.getAttribute("name") == "Get":
1545
for arg in cn.getElementsByTagName("arg"):
1546
if (arg.getAttribute("direction")
1548
arg.setAttribute("name", "value")
1549
elif cn.getAttribute("name") == "GetAll":
1550
for arg in cn.getElementsByTagName("arg"):
1551
if (arg.getAttribute("direction")
1553
arg.setAttribute("name", "props")
1554
xmlstring = document.toxml("utf-8")
1556
except (AttributeError, xml.dom.DOMException,
1557
xml.parsers.expat.ExpatError) as error:
1558
log.error("Failed to override Introspection method",
1564
dbus.OBJECT_MANAGER_IFACE
1565
except AttributeError:
1566
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1569
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1570
"""A D-Bus object with an ObjectManager.
1572
Classes inheriting from this exposes the standard
1573
GetManagedObjects call and the InterfacesAdded and
1574
InterfacesRemoved signals on the standard
1575
"org.freedesktop.DBus.ObjectManager" interface.
1577
Note: No signals are sent automatically; they must be sent
1580
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1581
out_signature="a{oa{sa{sv}}}")
1582
def GetManagedObjects(self):
1583
"""This function must be overridden"""
1584
raise NotImplementedError()
1586
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1587
signature="oa{sa{sv}}")
1588
def InterfacesAdded(self, object_path, interfaces_and_properties):
1591
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1592
def InterfacesRemoved(self, object_path, interfaces):
1595
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1597
path_keyword="object_path",
1598
connection_keyword="connection")
1599
def Introspect(self, object_path, connection):
1600
"""Overloading of standard D-Bus method.
1602
Override return argument name of GetManagedObjects to be
1603
"objpath_interfaces_and_properties"
1605
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1609
document = xml.dom.minidom.parseString(xmlstring)
1611
for if_tag in document.getElementsByTagName("interface"):
1612
# Fix argument name for the GetManagedObjects method
1613
if (if_tag.getAttribute("name")
1614
== dbus.OBJECT_MANAGER_IFACE):
1615
for cn in if_tag.getElementsByTagName("method"):
1616
if (cn.getAttribute("name")
1617
== "GetManagedObjects"):
1618
for arg in cn.getElementsByTagName("arg"):
1619
if (arg.getAttribute("direction")
1623
"objpath_interfaces"
1625
xmlstring = document.toxml("utf-8")
1627
except (AttributeError, xml.dom.DOMException,
1628
xml.parsers.expat.ExpatError) as error:
1629
log.error("Failed to override Introspection method",
1634
def datetime_to_dbus(dt, variant_level=0):
1635
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1637
return dbus.String("", variant_level=variant_level)
1638
return dbus.String(dt.isoformat(), variant_level=variant_level)
1641
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1642
"""A class decorator; applied to a subclass of
1643
dbus.service.Object, it will add alternate D-Bus attributes with
1644
interface names according to the "alt_interface_names" mapping.
1647
@alternate_dbus_interfaces({"org.example.Interface":
1648
"net.example.AlternateInterface"})
1649
class SampleDBusObject(dbus.service.Object):
1650
@dbus.service.method("org.example.Interface")
1651
def SampleDBusMethod():
1654
The above "SampleDBusMethod" on "SampleDBusObject" will be
1655
reachable via two interfaces: "org.example.Interface" and
1656
"net.example.AlternateInterface", the latter of which will have
1657
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1658
"true", unless "deprecate" is passed with a False value.
1660
This works for methods and signals, and also for D-Bus properties
1661
(from DBusObjectWithProperties) and interfaces (from the
1662
dbus_interface_annotations decorator).
1666
for orig_interface_name, alt_interface_name in (
1667
alt_interface_names.items()):
1669
interface_names = set()
1670
# Go though all attributes of the class
1671
for attrname, attribute in inspect.getmembers(cls):
1672
# Ignore non-D-Bus attributes, and D-Bus attributes
1673
# with the wrong interface name
1674
if (not hasattr(attribute, "_dbus_interface")
1675
or not attribute._dbus_interface.startswith(
1676
orig_interface_name)):
1678
# Create an alternate D-Bus interface name based on
1680
alt_interface = attribute._dbus_interface.replace(
1681
orig_interface_name, alt_interface_name)
1682
interface_names.add(alt_interface)
1683
# Is this a D-Bus signal?
1684
if getattr(attribute, "_dbus_is_signal", False):
1685
# Extract the original non-method undecorated
1686
# function by black magic
1687
if sys.version_info.major == 2:
1688
nonmethod_func = (dict(
1689
zip(attribute.func_code.co_freevars,
1690
attribute.__closure__))
1691
["func"].cell_contents)
1693
nonmethod_func = (dict(
1694
zip(attribute.__code__.co_freevars,
1695
attribute.__closure__))
1696
["func"].cell_contents)
1697
# Create a new, but exactly alike, function
1698
# object, and decorate it to be a new D-Bus signal
1699
# with the alternate D-Bus interface name
1700
new_function = copy_function(nonmethod_func)
1701
new_function = (dbus.service.signal(
1703
attribute._dbus_signature)(new_function))
1704
# Copy annotations, if any
1706
new_function._dbus_annotations = dict(
1707
attribute._dbus_annotations)
1708
except AttributeError:
1711
# Define a creator of a function to call both the
1712
# original and alternate functions, so both the
1713
# original and alternate signals gets sent when
1714
# the function is called
1715
def fixscope(func1, func2):
1716
"""This function is a scope container to pass
1717
func1 and func2 to the "call_both" function
1718
outside of its arguments"""
1720
@functools.wraps(func2)
1721
def call_both(*args, **kwargs):
1722
"""This function will emit two D-Bus
1723
signals by calling func1 and func2"""
1724
func1(*args, **kwargs)
1725
func2(*args, **kwargs)
1726
# Make wrapper function look like a D-Bus
1728
for name, attr in inspect.getmembers(func2):
1729
if name.startswith("_dbus_"):
1730
setattr(call_both, name, attr)
1733
# Create the "call_both" function and add it to
1735
attr[attrname] = fixscope(attribute, new_function)
1736
# Is this a D-Bus method?
1737
elif getattr(attribute, "_dbus_is_method", False):
1738
# Create a new, but exactly alike, function
1739
# object. Decorate it to be a new D-Bus method
1740
# with the alternate D-Bus interface name. Add it
1743
dbus.service.method(
1745
attribute._dbus_in_signature,
1746
attribute._dbus_out_signature)
1747
(copy_function(attribute)))
1748
# Copy annotations, if any
1750
attr[attrname]._dbus_annotations = dict(
1751
attribute._dbus_annotations)
1752
except AttributeError:
1754
# Is this a D-Bus property?
1755
elif getattr(attribute, "_dbus_is_property", False):
1756
# Create a new, but exactly alike, function
1757
# object, and decorate it to be a new D-Bus
1758
# property with the alternate D-Bus interface
1759
# name. Add it to the class.
1760
attr[attrname] = (dbus_service_property(
1761
alt_interface, attribute._dbus_signature,
1762
attribute._dbus_access,
1763
attribute._dbus_get_args_options
1765
(copy_function(attribute)))
1766
# Copy annotations, if any
1768
attr[attrname]._dbus_annotations = dict(
1769
attribute._dbus_annotations)
1770
except AttributeError:
1772
# Is this a D-Bus interface?
1773
elif getattr(attribute, "_dbus_is_interface", False):
1774
# Create a new, but exactly alike, function
1775
# object. Decorate it to be a new D-Bus interface
1776
# with the alternate D-Bus interface name. Add it
1779
dbus_interface_annotations(alt_interface)
1780
(copy_function(attribute)))
1782
# Deprecate all alternate interfaces
1783
iname = "_AlternateDBusNames_interface_annotation{}"
1784
for interface_name in interface_names:
1786
@dbus_interface_annotations(interface_name)
1788
return {"org.freedesktop.DBus.Deprecated":
1790
# Find an unused name
1791
for aname in (iname.format(i)
1792
for i in itertools.count()):
1793
if aname not in attr:
1797
# Replace the class with a new subclass of it with
1798
# methods, signals, etc. as created above.
1799
if sys.version_info.major == 2:
1800
cls = type(b"{}Alternate".format(cls.__name__),
1803
cls = type("{}Alternate".format(cls.__name__),
1810
@alternate_dbus_interfaces({"se.recompile.Mandos":
1811
"se.bsnet.fukt.Mandos"})
644
1812
class ClientDBus(Client, DBusObjectWithProperties):
645
1813
"""A Client class using D-Bus
648
1816
dbus_object_path: dbus.ObjectPath
649
1817
bus: dbus.SystemBus()
1820
runtime_expansions = (Client.runtime_expansions
1821
+ ("dbus_object_path", ))
1823
_interface = "se.recompile.Mandos.Client"
651
1825
# dbus.service.Object doesn't use super(), so we can't either.
653
def __init__(self, bus = None, *args, **kwargs):
1827
def __init__(self, bus=None, *args, **kwargs):
655
1829
Client.__init__(self, *args, **kwargs)
656
1830
# Only now, when this client is initialized, can it show up on
658
self.dbus_object_path = (dbus.ObjectPath
660
+ self.name.replace(u".", u"_")))
1832
client_object_name = str(self.name).translate(
1833
{ord("."): ord("_"),
1834
ord("-"): ord("_")})
1835
self.dbus_object_path = dbus.ObjectPath(
1836
"/clients/" + client_object_name)
661
1837
DBusObjectWithProperties.__init__(self, self.bus,
662
1838
self.dbus_object_path)
665
def _datetime_to_dbus(dt, variant_level=0):
666
"""Convert a UTC datetime.datetime() to a D-Bus type."""
667
return dbus.String(dt.isoformat(),
668
variant_level=variant_level)
671
oldstate = getattr(self, u"enabled", False)
672
r = Client.enable(self)
673
if oldstate != self.enabled:
675
self.PropertyChanged(dbus.String(u"enabled"),
676
dbus.Boolean(True, variant_level=1))
677
self.PropertyChanged(
678
dbus.String(u"last_enabled"),
679
self._datetime_to_dbus(self.last_enabled,
683
def disable(self, signal = True):
684
oldstate = getattr(self, u"enabled", False)
685
r = Client.disable(self)
686
if signal and oldstate != self.enabled:
688
self.PropertyChanged(dbus.String(u"enabled"),
689
dbus.Boolean(False, variant_level=1))
1840
def notifychangeproperty(transform_func, dbus_name,
1841
type_func=lambda x: x,
1843
invalidate_only=False,
1844
_interface=_interface):
1845
""" Modify a variable so that it's a property which announces
1846
its changes to DBus.
1848
transform_fun: Function that takes a value and a variant_level
1849
and transforms it to a D-Bus type.
1850
dbus_name: D-Bus name of the variable
1851
type_func: Function that transform the value before sending it
1852
to the D-Bus. Default: no transform
1853
variant_level: D-Bus variant level. Default: 1
1855
attrname = "_{}".format(dbus_name)
1857
def setter(self, value):
1858
if hasattr(self, "dbus_object_path"):
1859
if (not hasattr(self, attrname) or
1860
type_func(getattr(self, attrname, None))
1861
!= type_func(value)):
1863
self.PropertiesChanged(
1864
_interface, dbus.Dictionary(),
1865
dbus.Array((dbus_name, )))
1867
dbus_value = transform_func(
1869
variant_level=variant_level)
1870
self.PropertyChanged(dbus.String(dbus_name),
1872
self.PropertiesChanged(
1874
dbus.Dictionary({dbus.String(dbus_name):
1877
setattr(self, attrname, value)
1879
return property(lambda self: getattr(self, attrname), setter)
1881
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1882
approvals_pending = notifychangeproperty(dbus.Boolean,
1885
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1886
last_enabled = notifychangeproperty(datetime_to_dbus,
1888
checker = notifychangeproperty(
1889
dbus.Boolean, "CheckerRunning",
1890
type_func=lambda checker: checker is not None)
1891
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1893
last_checker_status = notifychangeproperty(dbus.Int16,
1894
"LastCheckerStatus")
1895
last_approval_request = notifychangeproperty(
1896
datetime_to_dbus, "LastApprovalRequest")
1897
approved_by_default = notifychangeproperty(dbus.Boolean,
1898
"ApprovedByDefault")
1899
approval_delay = notifychangeproperty(
1900
dbus.UInt64, "ApprovalDelay",
1901
type_func=lambda td: td.total_seconds() * 1000)
1902
approval_duration = notifychangeproperty(
1903
dbus.UInt64, "ApprovalDuration",
1904
type_func=lambda td: td.total_seconds() * 1000)
1905
host = notifychangeproperty(dbus.String, "Host")
1906
timeout = notifychangeproperty(
1907
dbus.UInt64, "Timeout",
1908
type_func=lambda td: td.total_seconds() * 1000)
1909
extended_timeout = notifychangeproperty(
1910
dbus.UInt64, "ExtendedTimeout",
1911
type_func=lambda td: td.total_seconds() * 1000)
1912
interval = notifychangeproperty(
1913
dbus.UInt64, "Interval",
1914
type_func=lambda td: td.total_seconds() * 1000)
1915
checker_command = notifychangeproperty(dbus.String, "Checker")
1916
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1917
invalidate_only=True)
1919
del notifychangeproperty
692
1921
def __del__(self, *args, **kwargs):
694
1923
self.remove_from_connection()
695
1924
except LookupError:
697
if hasattr(DBusObjectWithProperties, u"__del__"):
1926
if hasattr(DBusObjectWithProperties, "__del__"):
698
1927
DBusObjectWithProperties.__del__(self, *args, **kwargs)
699
1928
Client.__del__(self, *args, **kwargs)
701
def checker_callback(self, pid, condition, command,
703
self.checker_callback_tag = None
706
self.PropertyChanged(dbus.String(u"checker_running"),
707
dbus.Boolean(False, variant_level=1))
708
if os.WIFEXITED(condition):
709
exitstatus = os.WEXITSTATUS(condition)
1930
def checker_callback(self, source, condition,
1931
connection, command, *args, **kwargs):
1932
ret = Client.checker_callback(self, source, condition,
1933
connection, command, *args,
1935
exitstatus = self.last_checker_status
710
1937
# Emit D-Bus signal
711
1938
self.CheckerCompleted(dbus.Int16(exitstatus),
712
dbus.Int64(condition),
1939
# This is specific to GNU libC
1940
dbus.Int64(exitstatus << 8),
713
1941
dbus.String(command))
715
1943
# Emit D-Bus signal
716
1944
self.CheckerCompleted(dbus.Int16(-1),
717
dbus.Int64(condition),
1946
# This is specific to GNU libC
1948
| self.last_checker_signal),
718
1949
dbus.String(command))
720
return Client.checker_callback(self, pid, condition, command,
723
def checked_ok(self, *args, **kwargs):
724
r = Client.checked_ok(self, *args, **kwargs)
726
self.PropertyChanged(
727
dbus.String(u"last_checked_ok"),
728
(self._datetime_to_dbus(self.last_checked_ok,
732
1952
def start_checker(self, *args, **kwargs):
733
old_checker = self.checker
734
if self.checker is not None:
735
old_checker_pid = self.checker.pid
737
old_checker_pid = None
1953
old_checker_pid = getattr(self.checker, "pid", None)
738
1954
r = Client.start_checker(self, *args, **kwargs)
739
1955
# Only if new checker process was started
740
1956
if (self.checker is not None
741
1957
and old_checker_pid != self.checker.pid):
742
1958
# Emit D-Bus signal
743
1959
self.CheckerStarted(self.current_checker_command)
744
self.PropertyChanged(
745
dbus.String(u"checker_running"),
746
dbus.Boolean(True, variant_level=1))
749
def stop_checker(self, *args, **kwargs):
750
old_checker = getattr(self, u"checker", None)
751
r = Client.stop_checker(self, *args, **kwargs)
752
if (old_checker is not None
753
and getattr(self, u"checker", None) is None):
754
self.PropertyChanged(dbus.String(u"checker_running"),
755
dbus.Boolean(False, variant_level=1))
758
## D-Bus methods & signals
759
_interface = u"se.bsnet.fukt.Mandos.Client"
1962
def _reset_approved(self):
1963
self.approved = None
1966
def approve(self, value=True):
1967
self.approved = value
1968
GLib.timeout_add(int(self.approval_duration.total_seconds()
1969
* 1000), self._reset_approved)
1970
self.send_changedstate()
1972
# D-Bus methods, signals & properties
761
1978
# CheckerCompleted - signal
762
@dbus.service.signal(_interface, signature=u"nxs")
1979
@dbus.service.signal(_interface, signature="nxs")
763
1980
def CheckerCompleted(self, exitcode, waitstatus, command):
767
1984
# CheckerStarted - signal
768
@dbus.service.signal(_interface, signature=u"s")
1985
@dbus.service.signal(_interface, signature="s")
769
1986
def CheckerStarted(self, command):
773
1990
# PropertyChanged - signal
774
@dbus.service.signal(_interface, signature=u"sv")
1991
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1992
@dbus.service.signal(_interface, signature="sv")
775
1993
def PropertyChanged(self, property, value):
779
# ReceivedSecret - signal
1997
# GotSecret - signal
780
1998
@dbus.service.signal(_interface)
781
def ReceivedSecret(self):
1999
def GotSecret(self):
2001
Is sent after a successful transfer of secret from the Mandos
2002
server to mandos-client
785
2006
# Rejected - signal
786
@dbus.service.signal(_interface)
2007
@dbus.service.signal(_interface, signature="s")
2008
def Rejected(self, reason):
792
@dbus_service_property(_interface, signature=u"s", access=u"read")
793
def name_dbus_property(self):
2012
# NeedApproval - signal
2013
@dbus.service.signal(_interface, signature="tb")
2014
def NeedApproval(self, timeout, default):
2016
return self.need_approval()
2021
@dbus.service.method(_interface, in_signature="b")
2022
def Approve(self, value):
2025
# CheckedOK - method
2026
@dbus.service.method(_interface)
2027
def CheckedOK(self):
2031
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2032
@dbus.service.method(_interface)
2037
# StartChecker - method
2038
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2039
@dbus.service.method(_interface)
2040
def StartChecker(self):
2042
self.start_checker()
2045
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2046
@dbus.service.method(_interface)
2051
# StopChecker - method
2052
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2053
@dbus.service.method(_interface)
2054
def StopChecker(self):
2059
# ApprovalPending - property
2060
@dbus_service_property(_interface, signature="b", access="read")
2061
def ApprovalPending_dbus_property(self):
2062
return dbus.Boolean(bool(self.approvals_pending))
2064
# ApprovedByDefault - property
2065
@dbus_service_property(_interface,
2068
def ApprovedByDefault_dbus_property(self, value=None):
2069
if value is None: # get
2070
return dbus.Boolean(self.approved_by_default)
2071
self.approved_by_default = bool(value)
2073
# ApprovalDelay - property
2074
@dbus_service_property(_interface,
2077
def ApprovalDelay_dbus_property(self, value=None):
2078
if value is None: # get
2079
return dbus.UInt64(self.approval_delay.total_seconds()
2081
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2083
# ApprovalDuration - property
2084
@dbus_service_property(_interface,
2087
def ApprovalDuration_dbus_property(self, value=None):
2088
if value is None: # get
2089
return dbus.UInt64(self.approval_duration.total_seconds()
2091
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2095
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2096
@dbus_service_property(_interface, signature="s", access="read")
2097
def Name_dbus_property(self):
794
2098
return dbus.String(self.name)
796
# fingerprint - property
797
@dbus_service_property(_interface, signature=u"s", access=u"read")
798
def fingerprint_dbus_property(self):
2102
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2103
@dbus_service_property(_interface, signature="s", access="read")
2104
def KeyID_dbus_property(self):
2105
return dbus.String(self.key_id)
2107
# Fingerprint - property
2109
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2110
@dbus_service_property(_interface, signature="s", access="read")
2111
def Fingerprint_dbus_property(self):
799
2112
return dbus.String(self.fingerprint)
802
@dbus_service_property(_interface, signature=u"s",
804
def host_dbus_property(self, value=None):
2115
@dbus_service_property(_interface,
2118
def Host_dbus_property(self, value=None):
805
2119
if value is None: # get
806
2120
return dbus.String(self.host)
809
self.PropertyChanged(dbus.String(u"host"),
810
dbus.String(value, variant_level=1))
813
@dbus_service_property(_interface, signature=u"s", access=u"read")
814
def created_dbus_property(self):
815
return dbus.String(self._datetime_to_dbus(self.created))
817
# last_enabled - property
818
@dbus_service_property(_interface, signature=u"s", access=u"read")
819
def last_enabled_dbus_property(self):
820
if self.last_enabled is None:
821
return dbus.String(u"")
822
return dbus.String(self._datetime_to_dbus(self.last_enabled))
825
@dbus_service_property(_interface, signature=u"b",
827
def enabled_dbus_property(self, value=None):
2121
self.host = str(value)
2123
# Created - property
2125
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2126
@dbus_service_property(_interface, signature="s", access="read")
2127
def Created_dbus_property(self):
2128
return datetime_to_dbus(self.created)
2130
# LastEnabled - property
2131
@dbus_service_property(_interface, signature="s", access="read")
2132
def LastEnabled_dbus_property(self):
2133
return datetime_to_dbus(self.last_enabled)
2135
# Enabled - property
2136
@dbus_service_property(_interface,
2139
def Enabled_dbus_property(self, value=None):
828
2140
if value is None: # get
829
2141
return dbus.Boolean(self.enabled)
835
# last_checked_ok - property
836
@dbus_service_property(_interface, signature=u"s", access=u"read")
837
def last_checked_ok_dbus_property(self):
838
if self.last_checked_ok is None:
839
return dbus.String(u"")
840
return dbus.String(self._datetime_to_dbus(self
844
@dbus_service_property(_interface, signature=u"t",
846
def timeout_dbus_property(self, value=None):
2147
# LastCheckedOK - property
2148
@dbus_service_property(_interface,
2151
def LastCheckedOK_dbus_property(self, value=None):
2152
if value is not None:
2155
return datetime_to_dbus(self.last_checked_ok)
2157
# LastCheckerStatus - property
2158
@dbus_service_property(_interface, signature="n", access="read")
2159
def LastCheckerStatus_dbus_property(self):
2160
return dbus.Int16(self.last_checker_status)
2162
# Expires - property
2163
@dbus_service_property(_interface, signature="s", access="read")
2164
def Expires_dbus_property(self):
2165
return datetime_to_dbus(self.expires)
2167
# LastApprovalRequest - property
2168
@dbus_service_property(_interface, signature="s", access="read")
2169
def LastApprovalRequest_dbus_property(self):
2170
return datetime_to_dbus(self.last_approval_request)
2172
# Timeout - property
2173
@dbus_service_property(_interface,
2176
def Timeout_dbus_property(self, value=None):
847
2177
if value is None: # get
848
return dbus.UInt64(self.timeout_milliseconds())
2178
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2179
old_timeout = self.timeout
849
2180
self.timeout = datetime.timedelta(0, 0, 0, value)
851
self.PropertyChanged(dbus.String(u"timeout"),
852
dbus.UInt64(value, variant_level=1))
853
if getattr(self, u"disable_initiator_tag", None) is None:
856
gobject.source_remove(self.disable_initiator_tag)
857
self.disable_initiator_tag = None
859
_timedelta_to_milliseconds((self
865
# The timeout has passed
868
self.disable_initiator_tag = (gobject.timeout_add
869
(time_to_die, self.disable))
871
# interval - property
872
@dbus_service_property(_interface, signature=u"t",
874
def interval_dbus_property(self, value=None):
875
if value is None: # get
876
return dbus.UInt64(self.interval_milliseconds())
2181
# Reschedule disabling
2183
now = datetime.datetime.utcnow()
2184
self.expires += self.timeout - old_timeout
2185
if self.expires <= now:
2186
# The timeout has passed
2189
if (getattr(self, "disable_initiator_tag", None)
2192
GLib.source_remove(self.disable_initiator_tag)
2193
self.disable_initiator_tag = GLib.timeout_add(
2194
int((self.expires - now).total_seconds() * 1000),
2197
# ExtendedTimeout - property
2198
@dbus_service_property(_interface,
2201
def ExtendedTimeout_dbus_property(self, value=None):
2202
if value is None: # get
2203
return dbus.UInt64(self.extended_timeout.total_seconds()
2205
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2207
# Interval - property
2208
@dbus_service_property(_interface,
2211
def Interval_dbus_property(self, value=None):
2212
if value is None: # get
2213
return dbus.UInt64(self.interval.total_seconds() * 1000)
877
2214
self.interval = datetime.timedelta(0, 0, 0, value)
879
self.PropertyChanged(dbus.String(u"interval"),
880
dbus.UInt64(value, variant_level=1))
881
if getattr(self, u"checker_initiator_tag", None) is None:
2215
if getattr(self, "checker_initiator_tag", None) is None:
883
# Reschedule checker run
884
gobject.source_remove(self.checker_initiator_tag)
885
self.checker_initiator_tag = (gobject.timeout_add
886
(value, self.start_checker))
887
self.start_checker() # Start one now, too
2218
# Reschedule checker run
2219
GLib.source_remove(self.checker_initiator_tag)
2220
self.checker_initiator_tag = GLib.timeout_add(
2221
value, self.start_checker)
2222
self.start_checker() # Start one now, too
890
@dbus_service_property(_interface, signature=u"s",
892
def checker_dbus_property(self, value=None):
2224
# Checker - property
2225
@dbus_service_property(_interface,
2228
def Checker_dbus_property(self, value=None):
893
2229
if value is None: # get
894
2230
return dbus.String(self.checker_command)
895
self.checker_command = value
897
self.PropertyChanged(dbus.String(u"checker"),
898
dbus.String(self.checker_command,
901
# checker_running - property
902
@dbus_service_property(_interface, signature=u"b",
904
def checker_running_dbus_property(self, value=None):
2231
self.checker_command = str(value)
2233
# CheckerRunning - property
2234
@dbus_service_property(_interface,
2237
def CheckerRunning_dbus_property(self, value=None):
905
2238
if value is None: # get
906
2239
return dbus.Boolean(self.checker is not None)
908
2241
self.start_checker()
910
2243
self.stop_checker()
912
# object_path - property
913
@dbus_service_property(_interface, signature=u"o", access=u"read")
914
def object_path_dbus_property(self):
915
return self.dbus_object_path # is already a dbus.ObjectPath
917
# secret = property xxx
918
@dbus_service_property(_interface, signature=u"ay",
919
access=u"write", byte_arrays=True)
920
def secret_dbus_property(self, value):
921
self.secret = str(value)
2245
# ObjectPath - property
2247
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2248
"org.freedesktop.DBus.Deprecated": "true"})
2249
@dbus_service_property(_interface, signature="o", access="read")
2250
def ObjectPath_dbus_property(self):
2251
return self.dbus_object_path # is already a dbus.ObjectPath
2255
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2257
@dbus_service_property(_interface,
2261
def Secret_dbus_property(self, value):
2262
self.secret = bytes(value)
2268
def __init__(self, child_pipe, key_id, fpr, address):
2269
self._pipe = child_pipe
2270
self._pipe.send(("init", key_id, fpr, address))
2271
if not self._pipe.recv():
2272
raise KeyError(key_id or fpr)
2274
def __getattribute__(self, name):
2276
return super(ProxyClient, self).__getattribute__(name)
2277
self._pipe.send(("getattr", name))
2278
data = self._pipe.recv()
2279
if data[0] == "data":
2281
if data[0] == "function":
2283
def func(*args, **kwargs):
2284
self._pipe.send(("funcall", name, args, kwargs))
2285
return self._pipe.recv()[1]
2289
def __setattr__(self, name, value):
2291
return super(ProxyClient, self).__setattr__(name, value)
2292
self._pipe.send(("setattr", name, value))
926
2295
class ClientHandler(socketserver.BaseRequestHandler, object):
927
2296
"""A class to handle client connections.
929
2298
Instantiated once for each connection to handle it.
930
2299
Note: This will run in its own forked process."""
932
2301
def handle(self):
933
logger.info(u"TCP connection from: %s",
934
unicode(self.client_address))
935
logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
936
# Open IPC pipe to parent process
937
with closing(os.fdopen(self.server.pipe[1], u"w", 1)) as ipc:
938
session = (gnutls.connection
939
.ClientSession(self.request,
943
line = self.request.makefile().readline()
944
logger.debug(u"Protocol version: %r", line)
946
if int(line.strip().split()[0]) > 1:
948
except (ValueError, IndexError, RuntimeError), error:
949
logger.error(u"Unknown protocol version: %s", error)
952
# Note: gnutls.connection.X509Credentials is really a
953
# generic GnuTLS certificate credentials object so long as
954
# no X.509 keys are added to it. Therefore, we can use it
955
# here despite using OpenPGP certificates.
957
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
958
# u"+AES-256-CBC", u"+SHA1",
959
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
2302
with contextlib.closing(self.server.child_pipe) as child_pipe:
2303
log.info("TCP connection from: %s",
2304
str(self.client_address))
2305
log.debug("Pipe FD: %d", self.server.child_pipe.fileno())
2307
session = gnutls.ClientSession(self.request)
2309
# priority = ":".join(("NONE", "+VERS-TLS1.1",
2310
# "+AES-256-CBC", "+SHA1",
2311
# "+COMP-NULL", "+CTYPE-OPENPGP",
961
2313
# Use a fallback default, since this MUST be set.
962
2314
priority = self.server.gnutls_priority
963
2315
if priority is None:
965
(gnutls.library.functions
966
.gnutls_priority_set_direct(session._c_object,
2317
gnutls.priority_set_direct(session,
2318
priority.encode("utf-8"), None)
2320
# Start communication using the Mandos protocol
2321
# Get protocol number
2322
line = self.request.makefile().readline()
2323
log.debug("Protocol version: %r", line)
2325
if int(line.strip().split()[0]) > 1:
2326
raise RuntimeError(line)
2327
except (ValueError, IndexError, RuntimeError) as error:
2328
log.error("Unknown protocol version: %s", error)
2331
# Start GnuTLS connection
970
2333
session.handshake()
971
except gnutls.errors.GNUTLSError, error:
972
logger.warning(u"Handshake failed: %s", error)
2334
except gnutls.Error as error:
2335
log.warning("Handshake failed: %s", error)
973
2336
# Do not run session.bye() here: the session is not
974
2337
# established. Just abandon the request.
976
logger.debug(u"Handshake succeeded")
2339
log.debug("Handshake succeeded")
2341
approval_required = False
978
fpr = self.fingerprint(self.peer_certificate(session))
979
except (TypeError, gnutls.errors.GNUTLSError), error:
980
logger.warning(u"Bad certificate: %s", error)
983
logger.debug(u"Fingerprint: %s", fpr)
985
for c in self.server.clients:
986
if c.fingerprint == fpr:
990
ipc.write(u"NOTFOUND %s %s\n"
991
% (fpr, unicode(self.client_address)))
994
# Have to check if client.still_valid(), since it is
995
# possible that the client timed out while establishing
996
# the GnuTLS session.
997
if not client.still_valid():
998
ipc.write(u"INVALID %s\n" % client.name)
1001
ipc.write(u"SENDING %s\n" % client.name)
1003
while sent_size < len(client.secret):
1004
sent = session.send(client.secret[sent_size:])
1005
logger.debug(u"Sent: %d, remaining: %d",
1006
sent, len(client.secret)
1007
- (sent_size + sent))
2343
if gnutls.has_rawpk:
2346
key_id = self.key_id(
2347
self.peer_certificate(session))
2348
except (TypeError, gnutls.Error) as error:
2349
log.warning("Bad certificate: %s", error)
2351
log.debug("Key ID: %s",
2352
key_id.decode("utf-8",
2358
fpr = self.fingerprint(
2359
self.peer_certificate(session))
2360
except (TypeError, gnutls.Error) as error:
2361
log.warning("Bad certificate: %s", error)
2363
log.debug("Fingerprint: %s", fpr)
2366
client = ProxyClient(child_pipe, key_id, fpr,
2367
self.client_address)
2371
if client.approval_delay:
2372
delay = client.approval_delay
2373
client.approvals_pending += 1
2374
approval_required = True
2377
if not client.enabled:
2378
log.info("Client %s is disabled", client.name)
2379
if self.server.use_dbus:
2381
client.Rejected("Disabled")
2384
if client.approved or not client.approval_delay:
2385
# We are approved or approval is disabled
2387
elif client.approved is None:
2388
log.info("Client %s needs approval",
2390
if self.server.use_dbus:
2392
client.NeedApproval(
2393
client.approval_delay.total_seconds()
2394
* 1000, client.approved_by_default)
2396
log.warning("Client %s was not approved",
2398
if self.server.use_dbus:
2400
client.Rejected("Denied")
2403
# wait until timeout or approved
2404
time = datetime.datetime.now()
2405
client.changedstate.acquire()
2406
client.changedstate.wait(delay.total_seconds())
2407
client.changedstate.release()
2408
time2 = datetime.datetime.now()
2409
if (time2 - time) >= delay:
2410
if not client.approved_by_default:
2411
log.warning("Client %s timed out while"
2412
" waiting for approval",
2414
if self.server.use_dbus:
2416
client.Rejected("Approval timed out")
2421
delay -= time2 - time
2424
session.send(client.secret)
2425
except gnutls.Error as error:
2426
log.warning("gnutls send failed", exc_info=error)
2429
log.info("Sending secret to %s", client.name)
2430
# bump the timeout using extended_timeout
2431
client.bump_timeout(client.extended_timeout)
2432
if self.server.use_dbus:
2437
if approval_required:
2438
client.approvals_pending -= 1
2441
except gnutls.Error as error:
2442
log.warning("GnuTLS bye failed", exc_info=error)
1012
2445
def peer_certificate(session):
1013
"Return the peer's OpenPGP certificate as a bytestring"
1014
# If not an OpenPGP certificate...
1015
if (gnutls.library.functions
1016
.gnutls_certificate_type_get(session._c_object)
1017
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1018
# ...do the normal thing
1019
return session.peer_certificate
2446
"Return the peer's certificate as a bytestring"
2448
cert_type = gnutls.certificate_type_get2(
2449
session, gnutls.CTYPE_PEERS)
2450
except AttributeError:
2451
cert_type = gnutls.certificate_type_get(session)
2452
if gnutls.has_rawpk:
2453
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2455
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2456
# If not a valid certificate type...
2457
if cert_type not in valid_cert_types:
2458
log.info("Cert type %r not in %r", cert_type,
2460
# ...return invalid data
1020
2462
list_size = ctypes.c_uint(1)
1021
cert_list = (gnutls.library.functions
1022
.gnutls_certificate_get_peers
1023
(session._c_object, ctypes.byref(list_size)))
2463
cert_list = (gnutls.certificate_get_peers
2464
(session, ctypes.byref(list_size)))
1024
2465
if not bool(cert_list) and list_size.value != 0:
1025
raise gnutls.errors.GNUTLSError(u"error getting peer"
2466
raise gnutls.Error("error getting peer certificate")
1027
2467
if list_size.value == 0:
1029
2469
cert = cert_list[0]
1030
2470
return ctypes.string_at(cert.data, cert.size)
2473
def key_id(certificate):
2474
"Convert a certificate bytestring to a hexdigit key ID"
2475
# New GnuTLS "datum" with the public key
2476
datum = gnutls.datum_t(
2477
ctypes.cast(ctypes.c_char_p(certificate),
2478
ctypes.POINTER(ctypes.c_ubyte)),
2479
ctypes.c_uint(len(certificate)))
2480
# XXX all these need to be created in the gnutls "module"
2481
# New empty GnuTLS certificate
2482
pubkey = gnutls.pubkey_t()
2483
gnutls.pubkey_init(ctypes.byref(pubkey))
2484
# Import the raw public key into the certificate
2485
gnutls.pubkey_import(pubkey,
2486
ctypes.byref(datum),
2487
gnutls.X509_FMT_DER)
2488
# New buffer for the key ID
2489
buf = ctypes.create_string_buffer(32)
2490
buf_len = ctypes.c_size_t(len(buf))
2491
# Get the key ID from the raw public key into the buffer
2492
gnutls.pubkey_get_key_id(
2494
gnutls.KEYID_USE_SHA256,
2495
ctypes.cast(ctypes.byref(buf),
2496
ctypes.POINTER(ctypes.c_ubyte)),
2497
ctypes.byref(buf_len))
2498
# Deinit the certificate
2499
gnutls.pubkey_deinit(pubkey)
2501
# Convert the buffer to a Python bytestring
2502
key_id = ctypes.string_at(buf, buf_len.value)
2503
# Convert the bytestring to hexadecimal notation
2504
hex_key_id = binascii.hexlify(key_id).upper()
1033
2508
def fingerprint(openpgp):
1034
2509
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1035
2510
# New GnuTLS "datum" with the OpenPGP public key
1036
datum = (gnutls.library.types
1037
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1040
ctypes.c_uint(len(openpgp))))
2511
datum = gnutls.datum_t(
2512
ctypes.cast(ctypes.c_char_p(openpgp),
2513
ctypes.POINTER(ctypes.c_ubyte)),
2514
ctypes.c_uint(len(openpgp)))
1041
2515
# New empty GnuTLS certificate
1042
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1043
(gnutls.library.functions
1044
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2516
crt = gnutls.openpgp_crt_t()
2517
gnutls.openpgp_crt_init(ctypes.byref(crt))
1045
2518
# Import the OpenPGP public key into the certificate
1046
(gnutls.library.functions
1047
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1048
gnutls.library.constants
1049
.GNUTLS_OPENPGP_FMT_RAW))
2519
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2520
gnutls.OPENPGP_FMT_RAW)
1050
2521
# Verify the self signature in the key
1051
2522
crtverify = ctypes.c_uint()
1052
(gnutls.library.functions
1053
.gnutls_openpgp_crt_verify_self(crt, 0,
1054
ctypes.byref(crtverify)))
2523
gnutls.openpgp_crt_verify_self(crt, 0,
2524
ctypes.byref(crtverify))
1055
2525
if crtverify.value != 0:
1056
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1057
raise (gnutls.errors.CertificateSecurityError
2526
gnutls.openpgp_crt_deinit(crt)
2527
raise gnutls.CertificateSecurityError(code
1059
2529
# New buffer for the fingerprint
1060
2530
buf = ctypes.create_string_buffer(20)
1061
2531
buf_len = ctypes.c_size_t()
1062
2532
# Get the fingerprint from the certificate into the buffer
1063
(gnutls.library.functions
1064
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1065
ctypes.byref(buf_len)))
2533
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2534
ctypes.byref(buf_len))
1066
2535
# Deinit the certificate
1067
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2536
gnutls.openpgp_crt_deinit(crt)
1068
2537
# Convert the buffer to a Python bytestring
1069
2538
fpr = ctypes.string_at(buf, buf_len.value)
1070
2539
# Convert the bytestring to hexadecimal notation
1071
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2540
hex_fpr = binascii.hexlify(fpr).upper()
1075
class ForkingMixInWithPipe(socketserver.ForkingMixIn, object):
1076
"""Like socketserver.ForkingMixIn, but also pass a pipe."""
2544
class MultiprocessingMixIn:
2545
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2547
def sub_process_main(self, request, address):
2549
self.finish_request(request, address)
2551
self.handle_error(request, address)
2552
self.close_request(request)
2554
def process_request(self, request, address):
2555
"""Start a new process to process the request."""
2556
proc = multiprocessing.Process(target=self.sub_process_main,
2557
args=(request, address))
2562
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
2563
""" adds a pipe to the MixIn """
1077
2565
def process_request(self, request, client_address):
1078
2566
"""Overrides and wraps the original process_request().
1080
2568
This function creates a new pipe in self.pipe
1082
self.pipe = os.pipe()
1083
super(ForkingMixInWithPipe,
1084
self).process_request(request, client_address)
1085
os.close(self.pipe[1]) # close write end
1086
self.add_pipe(self.pipe[0])
1087
def add_pipe(self, pipe):
2570
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2572
proc = MultiprocessingMixIn.process_request(self, request,
2574
self.child_pipe.close()
2575
self.add_pipe(parent_pipe, proc)
2577
def add_pipe(self, parent_pipe, proc):
1088
2578
"""Dummy function; override as necessary"""
1092
class IPv6_TCPServer(ForkingMixInWithPipe,
1093
socketserver.TCPServer, object):
1094
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2579
raise NotImplementedError()
2582
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2583
socketserver.TCPServer):
2584
"""IPv6-capable TCP server. Accepts None as address and/or port
1097
2587
enabled: Boolean; whether this server is activated yet
1098
2588
interface: None or a network interface name (string)
1099
2589
use_ipv6: Boolean; to use IPv6 or not
1101
2592
def __init__(self, server_address, RequestHandlerClass,
1102
interface=None, use_ipv6=True):
2596
"""If socketfd is set, use that file descriptor instead of
2597
creating a new one with socket.socket().
1103
2599
self.interface = interface
1105
2601
self.address_family = socket.AF_INET6
2602
if socketfd is not None:
2603
# Save the file descriptor
2604
self.socketfd = socketfd
2605
# Save the original socket.socket() function
2606
self.socket_socket = socket.socket
2608
# To implement --socket, we monkey patch socket.socket.
2610
# (When socketserver.TCPServer is a new-style class, we
2611
# could make self.socket into a property instead of monkey
2612
# patching socket.socket.)
2614
# Create a one-time-only replacement for socket.socket()
2615
@functools.wraps(socket.socket)
2616
def socket_wrapper(*args, **kwargs):
2617
# Restore original function so subsequent calls are
2619
socket.socket = self.socket_socket
2620
del self.socket_socket
2621
# This time only, return a new socket object from the
2622
# saved file descriptor.
2623
return socket.fromfd(self.socketfd, *args, **kwargs)
2624
# Replace socket.socket() function with wrapper
2625
socket.socket = socket_wrapper
2626
# The socketserver.TCPServer.__init__ will call
2627
# socket.socket(), which might be our replacement,
2628
# socket_wrapper(), if socketfd was set.
1106
2629
socketserver.TCPServer.__init__(self, server_address,
1107
2630
RequestHandlerClass)
1108
2632
def server_bind(self):
1109
2633
"""This overrides the normal server_bind() function
1110
2634
to bind to an interface if one was specified, and also NOT to
1111
2635
bind to an address or port if they were not specified."""
2636
global SO_BINDTODEVICE
1112
2637
if self.interface is not None:
1113
2638
if SO_BINDTODEVICE is None:
1114
logger.error(u"SO_BINDTODEVICE does not exist;"
1115
u" cannot bind to interface %s",
1119
self.socket.setsockopt(socket.SOL_SOCKET,
1123
except socket.error, error:
1124
if error[0] == errno.EPERM:
1125
logger.error(u"No permission to"
1126
u" bind to interface %s",
1128
elif error[0] == errno.ENOPROTOOPT:
1129
logger.error(u"SO_BINDTODEVICE not available;"
1130
u" cannot bind to interface %s",
2639
# Fall back to a hard-coded value which seems to be
2641
log.warning("SO_BINDTODEVICE not found, trying 25")
2642
SO_BINDTODEVICE = 25
2644
self.socket.setsockopt(
2645
socket.SOL_SOCKET, SO_BINDTODEVICE,
2646
(self.interface + "\0").encode("utf-8"))
2647
except socket.error as error:
2648
if error.errno == errno.EPERM:
2649
log.error("No permission to bind to interface %s",
2651
elif error.errno == errno.ENOPROTOOPT:
2652
log.error("SO_BINDTODEVICE not available; cannot"
2653
" bind to interface %s", self.interface)
2654
elif error.errno == errno.ENODEV:
2655
log.error("Interface %s does not exist, cannot"
2656
" bind", self.interface)
1134
2659
# Only bind(2) the socket if we really need to.
1135
2660
if self.server_address[0] or self.server_address[1]:
2661
if self.server_address[1]:
2662
self.allow_reuse_address = True
1136
2663
if not self.server_address[0]:
1137
2664
if self.address_family == socket.AF_INET6:
1138
any_address = u"::" # in6addr_any
2665
any_address = "::" # in6addr_any
1140
any_address = socket.INADDR_ANY
2667
any_address = "0.0.0.0" # INADDR_ANY
1141
2668
self.server_address = (any_address,
1142
2669
self.server_address[1])
1143
2670
elif not self.server_address[1]:
1144
self.server_address = (self.server_address[0],
2671
self.server_address = (self.server_address[0], 0)
1146
2672
# if self.interface:
1147
2673
# self.server_address = (self.server_address[0],
1155
2681
class MandosServer(IPv6_TCPServer):
1156
2682
"""Mandos server.
1159
2685
clients: set of Client objects
1160
2686
gnutls_priority GnuTLS priority string
1161
2687
use_dbus: Boolean; to emit D-Bus signals or not
1163
Assumes a gobject.MainLoop event loop.
2689
Assumes a GLib.MainLoop event loop.
1165
2692
def __init__(self, server_address, RequestHandlerClass,
1166
interface=None, use_ipv6=True, clients=None,
1167
gnutls_priority=None, use_dbus=True):
2696
gnutls_priority=None,
1168
2699
self.enabled = False
1169
2700
self.clients = clients
1170
2701
if self.clients is None:
1171
self.clients = set()
1172
2703
self.use_dbus = use_dbus
1173
2704
self.gnutls_priority = gnutls_priority
1174
2705
IPv6_TCPServer.__init__(self, server_address,
1175
2706
RequestHandlerClass,
1176
interface = interface,
1177
use_ipv6 = use_ipv6)
2707
interface=interface,
1178
2711
def server_activate(self):
1179
2712
if self.enabled:
1180
2713
return socketserver.TCPServer.server_activate(self)
1181
2715
def enable(self):
1182
2716
self.enabled = True
1183
def add_pipe(self, pipe):
2718
def add_pipe(self, parent_pipe, proc):
1184
2719
# Call "handle_ipc" for both data and EOF events
1185
gobject.io_add_watch(pipe, gobject.IO_IN | gobject.IO_HUP,
1187
def handle_ipc(self, source, condition, file_objects={}):
1189
gobject.IO_IN: u"IN", # There is data to read.
1190
gobject.IO_OUT: u"OUT", # Data can be written (without
1192
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1193
gobject.IO_ERR: u"ERR", # Error condition.
1194
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1195
# broken, usually for pipes and
1198
conditions_string = ' | '.join(name
1200
condition_names.iteritems()
1201
if cond & condition)
1202
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1205
# Turn the pipe file descriptor into a Python file object
1206
if source not in file_objects:
1207
file_objects[source] = os.fdopen(source, u"r", 1)
1209
# Read a line from the file object
1210
cmdline = file_objects[source].readline()
1211
if not cmdline: # Empty line means end of file
1212
# close the IPC pipe
1213
file_objects[source].close()
1214
del file_objects[source]
1216
# Stop calling this function
1219
logger.debug(u"IPC command: %r", cmdline)
1221
# Parse and act on command
1222
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1224
if cmd == u"NOTFOUND":
1225
logger.warning(u"Client not found for fingerprint: %s",
1229
mandos_dbus_service.ClientNotFound(args)
1230
elif cmd == u"INVALID":
1231
for client in self.clients:
1232
if client.name == args:
1233
logger.warning(u"Client %s is invalid", args)
1239
logger.error(u"Unknown client %s is invalid", args)
1240
elif cmd == u"SENDING":
1241
for client in self.clients:
1242
if client.name == args:
1243
logger.info(u"Sending secret to %s", client.name)
1247
client.ReceivedSecret()
1250
logger.error(u"Sending secret to unknown client %s",
2721
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2722
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2723
functools.partial(self.handle_ipc,
2724
parent_pipe=parent_pipe,
2727
def handle_ipc(self, source, condition,
2730
client_object=None):
2731
# error, or the other end of multiprocessing.Pipe has closed
2732
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2733
# Wait for other process to exit
2737
# Read a request from the child
2738
request = parent_pipe.recv()
2739
command = request[0]
2741
if command == "init":
2742
key_id = request[1].decode("ascii")
2743
fpr = request[2].decode("ascii")
2744
address = request[3]
2746
for c in self.clients.values():
2747
if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2748
"27AE41E4649B934CA495991B7852B855"):
2750
if key_id and c.key_id == key_id:
2753
if fpr and c.fingerprint == fpr:
2757
log.info("Client not found for key ID: %s, address:"
2758
" %s", key_id or fpr, address)
2761
mandos_dbus_service.ClientNotFound(key_id or fpr,
2763
parent_pipe.send(False)
2767
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2768
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2769
functools.partial(self.handle_ipc,
2770
parent_pipe=parent_pipe,
2772
client_object=client))
2773
parent_pipe.send(True)
2774
# remove the old hook in favor of the new above hook on
2777
if command == "funcall":
2778
funcname = request[1]
2782
parent_pipe.send(("data", getattr(client_object,
2786
if command == "getattr":
2787
attrname = request[1]
2788
if isinstance(client_object.__getattribute__(attrname),
2789
collections.abc.Callable):
2790
parent_pipe.send(("function", ))
2793
"data", client_object.__getattribute__(attrname)))
2795
if command == "setattr":
2796
attrname = request[1]
2798
setattr(client_object, attrname, value)
2803
def rfc3339_duration_to_delta(duration):
2804
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2806
>>> timedelta = datetime.timedelta
2807
>>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2809
>>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2811
>>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2813
>>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2815
>>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2817
>>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2819
>>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2824
# Parsing an RFC 3339 duration with regular expressions is not
2825
# possible - there would have to be multiple places for the same
2826
# values, like seconds. The current code, while more esoteric, is
2827
# cleaner without depending on a parsing library. If Python had a
2828
# built-in library for parsing we would use it, but we'd like to
2829
# avoid excessive use of external libraries.
2831
# New type for defining tokens, syntax, and semantics all-in-one
2832
Token = collections.namedtuple("Token", (
2833
"regexp", # To match token; if "value" is not None, must have
2834
# a "group" containing digits
2835
"value", # datetime.timedelta or None
2836
"followers")) # Tokens valid after this token
2837
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2838
# the "duration" ABNF definition in RFC 3339, Appendix A.
2839
token_end = Token(re.compile(r"$"), None, frozenset())
2840
token_second = Token(re.compile(r"(\d+)S"),
2841
datetime.timedelta(seconds=1),
2842
frozenset((token_end, )))
2843
token_minute = Token(re.compile(r"(\d+)M"),
2844
datetime.timedelta(minutes=1),
2845
frozenset((token_second, token_end)))
2846
token_hour = Token(re.compile(r"(\d+)H"),
2847
datetime.timedelta(hours=1),
2848
frozenset((token_minute, token_end)))
2849
token_time = Token(re.compile(r"T"),
2851
frozenset((token_hour, token_minute,
2853
token_day = Token(re.compile(r"(\d+)D"),
2854
datetime.timedelta(days=1),
2855
frozenset((token_time, token_end)))
2856
token_month = Token(re.compile(r"(\d+)M"),
2857
datetime.timedelta(weeks=4),
2858
frozenset((token_day, token_end)))
2859
token_year = Token(re.compile(r"(\d+)Y"),
2860
datetime.timedelta(weeks=52),
2861
frozenset((token_month, token_end)))
2862
token_week = Token(re.compile(r"(\d+)W"),
2863
datetime.timedelta(weeks=1),
2864
frozenset((token_end, )))
2865
token_duration = Token(re.compile(r"P"), None,
2866
frozenset((token_year, token_month,
2867
token_day, token_time,
2869
# Define starting values:
2871
value = datetime.timedelta()
2873
# Following valid tokens
2874
followers = frozenset((token_duration, ))
2875
# String left to parse
2877
# Loop until end token is found
2878
while found_token is not token_end:
2879
# Search for any currently valid tokens
2880
for token in followers:
2881
match = token.regexp.match(s)
2882
if match is not None:
2884
if token.value is not None:
2885
# Value found, parse digits
2886
factor = int(match.group(1), 10)
2887
# Add to value so far
2888
value += factor * token.value
2889
# Strip token from string
2890
s = token.regexp.sub("", s, 1)
2893
# Set valid next tokens
2894
followers = found_token.followers
1253
logger.error(u"Unknown IPC command: %r", cmdline)
1255
# Keep calling this function
2897
# No currently valid tokens were found
2898
raise ValueError("Invalid RFC 3339 duration: {!r}"
1259
2904
def string_to_delta(interval):
1260
2905
"""Parse a string and return a datetime.timedelta
1262
>>> string_to_delta(u'7d')
1263
datetime.timedelta(7)
1264
>>> string_to_delta(u'60s')
1265
datetime.timedelta(0, 60)
1266
>>> string_to_delta(u'60m')
1267
datetime.timedelta(0, 3600)
1268
>>> string_to_delta(u'24h')
1269
datetime.timedelta(1)
1270
>>> string_to_delta(u'1w')
1271
datetime.timedelta(7)
1272
>>> string_to_delta(u'5m 30s')
1273
datetime.timedelta(0, 330)
2907
>>> string_to_delta("7d") == datetime.timedelta(7)
2909
>>> string_to_delta("60s") == datetime.timedelta(0, 60)
2911
>>> string_to_delta("60m") == datetime.timedelta(0, 3600)
2913
>>> string_to_delta("24h") == datetime.timedelta(1)
2915
>>> string_to_delta("1w") == datetime.timedelta(7)
2917
>>> string_to_delta("5m 30s") == datetime.timedelta(0, 330)
2922
return rfc3339_duration_to_delta(interval)
1275
2926
timevalue = datetime.timedelta(0)
1276
2927
for s in interval.split():
1278
suffix = unicode(s[-1])
1279
2930
value = int(s[:-1])
1281
2932
delta = datetime.timedelta(value)
1282
elif suffix == u"s":
1283
2934
delta = datetime.timedelta(0, value)
1284
elif suffix == u"m":
1285
2936
delta = datetime.timedelta(0, 0, 0, 0, value)
1286
elif suffix == u"h":
1287
2938
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1288
elif suffix == u"w":
1289
2940
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1292
except (ValueError, IndexError):
2942
raise ValueError("Unknown suffix {!r}".format(suffix))
2943
except IndexError as e:
2944
raise ValueError(*(e.args))
1294
2945
timevalue += delta
1295
2946
return timevalue
1298
def if_nametoindex(interface):
1299
"""Call the C function if_nametoindex(), or equivalent
1301
Note: This function cannot accept a unicode string."""
1302
global if_nametoindex
1304
if_nametoindex = (ctypes.cdll.LoadLibrary
1305
(ctypes.util.find_library(u"c"))
1307
except (OSError, AttributeError):
1308
logger.warning(u"Doing if_nametoindex the hard way")
1309
def if_nametoindex(interface):
1310
"Get an interface index the hard way, i.e. using fcntl()"
1311
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1312
with closing(socket.socket()) as s:
1313
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1314
struct.pack(str(u"16s16x"),
1316
interface_index = struct.unpack(str(u"I"),
1318
return interface_index
1319
return if_nametoindex(interface)
1322
def daemon(nochdir = False, noclose = False):
2949
def daemon(nochdir=False, noclose=False):
1323
2950
"""See daemon(3). Standard BSD Unix function.
1325
2952
This should really exist as os.daemon, but it doesn't (yet)."""
1329
2956
if not nochdir:
1333
2960
if not noclose:
1334
2961
# Close all standard open file descriptors
1335
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2962
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1336
2963
if not stat.S_ISCHR(os.fstat(null).st_mode):
1337
2964
raise OSError(errno.ENODEV,
1338
u"/dev/null not a character device")
2965
"{} not a character device"
2966
.format(os.devnull))
1339
2967
os.dup2(null, sys.stdin.fileno())
1340
2968
os.dup2(null, sys.stdout.fileno())
1341
2969
os.dup2(null, sys.stderr.fileno())
1348
2976
##################################################################
1349
2977
# Parsing of options, both command line and config file
1351
parser = optparse.OptionParser(version = "%%prog %s" % version)
1352
parser.add_option("-i", u"--interface", type=u"string",
1353
metavar="IF", help=u"Bind to interface IF")
1354
parser.add_option("-a", u"--address", type=u"string",
1355
help=u"Address to listen for requests on")
1356
parser.add_option("-p", u"--port", type=u"int",
1357
help=u"Port number to receive requests on")
1358
parser.add_option("--check", action=u"store_true",
1359
help=u"Run self-test")
1360
parser.add_option("--debug", action=u"store_true",
1361
help=u"Debug mode; run in foreground and log to"
1363
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1364
u" priority string (see GnuTLS documentation)")
1365
parser.add_option("--servicename", type=u"string",
1366
metavar=u"NAME", help=u"Zeroconf service name")
1367
parser.add_option("--configdir", type=u"string",
1368
default=u"/etc/mandos", metavar=u"DIR",
1369
help=u"Directory to search for configuration"
1371
parser.add_option("--no-dbus", action=u"store_false",
1372
dest=u"use_dbus", help=u"Do not provide D-Bus"
1373
u" system bus interface")
1374
parser.add_option("--no-ipv6", action=u"store_false",
1375
dest=u"use_ipv6", help=u"Do not use IPv6")
1376
options = parser.parse_args()[0]
2979
parser = argparse.ArgumentParser()
2980
parser.add_argument("-v", "--version", action="version",
2981
version="%(prog)s {}".format(version),
2982
help="show version number and exit")
2983
parser.add_argument("-i", "--interface", metavar="IF",
2984
help="Bind to interface IF")
2985
parser.add_argument("-a", "--address",
2986
help="Address to listen for requests on")
2987
parser.add_argument("-p", "--port", type=int,
2988
help="Port number to receive requests on")
2989
parser.add_argument("--check", action="store_true",
2990
help="Run self-test")
2991
parser.add_argument("--debug", action="store_true",
2992
help="Debug mode; run in foreground and log"
2993
" to terminal", default=None)
2994
parser.add_argument("--debuglevel", metavar="LEVEL",
2995
help="Debug level for stdout output")
2996
parser.add_argument("--priority", help="GnuTLS"
2997
" priority string (see GnuTLS documentation)")
2998
parser.add_argument("--servicename",
2999
metavar="NAME", help="Zeroconf service name")
3000
parser.add_argument("--configdir",
3001
default="/etc/mandos", metavar="DIR",
3002
help="Directory to search for configuration"
3004
parser.add_argument("--no-dbus", action="store_false",
3005
dest="use_dbus", help="Do not provide D-Bus"
3006
" system bus interface", default=None)
3007
parser.add_argument("--no-ipv6", action="store_false",
3008
dest="use_ipv6", help="Do not use IPv6",
3010
parser.add_argument("--no-restore", action="store_false",
3011
dest="restore", help="Do not restore stored"
3012
" state", default=None)
3013
parser.add_argument("--socket", type=int,
3014
help="Specify a file descriptor to a network"
3015
" socket to use instead of creating one")
3016
parser.add_argument("--statedir", metavar="DIR",
3017
help="Directory to save/restore state in")
3018
parser.add_argument("--foreground", action="store_true",
3019
help="Run in foreground", default=None)
3020
parser.add_argument("--no-zeroconf", action="store_false",
3021
dest="zeroconf", help="Do not use Zeroconf",
3024
options = parser.parse_args()
1383
3026
# Default values for config file for server-global settings
1384
server_defaults = { u"interface": u"",
1389
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1390
u"servicename": u"Mandos",
1391
u"use_dbus": u"True",
1392
u"use_ipv6": u"True",
3027
if gnutls.has_rawpk:
3028
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3029
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3031
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3032
":+SIGN-DSA-SHA256")
3033
server_defaults = {"interface": "",
3037
"priority": priority,
3038
"servicename": "Mandos",
3044
"statedir": "/var/lib/mandos",
3045
"foreground": "False",
1395
3050
# Parse config file for server-global settings
1396
server_config = configparser.SafeConfigParser(server_defaults)
3051
server_config = configparser.ConfigParser(server_defaults)
1397
3052
del server_defaults
1398
server_config.read(os.path.join(options.configdir,
1400
# Convert the SafeConfigParser object to a dict
3053
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3054
# Convert the ConfigParser object to a dict
1401
3055
server_settings = server_config.defaults()
1402
3056
# Use the appropriate methods on the non-string config options
1403
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1404
server_settings[option] = server_config.getboolean(u"DEFAULT",
3057
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3058
"foreground", "zeroconf"):
3059
server_settings[option] = server_config.getboolean("DEFAULT",
1406
3061
if server_settings["port"]:
1407
server_settings["port"] = server_config.getint(u"DEFAULT",
3062
server_settings["port"] = server_config.getint("DEFAULT",
3064
if server_settings["socket"]:
3065
server_settings["socket"] = server_config.getint("DEFAULT",
3067
# Later, stdin will, and stdout and stderr might, be dup'ed
3068
# over with an opened os.devnull. But we don't want this to
3069
# happen with a supplied network socket.
3070
if 0 <= server_settings["socket"] <= 2:
3071
server_settings["socket"] = os.dup(server_settings
1409
3073
del server_config
1411
3075
# Override the settings from the config file with command line
1412
3076
# options, if set.
1413
for option in (u"interface", u"address", u"port", u"debug",
1414
u"priority", u"servicename", u"configdir",
1415
u"use_dbus", u"use_ipv6"):
3077
for option in ("interface", "address", "port", "debug",
3078
"priority", "servicename", "configdir", "use_dbus",
3079
"use_ipv6", "debuglevel", "restore", "statedir",
3080
"socket", "foreground", "zeroconf"):
1416
3081
value = getattr(options, option)
1417
3082
if value is not None:
1418
3083
server_settings[option] = value
1420
3085
# Force all strings to be unicode
1421
3086
for option in server_settings.keys():
1422
if type(server_settings[option]) is str:
1423
server_settings[option] = unicode(server_settings[option])
3087
if isinstance(server_settings[option], bytes):
3088
server_settings[option] = (server_settings[option]
3090
# Force all boolean options to be boolean
3091
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3092
"foreground", "zeroconf"):
3093
server_settings[option] = bool(server_settings[option])
3094
# Debug implies foreground
3095
if server_settings["debug"]:
3096
server_settings["foreground"] = True
1424
3097
# Now we have our good server settings in "server_settings"
1426
3099
##################################################################
3101
if (not server_settings["zeroconf"]
3102
and not (server_settings["port"]
3103
or server_settings["socket"] != "")):
3104
parser.error("Needs port or socket to work without Zeroconf")
1428
3106
# For convenience
1429
debug = server_settings[u"debug"]
1430
use_dbus = server_settings[u"use_dbus"]
1431
use_ipv6 = server_settings[u"use_ipv6"]
1434
syslogger.setLevel(logging.WARNING)
1435
console.setLevel(logging.WARNING)
1437
if server_settings[u"servicename"] != u"Mandos":
1438
syslogger.setFormatter(logging.Formatter
1439
(u'Mandos (%s) [%%(process)d]:'
1440
u' %%(levelname)s: %%(message)s'
1441
% server_settings[u"servicename"]))
3107
debug = server_settings["debug"]
3108
debuglevel = server_settings["debuglevel"]
3109
use_dbus = server_settings["use_dbus"]
3110
use_ipv6 = server_settings["use_ipv6"]
3111
stored_state_path = os.path.join(server_settings["statedir"],
3113
foreground = server_settings["foreground"]
3114
zeroconf = server_settings["zeroconf"]
3117
initlogger(debug, logging.DEBUG)
3122
level = getattr(logging, debuglevel.upper())
3123
initlogger(debug, level)
3125
if server_settings["servicename"] != "Mandos":
3126
syslogger.setFormatter(
3127
logging.Formatter("Mandos ({}) [%(process)d]:"
3128
" %(levelname)s: %(message)s".format(
3129
server_settings["servicename"])))
1443
3131
# Parse config file with clients
1444
client_defaults = { u"timeout": u"1h",
1446
u"checker": u"fping -q -- %%(host)s",
1449
client_config = configparser.SafeConfigParser(client_defaults)
1450
client_config.read(os.path.join(server_settings[u"configdir"],
3132
client_config = configparser.ConfigParser(Client.client_defaults)
3133
client_config.read(os.path.join(server_settings["configdir"],
1453
3136
global mandos_dbus_service
1454
3137
mandos_dbus_service = None
1456
tcp_server = MandosServer((server_settings[u"address"],
1457
server_settings[u"port"]),
1459
interface=server_settings[u"interface"],
1462
server_settings[u"priority"],
1464
pidfilename = u"/var/run/mandos.pid"
1466
pidfile = open(pidfilename, u"w")
1468
logger.error(u"Could not open file %r", pidfilename)
1471
uid = pwd.getpwnam(u"_mandos").pw_uid
1472
gid = pwd.getpwnam(u"_mandos").pw_gid
1475
uid = pwd.getpwnam(u"mandos").pw_uid
1476
gid = pwd.getpwnam(u"mandos").pw_gid
3140
if server_settings["socket"] != "":
3141
socketfd = server_settings["socket"]
3142
tcp_server = MandosServer(
3143
(server_settings["address"], server_settings["port"]),
3145
interface=(server_settings["interface"] or None),
3147
gnutls_priority=server_settings["priority"],
3151
pidfilename = "/run/mandos.pid"
3152
if not os.path.isdir("/run/."):
3153
pidfilename = "/var/run/mandos.pid"
3156
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3157
except IOError as e:
3158
log.error("Could not open file %r", pidfilename,
3161
for name, group in (("_mandos", "_mandos"),
3162
("mandos", "mandos"),
3163
("nobody", "nogroup")):
3165
uid = pwd.getpwnam(name).pw_uid
3166
gid = pwd.getpwnam(group).pw_gid
1477
3168
except KeyError:
1479
uid = pwd.getpwnam(u"nobody").pw_uid
1480
gid = pwd.getpwnam(u"nobody").pw_gid
1487
except OSError, error:
1488
if error[0] != errno.EPERM:
1491
# Enable all possible GnuTLS debugging
3176
log.debug("Did setuid/setgid to %s:%s", uid, gid)
3177
except OSError as error:
3178
log.warning("Failed to setuid/setgid to %s:%s: %s", uid, gid,
3179
os.strerror(error.errno))
3180
if error.errno != errno.EPERM:
3184
# Enable all possible GnuTLS debugging
1493
3186
# "Use a log level over 10 to enable all debugging options."
1494
3187
# - GnuTLS manual
1495
gnutls.library.functions.gnutls_global_set_log_level(11)
1497
@gnutls.library.types.gnutls_log_func
3188
gnutls.global_set_log_level(11)
1498
3191
def debug_gnutls(level, string):
1499
logger.debug(u"GnuTLS: %s", string[:-1])
1501
(gnutls.library.functions
1502
.gnutls_global_set_log_function(debug_gnutls))
3192
log.debug("GnuTLS: %s",
3193
string[:-1].decode("utf-8", errors="replace"))
3195
gnutls.global_set_log_function(debug_gnutls)
3197
# Redirect stdin so all checkers get /dev/null
3198
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3199
os.dup2(null, sys.stdin.fileno())
3203
# Need to fork before connecting to D-Bus
3205
# Close all input and output, do double fork, etc.
3208
if gi.version_info < (3, 10, 2):
3209
# multiprocessing will use threads, so before we use GLib we
3210
# need to inform GLib that threads will be used.
1504
3213
global main_loop
1505
3214
# From the Avahi example code
1506
DBusGMainLoop(set_as_default=True )
1507
main_loop = gobject.MainLoop()
3215
DBusGMainLoop(set_as_default=True)
3216
main_loop = GLib.MainLoop()
1508
3217
bus = dbus.SystemBus()
1509
3218
# End of Avahi example code
1511
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
1512
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1513
service = AvahiService(name = server_settings[u"servicename"],
1514
servicetype = u"_mandos._tcp",
1515
protocol = protocol, bus = bus)
1516
if server_settings["interface"]:
1517
service.interface = (if_nametoindex
1518
(str(server_settings[u"interface"])))
3221
bus_name = dbus.service.BusName("se.recompile.Mandos",
3224
old_bus_name = dbus.service.BusName(
3225
"se.bsnet.fukt.Mandos", bus,
3227
except dbus.exceptions.DBusException as e:
3228
log.error("Disabling D-Bus:", exc_info=e)
3230
server_settings["use_dbus"] = False
3231
tcp_server.use_dbus = False
3233
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3234
service = AvahiServiceToSyslog(
3235
name=server_settings["servicename"],
3236
servicetype="_mandos._tcp",
3239
if server_settings["interface"]:
3240
service.interface = if_nametoindex(
3241
server_settings["interface"].encode("utf-8"))
3243
global multiprocessing_manager
3244
multiprocessing_manager = multiprocessing.Manager()
1520
3246
client_class = Client
1522
client_class = functools.partial(ClientDBus, bus = bus)
1523
tcp_server.clients.update(set(
1524
client_class(name = section,
1525
config= dict(client_config.items(section)))
1526
for section in client_config.sections()))
3248
client_class = functools.partial(ClientDBus, bus=bus)
3250
client_settings = Client.config_parser(client_config)
3251
old_client_settings = {}
3254
# This is used to redirect stdout and stderr for checker processes
3256
wnull = open(os.devnull, "w") # A writable /dev/null
3257
# Only used if server is running in foreground but not in debug
3259
if debug or not foreground:
3262
# Get client data and settings from last running state.
3263
if server_settings["restore"]:
3265
with open(stored_state_path, "rb") as stored_state:
3266
if sys.version_info.major == 2:
3267
clients_data, old_client_settings = pickle.load(
3270
bytes_clients_data, bytes_old_client_settings = (
3271
pickle.load(stored_state, encoding="bytes"))
3272
# Fix bytes to strings
3275
clients_data = {(key.decode("utf-8")
3276
if isinstance(key, bytes)
3279
bytes_clients_data.items()}
3280
del bytes_clients_data
3281
for key in clients_data:
3282
value = {(k.decode("utf-8")
3283
if isinstance(k, bytes) else k): v
3285
clients_data[key].items()}
3286
clients_data[key] = value
3288
value["client_structure"] = [
3290
if isinstance(s, bytes)
3292
value["client_structure"]]
3293
# .name, .host, and .checker_command
3294
for k in ("name", "host", "checker_command"):
3295
if isinstance(value[k], bytes):
3296
value[k] = value[k].decode("utf-8")
3297
if "key_id" not in value:
3298
value["key_id"] = ""
3299
elif "fingerprint" not in value:
3300
value["fingerprint"] = ""
3301
# old_client_settings
3303
old_client_settings = {
3304
(key.decode("utf-8")
3305
if isinstance(key, bytes)
3308
bytes_old_client_settings.items()}
3309
del bytes_old_client_settings
3310
# .host and .checker_command
3311
for value in old_client_settings.values():
3312
for attribute in ("host", "checker_command"):
3313
if isinstance(value[attribute], bytes):
3314
value[attribute] = (value[attribute]
3316
os.remove(stored_state_path)
3317
except IOError as e:
3318
if e.errno == errno.ENOENT:
3319
log.warning("Could not load persistent state:"
3320
" %s", os.strerror(e.errno))
3322
log.critical("Could not load persistent state:",
3325
except EOFError as e:
3326
log.warning("Could not load persistent state: EOFError:",
3329
with PGPEngine() as pgp:
3330
for client_name, client in clients_data.items():
3331
# Skip removed clients
3332
if client_name not in client_settings:
3335
# Decide which value to use after restoring saved state.
3336
# We have three different values: Old config file,
3337
# new config file, and saved state.
3338
# New config value takes precedence if it differs from old
3339
# config value, otherwise use saved state.
3340
for name, value in client_settings[client_name].items():
3342
# For each value in new config, check if it
3343
# differs from the old config value (Except for
3344
# the "secret" attribute)
3345
if (name != "secret"
3347
old_client_settings[client_name][name])):
3348
client[name] = value
3352
# Clients who has passed its expire date can still be
3353
# enabled if its last checker was successful. A Client
3354
# whose checker succeeded before we stored its state is
3355
# assumed to have successfully run all checkers during
3357
if client["enabled"]:
3358
if datetime.datetime.utcnow() >= client["expires"]:
3359
if not client["last_checked_ok"]:
3360
log.warning("disabling client %s - Client"
3361
" never performed a successful"
3362
" checker", client_name)
3363
client["enabled"] = False
3364
elif client["last_checker_status"] != 0:
3365
log.warning("disabling client %s - Client"
3366
" last checker failed with error"
3367
" code %s", client_name,
3368
client["last_checker_status"])
3369
client["enabled"] = False
3371
client["expires"] = (
3372
datetime.datetime.utcnow()
3373
+ client["timeout"])
3374
log.debug("Last checker succeeded, keeping %s"
3375
" enabled", client_name)
3377
client["secret"] = pgp.decrypt(
3378
client["encrypted_secret"],
3379
client_settings[client_name]["secret"])
3381
# If decryption fails, we use secret from new settings
3382
log.debug("Failed to decrypt %s old secret",
3384
client["secret"] = (client_settings[client_name]
3387
# Add/remove clients based on new changes made to config
3388
for client_name in (set(old_client_settings)
3389
- set(client_settings)):
3390
del clients_data[client_name]
3391
for client_name in (set(client_settings)
3392
- set(old_client_settings)):
3393
clients_data[client_name] = client_settings[client_name]
3395
# Create all client objects
3396
for client_name, client in clients_data.items():
3397
tcp_server.clients[client_name] = client_class(
3400
server_settings=server_settings)
1527
3402
if not tcp_server.clients:
1528
logger.warning(u"No clients defined")
1531
# Redirect stdin so all checkers get /dev/null
1532
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1533
os.dup2(null, sys.stdin.fileno())
1537
# No console logging
1538
logger.removeHandler(console)
1539
# Close all input and output, do double fork, etc.
1543
with closing(pidfile):
3403
log.warning("No clients defined")
3406
if pidfile is not None:
1544
3407
pid = os.getpid()
1545
pidfile.write(str(pid) + "\n")
3410
print(pid, file=pidfile)
3412
log.error("Could not write to file %r with PID %d",
1548
logger.error(u"Could not write to file %r with PID %d",
1551
# "pidfile" was never created
1556
"Cleanup function; run on exit"
1559
while tcp_server.clients:
1560
client = tcp_server.clients.pop()
1561
client.disable_hook = None
1564
atexit.register(cleanup)
1567
signal.signal(signal.SIGINT, signal.SIG_IGN)
1568
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1569
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3417
for termsig in (signal.SIGHUP, signal.SIGTERM):
3418
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3419
lambda: main_loop.quit() and False)
1572
class MandosDBusService(dbus.service.Object):
3423
@alternate_dbus_interfaces(
3424
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3425
class MandosDBusService(DBusObjectWithObjectManager):
1573
3426
"""A D-Bus proxy object"""
1574
3428
def __init__(self):
1575
dbus.service.Object.__init__(self, bus, u"/")
1576
_interface = u"se.bsnet.fukt.Mandos"
1578
@dbus.service.signal(_interface, signature=u"oa{sv}")
1579
def ClientAdded(self, objpath, properties):
1583
@dbus.service.signal(_interface, signature=u"s")
1584
def ClientNotFound(self, fingerprint):
1588
@dbus.service.signal(_interface, signature=u"os")
3429
dbus.service.Object.__init__(self, bus, "/")
3431
_interface = "se.recompile.Mandos"
3433
@dbus.service.signal(_interface, signature="o")
3434
def ClientAdded(self, objpath):
3438
@dbus.service.signal(_interface, signature="ss")
3439
def ClientNotFound(self, key_id, address):
3443
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3445
@dbus.service.signal(_interface, signature="os")
1589
3446
def ClientRemoved(self, objpath, name):
1593
@dbus.service.method(_interface, out_signature=u"ao")
3450
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3452
@dbus.service.method(_interface, out_signature="ao")
1594
3453
def GetAllClients(self):
1596
return dbus.Array(c.dbus_object_path
1597
for c in tcp_server.clients)
3455
return dbus.Array(c.dbus_object_path for c in
3456
tcp_server.clients.values())
3458
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1599
3460
@dbus.service.method(_interface,
1600
out_signature=u"a{oa{sv}}")
3461
out_signature="a{oa{sv}}")
1601
3462
def GetAllClientsWithProperties(self):
1603
3464
return dbus.Dictionary(
1604
((c.dbus_object_path, c.GetAll(u""))
1605
for c in tcp_server.clients),
1606
signature=u"oa{sv}")
1608
@dbus.service.method(_interface, in_signature=u"o")
3465
{c.dbus_object_path: c.GetAll(
3466
"se.recompile.Mandos.Client")
3467
for c in tcp_server.clients.values()},
3470
@dbus.service.method(_interface, in_signature="o")
1609
3471
def RemoveClient(self, object_path):
1611
for c in tcp_server.clients:
3473
for c in tcp_server.clients.values():
1612
3474
if c.dbus_object_path == object_path:
1613
tcp_server.clients.remove(c)
3475
del tcp_server.clients[c.name]
1614
3476
c.remove_from_connection()
1615
# Don't signal anything except ClientRemoved
1616
c.disable(signal=False)
1618
self.ClientRemoved(object_path, c.name)
3477
# Don't signal the disabling
3478
c.disable(quiet=True)
3479
# Emit D-Bus signal for removal
3480
self.client_removed_signal(c)
3482
raise KeyError(object_path)
3486
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3487
out_signature="a{oa{sa{sv}}}")
3488
def GetManagedObjects(self):
3490
return dbus.Dictionary(
3491
{client.dbus_object_path:
3493
{interface: client.GetAll(interface)
3495
client._get_all_interface_names()})
3496
for client in tcp_server.clients.values()})
3498
def client_added_signal(self, client):
3499
"""Send the new standard signal and the old signal"""
3501
# New standard signal
3502
self.InterfacesAdded(
3503
client.dbus_object_path,
3505
{interface: client.GetAll(interface)
3507
client._get_all_interface_names()}))
3509
self.ClientAdded(client.dbus_object_path)
3511
def client_removed_signal(self, client):
3512
"""Send the new standard signal and the old signal"""
3514
# New standard signal
3515
self.InterfacesRemoved(
3516
client.dbus_object_path,
3517
client._get_all_interface_names())
3519
self.ClientRemoved(client.dbus_object_path,
1624
3522
mandos_dbus_service = MandosDBusService()
1626
for client in tcp_server.clients:
3524
# Save modules to variables to exempt the modules from being
3525
# unloaded before the function registered with atexit() is run.
3526
mp = multiprocessing
3530
"Cleanup function; run on exit"
3534
mp.active_children()
3536
if not (tcp_server.clients or client_settings):
3539
# Store client before exiting. Secrets are encrypted with key
3540
# based on what config file has. If config file is
3541
# removed/edited, old secret will thus be unrecovable.
3543
with PGPEngine() as pgp:
3544
for client in tcp_server.clients.values():
3545
key = client_settings[client.name]["secret"]
3546
client.encrypted_secret = pgp.encrypt(client.secret,
3550
# A list of attributes that can not be pickled
3552
exclude = {"bus", "changedstate", "secret",
3553
"checker", "server_settings"}
3554
for name, typ in inspect.getmembers(dbus.service
3558
client_dict["encrypted_secret"] = (client
3560
for attr in client.client_structure:
3561
if attr not in exclude:
3562
client_dict[attr] = getattr(client, attr)
3564
clients[client.name] = client_dict
3565
del client_settings[client.name]["secret"]
3568
with tempfile.NamedTemporaryFile(
3572
dir=os.path.dirname(stored_state_path),
3573
delete=False) as stored_state:
3574
pickle.dump((clients, client_settings), stored_state,
3576
tempname = stored_state.name
3577
os.rename(tempname, stored_state_path)
3578
except (IOError, OSError) as e:
3584
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3585
log.warning("Could not save persistent state: %s",
3586
os.strerror(e.errno))
3588
log.warning("Could not save persistent state:",
3592
# Delete all clients, and settings from config
3593
while tcp_server.clients:
3594
name, client = tcp_server.clients.popitem()
3596
client.remove_from_connection()
3597
# Don't signal the disabling
3598
client.disable(quiet=True)
3599
# Emit D-Bus signal for removal
3601
mandos_dbus_service.client_removed_signal(client)
3602
client_settings.clear()
3604
atexit.register(cleanup)
3606
for client in tcp_server.clients.values():
1629
mandos_dbus_service.ClientAdded(client.dbus_object_path,
3608
# Emit D-Bus signal for adding
3609
mandos_dbus_service.client_added_signal(client)
3610
# Need to initiate checking of clients
3612
client.init_checker()
1633
3614
tcp_server.enable()
1634
3615
tcp_server.server_activate()
1636
3617
# Find out what port we got
1637
service.port = tcp_server.socket.getsockname()[1]
3619
service.port = tcp_server.socket.getsockname()[1]
1639
logger.info(u"Now listening on address %r, port %d,"
1640
" flowinfo %d, scope_id %d"
1641
% tcp_server.socket.getsockname())
3621
log.info("Now listening on address %r, port %d, flowinfo %d,"
3622
" scope_id %d", *tcp_server.socket.getsockname())
1643
logger.info(u"Now listening on address %r, port %d"
1644
% tcp_server.socket.getsockname())
1646
#service.interface = tcp_server.socket.getsockname()[3]
3624
log.info("Now listening on address %r, port %d",
3625
*tcp_server.socket.getsockname())
3627
# service.interface = tcp_server.socket.getsockname()[3]
1649
# From the Avahi example code
1652
except dbus.exceptions.DBusException, error:
1653
logger.critical(u"DBusException: %s", error)
1655
# End of Avahi example code
1657
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1658
lambda *args, **kwargs:
1659
(tcp_server.handle_request
1660
(*args[2:], **kwargs) or True))
1662
logger.debug(u"Starting main loop")
3631
# From the Avahi example code
3634
except dbus.exceptions.DBusException as error:
3635
log.critical("D-Bus Exception", exc_info=error)
3638
# End of Avahi example code
3641
GLib.IOChannel.unix_new(tcp_server.fileno()),
3642
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3643
lambda *args, **kwargs: (tcp_server.handle_request
3644
(*args[2:], **kwargs) or True))
3646
log.debug("Starting main loop")
1663
3647
main_loop.run()
1664
except AvahiError, error:
1665
logger.critical(u"AvahiError: %s", error)
3648
except AvahiError as error:
3649
log.critical("Avahi Error", exc_info=error)
1667
3652
except KeyboardInterrupt:
1670
logger.debug(u"Server received KeyboardInterrupt")
1671
logger.debug(u"Server exiting")
1673
if __name__ == '__main__':
3654
print("", file=sys.stderr)
3655
log.debug("Server received KeyboardInterrupt")
3656
log.debug("Server exiting")
3657
# Must run before the D-Bus bus name gets deregistered
3661
def parse_test_args():
3662
# type: () -> argparse.Namespace
3663
parser = argparse.ArgumentParser(add_help=False)
3664
parser.add_argument("--check", action="store_true")
3665
parser.add_argument("--prefix", )
3666
args, unknown_args = parser.parse_known_args()
3668
# Remove test options from sys.argv
3669
sys.argv[1:] = unknown_args
3672
# Add all tests from doctest strings
3673
def load_tests(loader, tests, none):
3675
tests.addTests(doctest.DocTestSuite())
3678
if __name__ == "__main__":
3679
options = parse_test_args()
3682
extra_test_prefix = options.prefix
3683
if extra_test_prefix is not None:
3684
if not (unittest.main(argv=[""], exit=False)
3685
.result.wasSuccessful()):
3687
class ExtraTestLoader(unittest.TestLoader):
3688
testMethodPrefix = extra_test_prefix
3689
# Call using ./scriptname --test [--verbose]
3690
unittest.main(argv=[""], testLoader=ExtraTestLoader())
3692
unittest.main(argv=[""])
3700
# (lambda (&optional extra)
3701
# (if (not (funcall run-tests-in-test-buffer default-directory
3703
# (funcall show-test-buffer-in-test-window)
3704
# (funcall remove-test-window)
3705
# (if extra (message "Extra tests run successfully!"))))
3706
# run-tests-in-test-buffer:
3707
# (lambda (dir &optional extra)
3708
# (with-current-buffer (get-buffer-create "*Test*")
3709
# (setq buffer-read-only nil
3710
# default-directory dir)
3712
# (compilation-mode))
3713
# (let ((process-result
3714
# (let ((inhibit-read-only t))
3715
# (process-file-shell-command
3716
# (funcall get-command-line extra) nil "*Test*"))))
3717
# (and (numberp process-result)
3718
# (= process-result 0))))
3720
# (lambda (&optional extra)
3721
# (let ((quoted-script
3722
# (shell-quote-argument (funcall get-script-name))))
3724
# (concat "%s --check" (if extra " --prefix=atest" ""))
3728
# (if (fboundp 'file-local-name)
3729
# (file-local-name (buffer-file-name))
3730
# (or (file-remote-p (buffer-file-name) 'localname)
3731
# (buffer-file-name))))
3732
# remove-test-window:
3734
# (let ((test-window (get-buffer-window "*Test*")))
3735
# (if test-window (delete-window test-window))))
3736
# show-test-buffer-in-test-window:
3738
# (when (not (get-buffer-window-list "*Test*"))
3739
# (setq next-error-last-buffer (get-buffer "*Test*"))
3740
# (let* ((side (if (>= (window-width) 146) 'right 'bottom))
3741
# (display-buffer-overriding-action
3742
# `((display-buffer-in-side-window) (side . ,side)
3743
# (window-height . fit-window-to-buffer)
3744
# (window-width . fit-window-to-buffer))))
3745
# (display-buffer "*Test*"))))
3748
# (let* ((run-extra-tests (lambda () (interactive)
3749
# (funcall run-tests t)))
3750
# (inner-keymap `(keymap (116 . ,run-extra-tests))) ; t
3751
# (outer-keymap `(keymap (3 . ,inner-keymap)))) ; C-c
3752
# (setq minor-mode-overriding-map-alist
3753
# (cons `(run-tests . ,outer-keymap)
3754
# minor-mode-overriding-map-alist)))
3755
# (add-hook 'after-save-hook run-tests 90 t))