447
191
dbus.UInt16(self.port),
448
192
avahi.string_array_to_txt_array(self.TXT))
449
193
self.group.Commit()
451
194
def entry_group_state_changed(self, state, error):
452
195
"""Derived from the Avahi example code"""
453
logger.debug("Avahi entry group state change: %i", state)
196
logger.debug(u"Avahi entry group state change: %i", state)
455
198
if state == avahi.ENTRY_GROUP_ESTABLISHED:
456
logger.debug("Zeroconf service established.")
199
logger.debug(u"Zeroconf service established.")
457
200
elif state == avahi.ENTRY_GROUP_COLLISION:
458
logger.info("Zeroconf service name collision.")
201
logger.warning(u"Zeroconf service name collision.")
460
203
elif state == avahi.ENTRY_GROUP_FAILURE:
461
logger.critical("Avahi: Error in group state changed %s",
463
raise AvahiGroupError("State changed: {!s}".format(error))
204
logger.critical(u"Avahi: Error in group state changed %s",
206
raise AvahiGroupError(u"State changed: %s"
465
208
def cleanup(self):
466
209
"""Derived from the Avahi example code"""
467
210
if self.group is not None:
470
except (dbus.exceptions.UnknownMethodException,
471
dbus.exceptions.DBusException):
473
212
self.group = None
476
def server_state_changed(self, state, error=None):
213
def server_state_changed(self, state):
477
214
"""Derived from the Avahi example code"""
478
logger.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
logger.error(bad_states[state])
490
logger.error(bad_states[state] + ": %r", error)
215
logger.debug(u"Avahi server state change: %i", state)
216
if state == avahi.SERVER_COLLISION:
217
logger.error(u"Zeroconf server name collision")
492
219
elif state == avahi.SERVER_RUNNING:
495
except dbus.exceptions.DBusException as error:
496
if (error.get_dbus_name()
497
== "org.freedesktop.Avahi.CollisionError"):
498
logger.info("Local Zeroconf service name"
500
return self.rename(remove=False)
502
logger.critical("D-Bus Exception", exc_info=error)
507
logger.debug("Unknown state: %r", state)
509
logger.debug("Unknown state: %r: %r", state, error)
511
221
def activate(self):
512
222
"""Derived from the Avahi example code"""
513
223
if self.server is None:
514
224
self.server = dbus.Interface(
515
225
self.bus.get_object(avahi.DBUS_NAME,
516
avahi.DBUS_PATH_SERVER,
517
follow_name_owner_changes=True),
226
avahi.DBUS_PATH_SERVER),
518
227
avahi.DBUS_INTERFACE_SERVER)
519
self.server.connect_to_signal("StateChanged",
520
self.server_state_changed)
228
self.server.connect_to_signal(u"StateChanged",
229
self.server_state_changed)
521
230
self.server_state_changed(self.server.GetState())
524
class AvahiServiceToSyslog(AvahiService):
525
def rename(self, *args, **kwargs):
526
"""Add the new name to the syslog messages"""
527
ret = super(AvahiServiceToSyslog, self).rename(*args,
529
syslogger.setFormatter(logging.Formatter(
530
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
535
# Pretend that we have a GnuTLS module
537
"""This isn't so much a class as it is a module-like namespace."""
539
library = ctypes.util.find_library("gnutls")
541
library = ctypes.util.find_library("gnutls-deb0")
542
_library = ctypes.cdll.LoadLibrary(library)
545
# Unless otherwise indicated, the constants and types below are
546
# all from the gnutls/gnutls.h C header file.
557
E_NO_CERTIFICATE_FOUND = -49
562
KEYID_USE_SHA256 = 1 # gnutls/x509.h
563
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
566
class session_int(ctypes.Structure):
568
session_t = ctypes.POINTER(session_int)
570
class certificate_credentials_st(ctypes.Structure):
572
certificate_credentials_t = ctypes.POINTER(
573
certificate_credentials_st)
574
certificate_type_t = ctypes.c_int
576
class datum_t(ctypes.Structure):
577
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
578
('size', ctypes.c_uint)]
580
class openpgp_crt_int(ctypes.Structure):
582
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
583
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
584
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
585
credentials_type_t = ctypes.c_int
586
transport_ptr_t = ctypes.c_void_p
587
close_request_t = ctypes.c_int
590
class Error(Exception):
591
def __init__(self, message=None, code=None, args=()):
592
# Default usage is by a message string, but if a return
593
# code is passed, convert it to a string with
596
if message is None and code is not None:
597
message = gnutls.strerror(code)
598
return super(gnutls.Error, self).__init__(
601
class CertificateSecurityError(Error):
607
self._c_object = gnutls.certificate_credentials_t()
608
gnutls.certificate_allocate_credentials(
609
ctypes.byref(self._c_object))
610
self.type = gnutls.CRD_CERTIFICATE
613
gnutls.certificate_free_credentials(self._c_object)
616
def __init__(self, socket, credentials=None):
617
self._c_object = gnutls.session_t()
618
gnutls_flags = gnutls.CLIENT
619
if gnutls.check_version(b"3.5.6"):
620
gnutls_flags |= gnutls.NO_TICKETS
622
gnutls_flags |= gnutls.ENABLE_RAWPK
623
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
625
gnutls.set_default_priority(self._c_object)
626
gnutls.transport_set_ptr(self._c_object, socket.fileno())
627
gnutls.handshake_set_private_extensions(self._c_object,
630
if credentials is None:
631
credentials = gnutls.Credentials()
632
gnutls.credentials_set(self._c_object, credentials.type,
633
ctypes.cast(credentials._c_object,
635
self.credentials = credentials
638
gnutls.deinit(self._c_object)
641
return gnutls.handshake(self._c_object)
643
def send(self, data):
647
data_len -= gnutls.record_send(self._c_object,
652
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
654
# Error handling functions
655
def _error_code(result):
656
"""A function to raise exceptions on errors, suitable
657
for the 'restype' attribute on ctypes functions"""
660
if result == gnutls.E_NO_CERTIFICATE_FOUND:
661
raise gnutls.CertificateSecurityError(code=result)
662
raise gnutls.Error(code=result)
664
def _retry_on_error(result, func, arguments):
665
"""A function to retry on some errors, suitable
666
for the 'errcheck' attribute on ctypes functions"""
668
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
669
return _error_code(result)
670
result = func(*arguments)
673
# Unless otherwise indicated, the function declarations below are
674
# all from the gnutls/gnutls.h C header file.
677
priority_set_direct = _library.gnutls_priority_set_direct
678
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
679
ctypes.POINTER(ctypes.c_char_p)]
680
priority_set_direct.restype = _error_code
682
init = _library.gnutls_init
683
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
684
init.restype = _error_code
686
set_default_priority = _library.gnutls_set_default_priority
687
set_default_priority.argtypes = [session_t]
688
set_default_priority.restype = _error_code
690
record_send = _library.gnutls_record_send
691
record_send.argtypes = [session_t, ctypes.c_void_p,
693
record_send.restype = ctypes.c_ssize_t
694
record_send.errcheck = _retry_on_error
696
certificate_allocate_credentials = (
697
_library.gnutls_certificate_allocate_credentials)
698
certificate_allocate_credentials.argtypes = [
699
ctypes.POINTER(certificate_credentials_t)]
700
certificate_allocate_credentials.restype = _error_code
702
certificate_free_credentials = (
703
_library.gnutls_certificate_free_credentials)
704
certificate_free_credentials.argtypes = [
705
certificate_credentials_t]
706
certificate_free_credentials.restype = None
708
handshake_set_private_extensions = (
709
_library.gnutls_handshake_set_private_extensions)
710
handshake_set_private_extensions.argtypes = [session_t,
712
handshake_set_private_extensions.restype = None
714
credentials_set = _library.gnutls_credentials_set
715
credentials_set.argtypes = [session_t, credentials_type_t,
717
credentials_set.restype = _error_code
719
strerror = _library.gnutls_strerror
720
strerror.argtypes = [ctypes.c_int]
721
strerror.restype = ctypes.c_char_p
723
certificate_type_get = _library.gnutls_certificate_type_get
724
certificate_type_get.argtypes = [session_t]
725
certificate_type_get.restype = _error_code
727
certificate_get_peers = _library.gnutls_certificate_get_peers
728
certificate_get_peers.argtypes = [session_t,
729
ctypes.POINTER(ctypes.c_uint)]
730
certificate_get_peers.restype = ctypes.POINTER(datum_t)
732
global_set_log_level = _library.gnutls_global_set_log_level
733
global_set_log_level.argtypes = [ctypes.c_int]
734
global_set_log_level.restype = None
736
global_set_log_function = _library.gnutls_global_set_log_function
737
global_set_log_function.argtypes = [log_func]
738
global_set_log_function.restype = None
740
deinit = _library.gnutls_deinit
741
deinit.argtypes = [session_t]
742
deinit.restype = None
744
handshake = _library.gnutls_handshake
745
handshake.argtypes = [session_t]
746
handshake.restype = _error_code
747
handshake.errcheck = _retry_on_error
749
transport_set_ptr = _library.gnutls_transport_set_ptr
750
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
751
transport_set_ptr.restype = None
753
bye = _library.gnutls_bye
754
bye.argtypes = [session_t, close_request_t]
755
bye.restype = _error_code
756
bye.errcheck = _retry_on_error
758
check_version = _library.gnutls_check_version
759
check_version.argtypes = [ctypes.c_char_p]
760
check_version.restype = ctypes.c_char_p
762
_need_version = b"3.3.0"
763
if check_version(_need_version) is None:
764
raise self.Error("Needs GnuTLS {} or later"
765
.format(_need_version))
767
_tls_rawpk_version = b"3.6.6"
768
has_rawpk = bool(check_version(_tls_rawpk_version))
772
class pubkey_st(ctypes.Structure):
774
pubkey_t = ctypes.POINTER(pubkey_st)
776
x509_crt_fmt_t = ctypes.c_int
778
# All the function declarations below are from
780
pubkey_init = _library.gnutls_pubkey_init
781
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
782
pubkey_init.restype = _error_code
784
pubkey_import = _library.gnutls_pubkey_import
785
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
787
pubkey_import.restype = _error_code
789
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
790
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
791
ctypes.POINTER(ctypes.c_ubyte),
792
ctypes.POINTER(ctypes.c_size_t)]
793
pubkey_get_key_id.restype = _error_code
795
pubkey_deinit = _library.gnutls_pubkey_deinit
796
pubkey_deinit.argtypes = [pubkey_t]
797
pubkey_deinit.restype = None
799
# All the function declarations below are from
802
openpgp_crt_init = _library.gnutls_openpgp_crt_init
803
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
804
openpgp_crt_init.restype = _error_code
806
openpgp_crt_import = _library.gnutls_openpgp_crt_import
807
openpgp_crt_import.argtypes = [openpgp_crt_t,
808
ctypes.POINTER(datum_t),
810
openpgp_crt_import.restype = _error_code
812
openpgp_crt_verify_self = \
813
_library.gnutls_openpgp_crt_verify_self
814
openpgp_crt_verify_self.argtypes = [
817
ctypes.POINTER(ctypes.c_uint),
819
openpgp_crt_verify_self.restype = _error_code
821
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
822
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
823
openpgp_crt_deinit.restype = None
825
openpgp_crt_get_fingerprint = (
826
_library.gnutls_openpgp_crt_get_fingerprint)
827
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
831
openpgp_crt_get_fingerprint.restype = _error_code
833
if check_version(b"3.6.4"):
834
certificate_type_get2 = _library.gnutls_certificate_type_get2
835
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
836
certificate_type_get2.restype = _error_code
838
# Remove non-public functions
839
del _error_code, _retry_on_error
842
def call_pipe(connection, # : multiprocessing.Connection
843
func, *args, **kwargs):
844
"""This function is meant to be called by multiprocessing.Process
846
This function runs func(*args, **kwargs), and writes the resulting
847
return value on the provided multiprocessing.Connection.
849
connection.send(func(*args, **kwargs))
233
class Client(object):
854
234
"""A representation of a client host served by this server.
857
approved: bool(); 'None' if not yet approved/disapproved
858
approval_delay: datetime.timedelta(); Time to wait for approval
859
approval_duration: datetime.timedelta(); Duration of one approval
860
checker: multiprocessing.Process(); a running checker process used
861
to see if the client lives. 'None' if no process is
863
checker_callback_tag: a GLib event source tag, or None
864
checker_command: string; External command which is run to check
865
if client lives. %() expansions are done at
866
runtime with vars(self) as dict, so that for
867
instance %(name)s can be used in the command.
868
checker_initiator_tag: a GLib event source tag, or None
237
name: string; from the config file, used in log messages and
239
fingerprint: string (40 or 32 hexadecimal digits); used to
240
uniquely identify the client
241
secret: bytestring; sent verbatim (over TLS) to client
242
host: string; available for use by the checker command
869
243
created: datetime.datetime(); (UTC) object creation
870
client_structure: Object describing what attributes a client has
871
and is used for storing the client at exit
872
current_checker_command: string; current running checker_command
873
disable_initiator_tag: a GLib event source tag, or None
244
last_enabled: datetime.datetime(); (UTC)
875
fingerprint: string (40 or 32 hexadecimal digits); used to
876
uniquely identify an OpenPGP client
877
key_id: string (64 hexadecimal digits); used to uniquely identify
878
a client using raw public keys
879
host: string; available for use by the checker command
880
interval: datetime.timedelta(); How often to start a new checker
881
last_approval_request: datetime.datetime(); (UTC) or None
882
246
last_checked_ok: datetime.datetime(); (UTC) or None
883
last_checker_status: integer between 0 and 255 reflecting exit
884
status of last checker. -1 reflects crashed
885
checker, -2 means no checker completed yet.
886
last_checker_signal: The signal which killed the last checker, if
887
last_checker_status is -1
888
last_enabled: datetime.datetime(); (UTC) or None
889
name: string; from the config file, used in log messages and
891
secret: bytestring; sent verbatim (over TLS) to client
892
247
timeout: datetime.timedelta(); How long from last_checked_ok
893
248
until this client is disabled
894
extended_timeout: extra long timeout when secret has been sent
895
runtime_expansions: Allowed attributes for runtime expansion.
896
expires: datetime.datetime(); time (UTC) when a client will be
898
server_settings: The server_settings dict from main()
249
interval: datetime.timedelta(); How often to start a new checker
250
disable_hook: If set, called by disable() as disable_hook(self)
251
checker: subprocess.Popen(); a running checker process used
252
to see if the client lives.
253
'None' if no process is running.
254
checker_initiator_tag: a gobject event source tag, or None
255
disable_initiator_tag: - '' -
256
checker_callback_tag: - '' -
257
checker_command: string; External command which is run to check if
258
client lives. %() expansions are done at
259
runtime with vars(self) as dict, so that for
260
instance %(name)s can be used in the command.
261
current_checker_command: string; current running checker_command
901
runtime_expansions = ("approval_delay", "approval_duration",
902
"created", "enabled", "expires", "key_id",
903
"fingerprint", "host", "interval",
904
"last_approval_request", "last_checked_ok",
905
"last_enabled", "name", "timeout")
908
"extended_timeout": "PT15M",
910
"checker": "fping -q -- %%(host)s",
912
"approval_delay": "PT0S",
913
"approval_duration": "PT1S",
914
"approved_by_default": "True",
919
def config_parser(config):
920
"""Construct a new dict of client settings of this form:
921
{ client_name: {setting_name: value, ...}, ...}
922
with exceptions for any special settings as defined above.
923
NOTE: Must be a pure function. Must return the same result
924
value given the same arguments.
927
for client_name in config.sections():
928
section = dict(config.items(client_name))
929
client = settings[client_name] = {}
931
client["host"] = section["host"]
932
# Reformat values from string types to Python types
933
client["approved_by_default"] = config.getboolean(
934
client_name, "approved_by_default")
935
client["enabled"] = config.getboolean(client_name,
938
# Uppercase and remove spaces from key_id and fingerprint
939
# for later comparison purposes with return value from the
940
# key_id() and fingerprint() functions
941
client["key_id"] = (section.get("key_id", "").upper()
943
client["fingerprint"] = (section["fingerprint"].upper()
945
if "secret" in section:
946
client["secret"] = codecs.decode(section["secret"]
949
elif "secfile" in section:
950
with open(os.path.expanduser(os.path.expandvars
951
(section["secfile"])),
953
client["secret"] = secfile.read()
955
raise TypeError("No secret or secfile for section {}"
957
client["timeout"] = string_to_delta(section["timeout"])
958
client["extended_timeout"] = string_to_delta(
959
section["extended_timeout"])
960
client["interval"] = string_to_delta(section["interval"])
961
client["approval_delay"] = string_to_delta(
962
section["approval_delay"])
963
client["approval_duration"] = string_to_delta(
964
section["approval_duration"])
965
client["checker_command"] = section["checker"]
966
client["last_approval_request"] = None
967
client["last_checked_ok"] = None
968
client["last_checker_status"] = -2
972
def __init__(self, settings, name=None, server_settings=None):
265
def _timedelta_to_milliseconds(td):
266
"Convert a datetime.timedelta() to milliseconds"
267
return ((td.days * 24 * 60 * 60 * 1000)
268
+ (td.seconds * 1000)
269
+ (td.microseconds // 1000))
271
def timeout_milliseconds(self):
272
"Return the 'timeout' attribute in milliseconds"
273
return self._timedelta_to_milliseconds(self.timeout)
275
def interval_milliseconds(self):
276
"Return the 'interval' attribute in milliseconds"
277
return self._timedelta_to_milliseconds(self.interval)
279
def __init__(self, name = None, disable_hook=None, config=None):
280
"""Note: the 'checker' key in 'config' sets the
281
'checker_command' attribute and *not* the 'checker'
974
if server_settings is None:
976
self.server_settings = server_settings
977
# adding all client settings
978
for setting, value in settings.items():
979
setattr(self, setting, value)
982
if not hasattr(self, "last_enabled"):
983
self.last_enabled = datetime.datetime.utcnow()
984
if not hasattr(self, "expires"):
985
self.expires = (datetime.datetime.utcnow()
286
logger.debug(u"Creating client %r", self.name)
287
# Uppercase and remove spaces from fingerprint for later
288
# comparison purposes with return value from the fingerprint()
290
self.fingerprint = (config[u"fingerprint"].upper()
292
logger.debug(u" Fingerprint: %s", self.fingerprint)
293
if u"secret" in config:
294
self.secret = config[u"secret"].decode(u"base64")
295
elif u"secfile" in config:
296
with open(os.path.expanduser(os.path.expandvars
297
(config[u"secfile"])),
299
self.secret = secfile.read()
988
self.last_enabled = None
991
logger.debug("Creating client %r", self.name)
992
logger.debug(" Key ID: %s", self.key_id)
993
logger.debug(" Fingerprint: %s", self.fingerprint)
994
self.created = settings.get("created",
995
datetime.datetime.utcnow())
997
# attributes specific for this server instance
301
raise TypeError(u"No secret or secfile for client %s"
303
self.host = config.get(u"host", u"")
304
self.created = datetime.datetime.utcnow()
306
self.last_enabled = None
307
self.last_checked_ok = None
308
self.timeout = string_to_delta(config[u"timeout"])
309
self.interval = string_to_delta(config[u"interval"])
310
self.disable_hook = disable_hook
998
311
self.checker = None
999
312
self.checker_initiator_tag = None
1000
313
self.disable_initiator_tag = None
1001
314
self.checker_callback_tag = None
315
self.checker_command = config[u"checker"]
1002
316
self.current_checker_command = None
1003
self.approved = None
1004
self.approvals_pending = 0
1005
self.changedstate = multiprocessing_manager.Condition(
1006
multiprocessing_manager.Lock())
1007
self.client_structure = [attr
1008
for attr in self.__dict__.keys()
1009
if not attr.startswith("_")]
1010
self.client_structure.append("client_structure")
1012
for name, t in inspect.getmembers(
1013
type(self), lambda obj: isinstance(obj, property)):
1014
if not name.startswith("_"):
1015
self.client_structure.append(name)
1017
# Send notice to process children that client state has changed
1018
def send_changedstate(self):
1019
with self.changedstate:
1020
self.changedstate.notify_all()
317
self.last_connect = None
1022
319
def enable(self):
1023
320
"""Start this client's checker and timeout hooks"""
1024
if getattr(self, "enabled", False):
321
if getattr(self, u"enabled", False):
1025
322
# Already enabled
1027
self.expires = datetime.datetime.utcnow() + self.timeout
1029
324
self.last_enabled = datetime.datetime.utcnow()
1031
self.send_changedstate()
325
# Schedule a new checker to be started an 'interval' from now,
326
# and every interval from then on.
327
self.checker_initiator_tag = (gobject.timeout_add
328
(self.interval_milliseconds(),
330
# Schedule a disable() when 'timeout' has passed
331
self.disable_initiator_tag = (gobject.timeout_add
332
(self.timeout_milliseconds(),
335
# Also start a new checker *right now*.
1033
338
def disable(self, quiet=True):
1034
339
"""Disable this client."""
1035
340
if not getattr(self, "enabled", False):
1038
logger.info("Disabling client %s", self.name)
1039
if getattr(self, "disable_initiator_tag", None) is not None:
1040
GLib.source_remove(self.disable_initiator_tag)
343
logger.info(u"Disabling client %s", self.name)
344
if getattr(self, u"disable_initiator_tag", False):
345
gobject.source_remove(self.disable_initiator_tag)
1041
346
self.disable_initiator_tag = None
1043
if getattr(self, "checker_initiator_tag", None) is not None:
1044
GLib.source_remove(self.checker_initiator_tag)
347
if getattr(self, u"checker_initiator_tag", False):
348
gobject.source_remove(self.checker_initiator_tag)
1045
349
self.checker_initiator_tag = None
1046
350
self.stop_checker()
351
if self.disable_hook:
352
self.disable_hook(self)
1047
353
self.enabled = False
1049
self.send_changedstate()
1050
# Do not run this again if called by a GLib.timeout_add
354
# Do not run this again if called by a gobject.timeout_add
1053
357
def __del__(self):
358
self.disable_hook = None
1056
def init_checker(self):
1057
# Schedule a new checker to be started an 'interval' from now,
1058
# and every interval from then on.
1059
if self.checker_initiator_tag is not None:
1060
GLib.source_remove(self.checker_initiator_tag)
1061
self.checker_initiator_tag = GLib.timeout_add(
1062
random.randrange(int(self.interval.total_seconds() * 1000
1065
# Schedule a disable() when 'timeout' has passed
1066
if self.disable_initiator_tag is not None:
1067
GLib.source_remove(self.disable_initiator_tag)
1068
self.disable_initiator_tag = GLib.timeout_add(
1069
int(self.timeout.total_seconds() * 1000), self.disable)
1070
# Also start a new checker *right now*.
1071
self.start_checker()
1073
def checker_callback(self, source, condition, connection,
361
def checker_callback(self, pid, condition, command):
1075
362
"""The checker has completed, so take appropriate actions."""
1076
# Read return code from connection (see call_pipe)
1077
returncode = connection.recv()
1079
if self.checker is not None:
1081
363
self.checker_callback_tag = None
1082
364
self.checker = None
1085
self.last_checker_status = returncode
1086
self.last_checker_signal = None
1087
if self.last_checker_status == 0:
1088
logger.info("Checker for %(name)s succeeded",
365
if os.WIFEXITED(condition):
366
exitstatus = os.WEXITSTATUS(condition)
368
logger.info(u"Checker for %(name)s succeeded",
1090
370
self.checked_ok()
1092
logger.info("Checker for %(name)s failed", vars(self))
372
logger.info(u"Checker for %(name)s failed",
1094
self.last_checker_status = -1
1095
self.last_checker_signal = -returncode
1096
logger.warning("Checker for %(name)s crashed?",
375
logger.warning(u"Checker for %(name)s crashed?",
1100
378
def checked_ok(self):
1101
"""Assert that the client has been seen, alive and well."""
379
"""Bump up the timeout for this client.
381
This should only be called when the client has been seen,
1102
384
self.last_checked_ok = datetime.datetime.utcnow()
1103
self.last_checker_status = 0
1104
self.last_checker_signal = None
1107
def bump_timeout(self, timeout=None):
1108
"""Bump up the timeout for this client."""
1110
timeout = self.timeout
1111
if self.disable_initiator_tag is not None:
1112
GLib.source_remove(self.disable_initiator_tag)
1113
self.disable_initiator_tag = None
1114
if getattr(self, "enabled", False):
1115
self.disable_initiator_tag = GLib.timeout_add(
1116
int(timeout.total_seconds() * 1000), self.disable)
1117
self.expires = datetime.datetime.utcnow() + timeout
1119
def need_approval(self):
1120
self.last_approval_request = datetime.datetime.utcnow()
385
gobject.source_remove(self.disable_initiator_tag)
386
self.disable_initiator_tag = (gobject.timeout_add
387
(self.timeout_milliseconds(),
1122
390
def start_checker(self):
1123
391
"""Start a new checker subprocess if one is not running.
1125
393
If a checker already exists, leave it running and do
1127
395
# The reason for not killing a running checker is that if we
1128
# did that, and if a checker (for some reason) started running
1129
# slowly and taking more than 'interval' time, then the client
1130
# would inevitably timeout, since no checker would get a
1131
# chance to run to completion. If we instead leave running
396
# did that, then if a checker (for some reason) started
397
# running slowly and taking more than 'interval' time, the
398
# client would inevitably timeout, since no checker would get
399
# a chance to run to completion. If we instead leave running
1132
400
# checkers alone, the checker would have to take more time
1133
401
# than 'timeout' for the client to be disabled, which is as it
1136
if self.checker is not None and not self.checker.is_alive():
1137
logger.warning("Checker was not alive; joining")
404
# If a checker exists, make sure it is not a zombie
406
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
407
except (AttributeError, OSError), error:
408
if (isinstance(error, OSError)
409
and error.errno != errno.ECHILD):
413
logger.warning(u"Checker was a zombie")
414
gobject.source_remove(self.checker_callback_tag)
415
self.checker_callback(pid, status,
416
self.current_checker_command)
1140
417
# Start a new checker if needed
1141
418
if self.checker is None:
1142
# Escape attributes for the shell
1144
attr: shlex.quote(str(getattr(self, attr)))
1145
for attr in self.runtime_expansions}
1147
command = self.checker_command % escaped_attrs
1148
except TypeError as error:
1149
logger.error('Could not format string "%s"',
1150
self.checker_command,
1152
return True # Try again later
420
# In case checker_command has exactly one % operator
421
command = self.checker_command % self.host
423
# Escape attributes for the shell
424
escaped_attrs = dict((key,
425
re.escape(unicode(str(val),
429
vars(self).iteritems())
431
command = self.checker_command % escaped_attrs
432
except TypeError, error:
433
logger.error(u'Could not format string "%s":'
434
u' %s', self.checker_command, error)
435
return True # Try again later
1153
436
self.current_checker_command = command
1154
logger.info("Starting checker %r for %s", command,
1156
# We don't need to redirect stdout and stderr, since
1157
# in normal mode, that is already done by daemon(),
1158
# and in debug mode we don't want to. (Stdin is
1159
# always replaced by /dev/null.)
1160
# The exception is when not debugging but nevertheless
1161
# running in the foreground; use the previously
1163
popen_args = {"close_fds": True,
1166
if (not self.server_settings["debug"]
1167
and self.server_settings["foreground"]):
1168
popen_args.update({"stdout": wnull,
1170
pipe = multiprocessing.Pipe(duplex=False)
1171
self.checker = multiprocessing.Process(
1173
args=(pipe[1], subprocess.call, command),
1175
self.checker.start()
1176
self.checker_callback_tag = GLib.io_add_watch(
1177
GLib.IOChannel.unix_new(pipe[0].fileno()),
1178
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1179
self.checker_callback, pipe[0], command)
1180
# Re-run this periodically if run by GLib.timeout_add
438
logger.info(u"Starting checker %r for %s",
440
# We don't need to redirect stdout and stderr, since
441
# in normal mode, that is already done by daemon(),
442
# and in debug mode we don't want to. (Stdin is
443
# always replaced by /dev/null.)
444
self.checker = subprocess.Popen(command,
446
shell=True, cwd=u"/")
447
self.checker_callback_tag = (gobject.child_watch_add
449
self.checker_callback,
451
# The checker may have completed before the gobject
452
# watch was added. Check for this.
453
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
455
gobject.source_remove(self.checker_callback_tag)
456
self.checker_callback(pid, status, command)
457
except OSError, error:
458
logger.error(u"Failed to start subprocess: %s",
460
# Re-run this periodically if run by gobject.timeout_add
1183
463
def stop_checker(self):
1184
464
"""Force the checker process, if any, to stop."""
1185
465
if self.checker_callback_tag:
1186
GLib.source_remove(self.checker_callback_tag)
466
gobject.source_remove(self.checker_callback_tag)
1187
467
self.checker_callback_tag = None
1188
if getattr(self, "checker", None) is None:
468
if getattr(self, u"checker", None) is None:
1190
logger.debug("Stopping checker for %(name)s", vars(self))
1191
self.checker.terminate()
470
logger.debug(u"Stopping checker for %(name)s", vars(self))
472
os.kill(self.checker.pid, signal.SIGTERM)
474
#if self.checker.poll() is None:
475
# os.kill(self.checker.pid, signal.SIGKILL)
476
except OSError, error:
477
if error.errno != errno.ESRCH: # No such process
1192
479
self.checker = None
1195
def dbus_service_property(dbus_interface,
482
def dbus_service_property(dbus_interface, signature=u"v",
483
access=u"readwrite", byte_arrays=False):
1199
484
"""Decorators for marking methods of a DBusObjectWithProperties to
1200
485
become properties on the D-Bus.
1202
487
The decorated method will be called with no arguments by "Get"
1203
488
and with one argument by "Set".
1205
490
The parameters, where they are supported, are the same as
1206
491
dbus.service.method, except there is only "signature", since the
1207
492
type from Get() and the type sent to Set() is the same.
1209
494
# Encoding deeply encoded byte arrays is not supported yet by the
1210
495
# "Set" method, so we fail early here:
1211
if byte_arrays and signature != "ay":
1212
raise ValueError("Byte arrays not supported for non-'ay'"
1213
" signature {!r}".format(signature))
496
if byte_arrays and signature != u"ay":
497
raise ValueError(u"Byte arrays not supported for non-'ay'"
498
u" signature %r" % signature)
1215
499
def decorator(func):
1216
500
func._dbus_is_property = True
1217
501
func._dbus_interface = dbus_interface
1218
502
func._dbus_signature = signature
1219
503
func._dbus_access = access
1220
504
func._dbus_name = func.__name__
1221
if func._dbus_name.endswith("_dbus_property"):
505
if func._dbus_name.endswith(u"_dbus_property"):
1222
506
func._dbus_name = func._dbus_name[:-14]
1223
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1229
def dbus_interface_annotations(dbus_interface):
1230
"""Decorator for marking functions returning interface annotations
1234
@dbus_interface_annotations("org.example.Interface")
1235
def _foo(self): # Function name does not matter
1236
return {"org.freedesktop.DBus.Deprecated": "true",
1237
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1241
def decorator(func):
1242
func._dbus_is_interface = True
1243
func._dbus_interface = dbus_interface
1244
func._dbus_name = dbus_interface
1250
def dbus_annotations(annotations):
1251
"""Decorator to annotate D-Bus methods, signals or properties
1254
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1255
"org.freedesktop.DBus.Property."
1256
"EmitsChangedSignal": "false"})
1257
@dbus_service_property("org.example.Interface", signature="b",
1259
def Property_dbus_property(self):
1260
return dbus.Boolean(False)
1262
See also the DBusObjectWithAnnotations class.
1265
def decorator(func):
1266
func._dbus_annotations = annotations
507
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
1269
509
return decorator
1272
512
class DBusPropertyException(dbus.exceptions.DBusException):
1273
513
"""A base class for D-Bus property-related exceptions
515
def __unicode__(self):
516
return unicode(str(self))
1278
519
class DBusPropertyAccessException(DBusPropertyException):
1290
class DBusObjectWithAnnotations(dbus.service.Object):
1291
"""A D-Bus object with annotations.
1293
Classes inheriting from this can use the dbus_annotations
1294
decorator to add annotations to methods or signals.
1298
def _is_dbus_thing(thing):
1299
"""Returns a function testing if an attribute is a D-Bus thing
1301
If called like _is_dbus_thing("method") it returns a function
1302
suitable for use as predicate to inspect.getmembers().
1304
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1307
def _get_all_dbus_things(self, thing):
1308
"""Returns a generator of (name, attribute) pairs
1310
return ((getattr(athing.__get__(self), "_dbus_name", name),
1311
athing.__get__(self))
1312
for cls in self.__class__.__mro__
1314
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1316
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1318
path_keyword='object_path',
1319
connection_keyword='connection')
1320
def Introspect(self, object_path, connection):
1321
"""Overloading of standard D-Bus method.
1323
Inserts annotation tags on methods and signals.
1325
xmlstring = dbus.service.Object.Introspect(self, object_path,
1328
document = xml.dom.minidom.parseString(xmlstring)
1330
for if_tag in document.getElementsByTagName("interface"):
1331
# Add annotation tags
1332
for typ in ("method", "signal"):
1333
for tag in if_tag.getElementsByTagName(typ):
1335
for name, prop in (self.
1336
_get_all_dbus_things(typ)):
1337
if (name == tag.getAttribute("name")
1338
and prop._dbus_interface
1339
== if_tag.getAttribute("name")):
1340
annots.update(getattr(
1341
prop, "_dbus_annotations", {}))
1342
for name, value in annots.items():
1343
ann_tag = document.createElement(
1345
ann_tag.setAttribute("name", name)
1346
ann_tag.setAttribute("value", value)
1347
tag.appendChild(ann_tag)
1348
# Add interface annotation tags
1349
for annotation, value in dict(
1350
itertools.chain.from_iterable(
1351
annotations().items()
1352
for name, annotations
1353
in self._get_all_dbus_things("interface")
1354
if name == if_tag.getAttribute("name")
1356
ann_tag = document.createElement("annotation")
1357
ann_tag.setAttribute("name", annotation)
1358
ann_tag.setAttribute("value", value)
1359
if_tag.appendChild(ann_tag)
1360
# Fix argument name for the Introspect method itself
1361
if (if_tag.getAttribute("name")
1362
== dbus.INTROSPECTABLE_IFACE):
1363
for cn in if_tag.getElementsByTagName("method"):
1364
if cn.getAttribute("name") == "Introspect":
1365
for arg in cn.getElementsByTagName("arg"):
1366
if (arg.getAttribute("direction")
1368
arg.setAttribute("name",
1370
xmlstring = document.toxml("utf-8")
1372
except (AttributeError, xml.dom.DOMException,
1373
xml.parsers.expat.ExpatError) as error:
1374
logger.error("Failed to override Introspection method",
1379
class DBusObjectWithProperties(DBusObjectWithAnnotations):
531
class DBusObjectWithProperties(dbus.service.Object):
1380
532
"""A D-Bus object with properties.
1382
534
Classes inheriting from this can use the dbus_service_property
1383
535
decorator to expose methods as D-Bus properties. It exposes the
1384
536
standard Get(), Set(), and GetAll() methods on the D-Bus.
540
def _is_dbus_property(obj):
541
return getattr(obj, u"_dbus_is_property", False)
543
def _get_all_dbus_properties(self):
544
"""Returns a generator of (name, attribute) pairs
546
return ((prop._dbus_name, prop)
548
inspect.getmembers(self, self._is_dbus_property))
1387
550
def _get_dbus_property(self, interface_name, property_name):
1388
551
"""Returns a bound method if one exists which is a D-Bus
1389
552
property with the specified name and interface.
1391
for cls in self.__class__.__mro__:
1392
for name, value in inspect.getmembers(
1393
cls, self._is_dbus_thing("property")):
1394
if (value._dbus_name == property_name
1395
and value._dbus_interface == interface_name):
1396
return value.__get__(self)
554
for name in (property_name,
555
property_name + u"_dbus_property"):
556
prop = getattr(self, name, None)
558
or not self._is_dbus_property(prop)
559
or prop._dbus_name != property_name
560
or (interface_name and prop._dbus_interface
561
and interface_name != prop._dbus_interface)):
1398
564
# No such property
1399
raise DBusPropertyNotFound("{}:{}.{}".format(
1400
self.dbus_object_path, interface_name, property_name))
1403
def _get_all_interface_names(cls):
1404
"""Get a sequence of all interfaces supported by an object"""
1405
return (name for name in set(getattr(getattr(x, attr),
1406
"_dbus_interface", None)
1407
for x in (inspect.getmro(cls))
1409
if name is not None)
1411
@dbus.service.method(dbus.PROPERTIES_IFACE,
565
raise DBusPropertyNotFound(self.dbus_object_path + u":"
566
+ interface_name + u"."
569
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
1414
571
def Get(self, interface_name, property_name):
1415
572
"""Standard D-Bus property Get() method, see D-Bus standard.
1417
574
prop = self._get_dbus_property(interface_name, property_name)
1418
if prop._dbus_access == "write":
575
if prop._dbus_access == u"write":
1419
576
raise DBusPropertyAccessException(property_name)
1421
if not hasattr(value, "variant_level"):
578
if not hasattr(value, u"variant_level"):
1423
580
return type(value)(value, variant_level=value.variant_level+1)
1425
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
582
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1426
583
def Set(self, interface_name, property_name, value):
1427
584
"""Standard D-Bus property Set() method, see D-Bus standard.
1429
586
prop = self._get_dbus_property(interface_name, property_name)
1430
if prop._dbus_access == "read":
587
if prop._dbus_access == u"read":
1431
588
raise DBusPropertyAccessException(property_name)
1432
if prop._dbus_get_args_options["byte_arrays"]:
589
if prop._dbus_get_args_options[u"byte_arrays"]:
1433
590
# The byte_arrays option is not supported yet on
1434
591
# signatures other than "ay".
1435
if prop._dbus_signature != "ay":
1436
raise ValueError("Byte arrays not supported for non-"
1437
"'ay' signature {!r}"
1438
.format(prop._dbus_signature))
1439
value = dbus.ByteArray(bytes(value))
592
if prop._dbus_signature != u"ay":
594
value = dbus.ByteArray(''.join(unichr(byte)
1442
@dbus.service.method(dbus.PROPERTIES_IFACE,
1444
out_signature="a{sv}")
598
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
599
out_signature=u"a{sv}")
1445
600
def GetAll(self, interface_name):
1446
601
"""Standard D-Bus property GetAll() method, see D-Bus
1449
604
Note: Will not include properties with access="write".
1452
for name, prop in self._get_all_dbus_things("property"):
607
for name, prop in self._get_all_dbus_properties():
1453
608
if (interface_name
1454
609
and interface_name != prop._dbus_interface):
1455
610
# Interface non-empty but did not match
1457
612
# Ignore write-only properties
1458
if prop._dbus_access == "write":
613
if prop._dbus_access == u"write":
1461
if not hasattr(value, "variant_level"):
1462
properties[name] = value
616
if not hasattr(value, u"variant_level"):
1464
properties[name] = type(value)(
1465
value, variant_level=value.variant_level + 1)
1466
return dbus.Dictionary(properties, signature="sv")
1468
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1469
def PropertiesChanged(self, interface_name, changed_properties,
1470
invalidated_properties):
1471
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
619
all[name] = type(value)(value, variant_level=
620
value.variant_level+1)
621
return dbus.Dictionary(all, signature=u"sv")
1476
623
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1478
625
path_keyword='object_path',
1479
626
connection_keyword='connection')
1480
627
def Introspect(self, object_path, connection):
1481
"""Overloading of standard D-Bus method.
1483
Inserts property tags and interface annotation tags.
628
"""Standard D-Bus method, overloaded to insert property tags.
1485
xmlstring = DBusObjectWithAnnotations.Introspect(self,
630
xmlstring = dbus.service.Object.Introspect(self, object_path,
1489
633
document = xml.dom.minidom.parseString(xmlstring)
1491
634
def make_tag(document, name, prop):
1492
e = document.createElement("property")
1493
e.setAttribute("name", name)
1494
e.setAttribute("type", prop._dbus_signature)
1495
e.setAttribute("access", prop._dbus_access)
635
e = document.createElement(u"property")
636
e.setAttribute(u"name", name)
637
e.setAttribute(u"type", prop._dbus_signature)
638
e.setAttribute(u"access", prop._dbus_access)
1498
for if_tag in document.getElementsByTagName("interface"):
640
for if_tag in document.getElementsByTagName(u"interface"):
1500
641
for tag in (make_tag(document, name, prop)
1502
in self._get_all_dbus_things("property")
643
in self._get_all_dbus_properties()
1503
644
if prop._dbus_interface
1504
== if_tag.getAttribute("name")):
645
== if_tag.getAttribute(u"name")):
1505
646
if_tag.appendChild(tag)
1506
# Add annotation tags for properties
1507
for tag in if_tag.getElementsByTagName("property"):
1509
for name, prop in self._get_all_dbus_things(
1511
if (name == tag.getAttribute("name")
1512
and prop._dbus_interface
1513
== if_tag.getAttribute("name")):
1514
annots.update(getattr(
1515
prop, "_dbus_annotations", {}))
1516
for name, value in annots.items():
1517
ann_tag = document.createElement(
1519
ann_tag.setAttribute("name", name)
1520
ann_tag.setAttribute("value", value)
1521
tag.appendChild(ann_tag)
1522
647
# Add the names to the return values for the
1523
648
# "org.freedesktop.DBus.Properties" methods
1524
if (if_tag.getAttribute("name")
1525
== "org.freedesktop.DBus.Properties"):
1526
for cn in if_tag.getElementsByTagName("method"):
1527
if cn.getAttribute("name") == "Get":
1528
for arg in cn.getElementsByTagName("arg"):
1529
if (arg.getAttribute("direction")
1531
arg.setAttribute("name", "value")
1532
elif cn.getAttribute("name") == "GetAll":
1533
for arg in cn.getElementsByTagName("arg"):
1534
if (arg.getAttribute("direction")
1536
arg.setAttribute("name", "props")
1537
xmlstring = document.toxml("utf-8")
1539
except (AttributeError, xml.dom.DOMException,
1540
xml.parsers.expat.ExpatError) as error:
1541
logger.error("Failed to override Introspection method",
1547
dbus.OBJECT_MANAGER_IFACE
1548
except AttributeError:
1549
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1552
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1553
"""A D-Bus object with an ObjectManager.
1555
Classes inheriting from this exposes the standard
1556
GetManagedObjects call and the InterfacesAdded and
1557
InterfacesRemoved signals on the standard
1558
"org.freedesktop.DBus.ObjectManager" interface.
1560
Note: No signals are sent automatically; they must be sent
1563
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1564
out_signature="a{oa{sa{sv}}}")
1565
def GetManagedObjects(self):
1566
"""This function must be overridden"""
1567
raise NotImplementedError()
1569
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1570
signature="oa{sa{sv}}")
1571
def InterfacesAdded(self, object_path, interfaces_and_properties):
1574
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1575
def InterfacesRemoved(self, object_path, interfaces):
1578
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1580
path_keyword='object_path',
1581
connection_keyword='connection')
1582
def Introspect(self, object_path, connection):
1583
"""Overloading of standard D-Bus method.
1585
Override return argument name of GetManagedObjects to be
1586
"objpath_interfaces_and_properties"
1588
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1592
document = xml.dom.minidom.parseString(xmlstring)
1594
for if_tag in document.getElementsByTagName("interface"):
1595
# Fix argument name for the GetManagedObjects method
1596
if (if_tag.getAttribute("name")
1597
== dbus.OBJECT_MANAGER_IFACE):
1598
for cn in if_tag.getElementsByTagName("method"):
1599
if (cn.getAttribute("name")
1600
== "GetManagedObjects"):
1601
for arg in cn.getElementsByTagName("arg"):
1602
if (arg.getAttribute("direction")
1606
"objpath_interfaces"
1608
xmlstring = document.toxml("utf-8")
1610
except (AttributeError, xml.dom.DOMException,
1611
xml.parsers.expat.ExpatError) as error:
1612
logger.error("Failed to override Introspection method",
1617
def datetime_to_dbus(dt, variant_level=0):
1618
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1620
return dbus.String("", variant_level=variant_level)
1621
return dbus.String(dt.isoformat(), variant_level=variant_level)
1624
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1625
"""A class decorator; applied to a subclass of
1626
dbus.service.Object, it will add alternate D-Bus attributes with
1627
interface names according to the "alt_interface_names" mapping.
1630
@alternate_dbus_interfaces({"org.example.Interface":
1631
"net.example.AlternateInterface"})
1632
class SampleDBusObject(dbus.service.Object):
1633
@dbus.service.method("org.example.Interface")
1634
def SampleDBusMethod():
1637
The above "SampleDBusMethod" on "SampleDBusObject" will be
1638
reachable via two interfaces: "org.example.Interface" and
1639
"net.example.AlternateInterface", the latter of which will have
1640
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1641
"true", unless "deprecate" is passed with a False value.
1643
This works for methods and signals, and also for D-Bus properties
1644
(from DBusObjectWithProperties) and interfaces (from the
1645
dbus_interface_annotations decorator).
1649
for orig_interface_name, alt_interface_name in (
1650
alt_interface_names.items()):
1652
interface_names = set()
1653
# Go though all attributes of the class
1654
for attrname, attribute in inspect.getmembers(cls):
1655
# Ignore non-D-Bus attributes, and D-Bus attributes
1656
# with the wrong interface name
1657
if (not hasattr(attribute, "_dbus_interface")
1658
or not attribute._dbus_interface.startswith(
1659
orig_interface_name)):
1661
# Create an alternate D-Bus interface name based on
1663
alt_interface = attribute._dbus_interface.replace(
1664
orig_interface_name, alt_interface_name)
1665
interface_names.add(alt_interface)
1666
# Is this a D-Bus signal?
1667
if getattr(attribute, "_dbus_is_signal", False):
1668
# Extract the original non-method undecorated
1669
# function by black magic
1670
if sys.version_info.major == 2:
1671
nonmethod_func = (dict(
1672
zip(attribute.func_code.co_freevars,
1673
attribute.__closure__))
1674
["func"].cell_contents)
1676
nonmethod_func = (dict(
1677
zip(attribute.__code__.co_freevars,
1678
attribute.__closure__))
1679
["func"].cell_contents)
1680
# Create a new, but exactly alike, function
1681
# object, and decorate it to be a new D-Bus signal
1682
# with the alternate D-Bus interface name
1683
new_function = copy_function(nonmethod_func)
1684
new_function = (dbus.service.signal(
1686
attribute._dbus_signature)(new_function))
1687
# Copy annotations, if any
1689
new_function._dbus_annotations = dict(
1690
attribute._dbus_annotations)
1691
except AttributeError:
1694
# Define a creator of a function to call both the
1695
# original and alternate functions, so both the
1696
# original and alternate signals gets sent when
1697
# the function is called
1698
def fixscope(func1, func2):
1699
"""This function is a scope container to pass
1700
func1 and func2 to the "call_both" function
1701
outside of its arguments"""
1703
@functools.wraps(func2)
1704
def call_both(*args, **kwargs):
1705
"""This function will emit two D-Bus
1706
signals by calling func1 and func2"""
1707
func1(*args, **kwargs)
1708
func2(*args, **kwargs)
1709
# Make wrapper function look like a D-Bus
1711
for name, attr in inspect.getmembers(func2):
1712
if name.startswith("_dbus_"):
1713
setattr(call_both, name, attr)
1716
# Create the "call_both" function and add it to
1718
attr[attrname] = fixscope(attribute, new_function)
1719
# Is this a D-Bus method?
1720
elif getattr(attribute, "_dbus_is_method", False):
1721
# Create a new, but exactly alike, function
1722
# object. Decorate it to be a new D-Bus method
1723
# with the alternate D-Bus interface name. Add it
1726
dbus.service.method(
1728
attribute._dbus_in_signature,
1729
attribute._dbus_out_signature)
1730
(copy_function(attribute)))
1731
# Copy annotations, if any
1733
attr[attrname]._dbus_annotations = dict(
1734
attribute._dbus_annotations)
1735
except AttributeError:
1737
# Is this a D-Bus property?
1738
elif getattr(attribute, "_dbus_is_property", False):
1739
# Create a new, but exactly alike, function
1740
# object, and decorate it to be a new D-Bus
1741
# property with the alternate D-Bus interface
1742
# name. Add it to the class.
1743
attr[attrname] = (dbus_service_property(
1744
alt_interface, attribute._dbus_signature,
1745
attribute._dbus_access,
1746
attribute._dbus_get_args_options
1748
(copy_function(attribute)))
1749
# Copy annotations, if any
1751
attr[attrname]._dbus_annotations = dict(
1752
attribute._dbus_annotations)
1753
except AttributeError:
1755
# Is this a D-Bus interface?
1756
elif getattr(attribute, "_dbus_is_interface", False):
1757
# Create a new, but exactly alike, function
1758
# object. Decorate it to be a new D-Bus interface
1759
# with the alternate D-Bus interface name. Add it
1762
dbus_interface_annotations(alt_interface)
1763
(copy_function(attribute)))
1765
# Deprecate all alternate interfaces
1766
iname = "_AlternateDBusNames_interface_annotation{}"
1767
for interface_name in interface_names:
1769
@dbus_interface_annotations(interface_name)
1771
return {"org.freedesktop.DBus.Deprecated":
1773
# Find an unused name
1774
for aname in (iname.format(i)
1775
for i in itertools.count()):
1776
if aname not in attr:
1780
# Replace the class with a new subclass of it with
1781
# methods, signals, etc. as created above.
1782
if sys.version_info.major == 2:
1783
cls = type(b"{}Alternate".format(cls.__name__),
1786
cls = type("{}Alternate".format(cls.__name__),
1793
@alternate_dbus_interfaces({"se.recompile.Mandos":
1794
"se.bsnet.fukt.Mandos"})
649
if (if_tag.getAttribute(u"name")
650
== u"org.freedesktop.DBus.Properties"):
651
for cn in if_tag.getElementsByTagName(u"method"):
652
if cn.getAttribute(u"name") == u"Get":
653
for arg in cn.getElementsByTagName(u"arg"):
654
if (arg.getAttribute(u"direction")
656
arg.setAttribute(u"name", u"value")
657
elif cn.getAttribute(u"name") == u"GetAll":
658
for arg in cn.getElementsByTagName(u"arg"):
659
if (arg.getAttribute(u"direction")
661
arg.setAttribute(u"name", u"props")
662
xmlstring = document.toxml(u"utf-8")
664
except (AttributeError, xml.dom.DOMException,
665
xml.parsers.expat.ExpatError), error:
666
logger.error(u"Failed to override Introspection method",
1795
671
class ClientDBus(Client, DBusObjectWithProperties):
1796
672
"""A Client class using D-Bus
1799
675
dbus_object_path: dbus.ObjectPath
1800
676
bus: dbus.SystemBus()
1803
runtime_expansions = (Client.runtime_expansions
1804
+ ("dbus_object_path", ))
1806
_interface = "se.recompile.Mandos.Client"
1808
678
# dbus.service.Object doesn't use super(), so we can't either.
1810
def __init__(self, bus=None, *args, **kwargs):
680
def __init__(self, bus = None, *args, **kwargs):
1812
682
Client.__init__(self, *args, **kwargs)
1813
683
# Only now, when this client is initialized, can it show up on
1815
client_object_name = str(self.name).translate(
1816
{ord("."): ord("_"),
1817
ord("-"): ord("_")})
1818
self.dbus_object_path = dbus.ObjectPath(
1819
"/clients/" + client_object_name)
685
self.dbus_object_path = (dbus.ObjectPath
687
+ self.name.replace(u".", u"_")))
1820
688
DBusObjectWithProperties.__init__(self, self.bus,
1821
689
self.dbus_object_path)
1823
def notifychangeproperty(transform_func, dbus_name,
1824
type_func=lambda x: x,
1826
invalidate_only=False,
1827
_interface=_interface):
1828
""" Modify a variable so that it's a property which announces
1829
its changes to DBus.
1831
transform_fun: Function that takes a value and a variant_level
1832
and transforms it to a D-Bus type.
1833
dbus_name: D-Bus name of the variable
1834
type_func: Function that transform the value before sending it
1835
to the D-Bus. Default: no transform
1836
variant_level: D-Bus variant level. Default: 1
1838
attrname = "_{}".format(dbus_name)
1840
def setter(self, value):
1841
if hasattr(self, "dbus_object_path"):
1842
if (not hasattr(self, attrname) or
1843
type_func(getattr(self, attrname, None))
1844
!= type_func(value)):
1846
self.PropertiesChanged(
1847
_interface, dbus.Dictionary(),
1848
dbus.Array((dbus_name, )))
1850
dbus_value = transform_func(
1852
variant_level=variant_level)
1853
self.PropertyChanged(dbus.String(dbus_name),
1855
self.PropertiesChanged(
1857
dbus.Dictionary({dbus.String(dbus_name):
1860
setattr(self, attrname, value)
1862
return property(lambda self: getattr(self, attrname), setter)
1864
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1865
approvals_pending = notifychangeproperty(dbus.Boolean,
1868
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1869
last_enabled = notifychangeproperty(datetime_to_dbus,
1871
checker = notifychangeproperty(
1872
dbus.Boolean, "CheckerRunning",
1873
type_func=lambda checker: checker is not None)
1874
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1876
last_checker_status = notifychangeproperty(dbus.Int16,
1877
"LastCheckerStatus")
1878
last_approval_request = notifychangeproperty(
1879
datetime_to_dbus, "LastApprovalRequest")
1880
approved_by_default = notifychangeproperty(dbus.Boolean,
1881
"ApprovedByDefault")
1882
approval_delay = notifychangeproperty(
1883
dbus.UInt64, "ApprovalDelay",
1884
type_func=lambda td: td.total_seconds() * 1000)
1885
approval_duration = notifychangeproperty(
1886
dbus.UInt64, "ApprovalDuration",
1887
type_func=lambda td: td.total_seconds() * 1000)
1888
host = notifychangeproperty(dbus.String, "Host")
1889
timeout = notifychangeproperty(
1890
dbus.UInt64, "Timeout",
1891
type_func=lambda td: td.total_seconds() * 1000)
1892
extended_timeout = notifychangeproperty(
1893
dbus.UInt64, "ExtendedTimeout",
1894
type_func=lambda td: td.total_seconds() * 1000)
1895
interval = notifychangeproperty(
1896
dbus.UInt64, "Interval",
1897
type_func=lambda td: td.total_seconds() * 1000)
1898
checker_command = notifychangeproperty(dbus.String, "Checker")
1899
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1900
invalidate_only=True)
1902
del notifychangeproperty
692
def _datetime_to_dbus(dt, variant_level=0):
693
"""Convert a UTC datetime.datetime() to a D-Bus type."""
694
return dbus.String(dt.isoformat(),
695
variant_level=variant_level)
698
oldstate = getattr(self, u"enabled", False)
699
r = Client.enable(self)
700
if oldstate != self.enabled:
702
self.PropertyChanged(dbus.String(u"enabled"),
703
dbus.Boolean(True, variant_level=1))
704
self.PropertyChanged(
705
dbus.String(u"last_enabled"),
706
self._datetime_to_dbus(self.last_enabled,
710
def disable(self, quiet = False):
711
oldstate = getattr(self, u"enabled", False)
712
r = Client.disable(self, quiet=quiet)
713
if not quiet and oldstate != self.enabled:
715
self.PropertyChanged(dbus.String(u"enabled"),
716
dbus.Boolean(False, variant_level=1))
1904
719
def __del__(self, *args, **kwargs):
1906
721
self.remove_from_connection()
1907
722
except LookupError:
1909
if hasattr(DBusObjectWithProperties, "__del__"):
724
if hasattr(DBusObjectWithProperties, u"__del__"):
1910
725
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1911
726
Client.__del__(self, *args, **kwargs)
1913
def checker_callback(self, source, condition,
1914
connection, command, *args, **kwargs):
1915
ret = Client.checker_callback(self, source, condition,
1916
connection, command, *args,
1918
exitstatus = self.last_checker_status
728
def checker_callback(self, pid, condition, command,
730
self.checker_callback_tag = None
733
self.PropertyChanged(dbus.String(u"checker_running"),
734
dbus.Boolean(False, variant_level=1))
735
if os.WIFEXITED(condition):
736
exitstatus = os.WEXITSTATUS(condition)
1920
737
# Emit D-Bus signal
1921
738
self.CheckerCompleted(dbus.Int16(exitstatus),
1922
# This is specific to GNU libC
1923
dbus.Int64(exitstatus << 8),
739
dbus.Int64(condition),
1924
740
dbus.String(command))
1926
742
# Emit D-Bus signal
1927
743
self.CheckerCompleted(dbus.Int16(-1),
1929
# This is specific to GNU libC
1931
| self.last_checker_signal),
744
dbus.Int64(condition),
1932
745
dbus.String(command))
747
return Client.checker_callback(self, pid, condition, command,
750
def checked_ok(self, *args, **kwargs):
751
r = Client.checked_ok(self, *args, **kwargs)
753
self.PropertyChanged(
754
dbus.String(u"last_checked_ok"),
755
(self._datetime_to_dbus(self.last_checked_ok,
1935
759
def start_checker(self, *args, **kwargs):
1936
old_checker_pid = getattr(self.checker, "pid", None)
760
old_checker = self.checker
761
if self.checker is not None:
762
old_checker_pid = self.checker.pid
764
old_checker_pid = None
1937
765
r = Client.start_checker(self, *args, **kwargs)
1938
766
# Only if new checker process was started
1939
767
if (self.checker is not None
1940
768
and old_checker_pid != self.checker.pid):
1941
769
# Emit D-Bus signal
1942
770
self.CheckerStarted(self.current_checker_command)
1945
def _reset_approved(self):
1946
self.approved = None
1949
def approve(self, value=True):
1950
self.approved = value
1951
GLib.timeout_add(int(self.approval_duration.total_seconds()
1952
* 1000), self._reset_approved)
1953
self.send_changedstate()
1955
# D-Bus methods, signals & properties
771
self.PropertyChanged(
772
dbus.String(u"checker_running"),
773
dbus.Boolean(True, variant_level=1))
776
def stop_checker(self, *args, **kwargs):
777
old_checker = getattr(self, u"checker", None)
778
r = Client.stop_checker(self, *args, **kwargs)
779
if (old_checker is not None
780
and getattr(self, u"checker", None) is None):
781
self.PropertyChanged(dbus.String(u"checker_running"),
782
dbus.Boolean(False, variant_level=1))
785
## D-Bus methods, signals & properties
786
_interface = u"se.bsnet.fukt.Mandos.Client"
1961
790
# CheckerCompleted - signal
1962
@dbus.service.signal(_interface, signature="nxs")
791
@dbus.service.signal(_interface, signature=u"nxs")
1963
792
def CheckerCompleted(self, exitcode, waitstatus, command):
1967
796
# CheckerStarted - signal
1968
@dbus.service.signal(_interface, signature="s")
797
@dbus.service.signal(_interface, signature=u"s")
1969
798
def CheckerStarted(self, command):
1973
802
# PropertyChanged - signal
1974
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1975
@dbus.service.signal(_interface, signature="sv")
803
@dbus.service.signal(_interface, signature=u"sv")
1976
804
def PropertyChanged(self, property, value):
1980
808
# GotSecret - signal
1981
809
@dbus.service.signal(_interface)
1982
810
def GotSecret(self):
1984
Is sent after a successful transfer of secret from the Mandos
1985
server to mandos-client
1989
814
# Rejected - signal
1990
@dbus.service.signal(_interface, signature="s")
1991
def Rejected(self, reason):
815
@dbus.service.signal(_interface)
1995
# NeedApproval - signal
1996
@dbus.service.signal(_interface, signature="tb")
1997
def NeedApproval(self, timeout, default):
1999
return self.need_approval()
2004
@dbus.service.method(_interface, in_signature="b")
2005
def Approve(self, value):
2008
822
# CheckedOK - method
2009
823
@dbus.service.method(_interface)
2010
824
def CheckedOK(self):
825
return self.checked_ok()
2013
827
# Enable - method
2014
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2015
828
@dbus.service.method(_interface)
2016
829
def Enable(self):
2020
833
# StartChecker - method
2021
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2022
834
@dbus.service.method(_interface)
2023
835
def StartChecker(self):
2025
837
self.start_checker()
2027
839
# Disable - method
2028
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2029
840
@dbus.service.method(_interface)
2030
841
def Disable(self):
2034
845
# StopChecker - method
2035
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2036
846
@dbus.service.method(_interface)
2037
847
def StopChecker(self):
2038
848
self.stop_checker()
2042
# ApprovalPending - property
2043
@dbus_service_property(_interface, signature="b", access="read")
2044
def ApprovalPending_dbus_property(self):
2045
return dbus.Boolean(bool(self.approvals_pending))
2047
# ApprovedByDefault - property
2048
@dbus_service_property(_interface,
2051
def ApprovedByDefault_dbus_property(self, value=None):
2052
if value is None: # get
2053
return dbus.Boolean(self.approved_by_default)
2054
self.approved_by_default = bool(value)
2056
# ApprovalDelay - property
2057
@dbus_service_property(_interface,
2060
def ApprovalDelay_dbus_property(self, value=None):
2061
if value is None: # get
2062
return dbus.UInt64(self.approval_delay.total_seconds()
2064
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2066
# ApprovalDuration - property
2067
@dbus_service_property(_interface,
2070
def ApprovalDuration_dbus_property(self, value=None):
2071
if value is None: # get
2072
return dbus.UInt64(self.approval_duration.total_seconds()
2074
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2078
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2079
@dbus_service_property(_interface, signature="s", access="read")
2080
def Name_dbus_property(self):
853
@dbus_service_property(_interface, signature=u"s", access=u"read")
854
def name_dbus_property(self):
2081
855
return dbus.String(self.name)
2085
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2086
@dbus_service_property(_interface, signature="s", access="read")
2087
def KeyID_dbus_property(self):
2088
return dbus.String(self.key_id)
2090
# Fingerprint - property
2092
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2093
@dbus_service_property(_interface, signature="s", access="read")
2094
def Fingerprint_dbus_property(self):
857
# fingerprint - property
858
@dbus_service_property(_interface, signature=u"s", access=u"read")
859
def fingerprint_dbus_property(self):
2095
860
return dbus.String(self.fingerprint)
2098
@dbus_service_property(_interface,
2101
def Host_dbus_property(self, value=None):
863
@dbus_service_property(_interface, signature=u"s",
865
def host_dbus_property(self, value=None):
2102
866
if value is None: # get
2103
867
return dbus.String(self.host)
2104
self.host = str(value)
2106
# Created - property
2108
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2109
@dbus_service_property(_interface, signature="s", access="read")
2110
def Created_dbus_property(self):
2111
return datetime_to_dbus(self.created)
2113
# LastEnabled - property
2114
@dbus_service_property(_interface, signature="s", access="read")
2115
def LastEnabled_dbus_property(self):
2116
return datetime_to_dbus(self.last_enabled)
2118
# Enabled - property
2119
@dbus_service_property(_interface,
2122
def Enabled_dbus_property(self, value=None):
870
self.PropertyChanged(dbus.String(u"host"),
871
dbus.String(value, variant_level=1))
874
@dbus_service_property(_interface, signature=u"s", access=u"read")
875
def created_dbus_property(self):
876
return dbus.String(self._datetime_to_dbus(self.created))
878
# last_enabled - property
879
@dbus_service_property(_interface, signature=u"s", access=u"read")
880
def last_enabled_dbus_property(self):
881
if self.last_enabled is None:
882
return dbus.String(u"")
883
return dbus.String(self._datetime_to_dbus(self.last_enabled))
886
@dbus_service_property(_interface, signature=u"b",
888
def enabled_dbus_property(self, value=None):
2123
889
if value is None: # get
2124
890
return dbus.Boolean(self.enabled)
2130
# LastCheckedOK - property
2131
@dbus_service_property(_interface,
2134
def LastCheckedOK_dbus_property(self, value=None):
896
# last_checked_ok - property
897
@dbus_service_property(_interface, signature=u"s",
899
def last_checked_ok_dbus_property(self, value=None):
2135
900
if value is not None:
2136
901
self.checked_ok()
2138
return datetime_to_dbus(self.last_checked_ok)
2140
# LastCheckerStatus - property
2141
@dbus_service_property(_interface, signature="n", access="read")
2142
def LastCheckerStatus_dbus_property(self):
2143
return dbus.Int16(self.last_checker_status)
2145
# Expires - property
2146
@dbus_service_property(_interface, signature="s", access="read")
2147
def Expires_dbus_property(self):
2148
return datetime_to_dbus(self.expires)
2150
# LastApprovalRequest - property
2151
@dbus_service_property(_interface, signature="s", access="read")
2152
def LastApprovalRequest_dbus_property(self):
2153
return datetime_to_dbus(self.last_approval_request)
2155
# Timeout - property
2156
@dbus_service_property(_interface,
2159
def Timeout_dbus_property(self, value=None):
903
if self.last_checked_ok is None:
904
return dbus.String(u"")
905
return dbus.String(self._datetime_to_dbus(self
909
@dbus_service_property(_interface, signature=u"t",
911
def timeout_dbus_property(self, value=None):
2160
912
if value is None: # get
2161
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2162
old_timeout = self.timeout
913
return dbus.UInt64(self.timeout_milliseconds())
2163
914
self.timeout = datetime.timedelta(0, 0, 0, value)
2164
# Reschedule disabling
2166
now = datetime.datetime.utcnow()
2167
self.expires += self.timeout - old_timeout
2168
if self.expires <= now:
2169
# The timeout has passed
2172
if (getattr(self, "disable_initiator_tag", None)
2175
GLib.source_remove(self.disable_initiator_tag)
2176
self.disable_initiator_tag = GLib.timeout_add(
2177
int((self.expires - now).total_seconds() * 1000),
2180
# ExtendedTimeout - property
2181
@dbus_service_property(_interface,
2184
def ExtendedTimeout_dbus_property(self, value=None):
2185
if value is None: # get
2186
return dbus.UInt64(self.extended_timeout.total_seconds()
2188
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2190
# Interval - property
2191
@dbus_service_property(_interface,
2194
def Interval_dbus_property(self, value=None):
2195
if value is None: # get
2196
return dbus.UInt64(self.interval.total_seconds() * 1000)
916
self.PropertyChanged(dbus.String(u"timeout"),
917
dbus.UInt64(value, variant_level=1))
918
if getattr(self, u"disable_initiator_tag", None) is None:
921
gobject.source_remove(self.disable_initiator_tag)
922
self.disable_initiator_tag = None
924
_timedelta_to_milliseconds((self
930
# The timeout has passed
933
self.disable_initiator_tag = (gobject.timeout_add
934
(time_to_die, self.disable))
936
# interval - property
937
@dbus_service_property(_interface, signature=u"t",
939
def interval_dbus_property(self, value=None):
940
if value is None: # get
941
return dbus.UInt64(self.interval_milliseconds())
2197
942
self.interval = datetime.timedelta(0, 0, 0, value)
2198
if getattr(self, "checker_initiator_tag", None) is None:
944
self.PropertyChanged(dbus.String(u"interval"),
945
dbus.UInt64(value, variant_level=1))
946
if getattr(self, u"checker_initiator_tag", None) is None:
2201
# Reschedule checker run
2202
GLib.source_remove(self.checker_initiator_tag)
2203
self.checker_initiator_tag = GLib.timeout_add(
2204
value, self.start_checker)
2205
self.start_checker() # Start one now, too
948
# Reschedule checker run
949
gobject.source_remove(self.checker_initiator_tag)
950
self.checker_initiator_tag = (gobject.timeout_add
951
(value, self.start_checker))
952
self.start_checker() # Start one now, too
2207
# Checker - property
2208
@dbus_service_property(_interface,
2211
def Checker_dbus_property(self, value=None):
955
@dbus_service_property(_interface, signature=u"s",
957
def checker_dbus_property(self, value=None):
2212
958
if value is None: # get
2213
959
return dbus.String(self.checker_command)
2214
self.checker_command = str(value)
2216
# CheckerRunning - property
2217
@dbus_service_property(_interface,
2220
def CheckerRunning_dbus_property(self, value=None):
960
self.checker_command = value
962
self.PropertyChanged(dbus.String(u"checker"),
963
dbus.String(self.checker_command,
966
# checker_running - property
967
@dbus_service_property(_interface, signature=u"b",
969
def checker_running_dbus_property(self, value=None):
2221
970
if value is None: # get
2222
971
return dbus.Boolean(self.checker is not None)
2224
973
self.start_checker()
2226
975
self.stop_checker()
2228
# ObjectPath - property
2230
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2231
"org.freedesktop.DBus.Deprecated": "true"})
2232
@dbus_service_property(_interface, signature="o", access="read")
2233
def ObjectPath_dbus_property(self):
2234
return self.dbus_object_path # is already a dbus.ObjectPath
2238
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2240
@dbus_service_property(_interface,
2244
def Secret_dbus_property(self, value):
2245
self.secret = bytes(value)
977
# object_path - property
978
@dbus_service_property(_interface, signature=u"o", access=u"read")
979
def object_path_dbus_property(self):
980
return self.dbus_object_path # is already a dbus.ObjectPath
983
@dbus_service_property(_interface, signature=u"ay",
984
access=u"write", byte_arrays=True)
985
def secret_dbus_property(self, value):
986
self.secret = str(value)
2251
def __init__(self, child_pipe, key_id, fpr, address):
2252
self._pipe = child_pipe
2253
self._pipe.send(('init', key_id, fpr, address))
2254
if not self._pipe.recv():
2255
raise KeyError(key_id or fpr)
2257
def __getattribute__(self, name):
2259
return super(ProxyClient, self).__getattribute__(name)
2260
self._pipe.send(('getattr', name))
2261
data = self._pipe.recv()
2262
if data[0] == 'data':
2264
if data[0] == 'function':
2266
def func(*args, **kwargs):
2267
self._pipe.send(('funcall', name, args, kwargs))
2268
return self._pipe.recv()[1]
2272
def __setattr__(self, name, value):
2274
return super(ProxyClient, self).__setattr__(name, value)
2275
self._pipe.send(('setattr', name, value))
2278
991
class ClientHandler(socketserver.BaseRequestHandler, object):
2279
992
"""A class to handle client connections.
2281
994
Instantiated once for each connection to handle it.
2282
995
Note: This will run in its own forked process."""
2284
997
def handle(self):
2285
with contextlib.closing(self.server.child_pipe) as child_pipe:
2286
logger.info("TCP connection from: %s",
2287
str(self.client_address))
2288
logger.debug("Pipe FD: %d",
2289
self.server.child_pipe.fileno())
2291
session = gnutls.ClientSession(self.request)
2293
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2294
# "+AES-256-CBC", "+SHA1",
2295
# "+COMP-NULL", "+CTYPE-OPENPGP",
998
logger.info(u"TCP connection from: %s",
999
unicode(self.client_address))
1000
logger.debug(u"IPC Pipe FD: %d",
1001
self.server.child_pipe[1].fileno())
1002
# Open IPC pipe to parent process
1003
with contextlib.nested(self.server.child_pipe[1],
1004
self.server.parent_pipe[0]
1005
) as (ipc, ipc_return):
1006
session = (gnutls.connection
1007
.ClientSession(self.request,
1009
.X509Credentials()))
1011
# Note: gnutls.connection.X509Credentials is really a
1012
# generic GnuTLS certificate credentials object so long as
1013
# no X.509 keys are added to it. Therefore, we can use it
1014
# here despite using OpenPGP certificates.
1016
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1017
# u"+AES-256-CBC", u"+SHA1",
1018
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
2297
1020
# Use a fallback default, since this MUST be set.
2298
1021
priority = self.server.gnutls_priority
2299
1022
if priority is None:
2301
gnutls.priority_set_direct(session._c_object,
2302
priority.encode("utf-8"),
1023
priority = u"NORMAL"
1024
(gnutls.library.functions
1025
.gnutls_priority_set_direct(session._c_object,
2305
1028
# Start communication using the Mandos protocol
2306
1029
# Get protocol number
2307
1030
line = self.request.makefile().readline()
2308
logger.debug("Protocol version: %r", line)
1031
logger.debug(u"Protocol version: %r", line)
2310
1033
if int(line.strip().split()[0]) > 1:
2311
raise RuntimeError(line)
2312
except (ValueError, IndexError, RuntimeError) as error:
2313
logger.error("Unknown protocol version: %s", error)
1035
except (ValueError, IndexError, RuntimeError), error:
1036
logger.error(u"Unknown protocol version: %s", error)
2316
1039
# Start GnuTLS connection
2318
1041
session.handshake()
2319
except gnutls.Error as error:
2320
logger.warning("Handshake failed: %s", error)
1042
except gnutls.errors.GNUTLSError, error:
1043
logger.warning(u"Handshake failed: %s", error)
2321
1044
# Do not run session.bye() here: the session is not
2322
1045
# established. Just abandon the request.
2324
logger.debug("Handshake succeeded")
2326
approval_required = False
1047
logger.debug(u"Handshake succeeded")
2328
if gnutls.has_rawpk:
2331
key_id = self.key_id(
2332
self.peer_certificate(session))
2333
except (TypeError, gnutls.Error) as error:
2334
logger.warning("Bad certificate: %s", error)
2336
logger.debug("Key ID: %s", key_id)
2341
fpr = self.fingerprint(
2342
self.peer_certificate(session))
2343
except (TypeError, gnutls.Error) as error:
2344
logger.warning("Bad certificate: %s", error)
2346
logger.debug("Fingerprint: %s", fpr)
2349
client = ProxyClient(child_pipe, key_id, fpr,
2350
self.client_address)
1050
fpr = self.fingerprint(self.peer_certificate
1052
except (TypeError, gnutls.errors.GNUTLSError), error:
1053
logger.warning(u"Bad certificate: %s", error)
2354
if client.approval_delay:
2355
delay = client.approval_delay
2356
client.approvals_pending += 1
2357
approval_required = True
2360
if not client.enabled:
2361
logger.info("Client %s is disabled",
2363
if self.server.use_dbus:
2365
client.Rejected("Disabled")
2368
if client.approved or not client.approval_delay:
2369
# We are approved or approval is disabled
1055
logger.debug(u"Fingerprint: %s", fpr)
1057
for c in self.server.clients:
1058
if c.fingerprint == fpr:
2371
elif client.approved is None:
2372
logger.info("Client %s needs approval",
2374
if self.server.use_dbus:
2376
client.NeedApproval(
2377
client.approval_delay.total_seconds()
2378
* 1000, client.approved_by_default)
2380
logger.warning("Client %s was not approved",
2382
if self.server.use_dbus:
2384
client.Rejected("Denied")
2387
# wait until timeout or approved
2388
time = datetime.datetime.now()
2389
client.changedstate.acquire()
2390
client.changedstate.wait(delay.total_seconds())
2391
client.changedstate.release()
2392
time2 = datetime.datetime.now()
2393
if (time2 - time) >= delay:
2394
if not client.approved_by_default:
2395
logger.warning("Client %s timed out while"
2396
" waiting for approval",
2398
if self.server.use_dbus:
2400
client.Rejected("Approval timed out")
2405
delay -= time2 - time
2408
session.send(client.secret)
2409
except gnutls.Error as error:
2410
logger.warning("gnutls send failed",
2414
logger.info("Sending secret to %s", client.name)
2415
# bump the timeout using extended_timeout
2416
client.bump_timeout(client.extended_timeout)
2417
if self.server.use_dbus:
1062
ipc.write(u"NOTFOUND %s %s\n"
1063
% (fpr, unicode(self.client_address)))
1066
class ClientProxy(object):
1067
"""Client proxy object. Not for calling methods."""
1068
def __init__(self, client):
1069
self.client = client
1070
def __getattr__(self, name):
1071
if name.startswith("ipc_"):
1073
ipc.write("%s %s\n" % (name[4:].upper(),
1076
if not hasattr(self.client, name):
1077
raise AttributeError
1078
ipc.write(u"GETATTR %s %s\n"
1079
% (name, self.client.fingerprint))
1080
return pickle.load(ipc_return)
1081
clientproxy = ClientProxy(client)
1082
# Have to check if client.enabled, since it is
1083
# possible that the client was disabled since the
1084
# GnuTLS session was established.
1085
if not clientproxy.enabled:
1086
clientproxy.ipc_disabled()
1089
clientproxy.ipc_sending()
1091
while sent_size < len(client.secret):
1092
sent = session.send(client.secret[sent_size:])
1093
logger.debug(u"Sent: %d, remaining: %d",
1094
sent, len(client.secret)
1095
- (sent_size + sent))
2422
if approval_required:
2423
client.approvals_pending -= 1
2426
except gnutls.Error as error:
2427
logger.warning("GnuTLS bye failed",
2431
1101
def peer_certificate(session):
2432
"Return the peer's certificate as a bytestring"
2434
cert_type = gnutls.certificate_type_get2(session._c_object,
2436
except AttributeError:
2437
cert_type = gnutls.certificate_type_get(session._c_object)
2438
if gnutls.has_rawpk:
2439
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2441
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2442
# If not a valid certificate type...
2443
if cert_type not in valid_cert_types:
2444
logger.info("Cert type %r not in %r", cert_type,
2446
# ...return invalid data
1102
"Return the peer's OpenPGP certificate as a bytestring"
1103
# If not an OpenPGP certificate...
1104
if (gnutls.library.functions
1105
.gnutls_certificate_type_get(session._c_object)
1106
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1107
# ...do the normal thing
1108
return session.peer_certificate
2448
1109
list_size = ctypes.c_uint(1)
2449
cert_list = (gnutls.certificate_get_peers
1110
cert_list = (gnutls.library.functions
1111
.gnutls_certificate_get_peers
2450
1112
(session._c_object, ctypes.byref(list_size)))
2451
1113
if not bool(cert_list) and list_size.value != 0:
2452
raise gnutls.Error("error getting peer certificate")
1114
raise gnutls.errors.GNUTLSError(u"error getting peer"
2453
1116
if list_size.value == 0:
2455
1118
cert = cert_list[0]
2456
1119
return ctypes.string_at(cert.data, cert.size)
2459
def key_id(certificate):
2460
"Convert a certificate bytestring to a hexdigit key ID"
2461
# New GnuTLS "datum" with the public key
2462
datum = gnutls.datum_t(
2463
ctypes.cast(ctypes.c_char_p(certificate),
2464
ctypes.POINTER(ctypes.c_ubyte)),
2465
ctypes.c_uint(len(certificate)))
2466
# XXX all these need to be created in the gnutls "module"
2467
# New empty GnuTLS certificate
2468
pubkey = gnutls.pubkey_t()
2469
gnutls.pubkey_init(ctypes.byref(pubkey))
2470
# Import the raw public key into the certificate
2471
gnutls.pubkey_import(pubkey,
2472
ctypes.byref(datum),
2473
gnutls.X509_FMT_DER)
2474
# New buffer for the key ID
2475
buf = ctypes.create_string_buffer(32)
2476
buf_len = ctypes.c_size_t(len(buf))
2477
# Get the key ID from the raw public key into the buffer
2478
gnutls.pubkey_get_key_id(
2480
gnutls.KEYID_USE_SHA256,
2481
ctypes.cast(ctypes.byref(buf),
2482
ctypes.POINTER(ctypes.c_ubyte)),
2483
ctypes.byref(buf_len))
2484
# Deinit the certificate
2485
gnutls.pubkey_deinit(pubkey)
2487
# Convert the buffer to a Python bytestring
2488
key_id = ctypes.string_at(buf, buf_len.value)
2489
# Convert the bytestring to hexadecimal notation
2490
hex_key_id = binascii.hexlify(key_id).upper()
2494
1122
def fingerprint(openpgp):
2495
1123
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2496
1124
# New GnuTLS "datum" with the OpenPGP public key
2497
datum = gnutls.datum_t(
2498
ctypes.cast(ctypes.c_char_p(openpgp),
2499
ctypes.POINTER(ctypes.c_ubyte)),
2500
ctypes.c_uint(len(openpgp)))
1125
datum = (gnutls.library.types
1126
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1129
ctypes.c_uint(len(openpgp))))
2501
1130
# New empty GnuTLS certificate
2502
crt = gnutls.openpgp_crt_t()
2503
gnutls.openpgp_crt_init(ctypes.byref(crt))
1131
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1132
(gnutls.library.functions
1133
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2504
1134
# Import the OpenPGP public key into the certificate
2505
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2506
gnutls.OPENPGP_FMT_RAW)
1135
(gnutls.library.functions
1136
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1137
gnutls.library.constants
1138
.GNUTLS_OPENPGP_FMT_RAW))
2507
1139
# Verify the self signature in the key
2508
1140
crtverify = ctypes.c_uint()
2509
gnutls.openpgp_crt_verify_self(crt, 0,
2510
ctypes.byref(crtverify))
1141
(gnutls.library.functions
1142
.gnutls_openpgp_crt_verify_self(crt, 0,
1143
ctypes.byref(crtverify)))
2511
1144
if crtverify.value != 0:
2512
gnutls.openpgp_crt_deinit(crt)
2513
raise gnutls.CertificateSecurityError(code
1145
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1146
raise (gnutls.errors.CertificateSecurityError
2515
1148
# New buffer for the fingerprint
2516
1149
buf = ctypes.create_string_buffer(20)
2517
1150
buf_len = ctypes.c_size_t()
2518
1151
# Get the fingerprint from the certificate into the buffer
2519
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2520
ctypes.byref(buf_len))
1152
(gnutls.library.functions
1153
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1154
ctypes.byref(buf_len)))
2521
1155
# Deinit the certificate
2522
gnutls.openpgp_crt_deinit(crt)
1156
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2523
1157
# Convert the buffer to a Python bytestring
2524
1158
fpr = ctypes.string_at(buf, buf_len.value)
2525
1159
# Convert the bytestring to hexadecimal notation
2526
hex_fpr = binascii.hexlify(fpr).upper()
1160
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2530
class MultiprocessingMixIn:
2531
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2533
def sub_process_main(self, request, address):
2535
self.finish_request(request, address)
2537
self.handle_error(request, address)
2538
self.close_request(request)
2540
def process_request(self, request, address):
2541
"""Start a new process to process the request."""
2542
proc = multiprocessing.Process(target=self.sub_process_main,
2543
args=(request, address))
2548
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
2549
""" adds a pipe to the MixIn """
1164
class ForkingMixInWithPipes(socketserver.ForkingMixIn, object):
1165
"""Like socketserver.ForkingMixIn, but also pass a pipe pair."""
2551
1166
def process_request(self, request, client_address):
2552
1167
"""Overrides and wraps the original process_request().
2554
1169
This function creates a new pipe in self.pipe
2556
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2558
proc = MultiprocessingMixIn.process_request(self, request,
2560
self.child_pipe.close()
2561
self.add_pipe(parent_pipe, proc)
2563
def add_pipe(self, parent_pipe, proc):
1171
# Child writes to child_pipe
1172
self.child_pipe = map(os.fdopen, os.pipe(), u"rw", (1, 0))
1173
# Parent writes to parent_pipe
1174
self.parent_pipe = map(os.fdopen, os.pipe(), u"rw", (1, 0))
1175
super(ForkingMixInWithPipes,
1176
self).process_request(request, client_address)
1177
# Close unused ends for parent
1178
self.parent_pipe[0].close() # close read end
1179
self.child_pipe[1].close() # close write end
1180
self.add_pipe_fds(self.child_pipe[0], self.parent_pipe[1])
1181
def add_pipe_fds(self, child_pipe_fd, parent_pipe_fd):
2564
1182
"""Dummy function; override as necessary"""
2565
raise NotImplementedError()
2568
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2569
socketserver.TCPServer):
1183
child_pipe_fd.close()
1184
parent_pipe_fd.close()
1187
class IPv6_TCPServer(ForkingMixInWithPipes,
1188
socketserver.TCPServer, object):
2570
1189
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2573
1192
enabled: Boolean; whether this server is activated yet
2574
1193
interface: None or a network interface name (string)
2575
1194
use_ipv6: Boolean; to use IPv6 or not
2578
1196
def __init__(self, server_address, RequestHandlerClass,
2582
"""If socketfd is set, use that file descriptor instead of
2583
creating a new one with socket.socket().
1197
interface=None, use_ipv6=True):
2585
1198
self.interface = interface
2587
1200
self.address_family = socket.AF_INET6
2588
if socketfd is not None:
2589
# Save the file descriptor
2590
self.socketfd = socketfd
2591
# Save the original socket.socket() function
2592
self.socket_socket = socket.socket
2594
# To implement --socket, we monkey patch socket.socket.
2596
# (When socketserver.TCPServer is a new-style class, we
2597
# could make self.socket into a property instead of monkey
2598
# patching socket.socket.)
2600
# Create a one-time-only replacement for socket.socket()
2601
@functools.wraps(socket.socket)
2602
def socket_wrapper(*args, **kwargs):
2603
# Restore original function so subsequent calls are
2605
socket.socket = self.socket_socket
2606
del self.socket_socket
2607
# This time only, return a new socket object from the
2608
# saved file descriptor.
2609
return socket.fromfd(self.socketfd, *args, **kwargs)
2610
# Replace socket.socket() function with wrapper
2611
socket.socket = socket_wrapper
2612
# The socketserver.TCPServer.__init__ will call
2613
# socket.socket(), which might be our replacement,
2614
# socket_wrapper(), if socketfd was set.
2615
1201
socketserver.TCPServer.__init__(self, server_address,
2616
1202
RequestHandlerClass)
2618
1203
def server_bind(self):
2619
1204
"""This overrides the normal server_bind() function
2620
1205
to bind to an interface if one was specified, and also NOT to
2621
1206
bind to an address or port if they were not specified."""
2622
global SO_BINDTODEVICE
2623
1207
if self.interface is not None:
2624
1208
if SO_BINDTODEVICE is None:
2625
# Fall back to a hard-coded value which seems to be
2627
logger.warning("SO_BINDTODEVICE not found, trying 25")
2628
SO_BINDTODEVICE = 25
2630
self.socket.setsockopt(
2631
socket.SOL_SOCKET, SO_BINDTODEVICE,
2632
(self.interface + "\0").encode("utf-8"))
2633
except socket.error as error:
2634
if error.errno == errno.EPERM:
2635
logger.error("No permission to bind to"
2636
" interface %s", self.interface)
2637
elif error.errno == errno.ENOPROTOOPT:
2638
logger.error("SO_BINDTODEVICE not available;"
2639
" cannot bind to interface %s",
2641
elif error.errno == errno.ENODEV:
2642
logger.error("Interface %s does not exist,"
2643
" cannot bind", self.interface)
1209
logger.error(u"SO_BINDTODEVICE does not exist;"
1210
u" cannot bind to interface %s",
1214
self.socket.setsockopt(socket.SOL_SOCKET,
1218
except socket.error, error:
1219
if error[0] == errno.EPERM:
1220
logger.error(u"No permission to"
1221
u" bind to interface %s",
1223
elif error[0] == errno.ENOPROTOOPT:
1224
logger.error(u"SO_BINDTODEVICE not available;"
1225
u" cannot bind to interface %s",
2646
1229
# Only bind(2) the socket if we really need to.
2647
1230
if self.server_address[0] or self.server_address[1]:
2648
if self.server_address[1]:
2649
self.allow_reuse_address = True
2650
1231
if not self.server_address[0]:
2651
1232
if self.address_family == socket.AF_INET6:
2652
any_address = "::" # in6addr_any
1233
any_address = u"::" # in6addr_any
2654
any_address = "0.0.0.0" # INADDR_ANY
1235
any_address = socket.INADDR_ANY
2655
1236
self.server_address = (any_address,
2656
1237
self.server_address[1])
2657
1238
elif not self.server_address[1]:
2658
self.server_address = (self.server_address[0], 0)
1239
self.server_address = (self.server_address[0],
2659
1241
# if self.interface:
2660
1242
# self.server_address = (self.server_address[0],
2668
1250
class MandosServer(IPv6_TCPServer):
2669
1251
"""Mandos server.
2672
1254
clients: set of Client objects
2673
1255
gnutls_priority GnuTLS priority string
2674
1256
use_dbus: Boolean; to emit D-Bus signals or not
2676
Assumes a GLib.MainLoop event loop.
1258
Assumes a gobject.MainLoop event loop.
2679
1260
def __init__(self, server_address, RequestHandlerClass,
2683
gnutls_priority=None,
1261
interface=None, use_ipv6=True, clients=None,
1262
gnutls_priority=None, use_dbus=True):
2686
1263
self.enabled = False
2687
1264
self.clients = clients
2688
1265
if self.clients is None:
1266
self.clients = set()
2690
1267
self.use_dbus = use_dbus
2691
1268
self.gnutls_priority = gnutls_priority
2692
1269
IPv6_TCPServer.__init__(self, server_address,
2693
1270
RequestHandlerClass,
2694
interface=interface,
1271
interface = interface,
1272
use_ipv6 = use_ipv6)
2698
1273
def server_activate(self):
2699
1274
if self.enabled:
2700
1275
return socketserver.TCPServer.server_activate(self)
2702
1276
def enable(self):
2703
1277
self.enabled = True
2705
def add_pipe(self, parent_pipe, proc):
1278
def add_pipe_fds(self, child_pipe_fd, parent_pipe_fd):
2706
1279
# Call "handle_ipc" for both data and EOF events
2708
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2709
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2710
functools.partial(self.handle_ipc,
2711
parent_pipe=parent_pipe,
2714
def handle_ipc(self, source, condition,
2717
client_object=None):
2718
# error, or the other end of multiprocessing.Pipe has closed
2719
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2720
# Wait for other process to exit
2724
# Read a request from the child
2725
request = parent_pipe.recv()
2726
command = request[0]
2728
if command == 'init':
2729
key_id = request[1].decode("ascii")
2730
fpr = request[2].decode("ascii")
2731
address = request[3]
2733
for c in self.clients.values():
2734
if key_id == ("E3B0C44298FC1C149AFBF4C8996FB924"
2735
"27AE41E4649B934CA495991B7852B855"):
2737
if key_id and c.key_id == key_id:
2740
if fpr and c.fingerprint == fpr:
2744
logger.info("Client not found for key ID: %s, address"
2745
": %s", key_id or fpr, address)
2748
mandos_dbus_service.ClientNotFound(key_id or fpr,
2750
parent_pipe.send(False)
2754
GLib.IOChannel.unix_new(parent_pipe.fileno()),
2755
GLib.PRIORITY_DEFAULT, GLib.IO_IN | GLib.IO_HUP,
2756
functools.partial(self.handle_ipc,
2757
parent_pipe=parent_pipe,
2759
client_object=client))
2760
parent_pipe.send(True)
2761
# remove the old hook in favor of the new above hook on
2764
if command == 'funcall':
2765
funcname = request[1]
2769
parent_pipe.send(('data', getattr(client_object,
2773
if command == 'getattr':
2774
attrname = request[1]
2775
if isinstance(client_object.__getattribute__(attrname),
2776
collections.abc.Callable):
2777
parent_pipe.send(('function', ))
2780
'data', client_object.__getattribute__(attrname)))
2782
if command == 'setattr':
2783
attrname = request[1]
2785
setattr(client_object, attrname, value)
1280
gobject.io_add_watch(child_pipe_fd.fileno(),
1281
gobject.IO_IN | gobject.IO_HUP,
1282
functools.partial(self.handle_ipc,
1283
reply = parent_pipe_fd,
1284
sender= child_pipe_fd))
1285
def handle_ipc(self, source, condition, reply=None, sender=None):
1287
gobject.IO_IN: u"IN", # There is data to read.
1288
gobject.IO_OUT: u"OUT", # Data can be written (without
1290
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1291
gobject.IO_ERR: u"ERR", # Error condition.
1292
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1293
# broken, usually for pipes and
1296
conditions_string = ' | '.join(name
1298
condition_names.iteritems()
1299
if cond & condition)
1300
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1303
# Read a line from the file object
1304
cmdline = sender.readline()
1305
if not cmdline: # Empty line means end of file
1306
# close the IPC pipes
1310
# Stop calling this function
1313
logger.debug(u"IPC command: %r", cmdline)
1315
# Parse and act on command
1316
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1318
if cmd == u"NOTFOUND":
1319
fpr, address = args.split(None, 1)
1320
logger.warning(u"Client not found for fingerprint: %s, ad"
1321
u"dress: %s", fpr, address)
1324
mandos_dbus_service.ClientNotFound(fpr, address)
1325
elif cmd == u"DISABLED":
1326
for client in self.clients:
1327
if client.name == args:
1328
logger.warning(u"Client %s is disabled", args)
1334
logger.error(u"Unknown client %s is disabled", args)
1335
elif cmd == u"SENDING":
1336
for client in self.clients:
1337
if client.name == args:
1338
logger.info(u"Sending secret to %s", client.name)
1345
logger.error(u"Sending secret to unknown client %s",
1347
elif cmd == u"GETATTR":
1348
attr_name, fpr = args.split(None, 1)
1349
for client in self.clients:
1350
if client.fingerprint == fpr:
1351
attr_value = getattr(client, attr_name, None)
1352
logger.debug("IPC reply: %r", attr_value)
1353
pickle.dump(attr_value, reply)
1356
logger.error(u"Client %s on address %s requesting "
1357
u"attribute %s not found", fpr, address,
1359
pickle.dump(None, reply)
1361
logger.error(u"Unknown IPC command: %r", cmdline)
1363
# Keep calling this function
2790
def rfc3339_duration_to_delta(duration):
2791
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2793
>>> timedelta = datetime.timedelta
2794
>>> rfc3339_duration_to_delta("P7D") == timedelta(7)
2796
>>> rfc3339_duration_to_delta("PT60S") == timedelta(0, 60)
2798
>>> rfc3339_duration_to_delta("PT60M") == timedelta(0, 3600)
2800
>>> rfc3339_duration_to_delta("PT24H") == timedelta(1)
2802
>>> rfc3339_duration_to_delta("P1W") == timedelta(7)
2804
>>> rfc3339_duration_to_delta("PT5M30S") == timedelta(0, 330)
2806
>>> rfc3339_duration_to_delta("P1DT3M20S") == timedelta(1, 200)
2811
# Parsing an RFC 3339 duration with regular expressions is not
2812
# possible - there would have to be multiple places for the same
2813
# values, like seconds. The current code, while more esoteric, is
2814
# cleaner without depending on a parsing library. If Python had a
2815
# built-in library for parsing we would use it, but we'd like to
2816
# avoid excessive use of external libraries.
2818
# New type for defining tokens, syntax, and semantics all-in-one
2819
Token = collections.namedtuple("Token", (
2820
"regexp", # To match token; if "value" is not None, must have
2821
# a "group" containing digits
2822
"value", # datetime.timedelta or None
2823
"followers")) # Tokens valid after this token
2824
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2825
# the "duration" ABNF definition in RFC 3339, Appendix A.
2826
token_end = Token(re.compile(r"$"), None, frozenset())
2827
token_second = Token(re.compile(r"(\d+)S"),
2828
datetime.timedelta(seconds=1),
2829
frozenset((token_end, )))
2830
token_minute = Token(re.compile(r"(\d+)M"),
2831
datetime.timedelta(minutes=1),
2832
frozenset((token_second, token_end)))
2833
token_hour = Token(re.compile(r"(\d+)H"),
2834
datetime.timedelta(hours=1),
2835
frozenset((token_minute, token_end)))
2836
token_time = Token(re.compile(r"T"),
2838
frozenset((token_hour, token_minute,
2840
token_day = Token(re.compile(r"(\d+)D"),
2841
datetime.timedelta(days=1),
2842
frozenset((token_time, token_end)))
2843
token_month = Token(re.compile(r"(\d+)M"),
2844
datetime.timedelta(weeks=4),
2845
frozenset((token_day, token_end)))
2846
token_year = Token(re.compile(r"(\d+)Y"),
2847
datetime.timedelta(weeks=52),
2848
frozenset((token_month, token_end)))
2849
token_week = Token(re.compile(r"(\d+)W"),
2850
datetime.timedelta(weeks=1),
2851
frozenset((token_end, )))
2852
token_duration = Token(re.compile(r"P"), None,
2853
frozenset((token_year, token_month,
2854
token_day, token_time,
2856
# Define starting values:
2858
value = datetime.timedelta()
2860
# Following valid tokens
2861
followers = frozenset((token_duration, ))
2862
# String left to parse
2864
# Loop until end token is found
2865
while found_token is not token_end:
2866
# Search for any currently valid tokens
2867
for token in followers:
2868
match = token.regexp.match(s)
2869
if match is not None:
2871
if token.value is not None:
2872
# Value found, parse digits
2873
factor = int(match.group(1), 10)
2874
# Add to value so far
2875
value += factor * token.value
2876
# Strip token from string
2877
s = token.regexp.sub("", s, 1)
2880
# Set valid next tokens
2881
followers = found_token.followers
2884
# No currently valid tokens were found
2885
raise ValueError("Invalid RFC 3339 duration: {!r}"
2891
1367
def string_to_delta(interval):
2892
1368
"""Parse a string and return a datetime.timedelta
2894
>>> string_to_delta('7d') == datetime.timedelta(7)
2896
>>> string_to_delta('60s') == datetime.timedelta(0, 60)
2898
>>> string_to_delta('60m') == datetime.timedelta(0, 3600)
2900
>>> string_to_delta('24h') == datetime.timedelta(1)
2902
>>> string_to_delta('1w') == datetime.timedelta(7)
2904
>>> string_to_delta('5m 30s') == datetime.timedelta(0, 330)
1370
>>> string_to_delta(u'7d')
1371
datetime.timedelta(7)
1372
>>> string_to_delta(u'60s')
1373
datetime.timedelta(0, 60)
1374
>>> string_to_delta(u'60m')
1375
datetime.timedelta(0, 3600)
1376
>>> string_to_delta(u'24h')
1377
datetime.timedelta(1)
1378
>>> string_to_delta(u'1w')
1379
datetime.timedelta(7)
1380
>>> string_to_delta(u'5m 30s')
1381
datetime.timedelta(0, 330)
2909
return rfc3339_duration_to_delta(interval)
2913
1383
timevalue = datetime.timedelta(0)
2914
1384
for s in interval.split():
1386
suffix = unicode(s[-1])
2917
1387
value = int(s[:-1])
2919
1389
delta = datetime.timedelta(value)
1390
elif suffix == u"s":
2921
1391
delta = datetime.timedelta(0, value)
1392
elif suffix == u"m":
2923
1393
delta = datetime.timedelta(0, 0, 0, 0, value)
1394
elif suffix == u"h":
2925
1395
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1396
elif suffix == u"w":
2927
1397
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2929
raise ValueError("Unknown suffix {!r}".format(suffix))
2930
except IndexError as e:
2931
raise ValueError(*(e.args))
1399
raise ValueError(u"Unknown suffix %r" % suffix)
1400
except (ValueError, IndexError), e:
1401
raise ValueError(e.message)
2932
1402
timevalue += delta
2933
1403
return timevalue
2936
def daemon(nochdir=False, noclose=False):
1406
def if_nametoindex(interface):
1407
"""Call the C function if_nametoindex(), or equivalent
1409
Note: This function cannot accept a unicode string."""
1410
global if_nametoindex
1412
if_nametoindex = (ctypes.cdll.LoadLibrary
1413
(ctypes.util.find_library(u"c"))
1415
except (OSError, AttributeError):
1416
logger.warning(u"Doing if_nametoindex the hard way")
1417
def if_nametoindex(interface):
1418
"Get an interface index the hard way, i.e. using fcntl()"
1419
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1420
with contextlib.closing(socket.socket()) as s:
1421
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1422
struct.pack(str(u"16s16x"),
1424
interface_index = struct.unpack(str(u"I"),
1426
return interface_index
1427
return if_nametoindex(interface)
1430
def daemon(nochdir = False, noclose = False):
2937
1431
"""See daemon(3). Standard BSD Unix function.
2939
1433
This should really exist as os.daemon, but it doesn't (yet)."""
2943
1437
if not nochdir:
2947
1441
if not noclose:
2948
1442
# Close all standard open file descriptors
2949
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1443
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2950
1444
if not stat.S_ISCHR(os.fstat(null).st_mode):
2951
1445
raise OSError(errno.ENODEV,
2952
"{} not a character device"
2953
.format(os.devnull))
1446
u"%s not a character device"
2954
1448
os.dup2(null, sys.stdin.fileno())
2955
1449
os.dup2(null, sys.stdout.fileno())
2956
1450
os.dup2(null, sys.stderr.fileno())
2963
1457
##################################################################
2964
1458
# Parsing of options, both command line and config file
2966
parser = argparse.ArgumentParser()
2967
parser.add_argument("-v", "--version", action="version",
2968
version="%(prog)s {}".format(version),
2969
help="show version number and exit")
2970
parser.add_argument("-i", "--interface", metavar="IF",
2971
help="Bind to interface IF")
2972
parser.add_argument("-a", "--address",
2973
help="Address to listen for requests on")
2974
parser.add_argument("-p", "--port", type=int,
2975
help="Port number to receive requests on")
2976
parser.add_argument("--check", action="store_true",
2977
help="Run self-test")
2978
parser.add_argument("--debug", action="store_true",
2979
help="Debug mode; run in foreground and log"
2980
" to terminal", default=None)
2981
parser.add_argument("--debuglevel", metavar="LEVEL",
2982
help="Debug level for stdout output")
2983
parser.add_argument("--priority", help="GnuTLS"
2984
" priority string (see GnuTLS documentation)")
2985
parser.add_argument("--servicename",
2986
metavar="NAME", help="Zeroconf service name")
2987
parser.add_argument("--configdir",
2988
default="/etc/mandos", metavar="DIR",
2989
help="Directory to search for configuration"
2991
parser.add_argument("--no-dbus", action="store_false",
2992
dest="use_dbus", help="Do not provide D-Bus"
2993
" system bus interface", default=None)
2994
parser.add_argument("--no-ipv6", action="store_false",
2995
dest="use_ipv6", help="Do not use IPv6",
2997
parser.add_argument("--no-restore", action="store_false",
2998
dest="restore", help="Do not restore stored"
2999
" state", default=None)
3000
parser.add_argument("--socket", type=int,
3001
help="Specify a file descriptor to a network"
3002
" socket to use instead of creating one")
3003
parser.add_argument("--statedir", metavar="DIR",
3004
help="Directory to save/restore state in")
3005
parser.add_argument("--foreground", action="store_true",
3006
help="Run in foreground", default=None)
3007
parser.add_argument("--no-zeroconf", action="store_false",
3008
dest="zeroconf", help="Do not use Zeroconf",
3011
options = parser.parse_args()
1460
parser = optparse.OptionParser(version = "%%prog %s" % version)
1461
parser.add_option("-i", u"--interface", type=u"string",
1462
metavar="IF", help=u"Bind to interface IF")
1463
parser.add_option("-a", u"--address", type=u"string",
1464
help=u"Address to listen for requests on")
1465
parser.add_option("-p", u"--port", type=u"int",
1466
help=u"Port number to receive requests on")
1467
parser.add_option("--check", action=u"store_true",
1468
help=u"Run self-test")
1469
parser.add_option("--debug", action=u"store_true",
1470
help=u"Debug mode; run in foreground and log to"
1472
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1473
u" priority string (see GnuTLS documentation)")
1474
parser.add_option("--servicename", type=u"string",
1475
metavar=u"NAME", help=u"Zeroconf service name")
1476
parser.add_option("--configdir", type=u"string",
1477
default=u"/etc/mandos", metavar=u"DIR",
1478
help=u"Directory to search for configuration"
1480
parser.add_option("--no-dbus", action=u"store_false",
1481
dest=u"use_dbus", help=u"Do not provide D-Bus"
1482
u" system bus interface")
1483
parser.add_option("--no-ipv6", action=u"store_false",
1484
dest=u"use_ipv6", help=u"Do not use IPv6")
1485
options = parser.parse_args()[0]
3013
1492
# Default values for config file for server-global settings
3014
if gnutls.has_rawpk:
3015
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
3016
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
3018
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
3019
":+SIGN-DSA-SHA256")
3020
server_defaults = {"interface": "",
3024
"priority": priority,
3025
"servicename": "Mandos",
3031
"statedir": "/var/lib/mandos",
3032
"foreground": "False",
1493
server_defaults = { u"interface": u"",
1498
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1499
u"servicename": u"Mandos",
1500
u"use_dbus": u"True",
1501
u"use_ipv6": u"True",
3037
1504
# Parse config file for server-global settings
3038
server_config = configparser.ConfigParser(server_defaults)
1505
server_config = configparser.SafeConfigParser(server_defaults)
3039
1506
del server_defaults
3040
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3041
# Convert the ConfigParser object to a dict
1507
server_config.read(os.path.join(options.configdir,
1509
# Convert the SafeConfigParser object to a dict
3042
1510
server_settings = server_config.defaults()
3043
1511
# Use the appropriate methods on the non-string config options
3044
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3045
"foreground", "zeroconf"):
3046
server_settings[option] = server_config.getboolean("DEFAULT",
1512
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1513
server_settings[option] = server_config.getboolean(u"DEFAULT",
3048
1515
if server_settings["port"]:
3049
server_settings["port"] = server_config.getint("DEFAULT",
3051
if server_settings["socket"]:
3052
server_settings["socket"] = server_config.getint("DEFAULT",
3054
# Later, stdin will, and stdout and stderr might, be dup'ed
3055
# over with an opened os.devnull. But we don't want this to
3056
# happen with a supplied network socket.
3057
if 0 <= server_settings["socket"] <= 2:
3058
server_settings["socket"] = os.dup(server_settings
1516
server_settings["port"] = server_config.getint(u"DEFAULT",
3060
1518
del server_config
3062
1520
# Override the settings from the config file with command line
3063
1521
# options, if set.
3064
for option in ("interface", "address", "port", "debug",
3065
"priority", "servicename", "configdir", "use_dbus",
3066
"use_ipv6", "debuglevel", "restore", "statedir",
3067
"socket", "foreground", "zeroconf"):
1522
for option in (u"interface", u"address", u"port", u"debug",
1523
u"priority", u"servicename", u"configdir",
1524
u"use_dbus", u"use_ipv6"):
3068
1525
value = getattr(options, option)
3069
1526
if value is not None:
3070
1527
server_settings[option] = value
3072
1529
# Force all strings to be unicode
3073
1530
for option in server_settings.keys():
3074
if isinstance(server_settings[option], bytes):
3075
server_settings[option] = (server_settings[option]
3077
# Force all boolean options to be boolean
3078
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3079
"foreground", "zeroconf"):
3080
server_settings[option] = bool(server_settings[option])
3081
# Debug implies foreground
3082
if server_settings["debug"]:
3083
server_settings["foreground"] = True
1531
if type(server_settings[option]) is str:
1532
server_settings[option] = unicode(server_settings[option])
3084
1533
# Now we have our good server settings in "server_settings"
3086
1535
##################################################################
3088
if (not server_settings["zeroconf"]
3089
and not (server_settings["port"]
3090
or server_settings["socket"] != "")):
3091
parser.error("Needs port or socket to work without Zeroconf")
3093
1537
# For convenience
3094
debug = server_settings["debug"]
3095
debuglevel = server_settings["debuglevel"]
3096
use_dbus = server_settings["use_dbus"]
3097
use_ipv6 = server_settings["use_ipv6"]
3098
stored_state_path = os.path.join(server_settings["statedir"],
3100
foreground = server_settings["foreground"]
3101
zeroconf = server_settings["zeroconf"]
3104
initlogger(debug, logging.DEBUG)
3109
level = getattr(logging, debuglevel.upper())
3110
initlogger(debug, level)
3112
if server_settings["servicename"] != "Mandos":
3113
syslogger.setFormatter(
3114
logging.Formatter('Mandos ({}) [%(process)d]:'
3115
' %(levelname)s: %(message)s'.format(
3116
server_settings["servicename"])))
1538
debug = server_settings[u"debug"]
1539
use_dbus = server_settings[u"use_dbus"]
1540
use_ipv6 = server_settings[u"use_ipv6"]
1543
syslogger.setLevel(logging.WARNING)
1544
console.setLevel(logging.WARNING)
1546
if server_settings[u"servicename"] != u"Mandos":
1547
syslogger.setFormatter(logging.Formatter
1548
(u'Mandos (%s) [%%(process)d]:'
1549
u' %%(levelname)s: %%(message)s'
1550
% server_settings[u"servicename"]))
3118
1552
# Parse config file with clients
3119
client_config = configparser.ConfigParser(Client.client_defaults)
3120
client_config.read(os.path.join(server_settings["configdir"],
1553
client_defaults = { u"timeout": u"1h",
1555
u"checker": u"fping -q -- %%(host)s",
1558
client_config = configparser.SafeConfigParser(client_defaults)
1559
client_config.read(os.path.join(server_settings[u"configdir"],
3123
1562
global mandos_dbus_service
3124
1563
mandos_dbus_service = None
3127
if server_settings["socket"] != "":
3128
socketfd = server_settings["socket"]
3129
tcp_server = MandosServer(
3130
(server_settings["address"], server_settings["port"]),
3132
interface=(server_settings["interface"] or None),
3134
gnutls_priority=server_settings["priority"],
3138
pidfilename = "/run/mandos.pid"
3139
if not os.path.isdir("/run/."):
3140
pidfilename = "/var/run/mandos.pid"
3143
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3144
except IOError as e:
3145
logger.error("Could not open file %r", pidfilename,
3148
for name, group in (("_mandos", "_mandos"),
3149
("mandos", "mandos"),
3150
("nobody", "nogroup")):
3152
uid = pwd.getpwnam(name).pw_uid
3153
gid = pwd.getpwnam(group).pw_gid
1565
tcp_server = MandosServer((server_settings[u"address"],
1566
server_settings[u"port"]),
1568
interface=(server_settings[u"interface"]
1572
server_settings[u"priority"],
1574
pidfilename = u"/var/run/mandos.pid"
1576
pidfile = open(pidfilename, u"w")
1578
logger.error(u"Could not open file %r", pidfilename)
1581
uid = pwd.getpwnam(u"_mandos").pw_uid
1582
gid = pwd.getpwnam(u"_mandos").pw_gid
1585
uid = pwd.getpwnam(u"mandos").pw_uid
1586
gid = pwd.getpwnam(u"mandos").pw_gid
3155
1587
except KeyError:
1589
uid = pwd.getpwnam(u"nobody").pw_uid
1590
gid = pwd.getpwnam(u"nobody").pw_gid
3164
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3166
except OSError as error:
3167
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3168
.format(uid, gid, os.strerror(error.errno)))
3169
if error.errno != errno.EPERM:
1597
except OSError, error:
1598
if error[0] != errno.EPERM:
1601
# Enable all possible GnuTLS debugging
3173
# Enable all possible GnuTLS debugging
3175
1603
# "Use a log level over 10 to enable all debugging options."
3176
1604
# - GnuTLS manual
3177
gnutls.global_set_log_level(11)
1605
gnutls.library.functions.gnutls_global_set_log_level(11)
1607
@gnutls.library.types.gnutls_log_func
3180
1608
def debug_gnutls(level, string):
3181
logger.debug("GnuTLS: %s", string[:-1])
3183
gnutls.global_set_log_function(debug_gnutls)
3185
# Redirect stdin so all checkers get /dev/null
3186
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3187
os.dup2(null, sys.stdin.fileno())
3191
# Need to fork before connecting to D-Bus
3193
# Close all input and output, do double fork, etc.
3196
if gi.version_info < (3, 10, 2):
3197
# multiprocessing will use threads, so before we use GLib we
3198
# need to inform GLib that threads will be used.
1609
logger.debug(u"GnuTLS: %s", string[:-1])
1611
(gnutls.library.functions
1612
.gnutls_global_set_log_function(debug_gnutls))
3201
1614
global main_loop
3202
1615
# From the Avahi example code
3203
DBusGMainLoop(set_as_default=True)
3204
main_loop = GLib.MainLoop()
1616
DBusGMainLoop(set_as_default=True )
1617
main_loop = gobject.MainLoop()
3205
1618
bus = dbus.SystemBus()
3206
1619
# End of Avahi example code
3209
bus_name = dbus.service.BusName("se.recompile.Mandos",
3212
old_bus_name = dbus.service.BusName(
3213
"se.bsnet.fukt.Mandos", bus,
3215
except dbus.exceptions.DBusException as e:
3216
logger.error("Disabling D-Bus:", exc_info=e)
1622
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1623
bus, do_not_queue=True)
1624
except dbus.exceptions.NameExistsException, e:
1625
logger.error(unicode(e) + u", disabling D-Bus")
3217
1626
use_dbus = False
3218
server_settings["use_dbus"] = False
1627
server_settings[u"use_dbus"] = False
3219
1628
tcp_server.use_dbus = False
3221
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3222
service = AvahiServiceToSyslog(
3223
name=server_settings["servicename"],
3224
servicetype="_mandos._tcp",
3227
if server_settings["interface"]:
3228
service.interface = if_nametoindex(
3229
server_settings["interface"].encode("utf-8"))
3231
global multiprocessing_manager
3232
multiprocessing_manager = multiprocessing.Manager()
1629
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1630
service = AvahiService(name = server_settings[u"servicename"],
1631
servicetype = u"_mandos._tcp",
1632
protocol = protocol, bus = bus)
1633
if server_settings["interface"]:
1634
service.interface = (if_nametoindex
1635
(str(server_settings[u"interface"])))
3234
1637
client_class = Client
3236
client_class = functools.partial(ClientDBus, bus=bus)
3238
client_settings = Client.config_parser(client_config)
3239
old_client_settings = {}
3242
# This is used to redirect stdout and stderr for checker processes
3244
wnull = open(os.devnull, "w") # A writable /dev/null
3245
# Only used if server is running in foreground but not in debug
3247
if debug or not foreground:
3250
# Get client data and settings from last running state.
3251
if server_settings["restore"]:
3253
with open(stored_state_path, "rb") as stored_state:
3254
if sys.version_info.major == 2:
3255
clients_data, old_client_settings = pickle.load(
3258
bytes_clients_data, bytes_old_client_settings = (
3259
pickle.load(stored_state, encoding="bytes"))
3260
# Fix bytes to strings
3263
clients_data = {(key.decode("utf-8")
3264
if isinstance(key, bytes)
3267
bytes_clients_data.items()}
3268
del bytes_clients_data
3269
for key in clients_data:
3270
value = {(k.decode("utf-8")
3271
if isinstance(k, bytes) else k): v
3273
clients_data[key].items()}
3274
clients_data[key] = value
3276
value["client_structure"] = [
3278
if isinstance(s, bytes)
3280
value["client_structure"]]
3281
# .name, .host, and .checker_command
3282
for k in ("name", "host", "checker_command"):
3283
if isinstance(value[k], bytes):
3284
value[k] = value[k].decode("utf-8")
3285
if "key_id" not in value:
3286
value["key_id"] = ""
3287
elif "fingerprint" not in value:
3288
value["fingerprint"] = ""
3289
# old_client_settings
3291
old_client_settings = {
3292
(key.decode("utf-8")
3293
if isinstance(key, bytes)
3296
bytes_old_client_settings.items()}
3297
del bytes_old_client_settings
3298
# .host and .checker_command
3299
for value in old_client_settings.values():
3300
for attribute in ("host", "checker_command"):
3301
if isinstance(value[attribute], bytes):
3302
value[attribute] = (value[attribute]
3304
os.remove(stored_state_path)
3305
except IOError as e:
3306
if e.errno == errno.ENOENT:
3307
logger.warning("Could not load persistent state:"
3308
" {}".format(os.strerror(e.errno)))
3310
logger.critical("Could not load persistent state:",
3313
except EOFError as e:
3314
logger.warning("Could not load persistent state: "
3318
with PGPEngine() as pgp:
3319
for client_name, client in clients_data.items():
3320
# Skip removed clients
3321
if client_name not in client_settings:
3324
# Decide which value to use after restoring saved state.
3325
# We have three different values: Old config file,
3326
# new config file, and saved state.
3327
# New config value takes precedence if it differs from old
3328
# config value, otherwise use saved state.
3329
for name, value in client_settings[client_name].items():
3331
# For each value in new config, check if it
3332
# differs from the old config value (Except for
3333
# the "secret" attribute)
3334
if (name != "secret"
3336
old_client_settings[client_name][name])):
3337
client[name] = value
3341
# Clients who has passed its expire date can still be
3342
# enabled if its last checker was successful. A Client
3343
# whose checker succeeded before we stored its state is
3344
# assumed to have successfully run all checkers during
3346
if client["enabled"]:
3347
if datetime.datetime.utcnow() >= client["expires"]:
3348
if not client["last_checked_ok"]:
3350
"disabling client {} - Client never "
3351
"performed a successful checker".format(
3353
client["enabled"] = False
3354
elif client["last_checker_status"] != 0:
3356
"disabling client {} - Client last"
3357
" checker failed with error code"
3360
client["last_checker_status"]))
3361
client["enabled"] = False
3363
client["expires"] = (
3364
datetime.datetime.utcnow()
3365
+ client["timeout"])
3366
logger.debug("Last checker succeeded,"
3367
" keeping {} enabled".format(
3370
client["secret"] = pgp.decrypt(
3371
client["encrypted_secret"],
3372
client_settings[client_name]["secret"])
3374
# If decryption fails, we use secret from new settings
3375
logger.debug("Failed to decrypt {} old secret".format(
3377
client["secret"] = (client_settings[client_name]
3380
# Add/remove clients based on new changes made to config
3381
for client_name in (set(old_client_settings)
3382
- set(client_settings)):
3383
del clients_data[client_name]
3384
for client_name in (set(client_settings)
3385
- set(old_client_settings)):
3386
clients_data[client_name] = client_settings[client_name]
3388
# Create all client objects
3389
for client_name, client in clients_data.items():
3390
tcp_server.clients[client_name] = client_class(
3393
server_settings=server_settings)
1639
client_class = functools.partial(ClientDBus, bus = bus)
1640
tcp_server.clients.update(set(
1641
client_class(name = section,
1642
config= dict(client_config.items(section)))
1643
for section in client_config.sections()))
3395
1644
if not tcp_server.clients:
3396
logger.warning("No clients defined")
3399
if pidfile is not None:
1645
logger.warning(u"No clients defined")
1648
# Redirect stdin so all checkers get /dev/null
1649
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1650
os.dup2(null, sys.stdin.fileno())
1654
# No console logging
1655
logger.removeHandler(console)
1656
# Close all input and output, do double fork, etc.
3400
1661
pid = os.getpid()
3403
print(pid, file=pidfile)
3405
logger.error("Could not write to file %r with PID %d",
1662
pidfile.write(str(pid) + "\n")
3410
for termsig in (signal.SIGHUP, signal.SIGTERM):
3411
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3412
lambda: main_loop.quit() and False)
1665
logger.error(u"Could not write to file %r with PID %d",
1668
# "pidfile" was never created
1673
signal.signal(signal.SIGINT, signal.SIG_IGN)
1674
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1675
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3416
@alternate_dbus_interfaces(
3417
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3418
class MandosDBusService(DBusObjectWithObjectManager):
1678
class MandosDBusService(dbus.service.Object):
3419
1679
"""A D-Bus proxy object"""
3421
1680
def __init__(self):
3422
dbus.service.Object.__init__(self, bus, "/")
3424
_interface = "se.recompile.Mandos"
3426
@dbus.service.signal(_interface, signature="o")
1681
dbus.service.Object.__init__(self, bus, u"/")
1682
_interface = u"se.bsnet.fukt.Mandos"
1684
@dbus.service.signal(_interface, signature=u"o")
3427
1685
def ClientAdded(self, objpath):
3431
@dbus.service.signal(_interface, signature="ss")
3432
def ClientNotFound(self, key_id, address):
1689
@dbus.service.signal(_interface, signature=u"ss")
1690
def ClientNotFound(self, fingerprint, address):
3436
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3438
@dbus.service.signal(_interface, signature="os")
1694
@dbus.service.signal(_interface, signature=u"os")
3439
1695
def ClientRemoved(self, objpath, name):
3443
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3445
@dbus.service.method(_interface, out_signature="ao")
1699
@dbus.service.method(_interface, out_signature=u"ao")
3446
1700
def GetAllClients(self):
3448
return dbus.Array(c.dbus_object_path for c in
3449
tcp_server.clients.values())
3451
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1702
return dbus.Array(c.dbus_object_path
1703
for c in tcp_server.clients)
3453
1705
@dbus.service.method(_interface,
3454
out_signature="a{oa{sv}}")
1706
out_signature=u"a{oa{sv}}")
3455
1707
def GetAllClientsWithProperties(self):
3457
1709
return dbus.Dictionary(
3458
{c.dbus_object_path: c.GetAll(
3459
"se.recompile.Mandos.Client")
3460
for c in tcp_server.clients.values()},
3463
@dbus.service.method(_interface, in_signature="o")
1710
((c.dbus_object_path, c.GetAll(u""))
1711
for c in tcp_server.clients),
1712
signature=u"oa{sv}")
1714
@dbus.service.method(_interface, in_signature=u"o")
3464
1715
def RemoveClient(self, object_path):
3466
for c in tcp_server.clients.values():
1717
for c in tcp_server.clients:
3467
1718
if c.dbus_object_path == object_path:
3468
del tcp_server.clients[c.name]
1719
tcp_server.clients.remove(c)
3469
1720
c.remove_from_connection()
3470
# Don't signal the disabling
1721
# Don't signal anything except ClientRemoved
3471
1722
c.disable(quiet=True)
3472
# Emit D-Bus signal for removal
3473
self.client_removed_signal(c)
1724
self.ClientRemoved(object_path, c.name)
3475
1726
raise KeyError(object_path)
3479
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3480
out_signature="a{oa{sa{sv}}}")
3481
def GetManagedObjects(self):
3483
return dbus.Dictionary(
3484
{client.dbus_object_path:
3486
{interface: client.GetAll(interface)
3488
client._get_all_interface_names()})
3489
for client in tcp_server.clients.values()})
3491
def client_added_signal(self, client):
3492
"""Send the new standard signal and the old signal"""
3494
# New standard signal
3495
self.InterfacesAdded(
3496
client.dbus_object_path,
3498
{interface: client.GetAll(interface)
3500
client._get_all_interface_names()}))
3502
self.ClientAdded(client.dbus_object_path)
3504
def client_removed_signal(self, client):
3505
"""Send the new standard signal and the old signal"""
3507
# New standard signal
3508
self.InterfacesRemoved(
3509
client.dbus_object_path,
3510
client._get_all_interface_names())
3512
self.ClientRemoved(client.dbus_object_path,
3515
1730
mandos_dbus_service = MandosDBusService()
3517
# Save modules to variables to exempt the modules from being
3518
# unloaded before the function registered with atexit() is run.
3519
mp = multiprocessing
3523
1733
"Cleanup function; run on exit"
3527
mp.active_children()
3529
if not (tcp_server.clients or client_settings):
3532
# Store client before exiting. Secrets are encrypted with key
3533
# based on what config file has. If config file is
3534
# removed/edited, old secret will thus be unrecovable.
3536
with PGPEngine() as pgp:
3537
for client in tcp_server.clients.values():
3538
key = client_settings[client.name]["secret"]
3539
client.encrypted_secret = pgp.encrypt(client.secret,
3543
# A list of attributes that can not be pickled
3545
exclude = {"bus", "changedstate", "secret",
3546
"checker", "server_settings"}
3547
for name, typ in inspect.getmembers(dbus.service
3551
client_dict["encrypted_secret"] = (client
3553
for attr in client.client_structure:
3554
if attr not in exclude:
3555
client_dict[attr] = getattr(client, attr)
3557
clients[client.name] = client_dict
3558
del client_settings[client.name]["secret"]
3561
with tempfile.NamedTemporaryFile(
3565
dir=os.path.dirname(stored_state_path),
3566
delete=False) as stored_state:
3567
pickle.dump((clients, client_settings), stored_state,
3569
tempname = stored_state.name
3570
os.rename(tempname, stored_state_path)
3571
except (IOError, OSError) as e:
3577
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3578
logger.warning("Could not save persistent state: {}"
3579
.format(os.strerror(e.errno)))
3581
logger.warning("Could not save persistent state:",
3585
# Delete all clients, and settings from config
3586
1736
while tcp_server.clients:
3587
name, client = tcp_server.clients.popitem()
1737
client = tcp_server.clients.pop()
3589
1739
client.remove_from_connection()
3590
# Don't signal the disabling
1740
client.disable_hook = None
1741
# Don't signal anything except ClientRemoved
3591
1742
client.disable(quiet=True)
3592
# Emit D-Bus signal for removal
3594
mandos_dbus_service.client_removed_signal(client)
3595
client_settings.clear()
1745
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3597
1748
atexit.register(cleanup)
3599
for client in tcp_server.clients.values():
1750
for client in tcp_server.clients:
3601
# Emit D-Bus signal for adding
3602
mandos_dbus_service.client_added_signal(client)
3603
# Need to initiate checking of clients
3605
client.init_checker()
1753
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3607
1756
tcp_server.enable()
3608
1757
tcp_server.server_activate()
3610
1759
# Find out what port we got
3612
service.port = tcp_server.socket.getsockname()[1]
1760
service.port = tcp_server.socket.getsockname()[1]
3614
logger.info("Now listening on address %r, port %d,"
3615
" flowinfo %d, scope_id %d",
3616
*tcp_server.socket.getsockname())
1762
logger.info(u"Now listening on address %r, port %d,"
1763
" flowinfo %d, scope_id %d"
1764
% tcp_server.socket.getsockname())
3618
logger.info("Now listening on address %r, port %d",
3619
*tcp_server.socket.getsockname())
3621
# service.interface = tcp_server.socket.getsockname()[3]
1766
logger.info(u"Now listening on address %r, port %d"
1767
% tcp_server.socket.getsockname())
1769
#service.interface = tcp_server.socket.getsockname()[3]
3625
# From the Avahi example code
3628
except dbus.exceptions.DBusException as error:
3629
logger.critical("D-Bus Exception", exc_info=error)
3632
# End of Avahi example code
3635
GLib.IOChannel.unix_new(tcp_server.fileno()),
3636
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3637
lambda *args, **kwargs: (tcp_server.handle_request
3638
(*args[2:], **kwargs) or True))
3640
logger.debug("Starting main loop")
1772
# From the Avahi example code
1775
except dbus.exceptions.DBusException, error:
1776
logger.critical(u"DBusException: %s", error)
1779
# End of Avahi example code
1781
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1782
lambda *args, **kwargs:
1783
(tcp_server.handle_request
1784
(*args[2:], **kwargs) or True))
1786
logger.debug(u"Starting main loop")
3641
1787
main_loop.run()
3642
except AvahiError as error:
3643
logger.critical("Avahi Error", exc_info=error)
1788
except AvahiError, error:
1789
logger.critical(u"AvahiError: %s", error)
3646
1792
except KeyboardInterrupt:
3648
print("", file=sys.stderr)
3649
logger.debug("Server received KeyboardInterrupt")
3650
logger.debug("Server exiting")
1795
logger.debug(u"Server received KeyboardInterrupt")
1796
logger.debug(u"Server exiting")
3651
1797
# Must run before the D-Bus bus name gets deregistered
3655
def should_only_run_tests():
3656
parser = argparse.ArgumentParser(add_help=False)
3657
parser.add_argument("--check", action='store_true')
3658
args, unknown_args = parser.parse_known_args()
3659
run_tests = args.check
3661
# Remove --check argument from sys.argv
3662
sys.argv[1:] = unknown_args
3665
# Add all tests from doctest strings
3666
def load_tests(loader, tests, none):
3668
tests.addTests(doctest.DocTestSuite())
3671
1800
if __name__ == '__main__':
3673
if should_only_run_tests():
3674
# Call using ./mandos --check [--verbose]