418
189
dbus.UInt16(self.port),
419
190
avahi.string_array_to_txt_array(self.TXT))
420
191
self.group.Commit()
422
192
def entry_group_state_changed(self, state, error):
423
193
"""Derived from the Avahi example code"""
424
logger.debug("Avahi entry group state change: %i", state)
194
logger.debug(u"Avahi state change: %i", state)
426
196
if state == avahi.ENTRY_GROUP_ESTABLISHED:
427
logger.debug("Zeroconf service established.")
197
logger.debug(u"Zeroconf service established.")
428
198
elif state == avahi.ENTRY_GROUP_COLLISION:
429
logger.info("Zeroconf service name collision.")
199
logger.warning(u"Zeroconf service name collision.")
431
201
elif state == avahi.ENTRY_GROUP_FAILURE:
432
logger.critical("Avahi: Error in group state changed %s",
434
raise AvahiGroupError("State changed: {!s}".format(error))
202
logger.critical(u"Avahi: Error in group state changed %s",
204
raise AvahiGroupError(u"State changed: %s"
436
206
def cleanup(self):
437
207
"""Derived from the Avahi example code"""
438
208
if self.group is not None:
441
except (dbus.exceptions.UnknownMethodException,
442
dbus.exceptions.DBusException):
444
210
self.group = None
447
def server_state_changed(self, state, error=None):
211
def server_state_changed(self, state):
448
212
"""Derived from the Avahi example code"""
449
logger.debug("Avahi server state change: %i", state)
451
avahi.SERVER_INVALID: "Zeroconf server invalid",
452
avahi.SERVER_REGISTERING: None,
453
avahi.SERVER_COLLISION: "Zeroconf server name collision",
454
avahi.SERVER_FAILURE: "Zeroconf server failure",
456
if state in bad_states:
457
if bad_states[state] is not None:
459
logger.error(bad_states[state])
461
logger.error(bad_states[state] + ": %r", error)
213
if state == avahi.SERVER_COLLISION:
214
logger.error(u"Zeroconf server name collision")
463
216
elif state == avahi.SERVER_RUNNING:
466
except dbus.exceptions.DBusException as error:
467
if (error.get_dbus_name()
468
== "org.freedesktop.Avahi.CollisionError"):
469
logger.info("Local Zeroconf service name"
471
return self.rename(remove=False)
473
logger.critical("D-Bus Exception", exc_info=error)
478
logger.debug("Unknown state: %r", state)
480
logger.debug("Unknown state: %r: %r", state, error)
482
218
def activate(self):
483
219
"""Derived from the Avahi example code"""
484
220
if self.server is None:
485
221
self.server = dbus.Interface(
486
222
self.bus.get_object(avahi.DBUS_NAME,
487
avahi.DBUS_PATH_SERVER,
488
follow_name_owner_changes=True),
223
avahi.DBUS_PATH_SERVER),
489
224
avahi.DBUS_INTERFACE_SERVER)
490
self.server.connect_to_signal("StateChanged",
491
self.server_state_changed)
225
self.server.connect_to_signal(u"StateChanged",
226
self.server_state_changed)
492
227
self.server_state_changed(self.server.GetState())
495
class AvahiServiceToSyslog(AvahiService):
496
def rename(self, *args, **kwargs):
497
"""Add the new name to the syslog messages"""
498
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
499
syslogger.setFormatter(logging.Formatter(
500
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
505
# Pretend that we have a GnuTLS module
506
class gnutls(object):
507
"""This isn't so much a class as it is a module-like namespace."""
509
library = ctypes.util.find_library("gnutls")
511
library = ctypes.util.find_library("gnutls-deb0")
512
_library = ctypes.cdll.LoadLibrary(library)
515
# Unless otherwise indicated, the constants and types below are
516
# all from the gnutls/gnutls.h C header file.
527
E_NO_CERTIFICATE_FOUND = -49
532
KEYID_USE_SHA256 = 1 # gnutls/x509.h
533
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
536
class session_int(ctypes.Structure):
538
session_t = ctypes.POINTER(session_int)
540
class certificate_credentials_st(ctypes.Structure):
542
certificate_credentials_t = ctypes.POINTER(
543
certificate_credentials_st)
544
certificate_type_t = ctypes.c_int
546
class datum_t(ctypes.Structure):
547
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
548
('size', ctypes.c_uint)]
550
class openpgp_crt_int(ctypes.Structure):
552
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
553
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
554
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
555
credentials_type_t = ctypes.c_int
556
transport_ptr_t = ctypes.c_void_p
557
close_request_t = ctypes.c_int
560
class Error(Exception):
561
def __init__(self, message=None, code=None, args=()):
562
# Default usage is by a message string, but if a return
563
# code is passed, convert it to a string with
566
if message is None and code is not None:
567
message = gnutls.strerror(code)
568
return super(gnutls.Error, self).__init__(
571
class CertificateSecurityError(Error):
575
class Credentials(object):
577
self._c_object = gnutls.certificate_credentials_t()
578
gnutls.certificate_allocate_credentials(
579
ctypes.byref(self._c_object))
580
self.type = gnutls.CRD_CERTIFICATE
583
gnutls.certificate_free_credentials(self._c_object)
585
class ClientSession(object):
586
def __init__(self, socket, credentials=None):
587
self._c_object = gnutls.session_t()
588
gnutls_flags = gnutls.CLIENT
589
if gnutls.check_version("3.5.6"):
590
gnutls_flags |= gnutls.NO_TICKETS
592
gnutls_flags |= gnutls.ENABLE_RAWPK
593
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
595
gnutls.set_default_priority(self._c_object)
596
gnutls.transport_set_ptr(self._c_object, socket.fileno())
597
gnutls.handshake_set_private_extensions(self._c_object,
600
if credentials is None:
601
credentials = gnutls.Credentials()
602
gnutls.credentials_set(self._c_object, credentials.type,
603
ctypes.cast(credentials._c_object,
605
self.credentials = credentials
608
gnutls.deinit(self._c_object)
611
return gnutls.handshake(self._c_object)
613
def send(self, data):
617
data_len -= gnutls.record_send(self._c_object,
622
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
624
# Error handling functions
625
def _error_code(result):
626
"""A function to raise exceptions on errors, suitable
627
for the 'restype' attribute on ctypes functions"""
630
if result == gnutls.E_NO_CERTIFICATE_FOUND:
631
raise gnutls.CertificateSecurityError(code=result)
632
raise gnutls.Error(code=result)
634
def _retry_on_error(result, func, arguments):
635
"""A function to retry on some errors, suitable
636
for the 'errcheck' attribute on ctypes functions"""
638
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
639
return _error_code(result)
640
result = func(*arguments)
643
# Unless otherwise indicated, the function declarations below are
644
# all from the gnutls/gnutls.h C header file.
647
priority_set_direct = _library.gnutls_priority_set_direct
648
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
649
ctypes.POINTER(ctypes.c_char_p)]
650
priority_set_direct.restype = _error_code
652
init = _library.gnutls_init
653
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
654
init.restype = _error_code
656
set_default_priority = _library.gnutls_set_default_priority
657
set_default_priority.argtypes = [session_t]
658
set_default_priority.restype = _error_code
660
record_send = _library.gnutls_record_send
661
record_send.argtypes = [session_t, ctypes.c_void_p,
663
record_send.restype = ctypes.c_ssize_t
664
record_send.errcheck = _retry_on_error
666
certificate_allocate_credentials = (
667
_library.gnutls_certificate_allocate_credentials)
668
certificate_allocate_credentials.argtypes = [
669
ctypes.POINTER(certificate_credentials_t)]
670
certificate_allocate_credentials.restype = _error_code
672
certificate_free_credentials = (
673
_library.gnutls_certificate_free_credentials)
674
certificate_free_credentials.argtypes = [
675
certificate_credentials_t]
676
certificate_free_credentials.restype = None
678
handshake_set_private_extensions = (
679
_library.gnutls_handshake_set_private_extensions)
680
handshake_set_private_extensions.argtypes = [session_t,
682
handshake_set_private_extensions.restype = None
684
credentials_set = _library.gnutls_credentials_set
685
credentials_set.argtypes = [session_t, credentials_type_t,
687
credentials_set.restype = _error_code
689
strerror = _library.gnutls_strerror
690
strerror.argtypes = [ctypes.c_int]
691
strerror.restype = ctypes.c_char_p
693
certificate_type_get = _library.gnutls_certificate_type_get
694
certificate_type_get.argtypes = [session_t]
695
certificate_type_get.restype = _error_code
697
certificate_get_peers = _library.gnutls_certificate_get_peers
698
certificate_get_peers.argtypes = [session_t,
699
ctypes.POINTER(ctypes.c_uint)]
700
certificate_get_peers.restype = ctypes.POINTER(datum_t)
702
global_set_log_level = _library.gnutls_global_set_log_level
703
global_set_log_level.argtypes = [ctypes.c_int]
704
global_set_log_level.restype = None
706
global_set_log_function = _library.gnutls_global_set_log_function
707
global_set_log_function.argtypes = [log_func]
708
global_set_log_function.restype = None
710
deinit = _library.gnutls_deinit
711
deinit.argtypes = [session_t]
712
deinit.restype = None
714
handshake = _library.gnutls_handshake
715
handshake.argtypes = [session_t]
716
handshake.restype = _error_code
717
handshake.errcheck = _retry_on_error
719
transport_set_ptr = _library.gnutls_transport_set_ptr
720
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
721
transport_set_ptr.restype = None
723
bye = _library.gnutls_bye
724
bye.argtypes = [session_t, close_request_t]
725
bye.restype = _error_code
726
bye.errcheck = _retry_on_error
728
check_version = _library.gnutls_check_version
729
check_version.argtypes = [ctypes.c_char_p]
730
check_version.restype = ctypes.c_char_p
732
_need_version = b"3.3.0"
733
if check_version(_need_version) is None:
734
raise self.Error("Needs GnuTLS {} or later"
735
.format(_need_version))
737
_tls_rawpk_version = b"3.6.6"
738
has_rawpk = bool(check_version(_tls_rawpk_version))
742
class pubkey_st(ctypes.Structure):
744
pubkey_t = ctypes.POINTER(pubkey_st)
746
x509_crt_fmt_t = ctypes.c_int
748
# All the function declarations below are from gnutls/abstract.h
749
pubkey_init = _library.gnutls_pubkey_init
750
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
751
pubkey_init.restype = _error_code
753
pubkey_import = _library.gnutls_pubkey_import
754
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
756
pubkey_import.restype = _error_code
758
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
759
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
760
ctypes.POINTER(ctypes.c_ubyte),
761
ctypes.POINTER(ctypes.c_size_t)]
762
pubkey_get_key_id.restype = _error_code
764
pubkey_deinit = _library.gnutls_pubkey_deinit
765
pubkey_deinit.argtypes = [pubkey_t]
766
pubkey_deinit.restype = None
768
# All the function declarations below are from gnutls/openpgp.h
770
openpgp_crt_init = _library.gnutls_openpgp_crt_init
771
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
772
openpgp_crt_init.restype = _error_code
774
openpgp_crt_import = _library.gnutls_openpgp_crt_import
775
openpgp_crt_import.argtypes = [openpgp_crt_t,
776
ctypes.POINTER(datum_t),
778
openpgp_crt_import.restype = _error_code
780
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
781
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
782
ctypes.POINTER(ctypes.c_uint)]
783
openpgp_crt_verify_self.restype = _error_code
785
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
786
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
787
openpgp_crt_deinit.restype = None
789
openpgp_crt_get_fingerprint = (
790
_library.gnutls_openpgp_crt_get_fingerprint)
791
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
795
openpgp_crt_get_fingerprint.restype = _error_code
797
if check_version("3.6.4"):
798
certificate_type_get2 = _library.gnutls_certificate_type_get2
799
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
800
certificate_type_get2.restype = _error_code
802
# Remove non-public functions
803
del _error_code, _retry_on_error
806
def call_pipe(connection, # : multiprocessing.Connection
807
func, *args, **kwargs):
808
"""This function is meant to be called by multiprocessing.Process
810
This function runs func(*args, **kwargs), and writes the resulting
811
return value on the provided multiprocessing.Connection.
813
connection.send(func(*args, **kwargs))
817
230
class Client(object):
818
231
"""A representation of a client host served by this server.
821
approved: bool(); 'None' if not yet approved/disapproved
822
approval_delay: datetime.timedelta(); Time to wait for approval
823
approval_duration: datetime.timedelta(); Duration of one approval
234
name: string; from the config file, used in log messages and
236
fingerprint: string (40 or 32 hexadecimal digits); used to
237
uniquely identify the client
238
secret: bytestring; sent verbatim (over TLS) to client
239
host: string; available for use by the checker command
240
created: datetime.datetime(); (UTC) object creation
241
last_enabled: datetime.datetime(); (UTC)
243
last_checked_ok: datetime.datetime(); (UTC) or None
244
timeout: datetime.timedelta(); How long from last_checked_ok
245
until this client is invalid
246
interval: datetime.timedelta(); How often to start a new checker
247
disable_hook: If set, called by disable() as disable_hook(self)
824
248
checker: subprocess.Popen(); a running checker process used
825
249
to see if the client lives.
826
250
'None' if no process is running.
827
checker_callback_tag: a GLib event source tag, or None
828
checker_command: string; External command which is run to check
829
if client lives. %() expansions are done at
251
checker_initiator_tag: a gobject event source tag, or None
252
disable_initiator_tag: - '' -
253
checker_callback_tag: - '' -
254
checker_command: string; External command which is run to check if
255
client lives. %() expansions are done at
830
256
runtime with vars(self) as dict, so that for
831
257
instance %(name)s can be used in the command.
832
checker_initiator_tag: a GLib event source tag, or None
833
created: datetime.datetime(); (UTC) object creation
834
client_structure: Object describing what attributes a client has
835
and is used for storing the client at exit
836
258
current_checker_command: string; current running checker_command
837
disable_initiator_tag: a GLib event source tag, or None
839
fingerprint: string (40 or 32 hexadecimal digits); used to
840
uniquely identify an OpenPGP client
841
key_id: string (64 hexadecimal digits); used to uniquely identify
842
a client using raw public keys
843
host: string; available for use by the checker command
844
interval: datetime.timedelta(); How often to start a new checker
845
last_approval_request: datetime.datetime(); (UTC) or None
846
last_checked_ok: datetime.datetime(); (UTC) or None
847
last_checker_status: integer between 0 and 255 reflecting exit
848
status of last checker. -1 reflects crashed
849
checker, -2 means no checker completed yet.
850
last_checker_signal: The signal which killed the last checker, if
851
last_checker_status is -1
852
last_enabled: datetime.datetime(); (UTC) or None
853
name: string; from the config file, used in log messages and
855
secret: bytestring; sent verbatim (over TLS) to client
856
timeout: datetime.timedelta(); How long from last_checked_ok
857
until this client is disabled
858
extended_timeout: extra long timeout when secret has been sent
859
runtime_expansions: Allowed attributes for runtime expansion.
860
expires: datetime.datetime(); time (UTC) when a client will be
862
server_settings: The server_settings dict from main()
865
runtime_expansions = ("approval_delay", "approval_duration",
866
"created", "enabled", "expires", "key_id",
867
"fingerprint", "host", "interval",
868
"last_approval_request", "last_checked_ok",
869
"last_enabled", "name", "timeout")
872
"extended_timeout": "PT15M",
874
"checker": "fping -q -- %%(host)s",
876
"approval_delay": "PT0S",
877
"approval_duration": "PT1S",
878
"approved_by_default": "True",
883
def config_parser(config):
884
"""Construct a new dict of client settings of this form:
885
{ client_name: {setting_name: value, ...}, ...}
886
with exceptions for any special settings as defined above.
887
NOTE: Must be a pure function. Must return the same result
888
value given the same arguments.
891
for client_name in config.sections():
892
section = dict(config.items(client_name))
893
client = settings[client_name] = {}
895
client["host"] = section["host"]
896
# Reformat values from string types to Python types
897
client["approved_by_default"] = config.getboolean(
898
client_name, "approved_by_default")
899
client["enabled"] = config.getboolean(client_name,
902
# Uppercase and remove spaces from key_id and fingerprint
903
# for later comparison purposes with return value from the
904
# key_id() and fingerprint() functions
905
client["key_id"] = (section.get("key_id", "").upper()
907
client["fingerprint"] = (section["fingerprint"].upper()
909
if "secret" in section:
910
client["secret"] = codecs.decode(section["secret"]
913
elif "secfile" in section:
914
with open(os.path.expanduser(os.path.expandvars
915
(section["secfile"])),
917
client["secret"] = secfile.read()
919
raise TypeError("No secret or secfile for section {}"
921
client["timeout"] = string_to_delta(section["timeout"])
922
client["extended_timeout"] = string_to_delta(
923
section["extended_timeout"])
924
client["interval"] = string_to_delta(section["interval"])
925
client["approval_delay"] = string_to_delta(
926
section["approval_delay"])
927
client["approval_duration"] = string_to_delta(
928
section["approval_duration"])
929
client["checker_command"] = section["checker"]
930
client["last_approval_request"] = None
931
client["last_checked_ok"] = None
932
client["last_checker_status"] = -2
936
def __init__(self, settings, name=None, server_settings=None):
262
def _timedelta_to_milliseconds(td):
263
"Convert a datetime.timedelta() to milliseconds"
264
return ((td.days * 24 * 60 * 60 * 1000)
265
+ (td.seconds * 1000)
266
+ (td.microseconds // 1000))
268
def timeout_milliseconds(self):
269
"Return the 'timeout' attribute in milliseconds"
270
return self._timedelta_to_milliseconds(self.timeout)
272
def interval_milliseconds(self):
273
"Return the 'interval' attribute in milliseconds"
274
return self._timedelta_to_milliseconds(self.interval)
276
def __init__(self, name = None, disable_hook=None, config=None):
277
"""Note: the 'checker' key in 'config' sets the
278
'checker_command' attribute and *not* the 'checker'
938
if server_settings is None:
940
self.server_settings = server_settings
941
# adding all client settings
942
for setting, value in settings.items():
943
setattr(self, setting, value)
946
if not hasattr(self, "last_enabled"):
947
self.last_enabled = datetime.datetime.utcnow()
948
if not hasattr(self, "expires"):
949
self.expires = (datetime.datetime.utcnow()
283
logger.debug(u"Creating client %r", self.name)
284
# Uppercase and remove spaces from fingerprint for later
285
# comparison purposes with return value from the fingerprint()
287
self.fingerprint = (config[u"fingerprint"].upper()
289
logger.debug(u" Fingerprint: %s", self.fingerprint)
290
if u"secret" in config:
291
self.secret = config[u"secret"].decode(u"base64")
292
elif u"secfile" in config:
293
with closing(open(os.path.expanduser
295
(config[u"secfile"])),
297
self.secret = secfile.read()
952
self.last_enabled = None
955
logger.debug("Creating client %r", self.name)
956
logger.debug(" Key ID: %s", self.key_id)
957
logger.debug(" Fingerprint: %s", self.fingerprint)
958
self.created = settings.get("created",
959
datetime.datetime.utcnow())
961
# attributes specific for this server instance
299
raise TypeError(u"No secret or secfile for client %s"
301
self.host = config.get(u"host", u"")
302
self.created = datetime.datetime.utcnow()
304
self.last_enabled = None
305
self.last_checked_ok = None
306
self.timeout = string_to_delta(config[u"timeout"])
307
self.interval = string_to_delta(config[u"interval"])
308
self.disable_hook = disable_hook
962
309
self.checker = None
963
310
self.checker_initiator_tag = None
964
311
self.disable_initiator_tag = None
965
312
self.checker_callback_tag = None
313
self.checker_command = config[u"checker"]
966
314
self.current_checker_command = None
968
self.approvals_pending = 0
969
self.changedstate = multiprocessing_manager.Condition(
970
multiprocessing_manager.Lock())
971
self.client_structure = [attr
972
for attr in self.__dict__.keys()
973
if not attr.startswith("_")]
974
self.client_structure.append("client_structure")
976
for name, t in inspect.getmembers(
977
type(self), lambda obj: isinstance(obj, property)):
978
if not name.startswith("_"):
979
self.client_structure.append(name)
981
# Send notice to process children that client state has changed
982
def send_changedstate(self):
983
with self.changedstate:
984
self.changedstate.notify_all()
315
self.last_connect = None
986
317
def enable(self):
987
318
"""Start this client's checker and timeout hooks"""
988
if getattr(self, "enabled", False):
319
if getattr(self, u"enabled", False):
989
320
# Already enabled
991
self.expires = datetime.datetime.utcnow() + self.timeout
993
322
self.last_enabled = datetime.datetime.utcnow()
995
self.send_changedstate()
323
# Schedule a new checker to be started an 'interval' from now,
324
# and every interval from then on.
325
self.checker_initiator_tag = (gobject.timeout_add
326
(self.interval_milliseconds(),
328
# Schedule a disable() when 'timeout' has passed
329
self.disable_initiator_tag = (gobject.timeout_add
330
(self.timeout_milliseconds(),
333
# Also start a new checker *right now*.
997
336
def disable(self, quiet=True):
998
337
"""Disable this client."""
999
338
if not getattr(self, "enabled", False):
1002
logger.info("Disabling client %s", self.name)
1003
if getattr(self, "disable_initiator_tag", None) is not None:
1004
GLib.source_remove(self.disable_initiator_tag)
341
logger.info(u"Disabling client %s", self.name)
342
if getattr(self, u"disable_initiator_tag", False):
343
gobject.source_remove(self.disable_initiator_tag)
1005
344
self.disable_initiator_tag = None
1007
if getattr(self, "checker_initiator_tag", None) is not None:
1008
GLib.source_remove(self.checker_initiator_tag)
345
if getattr(self, u"checker_initiator_tag", False):
346
gobject.source_remove(self.checker_initiator_tag)
1009
347
self.checker_initiator_tag = None
1010
348
self.stop_checker()
349
if self.disable_hook:
350
self.disable_hook(self)
1011
351
self.enabled = False
1013
self.send_changedstate()
1014
# Do not run this again if called by a GLib.timeout_add
352
# Do not run this again if called by a gobject.timeout_add
1017
355
def __del__(self):
356
self.disable_hook = None
1020
def init_checker(self):
1021
# Schedule a new checker to be started an 'interval' from now,
1022
# and every interval from then on.
1023
if self.checker_initiator_tag is not None:
1024
GLib.source_remove(self.checker_initiator_tag)
1025
self.checker_initiator_tag = GLib.timeout_add(
1026
int(self.interval.total_seconds() * 1000),
1028
# Schedule a disable() when 'timeout' has passed
1029
if self.disable_initiator_tag is not None:
1030
GLib.source_remove(self.disable_initiator_tag)
1031
self.disable_initiator_tag = GLib.timeout_add(
1032
int(self.timeout.total_seconds() * 1000), self.disable)
1033
# Also start a new checker *right now*.
1034
self.start_checker()
1036
def checker_callback(self, source, condition, connection,
359
def checker_callback(self, pid, condition, command):
1038
360
"""The checker has completed, so take appropriate actions."""
1039
361
self.checker_callback_tag = None
1040
362
self.checker = None
1041
# Read return code from connection (see call_pipe)
1042
returncode = connection.recv()
1046
self.last_checker_status = returncode
1047
self.last_checker_signal = None
1048
if self.last_checker_status == 0:
1049
logger.info("Checker for %(name)s succeeded",
363
if os.WIFEXITED(condition):
364
exitstatus = os.WEXITSTATUS(condition)
366
logger.info(u"Checker for %(name)s succeeded",
1051
368
self.checked_ok()
1053
logger.info("Checker for %(name)s failed", vars(self))
370
logger.info(u"Checker for %(name)s failed",
1055
self.last_checker_status = -1
1056
self.last_checker_signal = -returncode
1057
logger.warning("Checker for %(name)s crashed?",
373
logger.warning(u"Checker for %(name)s crashed?",
1061
376
def checked_ok(self):
1062
"""Assert that the client has been seen, alive and well."""
377
"""Bump up the timeout for this client.
379
This should only be called when the client has been seen,
1063
382
self.last_checked_ok = datetime.datetime.utcnow()
1064
self.last_checker_status = 0
1065
self.last_checker_signal = None
1068
def bump_timeout(self, timeout=None):
1069
"""Bump up the timeout for this client."""
1071
timeout = self.timeout
1072
if self.disable_initiator_tag is not None:
1073
GLib.source_remove(self.disable_initiator_tag)
1074
self.disable_initiator_tag = None
1075
if getattr(self, "enabled", False):
1076
self.disable_initiator_tag = GLib.timeout_add(
1077
int(timeout.total_seconds() * 1000), self.disable)
1078
self.expires = datetime.datetime.utcnow() + timeout
1080
def need_approval(self):
1081
self.last_approval_request = datetime.datetime.utcnow()
383
gobject.source_remove(self.disable_initiator_tag)
384
self.disable_initiator_tag = (gobject.timeout_add
385
(self.timeout_milliseconds(),
1083
388
def start_checker(self):
1084
389
"""Start a new checker subprocess if one is not running.
1086
391
If a checker already exists, leave it running and do
1088
393
# The reason for not killing a running checker is that if we
1089
# did that, and if a checker (for some reason) started running
1090
# slowly and taking more than 'interval' time, then the client
1091
# would inevitably timeout, since no checker would get a
1092
# chance to run to completion. If we instead leave running
394
# did that, then if a checker (for some reason) started
395
# running slowly and taking more than 'interval' time, the
396
# client would inevitably timeout, since no checker would get
397
# a chance to run to completion. If we instead leave running
1093
398
# checkers alone, the checker would have to take more time
1094
# than 'timeout' for the client to be disabled, which is as it
1097
if self.checker is not None and not self.checker.is_alive():
1098
logger.warning("Checker was not alive; joining")
399
# than 'timeout' for the client to be declared invalid, which
400
# is as it should be.
402
# If a checker exists, make sure it is not a zombie
404
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
405
except (AttributeError, OSError), error:
406
if (isinstance(error, OSError)
407
and error.errno != errno.ECHILD):
411
logger.warning(u"Checker was a zombie")
412
gobject.source_remove(self.checker_callback_tag)
413
self.checker_callback(pid, status,
414
self.current_checker_command)
1101
415
# Start a new checker if needed
1102
416
if self.checker is None:
1103
# Escape attributes for the shell
1105
attr: re.escape(str(getattr(self, attr)))
1106
for attr in self.runtime_expansions}
1108
command = self.checker_command % escaped_attrs
1109
except TypeError as error:
1110
logger.error('Could not format string "%s"',
1111
self.checker_command,
1113
return True # Try again later
418
# In case checker_command has exactly one % operator
419
command = self.checker_command % self.host
421
# Escape attributes for the shell
422
escaped_attrs = dict((key,
423
re.escape(unicode(str(val),
427
vars(self).iteritems())
429
command = self.checker_command % escaped_attrs
430
except TypeError, error:
431
logger.error(u'Could not format string "%s":'
432
u' %s', self.checker_command, error)
433
return True # Try again later
1114
434
self.current_checker_command = command
1115
logger.info("Starting checker %r for %s", command,
1117
# We don't need to redirect stdout and stderr, since
1118
# in normal mode, that is already done by daemon(),
1119
# and in debug mode we don't want to. (Stdin is
1120
# always replaced by /dev/null.)
1121
# The exception is when not debugging but nevertheless
1122
# running in the foreground; use the previously
1124
popen_args = {"close_fds": True,
1127
if (not self.server_settings["debug"]
1128
and self.server_settings["foreground"]):
1129
popen_args.update({"stdout": wnull,
1131
pipe = multiprocessing.Pipe(duplex=False)
1132
self.checker = multiprocessing.Process(
1134
args=(pipe[1], subprocess.call, command),
1136
self.checker.start()
1137
self.checker_callback_tag = GLib.io_add_watch(
1138
pipe[0].fileno(), GLib.IO_IN,
1139
self.checker_callback, pipe[0], command)
1140
# Re-run this periodically if run by GLib.timeout_add
436
logger.info(u"Starting checker %r for %s",
438
# We don't need to redirect stdout and stderr, since
439
# in normal mode, that is already done by daemon(),
440
# and in debug mode we don't want to. (Stdin is
441
# always replaced by /dev/null.)
442
self.checker = subprocess.Popen(command,
444
shell=True, cwd=u"/")
445
self.checker_callback_tag = (gobject.child_watch_add
447
self.checker_callback,
449
# The checker may have completed before the gobject
450
# watch was added. Check for this.
451
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
453
gobject.source_remove(self.checker_callback_tag)
454
self.checker_callback(pid, status, command)
455
except OSError, error:
456
logger.error(u"Failed to start subprocess: %s",
458
# Re-run this periodically if run by gobject.timeout_add
1143
461
def stop_checker(self):
1144
462
"""Force the checker process, if any, to stop."""
1145
463
if self.checker_callback_tag:
1146
GLib.source_remove(self.checker_callback_tag)
464
gobject.source_remove(self.checker_callback_tag)
1147
465
self.checker_callback_tag = None
1148
if getattr(self, "checker", None) is None:
466
if getattr(self, u"checker", None) is None:
1150
logger.debug("Stopping checker for %(name)s", vars(self))
1151
self.checker.terminate()
468
logger.debug(u"Stopping checker for %(name)s", vars(self))
470
os.kill(self.checker.pid, signal.SIGTERM)
472
#if self.checker.poll() is None:
473
# os.kill(self.checker.pid, signal.SIGKILL)
474
except OSError, error:
475
if error.errno != errno.ESRCH: # No such process
1152
477
self.checker = None
1155
def dbus_service_property(dbus_interface,
479
def still_valid(self):
480
"""Has the timeout not yet passed for this client?"""
481
if not getattr(self, u"enabled", False):
483
now = datetime.datetime.utcnow()
484
if self.last_checked_ok is None:
485
return now < (self.created + self.timeout)
487
return now < (self.last_checked_ok + self.timeout)
490
def dbus_service_property(dbus_interface, signature=u"v",
491
access=u"readwrite", byte_arrays=False):
1159
492
"""Decorators for marking methods of a DBusObjectWithProperties to
1160
493
become properties on the D-Bus.
1162
495
The decorated method will be called with no arguments by "Get"
1163
496
and with one argument by "Set".
1165
498
The parameters, where they are supported, are the same as
1166
499
dbus.service.method, except there is only "signature", since the
1167
500
type from Get() and the type sent to Set() is the same.
1169
# Encoding deeply encoded byte arrays is not supported yet by the
1170
# "Set" method, so we fail early here:
1171
if byte_arrays and signature != "ay":
1172
raise ValueError("Byte arrays not supported for non-'ay'"
1173
" signature {!r}".format(signature))
1175
502
def decorator(func):
1176
503
func._dbus_is_property = True
1177
504
func._dbus_interface = dbus_interface
1178
505
func._dbus_signature = signature
1179
506
func._dbus_access = access
1180
507
func._dbus_name = func.__name__
1181
if func._dbus_name.endswith("_dbus_property"):
508
if func._dbus_name.endswith(u"_dbus_property"):
1182
509
func._dbus_name = func._dbus_name[:-14]
1183
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1189
def dbus_interface_annotations(dbus_interface):
1190
"""Decorator for marking functions returning interface annotations
1194
@dbus_interface_annotations("org.example.Interface")
1195
def _foo(self): # Function name does not matter
1196
return {"org.freedesktop.DBus.Deprecated": "true",
1197
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1201
def decorator(func):
1202
func._dbus_is_interface = True
1203
func._dbus_interface = dbus_interface
1204
func._dbus_name = dbus_interface
1210
def dbus_annotations(annotations):
1211
"""Decorator to annotate D-Bus methods, signals or properties
1214
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1215
"org.freedesktop.DBus.Property."
1216
"EmitsChangedSignal": "false"})
1217
@dbus_service_property("org.example.Interface", signature="b",
1219
def Property_dbus_property(self):
1220
return dbus.Boolean(False)
1222
See also the DBusObjectWithAnnotations class.
1225
def decorator(func):
1226
func._dbus_annotations = annotations
510
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
1229
512
return decorator
1232
515
class DBusPropertyException(dbus.exceptions.DBusException):
1233
516
"""A base class for D-Bus property-related exceptions
518
def __unicode__(self):
519
return unicode(str(self))
1238
522
class DBusPropertyAccessException(DBusPropertyException):
1250
class DBusObjectWithAnnotations(dbus.service.Object):
1251
"""A D-Bus object with annotations.
1253
Classes inheriting from this can use the dbus_annotations
1254
decorator to add annotations to methods or signals.
1258
def _is_dbus_thing(thing):
1259
"""Returns a function testing if an attribute is a D-Bus thing
1261
If called like _is_dbus_thing("method") it returns a function
1262
suitable for use as predicate to inspect.getmembers().
1264
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1267
def _get_all_dbus_things(self, thing):
1268
"""Returns a generator of (name, attribute) pairs
1270
return ((getattr(athing.__get__(self), "_dbus_name", name),
1271
athing.__get__(self))
1272
for cls in self.__class__.__mro__
1274
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1276
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1278
path_keyword='object_path',
1279
connection_keyword='connection')
1280
def Introspect(self, object_path, connection):
1281
"""Overloading of standard D-Bus method.
1283
Inserts annotation tags on methods and signals.
1285
xmlstring = dbus.service.Object.Introspect(self, object_path,
1288
document = xml.dom.minidom.parseString(xmlstring)
1290
for if_tag in document.getElementsByTagName("interface"):
1291
# Add annotation tags
1292
for typ in ("method", "signal"):
1293
for tag in if_tag.getElementsByTagName(typ):
1295
for name, prop in (self.
1296
_get_all_dbus_things(typ)):
1297
if (name == tag.getAttribute("name")
1298
and prop._dbus_interface
1299
== if_tag.getAttribute("name")):
1300
annots.update(getattr(
1301
prop, "_dbus_annotations", {}))
1302
for name, value in annots.items():
1303
ann_tag = document.createElement(
1305
ann_tag.setAttribute("name", name)
1306
ann_tag.setAttribute("value", value)
1307
tag.appendChild(ann_tag)
1308
# Add interface annotation tags
1309
for annotation, value in dict(
1310
itertools.chain.from_iterable(
1311
annotations().items()
1312
for name, annotations
1313
in self._get_all_dbus_things("interface")
1314
if name == if_tag.getAttribute("name")
1316
ann_tag = document.createElement("annotation")
1317
ann_tag.setAttribute("name", annotation)
1318
ann_tag.setAttribute("value", value)
1319
if_tag.appendChild(ann_tag)
1320
# Fix argument name for the Introspect method itself
1321
if (if_tag.getAttribute("name")
1322
== dbus.INTROSPECTABLE_IFACE):
1323
for cn in if_tag.getElementsByTagName("method"):
1324
if cn.getAttribute("name") == "Introspect":
1325
for arg in cn.getElementsByTagName("arg"):
1326
if (arg.getAttribute("direction")
1328
arg.setAttribute("name",
1330
xmlstring = document.toxml("utf-8")
1332
except (AttributeError, xml.dom.DOMException,
1333
xml.parsers.expat.ExpatError) as error:
1334
logger.error("Failed to override Introspection method",
1339
class DBusObjectWithProperties(DBusObjectWithAnnotations):
534
class DBusObjectWithProperties(dbus.service.Object):
1340
535
"""A D-Bus object with properties.
1342
537
Classes inheriting from this can use the dbus_service_property
1343
538
decorator to expose methods as D-Bus properties. It exposes the
1344
539
standard Get(), Set(), and GetAll() methods on the D-Bus.
543
def _is_dbus_property(obj):
544
return getattr(obj, u"_dbus_is_property", False)
546
def _get_all_dbus_properties(self):
547
"""Returns a generator of (name, attribute) pairs
549
return ((prop._dbus_name, prop)
551
inspect.getmembers(self, self._is_dbus_property))
1347
553
def _get_dbus_property(self, interface_name, property_name):
1348
554
"""Returns a bound method if one exists which is a D-Bus
1349
555
property with the specified name and interface.
1351
for cls in self.__class__.__mro__:
1352
for name, value in inspect.getmembers(
1353
cls, self._is_dbus_thing("property")):
1354
if (value._dbus_name == property_name
1355
and value._dbus_interface == interface_name):
1356
return value.__get__(self)
557
for name in (property_name,
558
property_name + u"_dbus_property"):
559
prop = getattr(self, name, None)
561
or not self._is_dbus_property(prop)
562
or prop._dbus_name != property_name
563
or (interface_name and prop._dbus_interface
564
and interface_name != prop._dbus_interface)):
1358
567
# No such property
1359
raise DBusPropertyNotFound("{}:{}.{}".format(
1360
self.dbus_object_path, interface_name, property_name))
1363
def _get_all_interface_names(cls):
1364
"""Get a sequence of all interfaces supported by an object"""
1365
return (name for name in set(getattr(getattr(x, attr),
1366
"_dbus_interface", None)
1367
for x in (inspect.getmro(cls))
1369
if name is not None)
1371
@dbus.service.method(dbus.PROPERTIES_IFACE,
568
raise DBusPropertyNotFound(self.dbus_object_path + u":"
569
+ interface_name + u"."
572
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
1374
574
def Get(self, interface_name, property_name):
1375
575
"""Standard D-Bus property Get() method, see D-Bus standard.
1377
577
prop = self._get_dbus_property(interface_name, property_name)
1378
if prop._dbus_access == "write":
578
if prop._dbus_access == u"write":
1379
579
raise DBusPropertyAccessException(property_name)
1381
if not hasattr(value, "variant_level"):
581
if not hasattr(value, u"variant_level"):
1383
583
return type(value)(value, variant_level=value.variant_level+1)
1385
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
585
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1386
586
def Set(self, interface_name, property_name, value):
1387
587
"""Standard D-Bus property Set() method, see D-Bus standard.
1389
589
prop = self._get_dbus_property(interface_name, property_name)
1390
if prop._dbus_access == "read":
590
if prop._dbus_access == u"read":
1391
591
raise DBusPropertyAccessException(property_name)
1392
if prop._dbus_get_args_options["byte_arrays"]:
1393
# The byte_arrays option is not supported yet on
1394
# signatures other than "ay".
1395
if prop._dbus_signature != "ay":
1396
raise ValueError("Byte arrays not supported for non-"
1397
"'ay' signature {!r}"
1398
.format(prop._dbus_signature))
1399
value = dbus.ByteArray(b''.join(chr(byte)
592
if prop._dbus_get_args_options[u"byte_arrays"]:
593
value = dbus.ByteArray(''.join(unichr(byte)
1403
@dbus.service.method(dbus.PROPERTIES_IFACE,
1405
out_signature="a{sv}")
597
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
598
out_signature=u"a{sv}")
1406
599
def GetAll(self, interface_name):
1407
600
"""Standard D-Bus property GetAll() method, see D-Bus
1410
603
Note: Will not include properties with access="write".
1413
for name, prop in self._get_all_dbus_things("property"):
606
for name, prop in self._get_all_dbus_properties():
1414
607
if (interface_name
1415
608
and interface_name != prop._dbus_interface):
1416
609
# Interface non-empty but did not match
1418
611
# Ignore write-only properties
1419
if prop._dbus_access == "write":
612
if prop._dbus_access == u"write":
1422
if not hasattr(value, "variant_level"):
1423
properties[name] = value
615
if not hasattr(value, u"variant_level"):
1425
properties[name] = type(value)(
1426
value, variant_level=value.variant_level + 1)
1427
return dbus.Dictionary(properties, signature="sv")
1429
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1430
def PropertiesChanged(self, interface_name, changed_properties,
1431
invalidated_properties):
1432
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
618
all[name] = type(value)(value, variant_level=
619
value.variant_level+1)
620
return dbus.Dictionary(all, signature=u"sv")
1437
622
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1439
624
path_keyword='object_path',
1440
625
connection_keyword='connection')
1441
626
def Introspect(self, object_path, connection):
1442
"""Overloading of standard D-Bus method.
1444
Inserts property tags and interface annotation tags.
627
"""Standard D-Bus method, overloaded to insert property tags.
1446
xmlstring = DBusObjectWithAnnotations.Introspect(self,
629
xmlstring = dbus.service.Object.Introspect(self, object_path,
1450
632
document = xml.dom.minidom.parseString(xmlstring)
1452
633
def make_tag(document, name, prop):
1453
e = document.createElement("property")
1454
e.setAttribute("name", name)
1455
e.setAttribute("type", prop._dbus_signature)
1456
e.setAttribute("access", prop._dbus_access)
634
e = document.createElement(u"property")
635
e.setAttribute(u"name", name)
636
e.setAttribute(u"type", prop._dbus_signature)
637
e.setAttribute(u"access", prop._dbus_access)
1459
for if_tag in document.getElementsByTagName("interface"):
639
for if_tag in document.getElementsByTagName(u"interface"):
1461
640
for tag in (make_tag(document, name, prop)
1463
in self._get_all_dbus_things("property")
642
in self._get_all_dbus_properties()
1464
643
if prop._dbus_interface
1465
== if_tag.getAttribute("name")):
644
== if_tag.getAttribute(u"name")):
1466
645
if_tag.appendChild(tag)
1467
# Add annotation tags for properties
1468
for tag in if_tag.getElementsByTagName("property"):
1470
for name, prop in self._get_all_dbus_things(
1472
if (name == tag.getAttribute("name")
1473
and prop._dbus_interface
1474
== if_tag.getAttribute("name")):
1475
annots.update(getattr(
1476
prop, "_dbus_annotations", {}))
1477
for name, value in annots.items():
1478
ann_tag = document.createElement(
1480
ann_tag.setAttribute("name", name)
1481
ann_tag.setAttribute("value", value)
1482
tag.appendChild(ann_tag)
1483
646
# Add the names to the return values for the
1484
647
# "org.freedesktop.DBus.Properties" methods
1485
if (if_tag.getAttribute("name")
1486
== "org.freedesktop.DBus.Properties"):
1487
for cn in if_tag.getElementsByTagName("method"):
1488
if cn.getAttribute("name") == "Get":
1489
for arg in cn.getElementsByTagName("arg"):
1490
if (arg.getAttribute("direction")
1492
arg.setAttribute("name", "value")
1493
elif cn.getAttribute("name") == "GetAll":
1494
for arg in cn.getElementsByTagName("arg"):
1495
if (arg.getAttribute("direction")
1497
arg.setAttribute("name", "props")
1498
xmlstring = document.toxml("utf-8")
1500
except (AttributeError, xml.dom.DOMException,
1501
xml.parsers.expat.ExpatError) as error:
1502
logger.error("Failed to override Introspection method",
1508
dbus.OBJECT_MANAGER_IFACE
1509
except AttributeError:
1510
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1513
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1514
"""A D-Bus object with an ObjectManager.
1516
Classes inheriting from this exposes the standard
1517
GetManagedObjects call and the InterfacesAdded and
1518
InterfacesRemoved signals on the standard
1519
"org.freedesktop.DBus.ObjectManager" interface.
1521
Note: No signals are sent automatically; they must be sent
1524
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1525
out_signature="a{oa{sa{sv}}}")
1526
def GetManagedObjects(self):
1527
"""This function must be overridden"""
1528
raise NotImplementedError()
1530
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1531
signature="oa{sa{sv}}")
1532
def InterfacesAdded(self, object_path, interfaces_and_properties):
1535
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1536
def InterfacesRemoved(self, object_path, interfaces):
1539
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1541
path_keyword='object_path',
1542
connection_keyword='connection')
1543
def Introspect(self, object_path, connection):
1544
"""Overloading of standard D-Bus method.
1546
Override return argument name of GetManagedObjects to be
1547
"objpath_interfaces_and_properties"
1549
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1553
document = xml.dom.minidom.parseString(xmlstring)
1555
for if_tag in document.getElementsByTagName("interface"):
1556
# Fix argument name for the GetManagedObjects method
1557
if (if_tag.getAttribute("name")
1558
== dbus.OBJECT_MANAGER_IFACE):
1559
for cn in if_tag.getElementsByTagName("method"):
1560
if (cn.getAttribute("name")
1561
== "GetManagedObjects"):
1562
for arg in cn.getElementsByTagName("arg"):
1563
if (arg.getAttribute("direction")
1567
"objpath_interfaces"
1569
xmlstring = document.toxml("utf-8")
1571
except (AttributeError, xml.dom.DOMException,
1572
xml.parsers.expat.ExpatError) as error:
1573
logger.error("Failed to override Introspection method",
1578
def datetime_to_dbus(dt, variant_level=0):
1579
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1581
return dbus.String("", variant_level=variant_level)
1582
return dbus.String(dt.isoformat(), variant_level=variant_level)
1585
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1586
"""A class decorator; applied to a subclass of
1587
dbus.service.Object, it will add alternate D-Bus attributes with
1588
interface names according to the "alt_interface_names" mapping.
1591
@alternate_dbus_interfaces({"org.example.Interface":
1592
"net.example.AlternateInterface"})
1593
class SampleDBusObject(dbus.service.Object):
1594
@dbus.service.method("org.example.Interface")
1595
def SampleDBusMethod():
1598
The above "SampleDBusMethod" on "SampleDBusObject" will be
1599
reachable via two interfaces: "org.example.Interface" and
1600
"net.example.AlternateInterface", the latter of which will have
1601
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1602
"true", unless "deprecate" is passed with a False value.
1604
This works for methods and signals, and also for D-Bus properties
1605
(from DBusObjectWithProperties) and interfaces (from the
1606
dbus_interface_annotations decorator).
1610
for orig_interface_name, alt_interface_name in (
1611
alt_interface_names.items()):
1613
interface_names = set()
1614
# Go though all attributes of the class
1615
for attrname, attribute in inspect.getmembers(cls):
1616
# Ignore non-D-Bus attributes, and D-Bus attributes
1617
# with the wrong interface name
1618
if (not hasattr(attribute, "_dbus_interface")
1619
or not attribute._dbus_interface.startswith(
1620
orig_interface_name)):
1622
# Create an alternate D-Bus interface name based on
1624
alt_interface = attribute._dbus_interface.replace(
1625
orig_interface_name, alt_interface_name)
1626
interface_names.add(alt_interface)
1627
# Is this a D-Bus signal?
1628
if getattr(attribute, "_dbus_is_signal", False):
1629
# Extract the original non-method undecorated
1630
# function by black magic
1631
if sys.version_info.major == 2:
1632
nonmethod_func = (dict(
1633
zip(attribute.func_code.co_freevars,
1634
attribute.__closure__))
1635
["func"].cell_contents)
1637
nonmethod_func = (dict(
1638
zip(attribute.__code__.co_freevars,
1639
attribute.__closure__))
1640
["func"].cell_contents)
1641
# Create a new, but exactly alike, function
1642
# object, and decorate it to be a new D-Bus signal
1643
# with the alternate D-Bus interface name
1644
new_function = copy_function(nonmethod_func)
1645
new_function = (dbus.service.signal(
1647
attribute._dbus_signature)(new_function))
1648
# Copy annotations, if any
1650
new_function._dbus_annotations = dict(
1651
attribute._dbus_annotations)
1652
except AttributeError:
1655
# Define a creator of a function to call both the
1656
# original and alternate functions, so both the
1657
# original and alternate signals gets sent when
1658
# the function is called
1659
def fixscope(func1, func2):
1660
"""This function is a scope container to pass
1661
func1 and func2 to the "call_both" function
1662
outside of its arguments"""
1664
@functools.wraps(func2)
1665
def call_both(*args, **kwargs):
1666
"""This function will emit two D-Bus
1667
signals by calling func1 and func2"""
1668
func1(*args, **kwargs)
1669
func2(*args, **kwargs)
1670
# Make wrapper function look like a D-Bus
1672
for name, attr in inspect.getmembers(func2):
1673
if name.startswith("_dbus_"):
1674
setattr(call_both, name, attr)
1677
# Create the "call_both" function and add it to
1679
attr[attrname] = fixscope(attribute, new_function)
1680
# Is this a D-Bus method?
1681
elif getattr(attribute, "_dbus_is_method", False):
1682
# Create a new, but exactly alike, function
1683
# object. Decorate it to be a new D-Bus method
1684
# with the alternate D-Bus interface name. Add it
1687
dbus.service.method(
1689
attribute._dbus_in_signature,
1690
attribute._dbus_out_signature)
1691
(copy_function(attribute)))
1692
# Copy annotations, if any
1694
attr[attrname]._dbus_annotations = dict(
1695
attribute._dbus_annotations)
1696
except AttributeError:
1698
# Is this a D-Bus property?
1699
elif getattr(attribute, "_dbus_is_property", False):
1700
# Create a new, but exactly alike, function
1701
# object, and decorate it to be a new D-Bus
1702
# property with the alternate D-Bus interface
1703
# name. Add it to the class.
1704
attr[attrname] = (dbus_service_property(
1705
alt_interface, attribute._dbus_signature,
1706
attribute._dbus_access,
1707
attribute._dbus_get_args_options
1709
(copy_function(attribute)))
1710
# Copy annotations, if any
1712
attr[attrname]._dbus_annotations = dict(
1713
attribute._dbus_annotations)
1714
except AttributeError:
1716
# Is this a D-Bus interface?
1717
elif getattr(attribute, "_dbus_is_interface", False):
1718
# Create a new, but exactly alike, function
1719
# object. Decorate it to be a new D-Bus interface
1720
# with the alternate D-Bus interface name. Add it
1723
dbus_interface_annotations(alt_interface)
1724
(copy_function(attribute)))
1726
# Deprecate all alternate interfaces
1727
iname = "_AlternateDBusNames_interface_annotation{}"
1728
for interface_name in interface_names:
1730
@dbus_interface_annotations(interface_name)
1732
return {"org.freedesktop.DBus.Deprecated":
1734
# Find an unused name
1735
for aname in (iname.format(i)
1736
for i in itertools.count()):
1737
if aname not in attr:
1741
# Replace the class with a new subclass of it with
1742
# methods, signals, etc. as created above.
1743
if sys.version_info.major == 2:
1744
cls = type(b"{}Alternate".format(cls.__name__),
1747
cls = type("{}Alternate".format(cls.__name__),
1754
@alternate_dbus_interfaces({"se.recompile.Mandos":
1755
"se.bsnet.fukt.Mandos"})
648
if (if_tag.getAttribute(u"name")
649
== u"org.freedesktop.DBus.Properties"):
650
for cn in if_tag.getElementsByTagName(u"method"):
651
if cn.getAttribute(u"name") == u"Get":
652
for arg in cn.getElementsByTagName(u"arg"):
653
if (arg.getAttribute(u"direction")
655
arg.setAttribute(u"name", u"value")
656
elif cn.getAttribute(u"name") == u"GetAll":
657
for arg in cn.getElementsByTagName(u"arg"):
658
if (arg.getAttribute(u"direction")
660
arg.setAttribute(u"name", u"props")
661
xmlstring = document.toxml(u"utf-8")
663
except (AttributeError, xml.dom.DOMException,
664
xml.parsers.expat.ExpatError), error:
665
logger.error(u"Failed to override Introspection method",
1756
670
class ClientDBus(Client, DBusObjectWithProperties):
1757
671
"""A Client class using D-Bus
1760
674
dbus_object_path: dbus.ObjectPath
1761
675
bus: dbus.SystemBus()
1764
runtime_expansions = (Client.runtime_expansions
1765
+ ("dbus_object_path", ))
1767
_interface = "se.recompile.Mandos.Client"
1769
677
# dbus.service.Object doesn't use super(), so we can't either.
1771
def __init__(self, bus=None, *args, **kwargs):
679
def __init__(self, bus = None, *args, **kwargs):
1773
681
Client.__init__(self, *args, **kwargs)
1774
682
# Only now, when this client is initialized, can it show up on
1776
client_object_name = str(self.name).translate(
1777
{ord("."): ord("_"),
1778
ord("-"): ord("_")})
1779
self.dbus_object_path = dbus.ObjectPath(
1780
"/clients/" + client_object_name)
684
self.dbus_object_path = (dbus.ObjectPath
686
+ self.name.replace(u".", u"_")))
1781
687
DBusObjectWithProperties.__init__(self, self.bus,
1782
688
self.dbus_object_path)
1784
def notifychangeproperty(transform_func, dbus_name,
1785
type_func=lambda x: x,
1787
invalidate_only=False,
1788
_interface=_interface):
1789
""" Modify a variable so that it's a property which announces
1790
its changes to DBus.
1792
transform_fun: Function that takes a value and a variant_level
1793
and transforms it to a D-Bus type.
1794
dbus_name: D-Bus name of the variable
1795
type_func: Function that transform the value before sending it
1796
to the D-Bus. Default: no transform
1797
variant_level: D-Bus variant level. Default: 1
1799
attrname = "_{}".format(dbus_name)
1801
def setter(self, value):
1802
if hasattr(self, "dbus_object_path"):
1803
if (not hasattr(self, attrname) or
1804
type_func(getattr(self, attrname, None))
1805
!= type_func(value)):
1807
self.PropertiesChanged(
1808
_interface, dbus.Dictionary(),
1809
dbus.Array((dbus_name, )))
1811
dbus_value = transform_func(
1813
variant_level=variant_level)
1814
self.PropertyChanged(dbus.String(dbus_name),
1816
self.PropertiesChanged(
1818
dbus.Dictionary({dbus.String(dbus_name):
1821
setattr(self, attrname, value)
1823
return property(lambda self: getattr(self, attrname), setter)
1825
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1826
approvals_pending = notifychangeproperty(dbus.Boolean,
1829
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1830
last_enabled = notifychangeproperty(datetime_to_dbus,
1832
checker = notifychangeproperty(
1833
dbus.Boolean, "CheckerRunning",
1834
type_func=lambda checker: checker is not None)
1835
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1837
last_checker_status = notifychangeproperty(dbus.Int16,
1838
"LastCheckerStatus")
1839
last_approval_request = notifychangeproperty(
1840
datetime_to_dbus, "LastApprovalRequest")
1841
approved_by_default = notifychangeproperty(dbus.Boolean,
1842
"ApprovedByDefault")
1843
approval_delay = notifychangeproperty(
1844
dbus.UInt64, "ApprovalDelay",
1845
type_func=lambda td: td.total_seconds() * 1000)
1846
approval_duration = notifychangeproperty(
1847
dbus.UInt64, "ApprovalDuration",
1848
type_func=lambda td: td.total_seconds() * 1000)
1849
host = notifychangeproperty(dbus.String, "Host")
1850
timeout = notifychangeproperty(
1851
dbus.UInt64, "Timeout",
1852
type_func=lambda td: td.total_seconds() * 1000)
1853
extended_timeout = notifychangeproperty(
1854
dbus.UInt64, "ExtendedTimeout",
1855
type_func=lambda td: td.total_seconds() * 1000)
1856
interval = notifychangeproperty(
1857
dbus.UInt64, "Interval",
1858
type_func=lambda td: td.total_seconds() * 1000)
1859
checker_command = notifychangeproperty(dbus.String, "Checker")
1860
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1861
invalidate_only=True)
1863
del notifychangeproperty
691
def _datetime_to_dbus(dt, variant_level=0):
692
"""Convert a UTC datetime.datetime() to a D-Bus type."""
693
return dbus.String(dt.isoformat(),
694
variant_level=variant_level)
697
oldstate = getattr(self, u"enabled", False)
698
r = Client.enable(self)
699
if oldstate != self.enabled:
701
self.PropertyChanged(dbus.String(u"enabled"),
702
dbus.Boolean(True, variant_level=1))
703
self.PropertyChanged(
704
dbus.String(u"last_enabled"),
705
self._datetime_to_dbus(self.last_enabled,
709
def disable(self, quiet = False):
710
oldstate = getattr(self, u"enabled", False)
711
r = Client.disable(self, quiet=quiet)
712
if not quiet and oldstate != self.enabled:
714
self.PropertyChanged(dbus.String(u"enabled"),
715
dbus.Boolean(False, variant_level=1))
1865
718
def __del__(self, *args, **kwargs):
1867
720
self.remove_from_connection()
1868
721
except LookupError:
1870
if hasattr(DBusObjectWithProperties, "__del__"):
723
if hasattr(DBusObjectWithProperties, u"__del__"):
1871
724
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1872
725
Client.__del__(self, *args, **kwargs)
1874
def checker_callback(self, source, condition,
1875
connection, command, *args, **kwargs):
1876
ret = Client.checker_callback(self, source, condition,
1877
connection, command, *args,
1879
exitstatus = self.last_checker_status
727
def checker_callback(self, pid, condition, command,
729
self.checker_callback_tag = None
732
self.PropertyChanged(dbus.String(u"checker_running"),
733
dbus.Boolean(False, variant_level=1))
734
if os.WIFEXITED(condition):
735
exitstatus = os.WEXITSTATUS(condition)
1881
736
# Emit D-Bus signal
1882
737
self.CheckerCompleted(dbus.Int16(exitstatus),
1883
# This is specific to GNU libC
1884
dbus.Int64(exitstatus << 8),
738
dbus.Int64(condition),
1885
739
dbus.String(command))
1887
741
# Emit D-Bus signal
1888
742
self.CheckerCompleted(dbus.Int16(-1),
1890
# This is specific to GNU libC
1892
| self.last_checker_signal),
743
dbus.Int64(condition),
1893
744
dbus.String(command))
746
return Client.checker_callback(self, pid, condition, command,
749
def checked_ok(self, *args, **kwargs):
750
r = Client.checked_ok(self, *args, **kwargs)
752
self.PropertyChanged(
753
dbus.String(u"last_checked_ok"),
754
(self._datetime_to_dbus(self.last_checked_ok,
1896
758
def start_checker(self, *args, **kwargs):
1897
old_checker_pid = getattr(self.checker, "pid", None)
759
old_checker = self.checker
760
if self.checker is not None:
761
old_checker_pid = self.checker.pid
763
old_checker_pid = None
1898
764
r = Client.start_checker(self, *args, **kwargs)
1899
765
# Only if new checker process was started
1900
766
if (self.checker is not None
1901
767
and old_checker_pid != self.checker.pid):
1902
768
# Emit D-Bus signal
1903
769
self.CheckerStarted(self.current_checker_command)
1906
def _reset_approved(self):
1907
self.approved = None
1910
def approve(self, value=True):
1911
self.approved = value
1912
GLib.timeout_add(int(self.approval_duration.total_seconds()
1913
* 1000), self._reset_approved)
1914
self.send_changedstate()
1916
# D-Bus methods, signals & properties
770
self.PropertyChanged(
771
dbus.String(u"checker_running"),
772
dbus.Boolean(True, variant_level=1))
775
def stop_checker(self, *args, **kwargs):
776
old_checker = getattr(self, u"checker", None)
777
r = Client.stop_checker(self, *args, **kwargs)
778
if (old_checker is not None
779
and getattr(self, u"checker", None) is None):
780
self.PropertyChanged(dbus.String(u"checker_running"),
781
dbus.Boolean(False, variant_level=1))
784
## D-Bus methods & signals
785
_interface = u"se.bsnet.fukt.Mandos.Client"
788
@dbus.service.method(_interface)
790
return self.checked_ok()
1922
792
# CheckerCompleted - signal
1923
@dbus.service.signal(_interface, signature="nxs")
793
@dbus.service.signal(_interface, signature=u"nxs")
1924
794
def CheckerCompleted(self, exitcode, waitstatus, command):
1928
798
# CheckerStarted - signal
1929
@dbus.service.signal(_interface, signature="s")
799
@dbus.service.signal(_interface, signature=u"s")
1930
800
def CheckerStarted(self, command):
1934
804
# PropertyChanged - signal
1935
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1936
@dbus.service.signal(_interface, signature="sv")
805
@dbus.service.signal(_interface, signature=u"sv")
1937
806
def PropertyChanged(self, property, value):
1941
810
# GotSecret - signal
1942
811
@dbus.service.signal(_interface)
1943
812
def GotSecret(self):
1945
Is sent after a successful transfer of secret from the Mandos
1946
server to mandos-client
1950
816
# Rejected - signal
1951
@dbus.service.signal(_interface, signature="s")
1952
def Rejected(self, reason):
817
@dbus.service.signal(_interface)
1956
# NeedApproval - signal
1957
@dbus.service.signal(_interface, signature="tb")
1958
def NeedApproval(self, timeout, default):
1960
return self.need_approval()
1965
@dbus.service.method(_interface, in_signature="b")
1966
def Approve(self, value):
1969
# CheckedOK - method
1970
@dbus.service.method(_interface)
1971
def CheckedOK(self):
1974
822
# Enable - method
1975
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1976
823
@dbus.service.method(_interface)
1977
824
def Enable(self):
1981
828
# StartChecker - method
1982
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1983
829
@dbus.service.method(_interface)
1984
830
def StartChecker(self):
1986
832
self.start_checker()
1988
834
# Disable - method
1989
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1990
835
@dbus.service.method(_interface)
1991
836
def Disable(self):
1995
840
# StopChecker - method
1996
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1997
841
@dbus.service.method(_interface)
1998
842
def StopChecker(self):
1999
843
self.stop_checker()
2003
# ApprovalPending - property
2004
@dbus_service_property(_interface, signature="b", access="read")
2005
def ApprovalPending_dbus_property(self):
2006
return dbus.Boolean(bool(self.approvals_pending))
2008
# ApprovedByDefault - property
2009
@dbus_service_property(_interface,
2012
def ApprovedByDefault_dbus_property(self, value=None):
2013
if value is None: # get
2014
return dbus.Boolean(self.approved_by_default)
2015
self.approved_by_default = bool(value)
2017
# ApprovalDelay - property
2018
@dbus_service_property(_interface,
2021
def ApprovalDelay_dbus_property(self, value=None):
2022
if value is None: # get
2023
return dbus.UInt64(self.approval_delay.total_seconds()
2025
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2027
# ApprovalDuration - property
2028
@dbus_service_property(_interface,
2031
def ApprovalDuration_dbus_property(self, value=None):
2032
if value is None: # get
2033
return dbus.UInt64(self.approval_duration.total_seconds()
2035
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2039
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2040
@dbus_service_property(_interface, signature="s", access="read")
2041
def Name_dbus_property(self):
846
@dbus_service_property(_interface, signature=u"s", access=u"read")
847
def name_dbus_property(self):
2042
848
return dbus.String(self.name)
2046
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2047
@dbus_service_property(_interface, signature="s", access="read")
2048
def KeyID_dbus_property(self):
2049
return dbus.String(self.key_id)
2051
# Fingerprint - property
2053
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2054
@dbus_service_property(_interface, signature="s", access="read")
2055
def Fingerprint_dbus_property(self):
850
# fingerprint - property
851
@dbus_service_property(_interface, signature=u"s", access=u"read")
852
def fingerprint_dbus_property(self):
2056
853
return dbus.String(self.fingerprint)
2059
@dbus_service_property(_interface,
2062
def Host_dbus_property(self, value=None):
856
@dbus_service_property(_interface, signature=u"s",
858
def host_dbus_property(self, value=None):
2063
859
if value is None: # get
2064
860
return dbus.String(self.host)
2065
self.host = str(value)
2067
# Created - property
2069
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2070
@dbus_service_property(_interface, signature="s", access="read")
2071
def Created_dbus_property(self):
2072
return datetime_to_dbus(self.created)
2074
# LastEnabled - property
2075
@dbus_service_property(_interface, signature="s", access="read")
2076
def LastEnabled_dbus_property(self):
2077
return datetime_to_dbus(self.last_enabled)
2079
# Enabled - property
2080
@dbus_service_property(_interface,
2083
def Enabled_dbus_property(self, value=None):
863
self.PropertyChanged(dbus.String(u"host"),
864
dbus.String(value, variant_level=1))
867
@dbus_service_property(_interface, signature=u"s", access=u"read")
868
def created_dbus_property(self):
869
return dbus.String(self._datetime_to_dbus(self.created))
871
# last_enabled - property
872
@dbus_service_property(_interface, signature=u"s", access=u"read")
873
def last_enabled_dbus_property(self):
874
if self.last_enabled is None:
875
return dbus.String(u"")
876
return dbus.String(self._datetime_to_dbus(self.last_enabled))
879
@dbus_service_property(_interface, signature=u"b",
881
def enabled_dbus_property(self, value=None):
2084
882
if value is None: # get
2085
883
return dbus.Boolean(self.enabled)
2091
# LastCheckedOK - property
2092
@dbus_service_property(_interface,
2095
def LastCheckedOK_dbus_property(self, value=None):
889
# last_checked_ok - property
890
@dbus_service_property(_interface, signature=u"s",
892
def last_checked_ok_dbus_property(self, value=None):
2096
893
if value is not None:
2097
894
self.checked_ok()
2099
return datetime_to_dbus(self.last_checked_ok)
2101
# LastCheckerStatus - property
2102
@dbus_service_property(_interface, signature="n", access="read")
2103
def LastCheckerStatus_dbus_property(self):
2104
return dbus.Int16(self.last_checker_status)
2106
# Expires - property
2107
@dbus_service_property(_interface, signature="s", access="read")
2108
def Expires_dbus_property(self):
2109
return datetime_to_dbus(self.expires)
2111
# LastApprovalRequest - property
2112
@dbus_service_property(_interface, signature="s", access="read")
2113
def LastApprovalRequest_dbus_property(self):
2114
return datetime_to_dbus(self.last_approval_request)
2116
# Timeout - property
2117
@dbus_service_property(_interface,
2120
def Timeout_dbus_property(self, value=None):
896
if self.last_checked_ok is None:
897
return dbus.String(u"")
898
return dbus.String(self._datetime_to_dbus(self
902
@dbus_service_property(_interface, signature=u"t",
904
def timeout_dbus_property(self, value=None):
2121
905
if value is None: # get
2122
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2123
old_timeout = self.timeout
906
return dbus.UInt64(self.timeout_milliseconds())
2124
907
self.timeout = datetime.timedelta(0, 0, 0, value)
2125
# Reschedule disabling
2127
now = datetime.datetime.utcnow()
2128
self.expires += self.timeout - old_timeout
2129
if self.expires <= now:
2130
# The timeout has passed
2133
if (getattr(self, "disable_initiator_tag", None)
2136
GLib.source_remove(self.disable_initiator_tag)
2137
self.disable_initiator_tag = GLib.timeout_add(
2138
int((self.expires - now).total_seconds() * 1000),
2141
# ExtendedTimeout - property
2142
@dbus_service_property(_interface,
2145
def ExtendedTimeout_dbus_property(self, value=None):
2146
if value is None: # get
2147
return dbus.UInt64(self.extended_timeout.total_seconds()
2149
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2151
# Interval - property
2152
@dbus_service_property(_interface,
2155
def Interval_dbus_property(self, value=None):
2156
if value is None: # get
2157
return dbus.UInt64(self.interval.total_seconds() * 1000)
909
self.PropertyChanged(dbus.String(u"timeout"),
910
dbus.UInt64(value, variant_level=1))
911
if getattr(self, u"disable_initiator_tag", None) is None:
914
gobject.source_remove(self.disable_initiator_tag)
915
self.disable_initiator_tag = None
917
_timedelta_to_milliseconds((self
923
# The timeout has passed
926
self.disable_initiator_tag = (gobject.timeout_add
927
(time_to_die, self.disable))
929
# interval - property
930
@dbus_service_property(_interface, signature=u"t",
932
def interval_dbus_property(self, value=None):
933
if value is None: # get
934
return dbus.UInt64(self.interval_milliseconds())
2158
935
self.interval = datetime.timedelta(0, 0, 0, value)
2159
if getattr(self, "checker_initiator_tag", None) is None:
937
self.PropertyChanged(dbus.String(u"interval"),
938
dbus.UInt64(value, variant_level=1))
939
if getattr(self, u"checker_initiator_tag", None) is None:
2162
# Reschedule checker run
2163
GLib.source_remove(self.checker_initiator_tag)
2164
self.checker_initiator_tag = GLib.timeout_add(
2165
value, self.start_checker)
2166
self.start_checker() # Start one now, too
941
# Reschedule checker run
942
gobject.source_remove(self.checker_initiator_tag)
943
self.checker_initiator_tag = (gobject.timeout_add
944
(value, self.start_checker))
945
self.start_checker() # Start one now, too
2168
# Checker - property
2169
@dbus_service_property(_interface,
2172
def Checker_dbus_property(self, value=None):
948
@dbus_service_property(_interface, signature=u"s",
950
def checker_dbus_property(self, value=None):
2173
951
if value is None: # get
2174
952
return dbus.String(self.checker_command)
2175
self.checker_command = str(value)
2177
# CheckerRunning - property
2178
@dbus_service_property(_interface,
2181
def CheckerRunning_dbus_property(self, value=None):
953
self.checker_command = value
955
self.PropertyChanged(dbus.String(u"checker"),
956
dbus.String(self.checker_command,
959
# checker_running - property
960
@dbus_service_property(_interface, signature=u"b",
962
def checker_running_dbus_property(self, value=None):
2182
963
if value is None: # get
2183
964
return dbus.Boolean(self.checker is not None)
2185
966
self.start_checker()
2187
968
self.stop_checker()
2189
# ObjectPath - property
2191
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2192
"org.freedesktop.DBus.Deprecated": "true"})
2193
@dbus_service_property(_interface, signature="o", access="read")
2194
def ObjectPath_dbus_property(self):
2195
return self.dbus_object_path # is already a dbus.ObjectPath
2199
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2201
@dbus_service_property(_interface,
2205
def Secret_dbus_property(self, value):
2206
self.secret = bytes(value)
970
# object_path - property
971
@dbus_service_property(_interface, signature=u"o", access=u"read")
972
def object_path_dbus_property(self):
973
return self.dbus_object_path # is already a dbus.ObjectPath
976
@dbus_service_property(_interface, signature=u"ay",
977
access=u"write", byte_arrays=True)
978
def secret_dbus_property(self, value):
979
self.secret = str(value)
2211
class ProxyClient(object):
2212
def __init__(self, child_pipe, key_id, fpr, address):
2213
self._pipe = child_pipe
2214
self._pipe.send(('init', key_id, fpr, address))
2215
if not self._pipe.recv():
2216
raise KeyError(key_id or fpr)
2218
def __getattribute__(self, name):
2220
return super(ProxyClient, self).__getattribute__(name)
2221
self._pipe.send(('getattr', name))
2222
data = self._pipe.recv()
2223
if data[0] == 'data':
2225
if data[0] == 'function':
2227
def func(*args, **kwargs):
2228
self._pipe.send(('funcall', name, args, kwargs))
2229
return self._pipe.recv()[1]
2233
def __setattr__(self, name, value):
2235
return super(ProxyClient, self).__setattr__(name, value)
2236
self._pipe.send(('setattr', name, value))
2239
984
class ClientHandler(socketserver.BaseRequestHandler, object):
2240
985
"""A class to handle client connections.
2242
987
Instantiated once for each connection to handle it.
2243
988
Note: This will run in its own forked process."""
2245
990
def handle(self):
2246
with contextlib.closing(self.server.child_pipe) as child_pipe:
2247
logger.info("TCP connection from: %s",
2248
str(self.client_address))
2249
logger.debug("Pipe FD: %d",
2250
self.server.child_pipe.fileno())
2252
session = gnutls.ClientSession(self.request)
2254
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2255
# "+AES-256-CBC", "+SHA1",
2256
# "+COMP-NULL", "+CTYPE-OPENPGP",
991
logger.info(u"TCP connection from: %s",
992
unicode(self.client_address))
993
logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
994
# Open IPC pipe to parent process
995
with closing(os.fdopen(self.server.pipe[1], u"w", 1)) as ipc:
996
session = (gnutls.connection
997
.ClientSession(self.request,
1001
line = self.request.makefile().readline()
1002
logger.debug(u"Protocol version: %r", line)
1004
if int(line.strip().split()[0]) > 1:
1006
except (ValueError, IndexError, RuntimeError), error:
1007
logger.error(u"Unknown protocol version: %s", error)
1010
# Note: gnutls.connection.X509Credentials is really a
1011
# generic GnuTLS certificate credentials object so long as
1012
# no X.509 keys are added to it. Therefore, we can use it
1013
# here despite using OpenPGP certificates.
1015
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1016
# u"+AES-256-CBC", u"+SHA1",
1017
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
2258
1019
# Use a fallback default, since this MUST be set.
2259
1020
priority = self.server.gnutls_priority
2260
1021
if priority is None:
2262
gnutls.priority_set_direct(session._c_object,
2263
priority.encode("utf-8"),
2266
# Start communication using the Mandos protocol
2267
# Get protocol number
2268
line = self.request.makefile().readline()
2269
logger.debug("Protocol version: %r", line)
2271
if int(line.strip().split()[0]) > 1:
2272
raise RuntimeError(line)
2273
except (ValueError, IndexError, RuntimeError) as error:
2274
logger.error("Unknown protocol version: %s", error)
2277
# Start GnuTLS connection
1022
priority = u"NORMAL"
1023
(gnutls.library.functions
1024
.gnutls_priority_set_direct(session._c_object,
2279
1028
session.handshake()
2280
except gnutls.Error as error:
2281
logger.warning("Handshake failed: %s", error)
1029
except gnutls.errors.GNUTLSError, error:
1030
logger.warning(u"Handshake failed: %s", error)
2282
1031
# Do not run session.bye() here: the session is not
2283
1032
# established. Just abandon the request.
2285
logger.debug("Handshake succeeded")
2287
approval_required = False
1034
logger.debug(u"Handshake succeeded")
2289
if gnutls.has_rawpk:
2292
key_id = self.key_id(
2293
self.peer_certificate(session))
2294
except (TypeError, gnutls.Error) as error:
2295
logger.warning("Bad certificate: %s", error)
2297
logger.debug("Key ID: %s", key_id)
2302
fpr = self.fingerprint(
2303
self.peer_certificate(session))
2304
except (TypeError, gnutls.Error) as error:
2305
logger.warning("Bad certificate: %s", error)
2307
logger.debug("Fingerprint: %s", fpr)
2310
client = ProxyClient(child_pipe, key_id, fpr,
2311
self.client_address)
2315
if client.approval_delay:
2316
delay = client.approval_delay
2317
client.approvals_pending += 1
2318
approval_required = True
2321
if not client.enabled:
2322
logger.info("Client %s is disabled",
2324
if self.server.use_dbus:
2326
client.Rejected("Disabled")
2329
if client.approved or not client.approval_delay:
2330
# We are approved or approval is disabled
2332
elif client.approved is None:
2333
logger.info("Client %s needs approval",
2335
if self.server.use_dbus:
2337
client.NeedApproval(
2338
client.approval_delay.total_seconds()
2339
* 1000, client.approved_by_default)
2341
logger.warning("Client %s was not approved",
2343
if self.server.use_dbus:
2345
client.Rejected("Denied")
2348
# wait until timeout or approved
2349
time = datetime.datetime.now()
2350
client.changedstate.acquire()
2351
client.changedstate.wait(delay.total_seconds())
2352
client.changedstate.release()
2353
time2 = datetime.datetime.now()
2354
if (time2 - time) >= delay:
2355
if not client.approved_by_default:
2356
logger.warning("Client %s timed out while"
2357
" waiting for approval",
2359
if self.server.use_dbus:
2361
client.Rejected("Approval timed out")
2366
delay -= time2 - time
2369
session.send(client.secret)
2370
except gnutls.Error as error:
2371
logger.warning("gnutls send failed",
2375
logger.info("Sending secret to %s", client.name)
2376
# bump the timeout using extended_timeout
2377
client.bump_timeout(client.extended_timeout)
2378
if self.server.use_dbus:
2383
if approval_required:
2384
client.approvals_pending -= 1
2387
except gnutls.Error as error:
2388
logger.warning("GnuTLS bye failed",
1036
fpr = self.fingerprint(self.peer_certificate(session))
1037
except (TypeError, gnutls.errors.GNUTLSError), error:
1038
logger.warning(u"Bad certificate: %s", error)
1041
logger.debug(u"Fingerprint: %s", fpr)
1043
for c in self.server.clients:
1044
if c.fingerprint == fpr:
1048
ipc.write(u"NOTFOUND %s %s\n"
1049
% (fpr, unicode(self.client_address)))
1052
# Have to check if client.still_valid(), since it is
1053
# possible that the client timed out while establishing
1054
# the GnuTLS session.
1055
if not client.still_valid():
1056
ipc.write(u"INVALID %s\n" % client.name)
1059
ipc.write(u"SENDING %s\n" % client.name)
1061
while sent_size < len(client.secret):
1062
sent = session.send(client.secret[sent_size:])
1063
logger.debug(u"Sent: %d, remaining: %d",
1064
sent, len(client.secret)
1065
- (sent_size + sent))
2392
1070
def peer_certificate(session):
2393
"Return the peer's certificate as a bytestring"
2395
cert_type = gnutls.certificate_type_get2(session._c_object,
2397
except AttributeError:
2398
cert_type = gnutls.certificate_type_get(session._c_object)
2399
if gnutls.has_rawpk:
2400
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2402
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2403
# If not a valid certificate type...
2404
if cert_type not in valid_cert_types:
2405
logger.info("Cert type %r not in %r", cert_type,
2407
# ...return invalid data
1071
"Return the peer's OpenPGP certificate as a bytestring"
1072
# If not an OpenPGP certificate...
1073
if (gnutls.library.functions
1074
.gnutls_certificate_type_get(session._c_object)
1075
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1076
# ...do the normal thing
1077
return session.peer_certificate
2409
1078
list_size = ctypes.c_uint(1)
2410
cert_list = (gnutls.certificate_get_peers
1079
cert_list = (gnutls.library.functions
1080
.gnutls_certificate_get_peers
2411
1081
(session._c_object, ctypes.byref(list_size)))
2412
1082
if not bool(cert_list) and list_size.value != 0:
2413
raise gnutls.Error("error getting peer certificate")
1083
raise gnutls.errors.GNUTLSError(u"error getting peer"
2414
1085
if list_size.value == 0:
2416
1087
cert = cert_list[0]
2417
1088
return ctypes.string_at(cert.data, cert.size)
2420
def key_id(certificate):
2421
"Convert a certificate bytestring to a hexdigit key ID"
2422
# New GnuTLS "datum" with the public key
2423
datum = gnutls.datum_t(
2424
ctypes.cast(ctypes.c_char_p(certificate),
2425
ctypes.POINTER(ctypes.c_ubyte)),
2426
ctypes.c_uint(len(certificate)))
2427
# XXX all these need to be created in the gnutls "module"
2428
# New empty GnuTLS certificate
2429
pubkey = gnutls.pubkey_t()
2430
gnutls.pubkey_init(ctypes.byref(pubkey))
2431
# Import the raw public key into the certificate
2432
gnutls.pubkey_import(pubkey,
2433
ctypes.byref(datum),
2434
gnutls.X509_FMT_DER)
2435
# New buffer for the key ID
2436
buf = ctypes.create_string_buffer(32)
2437
buf_len = ctypes.c_size_t(len(buf))
2438
# Get the key ID from the raw public key into the buffer
2439
gnutls.pubkey_get_key_id(pubkey,
2440
gnutls.KEYID_USE_SHA256,
2441
ctypes.cast(ctypes.byref(buf),
2442
ctypes.POINTER(ctypes.c_ubyte)),
2443
ctypes.byref(buf_len))
2444
# Deinit the certificate
2445
gnutls.pubkey_deinit(pubkey)
2447
# Convert the buffer to a Python bytestring
2448
key_id = ctypes.string_at(buf, buf_len.value)
2449
# Convert the bytestring to hexadecimal notation
2450
hex_key_id = binascii.hexlify(key_id).upper()
2454
1091
def fingerprint(openpgp):
2455
1092
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2456
1093
# New GnuTLS "datum" with the OpenPGP public key
2457
datum = gnutls.datum_t(
2458
ctypes.cast(ctypes.c_char_p(openpgp),
2459
ctypes.POINTER(ctypes.c_ubyte)),
2460
ctypes.c_uint(len(openpgp)))
1094
datum = (gnutls.library.types
1095
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1098
ctypes.c_uint(len(openpgp))))
2461
1099
# New empty GnuTLS certificate
2462
crt = gnutls.openpgp_crt_t()
2463
gnutls.openpgp_crt_init(ctypes.byref(crt))
1100
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1101
(gnutls.library.functions
1102
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2464
1103
# Import the OpenPGP public key into the certificate
2465
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2466
gnutls.OPENPGP_FMT_RAW)
1104
(gnutls.library.functions
1105
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1106
gnutls.library.constants
1107
.GNUTLS_OPENPGP_FMT_RAW))
2467
1108
# Verify the self signature in the key
2468
1109
crtverify = ctypes.c_uint()
2469
gnutls.openpgp_crt_verify_self(crt, 0,
2470
ctypes.byref(crtverify))
1110
(gnutls.library.functions
1111
.gnutls_openpgp_crt_verify_self(crt, 0,
1112
ctypes.byref(crtverify)))
2471
1113
if crtverify.value != 0:
2472
gnutls.openpgp_crt_deinit(crt)
2473
raise gnutls.CertificateSecurityError(code
1114
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1115
raise (gnutls.errors.CertificateSecurityError
2475
1117
# New buffer for the fingerprint
2476
1118
buf = ctypes.create_string_buffer(20)
2477
1119
buf_len = ctypes.c_size_t()
2478
1120
# Get the fingerprint from the certificate into the buffer
2479
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2480
ctypes.byref(buf_len))
1121
(gnutls.library.functions
1122
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1123
ctypes.byref(buf_len)))
2481
1124
# Deinit the certificate
2482
gnutls.openpgp_crt_deinit(crt)
1125
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2483
1126
# Convert the buffer to a Python bytestring
2484
1127
fpr = ctypes.string_at(buf, buf_len.value)
2485
1128
# Convert the bytestring to hexadecimal notation
2486
hex_fpr = binascii.hexlify(fpr).upper()
1129
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2490
class MultiprocessingMixIn(object):
2491
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2493
def sub_process_main(self, request, address):
2495
self.finish_request(request, address)
2497
self.handle_error(request, address)
2498
self.close_request(request)
2500
def process_request(self, request, address):
2501
"""Start a new process to process the request."""
2502
proc = multiprocessing.Process(target=self.sub_process_main,
2503
args=(request, address))
2508
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2509
""" adds a pipe to the MixIn """
1133
class ForkingMixInWithPipe(socketserver.ForkingMixIn, object):
1134
"""Like socketserver.ForkingMixIn, but also pass a pipe."""
2511
1135
def process_request(self, request, client_address):
2512
1136
"""Overrides and wraps the original process_request().
2514
1138
This function creates a new pipe in self.pipe
2516
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2518
proc = MultiprocessingMixIn.process_request(self, request,
2520
self.child_pipe.close()
2521
self.add_pipe(parent_pipe, proc)
2523
def add_pipe(self, parent_pipe, proc):
1140
self.pipe = os.pipe()
1141
super(ForkingMixInWithPipe,
1142
self).process_request(request, client_address)
1143
os.close(self.pipe[1]) # close write end
1144
self.add_pipe(self.pipe[0])
1145
def add_pipe(self, pipe):
2524
1146
"""Dummy function; override as necessary"""
2525
raise NotImplementedError()
2528
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1150
class IPv6_TCPServer(ForkingMixInWithPipe,
2529
1151
socketserver.TCPServer, object):
2530
1152
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2533
1155
enabled: Boolean; whether this server is activated yet
2534
1156
interface: None or a network interface name (string)
2535
1157
use_ipv6: Boolean; to use IPv6 or not
2538
1159
def __init__(self, server_address, RequestHandlerClass,
2542
"""If socketfd is set, use that file descriptor instead of
2543
creating a new one with socket.socket().
1160
interface=None, use_ipv6=True):
2545
1161
self.interface = interface
2547
1163
self.address_family = socket.AF_INET6
2548
if socketfd is not None:
2549
# Save the file descriptor
2550
self.socketfd = socketfd
2551
# Save the original socket.socket() function
2552
self.socket_socket = socket.socket
2554
# To implement --socket, we monkey patch socket.socket.
2556
# (When socketserver.TCPServer is a new-style class, we
2557
# could make self.socket into a property instead of monkey
2558
# patching socket.socket.)
2560
# Create a one-time-only replacement for socket.socket()
2561
@functools.wraps(socket.socket)
2562
def socket_wrapper(*args, **kwargs):
2563
# Restore original function so subsequent calls are
2565
socket.socket = self.socket_socket
2566
del self.socket_socket
2567
# This time only, return a new socket object from the
2568
# saved file descriptor.
2569
return socket.fromfd(self.socketfd, *args, **kwargs)
2570
# Replace socket.socket() function with wrapper
2571
socket.socket = socket_wrapper
2572
# The socketserver.TCPServer.__init__ will call
2573
# socket.socket(), which might be our replacement,
2574
# socket_wrapper(), if socketfd was set.
2575
1164
socketserver.TCPServer.__init__(self, server_address,
2576
1165
RequestHandlerClass)
2578
1166
def server_bind(self):
2579
1167
"""This overrides the normal server_bind() function
2580
1168
to bind to an interface if one was specified, and also NOT to
2581
1169
bind to an address or port if they were not specified."""
2582
global SO_BINDTODEVICE
2583
1170
if self.interface is not None:
2584
1171
if SO_BINDTODEVICE is None:
2585
# Fall back to a hard-coded value which seems to be
2587
logger.warning("SO_BINDTODEVICE not found, trying 25")
2588
SO_BINDTODEVICE = 25
2590
self.socket.setsockopt(
2591
socket.SOL_SOCKET, SO_BINDTODEVICE,
2592
(self.interface + "\0").encode("utf-8"))
2593
except socket.error as error:
2594
if error.errno == errno.EPERM:
2595
logger.error("No permission to bind to"
2596
" interface %s", self.interface)
2597
elif error.errno == errno.ENOPROTOOPT:
2598
logger.error("SO_BINDTODEVICE not available;"
2599
" cannot bind to interface %s",
2601
elif error.errno == errno.ENODEV:
2602
logger.error("Interface %s does not exist,"
2603
" cannot bind", self.interface)
1172
logger.error(u"SO_BINDTODEVICE does not exist;"
1173
u" cannot bind to interface %s",
1177
self.socket.setsockopt(socket.SOL_SOCKET,
1181
except socket.error, error:
1182
if error[0] == errno.EPERM:
1183
logger.error(u"No permission to"
1184
u" bind to interface %s",
1186
elif error[0] == errno.ENOPROTOOPT:
1187
logger.error(u"SO_BINDTODEVICE not available;"
1188
u" cannot bind to interface %s",
2606
1192
# Only bind(2) the socket if we really need to.
2607
1193
if self.server_address[0] or self.server_address[1]:
2608
if self.server_address[1]:
2609
self.allow_reuse_address = True
2610
1194
if not self.server_address[0]:
2611
1195
if self.address_family == socket.AF_INET6:
2612
any_address = "::" # in6addr_any
1196
any_address = u"::" # in6addr_any
2614
any_address = "0.0.0.0" # INADDR_ANY
1198
any_address = socket.INADDR_ANY
2615
1199
self.server_address = (any_address,
2616
1200
self.server_address[1])
2617
1201
elif not self.server_address[1]:
2618
self.server_address = (self.server_address[0], 0)
1202
self.server_address = (self.server_address[0],
2619
1204
# if self.interface:
2620
1205
# self.server_address = (self.server_address[0],
2628
1213
class MandosServer(IPv6_TCPServer):
2629
1214
"""Mandos server.
2632
1217
clients: set of Client objects
2633
1218
gnutls_priority GnuTLS priority string
2634
1219
use_dbus: Boolean; to emit D-Bus signals or not
2636
Assumes a GLib.MainLoop event loop.
1221
Assumes a gobject.MainLoop event loop.
2639
1223
def __init__(self, server_address, RequestHandlerClass,
2643
gnutls_priority=None,
1224
interface=None, use_ipv6=True, clients=None,
1225
gnutls_priority=None, use_dbus=True):
2646
1226
self.enabled = False
2647
1227
self.clients = clients
2648
1228
if self.clients is None:
1229
self.clients = set()
2650
1230
self.use_dbus = use_dbus
2651
1231
self.gnutls_priority = gnutls_priority
2652
1232
IPv6_TCPServer.__init__(self, server_address,
2653
1233
RequestHandlerClass,
2654
interface=interface,
1234
interface = interface,
1235
use_ipv6 = use_ipv6)
2658
1236
def server_activate(self):
2659
1237
if self.enabled:
2660
1238
return socketserver.TCPServer.server_activate(self)
2662
1239
def enable(self):
2663
1240
self.enabled = True
2665
def add_pipe(self, parent_pipe, proc):
1241
def add_pipe(self, pipe):
2666
1242
# Call "handle_ipc" for both data and EOF events
2668
parent_pipe.fileno(),
2669
GLib.IO_IN | GLib.IO_HUP,
2670
functools.partial(self.handle_ipc,
2671
parent_pipe=parent_pipe,
2674
def handle_ipc(self, source, condition,
2677
client_object=None):
2678
# error, or the other end of multiprocessing.Pipe has closed
2679
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2680
# Wait for other process to exit
2684
# Read a request from the child
2685
request = parent_pipe.recv()
2686
command = request[0]
2688
if command == 'init':
2689
key_id = request[1].decode("ascii")
2690
fpr = request[2].decode("ascii")
2691
address = request[3]
2693
for c in self.clients.values():
2694
if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2696
if key_id and c.key_id == key_id:
2699
if fpr and c.fingerprint == fpr:
2703
logger.info("Client not found for key ID: %s, address"
2704
": %s", key_id or fpr, address)
2707
mandos_dbus_service.ClientNotFound(key_id or fpr,
2709
parent_pipe.send(False)
2713
parent_pipe.fileno(),
2714
GLib.IO_IN | GLib.IO_HUP,
2715
functools.partial(self.handle_ipc,
2716
parent_pipe=parent_pipe,
2718
client_object=client))
2719
parent_pipe.send(True)
2720
# remove the old hook in favor of the new above hook on
2723
if command == 'funcall':
2724
funcname = request[1]
2728
parent_pipe.send(('data', getattr(client_object,
2732
if command == 'getattr':
2733
attrname = request[1]
2734
if isinstance(client_object.__getattribute__(attrname),
2735
collections.Callable):
2736
parent_pipe.send(('function', ))
2739
'data', client_object.__getattribute__(attrname)))
2741
if command == 'setattr':
2742
attrname = request[1]
2744
setattr(client_object, attrname, value)
1243
gobject.io_add_watch(pipe, gobject.IO_IN | gobject.IO_HUP,
1245
def handle_ipc(self, source, condition, file_objects={}):
1247
gobject.IO_IN: u"IN", # There is data to read.
1248
gobject.IO_OUT: u"OUT", # Data can be written (without
1250
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1251
gobject.IO_ERR: u"ERR", # Error condition.
1252
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1253
# broken, usually for pipes and
1256
conditions_string = ' | '.join(name
1258
condition_names.iteritems()
1259
if cond & condition)
1260
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1263
# Turn the pipe file descriptor into a Python file object
1264
if source not in file_objects:
1265
file_objects[source] = os.fdopen(source, u"r", 1)
1267
# Read a line from the file object
1268
cmdline = file_objects[source].readline()
1269
if not cmdline: # Empty line means end of file
1270
# close the IPC pipe
1271
file_objects[source].close()
1272
del file_objects[source]
1274
# Stop calling this function
1277
logger.debug(u"IPC command: %r", cmdline)
1279
# Parse and act on command
1280
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1282
if cmd == u"NOTFOUND":
1283
logger.warning(u"Client not found for fingerprint: %s",
1287
mandos_dbus_service.ClientNotFound(args)
1288
elif cmd == u"INVALID":
1289
for client in self.clients:
1290
if client.name == args:
1291
logger.warning(u"Client %s is invalid", args)
1297
logger.error(u"Unknown client %s is invalid", args)
1298
elif cmd == u"SENDING":
1299
for client in self.clients:
1300
if client.name == args:
1301
logger.info(u"Sending secret to %s", client.name)
1308
logger.error(u"Sending secret to unknown client %s",
1311
logger.error(u"Unknown IPC command: %r", cmdline)
1313
# Keep calling this function
2749
def rfc3339_duration_to_delta(duration):
2750
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2752
>>> rfc3339_duration_to_delta("P7D")
2753
datetime.timedelta(7)
2754
>>> rfc3339_duration_to_delta("PT60S")
2755
datetime.timedelta(0, 60)
2756
>>> rfc3339_duration_to_delta("PT60M")
2757
datetime.timedelta(0, 3600)
2758
>>> rfc3339_duration_to_delta("PT24H")
2759
datetime.timedelta(1)
2760
>>> rfc3339_duration_to_delta("P1W")
2761
datetime.timedelta(7)
2762
>>> rfc3339_duration_to_delta("PT5M30S")
2763
datetime.timedelta(0, 330)
2764
>>> rfc3339_duration_to_delta("P1DT3M20S")
2765
datetime.timedelta(1, 200)
2768
# Parsing an RFC 3339 duration with regular expressions is not
2769
# possible - there would have to be multiple places for the same
2770
# values, like seconds. The current code, while more esoteric, is
2771
# cleaner without depending on a parsing library. If Python had a
2772
# built-in library for parsing we would use it, but we'd like to
2773
# avoid excessive use of external libraries.
2775
# New type for defining tokens, syntax, and semantics all-in-one
2776
Token = collections.namedtuple("Token", (
2777
"regexp", # To match token; if "value" is not None, must have
2778
# a "group" containing digits
2779
"value", # datetime.timedelta or None
2780
"followers")) # Tokens valid after this token
2781
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2782
# the "duration" ABNF definition in RFC 3339, Appendix A.
2783
token_end = Token(re.compile(r"$"), None, frozenset())
2784
token_second = Token(re.compile(r"(\d+)S"),
2785
datetime.timedelta(seconds=1),
2786
frozenset((token_end, )))
2787
token_minute = Token(re.compile(r"(\d+)M"),
2788
datetime.timedelta(minutes=1),
2789
frozenset((token_second, token_end)))
2790
token_hour = Token(re.compile(r"(\d+)H"),
2791
datetime.timedelta(hours=1),
2792
frozenset((token_minute, token_end)))
2793
token_time = Token(re.compile(r"T"),
2795
frozenset((token_hour, token_minute,
2797
token_day = Token(re.compile(r"(\d+)D"),
2798
datetime.timedelta(days=1),
2799
frozenset((token_time, token_end)))
2800
token_month = Token(re.compile(r"(\d+)M"),
2801
datetime.timedelta(weeks=4),
2802
frozenset((token_day, token_end)))
2803
token_year = Token(re.compile(r"(\d+)Y"),
2804
datetime.timedelta(weeks=52),
2805
frozenset((token_month, token_end)))
2806
token_week = Token(re.compile(r"(\d+)W"),
2807
datetime.timedelta(weeks=1),
2808
frozenset((token_end, )))
2809
token_duration = Token(re.compile(r"P"), None,
2810
frozenset((token_year, token_month,
2811
token_day, token_time,
2813
# Define starting values:
2815
value = datetime.timedelta()
2817
# Following valid tokens
2818
followers = frozenset((token_duration, ))
2819
# String left to parse
2821
# Loop until end token is found
2822
while found_token is not token_end:
2823
# Search for any currently valid tokens
2824
for token in followers:
2825
match = token.regexp.match(s)
2826
if match is not None:
2828
if token.value is not None:
2829
# Value found, parse digits
2830
factor = int(match.group(1), 10)
2831
# Add to value so far
2832
value += factor * token.value
2833
# Strip token from string
2834
s = token.regexp.sub("", s, 1)
2837
# Set valid next tokens
2838
followers = found_token.followers
2841
# No currently valid tokens were found
2842
raise ValueError("Invalid RFC 3339 duration: {!r}"
2848
1317
def string_to_delta(interval):
2849
1318
"""Parse a string and return a datetime.timedelta
2851
>>> string_to_delta('7d')
1320
>>> string_to_delta(u'7d')
2852
1321
datetime.timedelta(7)
2853
>>> string_to_delta('60s')
1322
>>> string_to_delta(u'60s')
2854
1323
datetime.timedelta(0, 60)
2855
>>> string_to_delta('60m')
1324
>>> string_to_delta(u'60m')
2856
1325
datetime.timedelta(0, 3600)
2857
>>> string_to_delta('24h')
1326
>>> string_to_delta(u'24h')
2858
1327
datetime.timedelta(1)
2859
>>> string_to_delta('1w')
1328
>>> string_to_delta(u'1w')
2860
1329
datetime.timedelta(7)
2861
>>> string_to_delta('5m 30s')
1330
>>> string_to_delta(u'5m 30s')
2862
1331
datetime.timedelta(0, 330)
2866
return rfc3339_duration_to_delta(interval)
2870
1333
timevalue = datetime.timedelta(0)
2871
1334
for s in interval.split():
1336
suffix = unicode(s[-1])
2874
1337
value = int(s[:-1])
2876
1339
delta = datetime.timedelta(value)
1340
elif suffix == u"s":
2878
1341
delta = datetime.timedelta(0, value)
1342
elif suffix == u"m":
2880
1343
delta = datetime.timedelta(0, 0, 0, 0, value)
1344
elif suffix == u"h":
2882
1345
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1346
elif suffix == u"w":
2884
1347
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2886
raise ValueError("Unknown suffix {!r}".format(suffix))
2887
except IndexError as e:
2888
raise ValueError(*(e.args))
1349
raise ValueError(u"Unknown suffix %r" % suffix)
1350
except (ValueError, IndexError), e:
1351
raise ValueError(e.message)
2889
1352
timevalue += delta
2890
1353
return timevalue
2893
def daemon(nochdir=False, noclose=False):
1356
def if_nametoindex(interface):
1357
"""Call the C function if_nametoindex(), or equivalent
1359
Note: This function cannot accept a unicode string."""
1360
global if_nametoindex
1362
if_nametoindex = (ctypes.cdll.LoadLibrary
1363
(ctypes.util.find_library(u"c"))
1365
except (OSError, AttributeError):
1366
logger.warning(u"Doing if_nametoindex the hard way")
1367
def if_nametoindex(interface):
1368
"Get an interface index the hard way, i.e. using fcntl()"
1369
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1370
with closing(socket.socket()) as s:
1371
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1372
struct.pack(str(u"16s16x"),
1374
interface_index = struct.unpack(str(u"I"),
1376
return interface_index
1377
return if_nametoindex(interface)
1380
def daemon(nochdir = False, noclose = False):
2894
1381
"""See daemon(3). Standard BSD Unix function.
2896
1383
This should really exist as os.daemon, but it doesn't (yet)."""
2900
1387
if not nochdir:
2904
1391
if not noclose:
2905
1392
# Close all standard open file descriptors
2906
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1393
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2907
1394
if not stat.S_ISCHR(os.fstat(null).st_mode):
2908
1395
raise OSError(errno.ENODEV,
2909
"{} not a character device"
2910
.format(os.devnull))
1396
u"%s not a character device"
2911
1398
os.dup2(null, sys.stdin.fileno())
2912
1399
os.dup2(null, sys.stdout.fileno())
2913
1400
os.dup2(null, sys.stderr.fileno())
2920
1407
##################################################################
2921
1408
# Parsing of options, both command line and config file
2923
parser = argparse.ArgumentParser()
2924
parser.add_argument("-v", "--version", action="version",
2925
version="%(prog)s {}".format(version),
2926
help="show version number and exit")
2927
parser.add_argument("-i", "--interface", metavar="IF",
2928
help="Bind to interface IF")
2929
parser.add_argument("-a", "--address",
2930
help="Address to listen for requests on")
2931
parser.add_argument("-p", "--port", type=int,
2932
help="Port number to receive requests on")
2933
parser.add_argument("--check", action="store_true",
2934
help="Run self-test")
2935
parser.add_argument("--debug", action="store_true",
2936
help="Debug mode; run in foreground and log"
2937
" to terminal", default=None)
2938
parser.add_argument("--debuglevel", metavar="LEVEL",
2939
help="Debug level for stdout output")
2940
parser.add_argument("--priority", help="GnuTLS"
2941
" priority string (see GnuTLS documentation)")
2942
parser.add_argument("--servicename",
2943
metavar="NAME", help="Zeroconf service name")
2944
parser.add_argument("--configdir",
2945
default="/etc/mandos", metavar="DIR",
2946
help="Directory to search for configuration"
2948
parser.add_argument("--no-dbus", action="store_false",
2949
dest="use_dbus", help="Do not provide D-Bus"
2950
" system bus interface", default=None)
2951
parser.add_argument("--no-ipv6", action="store_false",
2952
dest="use_ipv6", help="Do not use IPv6",
2954
parser.add_argument("--no-restore", action="store_false",
2955
dest="restore", help="Do not restore stored"
2956
" state", default=None)
2957
parser.add_argument("--socket", type=int,
2958
help="Specify a file descriptor to a network"
2959
" socket to use instead of creating one")
2960
parser.add_argument("--statedir", metavar="DIR",
2961
help="Directory to save/restore state in")
2962
parser.add_argument("--foreground", action="store_true",
2963
help="Run in foreground", default=None)
2964
parser.add_argument("--no-zeroconf", action="store_false",
2965
dest="zeroconf", help="Do not use Zeroconf",
2968
options = parser.parse_args()
1410
parser = optparse.OptionParser(version = "%%prog %s" % version)
1411
parser.add_option("-i", u"--interface", type=u"string",
1412
metavar="IF", help=u"Bind to interface IF")
1413
parser.add_option("-a", u"--address", type=u"string",
1414
help=u"Address to listen for requests on")
1415
parser.add_option("-p", u"--port", type=u"int",
1416
help=u"Port number to receive requests on")
1417
parser.add_option("--check", action=u"store_true",
1418
help=u"Run self-test")
1419
parser.add_option("--debug", action=u"store_true",
1420
help=u"Debug mode; run in foreground and log to"
1422
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1423
u" priority string (see GnuTLS documentation)")
1424
parser.add_option("--servicename", type=u"string",
1425
metavar=u"NAME", help=u"Zeroconf service name")
1426
parser.add_option("--configdir", type=u"string",
1427
default=u"/etc/mandos", metavar=u"DIR",
1428
help=u"Directory to search for configuration"
1430
parser.add_option("--no-dbus", action=u"store_false",
1431
dest=u"use_dbus", help=u"Do not provide D-Bus"
1432
u" system bus interface")
1433
parser.add_option("--no-ipv6", action=u"store_false",
1434
dest=u"use_ipv6", help=u"Do not use IPv6")
1435
options = parser.parse_args()[0]
2970
1437
if options.check:
2972
fail_count, test_count = doctest.testmod()
2973
sys.exit(os.EX_OK if fail_count == 0 else 1)
2975
1442
# Default values for config file for server-global settings
2976
if gnutls.has_rawpk:
2977
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2978
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2980
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2981
":+SIGN-DSA-SHA256")
2982
server_defaults = {"interface": "",
2986
"priority": priority,
2987
"servicename": "Mandos",
2993
"statedir": "/var/lib/mandos",
2994
"foreground": "False",
1443
server_defaults = { u"interface": u"",
1448
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1449
u"servicename": u"Mandos",
1450
u"use_dbus": u"True",
1451
u"use_ipv6": u"True",
2999
1454
# Parse config file for server-global settings
3000
1455
server_config = configparser.SafeConfigParser(server_defaults)
3001
1456
del server_defaults
3002
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1457
server_config.read(os.path.join(options.configdir,
3003
1459
# Convert the SafeConfigParser object to a dict
3004
1460
server_settings = server_config.defaults()
3005
1461
# Use the appropriate methods on the non-string config options
3006
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3007
"foreground", "zeroconf"):
3008
server_settings[option] = server_config.getboolean("DEFAULT",
1462
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1463
server_settings[option] = server_config.getboolean(u"DEFAULT",
3010
1465
if server_settings["port"]:
3011
server_settings["port"] = server_config.getint("DEFAULT",
3013
if server_settings["socket"]:
3014
server_settings["socket"] = server_config.getint("DEFAULT",
3016
# Later, stdin will, and stdout and stderr might, be dup'ed
3017
# over with an opened os.devnull. But we don't want this to
3018
# happen with a supplied network socket.
3019
if 0 <= server_settings["socket"] <= 2:
3020
server_settings["socket"] = os.dup(server_settings
1466
server_settings["port"] = server_config.getint(u"DEFAULT",
3022
1468
del server_config
3024
1470
# Override the settings from the config file with command line
3025
1471
# options, if set.
3026
for option in ("interface", "address", "port", "debug",
3027
"priority", "servicename", "configdir", "use_dbus",
3028
"use_ipv6", "debuglevel", "restore", "statedir",
3029
"socket", "foreground", "zeroconf"):
1472
for option in (u"interface", u"address", u"port", u"debug",
1473
u"priority", u"servicename", u"configdir",
1474
u"use_dbus", u"use_ipv6"):
3030
1475
value = getattr(options, option)
3031
1476
if value is not None:
3032
1477
server_settings[option] = value
3034
1479
# Force all strings to be unicode
3035
1480
for option in server_settings.keys():
3036
if isinstance(server_settings[option], bytes):
3037
server_settings[option] = (server_settings[option]
3039
# Force all boolean options to be boolean
3040
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3041
"foreground", "zeroconf"):
3042
server_settings[option] = bool(server_settings[option])
3043
# Debug implies foreground
3044
if server_settings["debug"]:
3045
server_settings["foreground"] = True
1481
if type(server_settings[option]) is str:
1482
server_settings[option] = unicode(server_settings[option])
3046
1483
# Now we have our good server settings in "server_settings"
3048
1485
##################################################################
3050
if (not server_settings["zeroconf"]
3051
and not (server_settings["port"]
3052
or server_settings["socket"] != "")):
3053
parser.error("Needs port or socket to work without Zeroconf")
3055
1487
# For convenience
3056
debug = server_settings["debug"]
3057
debuglevel = server_settings["debuglevel"]
3058
use_dbus = server_settings["use_dbus"]
3059
use_ipv6 = server_settings["use_ipv6"]
3060
stored_state_path = os.path.join(server_settings["statedir"],
3062
foreground = server_settings["foreground"]
3063
zeroconf = server_settings["zeroconf"]
3066
initlogger(debug, logging.DEBUG)
3071
level = getattr(logging, debuglevel.upper())
3072
initlogger(debug, level)
3074
if server_settings["servicename"] != "Mandos":
3075
syslogger.setFormatter(
3076
logging.Formatter('Mandos ({}) [%(process)d]:'
3077
' %(levelname)s: %(message)s'.format(
3078
server_settings["servicename"])))
1488
debug = server_settings[u"debug"]
1489
use_dbus = server_settings[u"use_dbus"]
1490
use_ipv6 = server_settings[u"use_ipv6"]
1493
syslogger.setLevel(logging.WARNING)
1494
console.setLevel(logging.WARNING)
1496
if server_settings[u"servicename"] != u"Mandos":
1497
syslogger.setFormatter(logging.Formatter
1498
(u'Mandos (%s) [%%(process)d]:'
1499
u' %%(levelname)s: %%(message)s'
1500
% server_settings[u"servicename"]))
3080
1502
# Parse config file with clients
3081
client_config = configparser.SafeConfigParser(Client
3083
client_config.read(os.path.join(server_settings["configdir"],
1503
client_defaults = { u"timeout": u"1h",
1505
u"checker": u"fping -q -- %%(host)s",
1508
client_config = configparser.SafeConfigParser(client_defaults)
1509
client_config.read(os.path.join(server_settings[u"configdir"],
3086
1512
global mandos_dbus_service
3087
1513
mandos_dbus_service = None
3090
if server_settings["socket"] != "":
3091
socketfd = server_settings["socket"]
3092
tcp_server = MandosServer(
3093
(server_settings["address"], server_settings["port"]),
3095
interface=(server_settings["interface"] or None),
3097
gnutls_priority=server_settings["priority"],
3101
pidfilename = "/run/mandos.pid"
3102
if not os.path.isdir("/run/."):
3103
pidfilename = "/var/run/mandos.pid"
3106
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3107
except IOError as e:
3108
logger.error("Could not open file %r", pidfilename,
3111
for name, group in (("_mandos", "_mandos"),
3112
("mandos", "mandos"),
3113
("nobody", "nogroup")):
3115
uid = pwd.getpwnam(name).pw_uid
3116
gid = pwd.getpwnam(group).pw_gid
1515
tcp_server = MandosServer((server_settings[u"address"],
1516
server_settings[u"port"]),
1518
interface=server_settings[u"interface"],
1521
server_settings[u"priority"],
1523
pidfilename = u"/var/run/mandos.pid"
1525
pidfile = open(pidfilename, u"w")
1527
logger.error(u"Could not open file %r", pidfilename)
1530
uid = pwd.getpwnam(u"_mandos").pw_uid
1531
gid = pwd.getpwnam(u"_mandos").pw_gid
1534
uid = pwd.getpwnam(u"mandos").pw_uid
1535
gid = pwd.getpwnam(u"mandos").pw_gid
3118
1536
except KeyError:
1538
uid = pwd.getpwnam(u"nobody").pw_uid
1539
gid = pwd.getpwnam(u"nobody").pw_gid
3127
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3129
except OSError as error:
3130
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3131
.format(uid, gid, os.strerror(error.errno)))
3132
if error.errno != errno.EPERM:
1546
except OSError, error:
1547
if error[0] != errno.EPERM:
1550
# Enable all possible GnuTLS debugging
3136
# Enable all possible GnuTLS debugging
3138
1552
# "Use a log level over 10 to enable all debugging options."
3139
1553
# - GnuTLS manual
3140
gnutls.global_set_log_level(11)
1554
gnutls.library.functions.gnutls_global_set_log_level(11)
1556
@gnutls.library.types.gnutls_log_func
3143
1557
def debug_gnutls(level, string):
3144
logger.debug("GnuTLS: %s", string[:-1])
3146
gnutls.global_set_log_function(debug_gnutls)
3148
# Redirect stdin so all checkers get /dev/null
3149
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3150
os.dup2(null, sys.stdin.fileno())
3154
# Need to fork before connecting to D-Bus
3156
# Close all input and output, do double fork, etc.
3159
# multiprocessing will use threads, so before we use GLib we need
3160
# to inform GLib that threads will be used.
1558
logger.debug(u"GnuTLS: %s", string[:-1])
1560
(gnutls.library.functions
1561
.gnutls_global_set_log_function(debug_gnutls))
3163
1563
global main_loop
3164
1564
# From the Avahi example code
3165
DBusGMainLoop(set_as_default=True)
3166
main_loop = GLib.MainLoop()
1565
DBusGMainLoop(set_as_default=True )
1566
main_loop = gobject.MainLoop()
3167
1567
bus = dbus.SystemBus()
3168
1568
# End of Avahi example code
3171
bus_name = dbus.service.BusName("se.recompile.Mandos",
3174
old_bus_name = dbus.service.BusName(
3175
"se.bsnet.fukt.Mandos", bus,
3177
except dbus.exceptions.DBusException as e:
3178
logger.error("Disabling D-Bus:", exc_info=e)
1571
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1572
bus, do_not_queue=True)
1573
except dbus.exceptions.NameExistsException, e:
1574
logger.error(unicode(e) + u", disabling D-Bus")
3179
1575
use_dbus = False
3180
server_settings["use_dbus"] = False
1576
server_settings[u"use_dbus"] = False
3181
1577
tcp_server.use_dbus = False
3183
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3184
service = AvahiServiceToSyslog(
3185
name=server_settings["servicename"],
3186
servicetype="_mandos._tcp",
3189
if server_settings["interface"]:
3190
service.interface = if_nametoindex(
3191
server_settings["interface"].encode("utf-8"))
3193
global multiprocessing_manager
3194
multiprocessing_manager = multiprocessing.Manager()
1578
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1579
service = AvahiService(name = server_settings[u"servicename"],
1580
servicetype = u"_mandos._tcp",
1581
protocol = protocol, bus = bus)
1582
if server_settings["interface"]:
1583
service.interface = (if_nametoindex
1584
(str(server_settings[u"interface"])))
3196
1586
client_class = Client
3198
client_class = functools.partial(ClientDBus, bus=bus)
3200
client_settings = Client.config_parser(client_config)
3201
old_client_settings = {}
3204
# This is used to redirect stdout and stderr for checker processes
3206
wnull = open(os.devnull, "w") # A writable /dev/null
3207
# Only used if server is running in foreground but not in debug
3209
if debug or not foreground:
3212
# Get client data and settings from last running state.
3213
if server_settings["restore"]:
3215
with open(stored_state_path, "rb") as stored_state:
3216
if sys.version_info.major == 2:
3217
clients_data, old_client_settings = pickle.load(
3220
bytes_clients_data, bytes_old_client_settings = (
3221
pickle.load(stored_state, encoding="bytes"))
3222
# Fix bytes to strings
3225
clients_data = {(key.decode("utf-8")
3226
if isinstance(key, bytes)
3229
bytes_clients_data.items()}
3230
del bytes_clients_data
3231
for key in clients_data:
3232
value = {(k.decode("utf-8")
3233
if isinstance(k, bytes) else k): v
3235
clients_data[key].items()}
3236
clients_data[key] = value
3238
value["client_structure"] = [
3240
if isinstance(s, bytes)
3242
value["client_structure"]]
3244
for k in ("name", "host"):
3245
if isinstance(value[k], bytes):
3246
value[k] = value[k].decode("utf-8")
3247
if not value.has_key("key_id"):
3248
value["key_id"] = ""
3249
elif not value.has_key("fingerprint"):
3250
value["fingerprint"] = ""
3251
# old_client_settings
3253
old_client_settings = {
3254
(key.decode("utf-8")
3255
if isinstance(key, bytes)
3258
bytes_old_client_settings.items()}
3259
del bytes_old_client_settings
3261
for value in old_client_settings.values():
3262
if isinstance(value["host"], bytes):
3263
value["host"] = (value["host"]
3265
os.remove(stored_state_path)
3266
except IOError as e:
3267
if e.errno == errno.ENOENT:
3268
logger.warning("Could not load persistent state:"
3269
" {}".format(os.strerror(e.errno)))
3271
logger.critical("Could not load persistent state:",
3274
except EOFError as e:
3275
logger.warning("Could not load persistent state: "
3279
with PGPEngine() as pgp:
3280
for client_name, client in clients_data.items():
3281
# Skip removed clients
3282
if client_name not in client_settings:
3285
# Decide which value to use after restoring saved state.
3286
# We have three different values: Old config file,
3287
# new config file, and saved state.
3288
# New config value takes precedence if it differs from old
3289
# config value, otherwise use saved state.
3290
for name, value in client_settings[client_name].items():
3292
# For each value in new config, check if it
3293
# differs from the old config value (Except for
3294
# the "secret" attribute)
3295
if (name != "secret"
3297
old_client_settings[client_name][name])):
3298
client[name] = value
3302
# Clients who has passed its expire date can still be
3303
# enabled if its last checker was successful. A Client
3304
# whose checker succeeded before we stored its state is
3305
# assumed to have successfully run all checkers during
3307
if client["enabled"]:
3308
if datetime.datetime.utcnow() >= client["expires"]:
3309
if not client["last_checked_ok"]:
3311
"disabling client {} - Client never "
3312
"performed a successful checker".format(
3314
client["enabled"] = False
3315
elif client["last_checker_status"] != 0:
3317
"disabling client {} - Client last"
3318
" checker failed with error code"
3321
client["last_checker_status"]))
3322
client["enabled"] = False
3324
client["expires"] = (
3325
datetime.datetime.utcnow()
3326
+ client["timeout"])
3327
logger.debug("Last checker succeeded,"
3328
" keeping {} enabled".format(
3331
client["secret"] = pgp.decrypt(
3332
client["encrypted_secret"],
3333
client_settings[client_name]["secret"])
3335
# If decryption fails, we use secret from new settings
3336
logger.debug("Failed to decrypt {} old secret".format(
3338
client["secret"] = (client_settings[client_name]
3341
# Add/remove clients based on new changes made to config
3342
for client_name in (set(old_client_settings)
3343
- set(client_settings)):
3344
del clients_data[client_name]
3345
for client_name in (set(client_settings)
3346
- set(old_client_settings)):
3347
clients_data[client_name] = client_settings[client_name]
3349
# Create all client objects
3350
for client_name, client in clients_data.items():
3351
tcp_server.clients[client_name] = client_class(
3354
server_settings=server_settings)
1588
client_class = functools.partial(ClientDBus, bus = bus)
1589
tcp_server.clients.update(set(
1590
client_class(name = section,
1591
config= dict(client_config.items(section)))
1592
for section in client_config.sections()))
3356
1593
if not tcp_server.clients:
3357
logger.warning("No clients defined")
3360
if pidfile is not None:
1594
logger.warning(u"No clients defined")
1597
# Redirect stdin so all checkers get /dev/null
1598
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1599
os.dup2(null, sys.stdin.fileno())
1603
# No console logging
1604
logger.removeHandler(console)
1605
# Close all input and output, do double fork, etc.
1609
with closing(pidfile):
3361
1610
pid = os.getpid()
3364
print(pid, file=pidfile)
3366
logger.error("Could not write to file %r with PID %d",
1611
pidfile.write(str(pid) + "\n")
3371
for termsig in (signal.SIGHUP, signal.SIGTERM):
3372
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3373
lambda: main_loop.quit() and False)
1614
logger.error(u"Could not write to file %r with PID %d",
1617
# "pidfile" was never created
1622
signal.signal(signal.SIGINT, signal.SIG_IGN)
1623
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1624
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3377
@alternate_dbus_interfaces(
3378
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3379
class MandosDBusService(DBusObjectWithObjectManager):
1627
class MandosDBusService(dbus.service.Object):
3380
1628
"""A D-Bus proxy object"""
3382
1629
def __init__(self):
3383
dbus.service.Object.__init__(self, bus, "/")
3385
_interface = "se.recompile.Mandos"
3387
@dbus.service.signal(_interface, signature="o")
3388
def ClientAdded(self, objpath):
3392
@dbus.service.signal(_interface, signature="ss")
3393
def ClientNotFound(self, key_id, address):
3397
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3399
@dbus.service.signal(_interface, signature="os")
1630
dbus.service.Object.__init__(self, bus, u"/")
1631
_interface = u"se.bsnet.fukt.Mandos"
1633
@dbus.service.signal(_interface, signature=u"oa{sv}")
1634
def ClientAdded(self, objpath, properties):
1638
@dbus.service.signal(_interface, signature=u"s")
1639
def ClientNotFound(self, fingerprint):
1643
@dbus.service.signal(_interface, signature=u"os")
3400
1644
def ClientRemoved(self, objpath, name):
3404
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3406
@dbus.service.method(_interface, out_signature="ao")
1648
@dbus.service.method(_interface, out_signature=u"ao")
3407
1649
def GetAllClients(self):
3409
return dbus.Array(c.dbus_object_path for c in
3410
tcp_server.clients.values())
3412
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1651
return dbus.Array(c.dbus_object_path
1652
for c in tcp_server.clients)
3414
1654
@dbus.service.method(_interface,
3415
out_signature="a{oa{sv}}")
1655
out_signature=u"a{oa{sv}}")
3416
1656
def GetAllClientsWithProperties(self):
3418
1658
return dbus.Dictionary(
3419
{c.dbus_object_path: c.GetAll(
3420
"se.recompile.Mandos.Client")
3421
for c in tcp_server.clients.values()},
3424
@dbus.service.method(_interface, in_signature="o")
1659
((c.dbus_object_path, c.GetAll(u""))
1660
for c in tcp_server.clients),
1661
signature=u"oa{sv}")
1663
@dbus.service.method(_interface, in_signature=u"o")
3425
1664
def RemoveClient(self, object_path):
3427
for c in tcp_server.clients.values():
1666
for c in tcp_server.clients:
3428
1667
if c.dbus_object_path == object_path:
3429
del tcp_server.clients[c.name]
1668
tcp_server.clients.remove(c)
3430
1669
c.remove_from_connection()
3431
# Don't signal the disabling
1670
# Don't signal anything except ClientRemoved
3432
1671
c.disable(quiet=True)
3433
# Emit D-Bus signal for removal
3434
self.client_removed_signal(c)
1673
self.ClientRemoved(object_path, c.name)
3436
1675
raise KeyError(object_path)
3440
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3441
out_signature="a{oa{sa{sv}}}")
3442
def GetManagedObjects(self):
3444
return dbus.Dictionary(
3445
{client.dbus_object_path:
3447
{interface: client.GetAll(interface)
3449
client._get_all_interface_names()})
3450
for client in tcp_server.clients.values()})
3452
def client_added_signal(self, client):
3453
"""Send the new standard signal and the old signal"""
3455
# New standard signal
3456
self.InterfacesAdded(
3457
client.dbus_object_path,
3459
{interface: client.GetAll(interface)
3461
client._get_all_interface_names()}))
3463
self.ClientAdded(client.dbus_object_path)
3465
def client_removed_signal(self, client):
3466
"""Send the new standard signal and the old signal"""
3468
# New standard signal
3469
self.InterfacesRemoved(
3470
client.dbus_object_path,
3471
client._get_all_interface_names())
3473
self.ClientRemoved(client.dbus_object_path,
3476
1679
mandos_dbus_service = MandosDBusService()
3478
# Save modules to variables to exempt the modules from being
3479
# unloaded before the function registered with atexit() is run.
3480
mp = multiprocessing
3484
1682
"Cleanup function; run on exit"
3488
mp.active_children()
3490
if not (tcp_server.clients or client_settings):
3493
# Store client before exiting. Secrets are encrypted with key
3494
# based on what config file has. If config file is
3495
# removed/edited, old secret will thus be unrecovable.
3497
with PGPEngine() as pgp:
3498
for client in tcp_server.clients.values():
3499
key = client_settings[client.name]["secret"]
3500
client.encrypted_secret = pgp.encrypt(client.secret,
3504
# A list of attributes that can not be pickled
3506
exclude = {"bus", "changedstate", "secret",
3507
"checker", "server_settings"}
3508
for name, typ in inspect.getmembers(dbus.service
3512
client_dict["encrypted_secret"] = (client
3514
for attr in client.client_structure:
3515
if attr not in exclude:
3516
client_dict[attr] = getattr(client, attr)
3518
clients[client.name] = client_dict
3519
del client_settings[client.name]["secret"]
3522
with tempfile.NamedTemporaryFile(
3526
dir=os.path.dirname(stored_state_path),
3527
delete=False) as stored_state:
3528
pickle.dump((clients, client_settings), stored_state,
3530
tempname = stored_state.name
3531
os.rename(tempname, stored_state_path)
3532
except (IOError, OSError) as e:
3538
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3539
logger.warning("Could not save persistent state: {}"
3540
.format(os.strerror(e.errno)))
3542
logger.warning("Could not save persistent state:",
3546
# Delete all clients, and settings from config
3547
1685
while tcp_server.clients:
3548
name, client = tcp_server.clients.popitem()
1686
client = tcp_server.clients.pop()
3550
1688
client.remove_from_connection()
3551
# Don't signal the disabling
1689
client.disable_hook = None
1690
# Don't signal anything except ClientRemoved
3552
1691
client.disable(quiet=True)
3553
# Emit D-Bus signal for removal
3555
mandos_dbus_service.client_removed_signal(client)
3556
client_settings.clear()
1694
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3558
1697
atexit.register(cleanup)
3560
for client in tcp_server.clients.values():
1699
for client in tcp_server.clients:
3562
# Emit D-Bus signal for adding
3563
mandos_dbus_service.client_added_signal(client)
3564
# Need to initiate checking of clients
3566
client.init_checker()
1702
mandos_dbus_service.ClientAdded(client.dbus_object_path,
3568
1706
tcp_server.enable()
3569
1707
tcp_server.server_activate()
3571
1709
# Find out what port we got
3573
service.port = tcp_server.socket.getsockname()[1]
1710
service.port = tcp_server.socket.getsockname()[1]
3575
logger.info("Now listening on address %r, port %d,"
3576
" flowinfo %d, scope_id %d",
3577
*tcp_server.socket.getsockname())
1712
logger.info(u"Now listening on address %r, port %d,"
1713
" flowinfo %d, scope_id %d"
1714
% tcp_server.socket.getsockname())
3579
logger.info("Now listening on address %r, port %d",
3580
*tcp_server.socket.getsockname())
3582
# service.interface = tcp_server.socket.getsockname()[3]
1716
logger.info(u"Now listening on address %r, port %d"
1717
% tcp_server.socket.getsockname())
1719
#service.interface = tcp_server.socket.getsockname()[3]
3586
# From the Avahi example code
3589
except dbus.exceptions.DBusException as error:
3590
logger.critical("D-Bus Exception", exc_info=error)
3593
# End of Avahi example code
3595
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3596
lambda *args, **kwargs:
3597
(tcp_server.handle_request
3598
(*args[2:], **kwargs) or True))
3600
logger.debug("Starting main loop")
1722
# From the Avahi example code
1725
except dbus.exceptions.DBusException, error:
1726
logger.critical(u"DBusException: %s", error)
1729
# End of Avahi example code
1731
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1732
lambda *args, **kwargs:
1733
(tcp_server.handle_request
1734
(*args[2:], **kwargs) or True))
1736
logger.debug(u"Starting main loop")
3601
1737
main_loop.run()
3602
except AvahiError as error:
3603
logger.critical("Avahi Error", exc_info=error)
1738
except AvahiError, error:
1739
logger.critical(u"AvahiError: %s", error)
3606
1742
except KeyboardInterrupt:
3608
print("", file=sys.stderr)
3609
logger.debug("Server received KeyboardInterrupt")
3610
logger.debug("Server exiting")
1745
logger.debug(u"Server received KeyboardInterrupt")
1746
logger.debug(u"Server exiting")
3611
1747
# Must run before the D-Bus bus name gets deregistered
3615
1750
if __name__ == '__main__':