189
425
dbus.UInt16(self.port),
190
426
avahi.string_array_to_txt_array(self.TXT))
191
427
self.group.Commit()
192
429
def entry_group_state_changed(self, state, error):
193
430
"""Derived from the Avahi example code"""
194
logger.debug(u"Avahi state change: %i", state)
431
logger.debug("Avahi entry group state change: %i", state)
196
433
if state == avahi.ENTRY_GROUP_ESTABLISHED:
197
logger.debug(u"Zeroconf service established.")
434
logger.debug("Zeroconf service established.")
198
435
elif state == avahi.ENTRY_GROUP_COLLISION:
199
logger.warning(u"Zeroconf service name collision.")
436
logger.info("Zeroconf service name collision.")
201
438
elif state == avahi.ENTRY_GROUP_FAILURE:
202
logger.critical(u"Avahi: Error in group state changed %s",
204
raise AvahiGroupError(u"State changed: %s"
439
logger.critical("Avahi: Error in group state changed %s",
441
raise AvahiGroupError("State changed: {!s}".format(error))
206
443
def cleanup(self):
207
444
"""Derived from the Avahi example code"""
208
445
if self.group is not None:
448
except (dbus.exceptions.UnknownMethodException,
449
dbus.exceptions.DBusException):
210
451
self.group = None
211
def server_state_changed(self, state):
454
def server_state_changed(self, state, error=None):
212
455
"""Derived from the Avahi example code"""
213
if state == avahi.SERVER_COLLISION:
214
logger.error(u"Zeroconf server name collision")
456
logger.debug("Avahi server state change: %i", state)
458
avahi.SERVER_INVALID: "Zeroconf server invalid",
459
avahi.SERVER_REGISTERING: None,
460
avahi.SERVER_COLLISION: "Zeroconf server name collision",
461
avahi.SERVER_FAILURE: "Zeroconf server failure",
463
if state in bad_states:
464
if bad_states[state] is not None:
466
logger.error(bad_states[state])
468
logger.error(bad_states[state] + ": %r", error)
216
470
elif state == avahi.SERVER_RUNNING:
473
except dbus.exceptions.DBusException as error:
474
if (error.get_dbus_name()
475
== "org.freedesktop.Avahi.CollisionError"):
476
logger.info("Local Zeroconf service name"
478
return self.rename(remove=False)
480
logger.critical("D-Bus Exception", exc_info=error)
485
logger.debug("Unknown state: %r", state)
487
logger.debug("Unknown state: %r: %r", state, error)
218
489
def activate(self):
219
490
"""Derived from the Avahi example code"""
220
491
if self.server is None:
221
492
self.server = dbus.Interface(
222
493
self.bus.get_object(avahi.DBUS_NAME,
223
avahi.DBUS_PATH_SERVER),
494
avahi.DBUS_PATH_SERVER,
495
follow_name_owner_changes=True),
224
496
avahi.DBUS_INTERFACE_SERVER)
225
self.server.connect_to_signal(u"StateChanged",
226
self.server_state_changed)
497
self.server.connect_to_signal("StateChanged",
498
self.server_state_changed)
227
499
self.server_state_changed(self.server.GetState())
230
class Client(object):
502
class AvahiServiceToSyslog(AvahiService):
503
def rename(self, *args, **kwargs):
504
"""Add the new name to the syslog messages"""
505
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
506
syslogger.setFormatter(logging.Formatter(
507
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
512
# Pretend that we have a GnuTLS module
514
"""This isn't so much a class as it is a module-like namespace."""
516
library = ctypes.util.find_library("gnutls")
518
library = ctypes.util.find_library("gnutls-deb0")
519
_library = ctypes.cdll.LoadLibrary(library)
522
# Unless otherwise indicated, the constants and types below are
523
# all from the gnutls/gnutls.h C header file.
534
E_NO_CERTIFICATE_FOUND = -49
539
KEYID_USE_SHA256 = 1 # gnutls/x509.h
540
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
543
class session_int(ctypes.Structure):
545
session_t = ctypes.POINTER(session_int)
547
class certificate_credentials_st(ctypes.Structure):
549
certificate_credentials_t = ctypes.POINTER(
550
certificate_credentials_st)
551
certificate_type_t = ctypes.c_int
553
class datum_t(ctypes.Structure):
554
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
555
('size', ctypes.c_uint)]
557
class openpgp_crt_int(ctypes.Structure):
559
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
560
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
561
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
562
credentials_type_t = ctypes.c_int
563
transport_ptr_t = ctypes.c_void_p
564
close_request_t = ctypes.c_int
567
class Error(Exception):
568
def __init__(self, message=None, code=None, args=()):
569
# Default usage is by a message string, but if a return
570
# code is passed, convert it to a string with
573
if message is None and code is not None:
574
message = gnutls.strerror(code)
575
return super(gnutls.Error, self).__init__(
578
class CertificateSecurityError(Error):
584
self._c_object = gnutls.certificate_credentials_t()
585
gnutls.certificate_allocate_credentials(
586
ctypes.byref(self._c_object))
587
self.type = gnutls.CRD_CERTIFICATE
590
gnutls.certificate_free_credentials(self._c_object)
593
def __init__(self, socket, credentials=None):
594
self._c_object = gnutls.session_t()
595
gnutls_flags = gnutls.CLIENT
596
if gnutls.check_version(b"3.5.6"):
597
gnutls_flags |= gnutls.NO_TICKETS
599
gnutls_flags |= gnutls.ENABLE_RAWPK
600
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
602
gnutls.set_default_priority(self._c_object)
603
gnutls.transport_set_ptr(self._c_object, socket.fileno())
604
gnutls.handshake_set_private_extensions(self._c_object,
607
if credentials is None:
608
credentials = gnutls.Credentials()
609
gnutls.credentials_set(self._c_object, credentials.type,
610
ctypes.cast(credentials._c_object,
612
self.credentials = credentials
615
gnutls.deinit(self._c_object)
618
return gnutls.handshake(self._c_object)
620
def send(self, data):
624
data_len -= gnutls.record_send(self._c_object,
629
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
631
# Error handling functions
632
def _error_code(result):
633
"""A function to raise exceptions on errors, suitable
634
for the 'restype' attribute on ctypes functions"""
637
if result == gnutls.E_NO_CERTIFICATE_FOUND:
638
raise gnutls.CertificateSecurityError(code=result)
639
raise gnutls.Error(code=result)
641
def _retry_on_error(result, func, arguments):
642
"""A function to retry on some errors, suitable
643
for the 'errcheck' attribute on ctypes functions"""
645
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
646
return _error_code(result)
647
result = func(*arguments)
650
# Unless otherwise indicated, the function declarations below are
651
# all from the gnutls/gnutls.h C header file.
654
priority_set_direct = _library.gnutls_priority_set_direct
655
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
656
ctypes.POINTER(ctypes.c_char_p)]
657
priority_set_direct.restype = _error_code
659
init = _library.gnutls_init
660
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
661
init.restype = _error_code
663
set_default_priority = _library.gnutls_set_default_priority
664
set_default_priority.argtypes = [session_t]
665
set_default_priority.restype = _error_code
667
record_send = _library.gnutls_record_send
668
record_send.argtypes = [session_t, ctypes.c_void_p,
670
record_send.restype = ctypes.c_ssize_t
671
record_send.errcheck = _retry_on_error
673
certificate_allocate_credentials = (
674
_library.gnutls_certificate_allocate_credentials)
675
certificate_allocate_credentials.argtypes = [
676
ctypes.POINTER(certificate_credentials_t)]
677
certificate_allocate_credentials.restype = _error_code
679
certificate_free_credentials = (
680
_library.gnutls_certificate_free_credentials)
681
certificate_free_credentials.argtypes = [
682
certificate_credentials_t]
683
certificate_free_credentials.restype = None
685
handshake_set_private_extensions = (
686
_library.gnutls_handshake_set_private_extensions)
687
handshake_set_private_extensions.argtypes = [session_t,
689
handshake_set_private_extensions.restype = None
691
credentials_set = _library.gnutls_credentials_set
692
credentials_set.argtypes = [session_t, credentials_type_t,
694
credentials_set.restype = _error_code
696
strerror = _library.gnutls_strerror
697
strerror.argtypes = [ctypes.c_int]
698
strerror.restype = ctypes.c_char_p
700
certificate_type_get = _library.gnutls_certificate_type_get
701
certificate_type_get.argtypes = [session_t]
702
certificate_type_get.restype = _error_code
704
certificate_get_peers = _library.gnutls_certificate_get_peers
705
certificate_get_peers.argtypes = [session_t,
706
ctypes.POINTER(ctypes.c_uint)]
707
certificate_get_peers.restype = ctypes.POINTER(datum_t)
709
global_set_log_level = _library.gnutls_global_set_log_level
710
global_set_log_level.argtypes = [ctypes.c_int]
711
global_set_log_level.restype = None
713
global_set_log_function = _library.gnutls_global_set_log_function
714
global_set_log_function.argtypes = [log_func]
715
global_set_log_function.restype = None
717
deinit = _library.gnutls_deinit
718
deinit.argtypes = [session_t]
719
deinit.restype = None
721
handshake = _library.gnutls_handshake
722
handshake.argtypes = [session_t]
723
handshake.restype = _error_code
724
handshake.errcheck = _retry_on_error
726
transport_set_ptr = _library.gnutls_transport_set_ptr
727
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
728
transport_set_ptr.restype = None
730
bye = _library.gnutls_bye
731
bye.argtypes = [session_t, close_request_t]
732
bye.restype = _error_code
733
bye.errcheck = _retry_on_error
735
check_version = _library.gnutls_check_version
736
check_version.argtypes = [ctypes.c_char_p]
737
check_version.restype = ctypes.c_char_p
739
_need_version = b"3.3.0"
740
if check_version(_need_version) is None:
741
raise self.Error("Needs GnuTLS {} or later"
742
.format(_need_version))
744
_tls_rawpk_version = b"3.6.6"
745
has_rawpk = bool(check_version(_tls_rawpk_version))
749
class pubkey_st(ctypes.Structure):
751
pubkey_t = ctypes.POINTER(pubkey_st)
753
x509_crt_fmt_t = ctypes.c_int
755
# All the function declarations below are from gnutls/abstract.h
756
pubkey_init = _library.gnutls_pubkey_init
757
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
758
pubkey_init.restype = _error_code
760
pubkey_import = _library.gnutls_pubkey_import
761
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
763
pubkey_import.restype = _error_code
765
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
766
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
767
ctypes.POINTER(ctypes.c_ubyte),
768
ctypes.POINTER(ctypes.c_size_t)]
769
pubkey_get_key_id.restype = _error_code
771
pubkey_deinit = _library.gnutls_pubkey_deinit
772
pubkey_deinit.argtypes = [pubkey_t]
773
pubkey_deinit.restype = None
775
# All the function declarations below are from gnutls/openpgp.h
777
openpgp_crt_init = _library.gnutls_openpgp_crt_init
778
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
779
openpgp_crt_init.restype = _error_code
781
openpgp_crt_import = _library.gnutls_openpgp_crt_import
782
openpgp_crt_import.argtypes = [openpgp_crt_t,
783
ctypes.POINTER(datum_t),
785
openpgp_crt_import.restype = _error_code
787
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
788
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
789
ctypes.POINTER(ctypes.c_uint)]
790
openpgp_crt_verify_self.restype = _error_code
792
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
793
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
794
openpgp_crt_deinit.restype = None
796
openpgp_crt_get_fingerprint = (
797
_library.gnutls_openpgp_crt_get_fingerprint)
798
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
802
openpgp_crt_get_fingerprint.restype = _error_code
804
if check_version(b"3.6.4"):
805
certificate_type_get2 = _library.gnutls_certificate_type_get2
806
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
807
certificate_type_get2.restype = _error_code
809
# Remove non-public functions
810
del _error_code, _retry_on_error
813
def call_pipe(connection, # : multiprocessing.Connection
814
func, *args, **kwargs):
815
"""This function is meant to be called by multiprocessing.Process
817
This function runs func(*args, **kwargs), and writes the resulting
818
return value on the provided multiprocessing.Connection.
820
connection.send(func(*args, **kwargs))
231
825
"""A representation of a client host served by this server.
828
approved: bool(); 'None' if not yet approved/disapproved
829
approval_delay: datetime.timedelta(); Time to wait for approval
830
approval_duration: datetime.timedelta(); Duration of one approval
831
checker: multiprocessing.Process(); a running checker process used
832
to see if the client lives. 'None' if no process is
834
checker_callback_tag: a GLib event source tag, or None
835
checker_command: string; External command which is run to check
836
if client lives. %() expansions are done at
837
runtime with vars(self) as dict, so that for
838
instance %(name)s can be used in the command.
839
checker_initiator_tag: a GLib event source tag, or None
840
created: datetime.datetime(); (UTC) object creation
841
client_structure: Object describing what attributes a client has
842
and is used for storing the client at exit
843
current_checker_command: string; current running checker_command
844
disable_initiator_tag: a GLib event source tag, or None
846
fingerprint: string (40 or 32 hexadecimal digits); used to
847
uniquely identify an OpenPGP client
848
key_id: string (64 hexadecimal digits); used to uniquely identify
849
a client using raw public keys
850
host: string; available for use by the checker command
851
interval: datetime.timedelta(); How often to start a new checker
852
last_approval_request: datetime.datetime(); (UTC) or None
853
last_checked_ok: datetime.datetime(); (UTC) or None
854
last_checker_status: integer between 0 and 255 reflecting exit
855
status of last checker. -1 reflects crashed
856
checker, -2 means no checker completed yet.
857
last_checker_signal: The signal which killed the last checker, if
858
last_checker_status is -1
859
last_enabled: datetime.datetime(); (UTC) or None
234
860
name: string; from the config file, used in log messages and
235
861
D-Bus identifiers
236
fingerprint: string (40 or 32 hexadecimal digits); used to
237
uniquely identify the client
238
862
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
863
timeout: datetime.timedelta(); How long from last_checked_ok
245
until this client is invalid
246
interval: datetime.timedelta(); How often to start a new checker
247
disable_hook: If set, called by disable() as disable_hook(self)
248
checker: subprocess.Popen(); a running checker process used
249
to see if the client lives.
250
'None' if no process is running.
251
checker_initiator_tag: a gobject event source tag, or None
252
disable_initiator_tag: - '' -
253
checker_callback_tag: - '' -
254
checker_command: string; External command which is run to check if
255
client lives. %() expansions are done at
256
runtime with vars(self) as dict, so that for
257
instance %(name)s can be used in the command.
258
current_checker_command: string; current running checker_command
864
until this client is disabled
865
extended_timeout: extra long timeout when secret has been sent
866
runtime_expansions: Allowed attributes for runtime expansion.
867
expires: datetime.datetime(); time (UTC) when a client will be
869
server_settings: The server_settings dict from main()
872
runtime_expansions = ("approval_delay", "approval_duration",
873
"created", "enabled", "expires", "key_id",
874
"fingerprint", "host", "interval",
875
"last_approval_request", "last_checked_ok",
876
"last_enabled", "name", "timeout")
879
"extended_timeout": "PT15M",
881
"checker": "fping -q -- %%(host)s",
883
"approval_delay": "PT0S",
884
"approval_duration": "PT1S",
885
"approved_by_default": "True",
262
def _timedelta_to_milliseconds(td):
263
"Convert a datetime.timedelta() to milliseconds"
264
return ((td.days * 24 * 60 * 60 * 1000)
265
+ (td.seconds * 1000)
266
+ (td.microseconds // 1000))
268
def timeout_milliseconds(self):
269
"Return the 'timeout' attribute in milliseconds"
270
return self._timedelta_to_milliseconds(self.timeout)
272
def interval_milliseconds(self):
273
"Return the 'interval' attribute in milliseconds"
274
return self._timedelta_to_milliseconds(self.interval)
276
def __init__(self, name = None, disable_hook=None, config=None):
277
"""Note: the 'checker' key in 'config' sets the
278
'checker_command' attribute and *not* the 'checker'
890
def config_parser(config):
891
"""Construct a new dict of client settings of this form:
892
{ client_name: {setting_name: value, ...}, ...}
893
with exceptions for any special settings as defined above.
894
NOTE: Must be a pure function. Must return the same result
895
value given the same arguments.
898
for client_name in config.sections():
899
section = dict(config.items(client_name))
900
client = settings[client_name] = {}
902
client["host"] = section["host"]
903
# Reformat values from string types to Python types
904
client["approved_by_default"] = config.getboolean(
905
client_name, "approved_by_default")
906
client["enabled"] = config.getboolean(client_name,
909
# Uppercase and remove spaces from key_id and fingerprint
910
# for later comparison purposes with return value from the
911
# key_id() and fingerprint() functions
912
client["key_id"] = (section.get("key_id", "").upper()
914
client["fingerprint"] = (section["fingerprint"].upper()
916
if "secret" in section:
917
client["secret"] = codecs.decode(section["secret"]
920
elif "secfile" in section:
921
with open(os.path.expanduser(os.path.expandvars
922
(section["secfile"])),
924
client["secret"] = secfile.read()
926
raise TypeError("No secret or secfile for section {}"
928
client["timeout"] = string_to_delta(section["timeout"])
929
client["extended_timeout"] = string_to_delta(
930
section["extended_timeout"])
931
client["interval"] = string_to_delta(section["interval"])
932
client["approval_delay"] = string_to_delta(
933
section["approval_delay"])
934
client["approval_duration"] = string_to_delta(
935
section["approval_duration"])
936
client["checker_command"] = section["checker"]
937
client["last_approval_request"] = None
938
client["last_checked_ok"] = None
939
client["last_checker_status"] = -2
943
def __init__(self, settings, name=None, server_settings=None):
283
logger.debug(u"Creating client %r", self.name)
284
# Uppercase and remove spaces from fingerprint for later
285
# comparison purposes with return value from the fingerprint()
287
self.fingerprint = (config[u"fingerprint"].upper()
289
logger.debug(u" Fingerprint: %s", self.fingerprint)
290
if u"secret" in config:
291
self.secret = config[u"secret"].decode(u"base64")
292
elif u"secfile" in config:
293
with closing(open(os.path.expanduser
295
(config[u"secfile"])),
297
self.secret = secfile.read()
945
if server_settings is None:
947
self.server_settings = server_settings
948
# adding all client settings
949
for setting, value in settings.items():
950
setattr(self, setting, value)
953
if not hasattr(self, "last_enabled"):
954
self.last_enabled = datetime.datetime.utcnow()
955
if not hasattr(self, "expires"):
956
self.expires = (datetime.datetime.utcnow()
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
959
self.last_enabled = None
962
logger.debug("Creating client %r", self.name)
963
logger.debug(" Key ID: %s", self.key_id)
964
logger.debug(" Fingerprint: %s", self.fingerprint)
965
self.created = settings.get("created",
966
datetime.datetime.utcnow())
968
# attributes specific for this server instance
309
969
self.checker = None
310
970
self.checker_initiator_tag = None
311
971
self.disable_initiator_tag = None
312
972
self.checker_callback_tag = None
313
self.checker_command = config[u"checker"]
314
973
self.current_checker_command = None
315
self.last_connect = None
975
self.approvals_pending = 0
976
self.changedstate = multiprocessing_manager.Condition(
977
multiprocessing_manager.Lock())
978
self.client_structure = [attr
979
for attr in self.__dict__.keys()
980
if not attr.startswith("_")]
981
self.client_structure.append("client_structure")
983
for name, t in inspect.getmembers(
984
type(self), lambda obj: isinstance(obj, property)):
985
if not name.startswith("_"):
986
self.client_structure.append(name)
988
# Send notice to process children that client state has changed
989
def send_changedstate(self):
990
with self.changedstate:
991
self.changedstate.notify_all()
317
993
def enable(self):
318
994
"""Start this client's checker and timeout hooks"""
319
if getattr(self, u"enabled", False):
995
if getattr(self, "enabled", False):
320
996
# Already enabled
998
self.expires = datetime.datetime.utcnow() + self.timeout
322
1000
self.last_enabled = datetime.datetime.utcnow()
1002
self.send_changedstate()
1004
def disable(self, quiet=True):
1005
"""Disable this client."""
1006
if not getattr(self, "enabled", False):
1009
logger.info("Disabling client %s", self.name)
1010
if getattr(self, "disable_initiator_tag", None) is not None:
1011
GLib.source_remove(self.disable_initiator_tag)
1012
self.disable_initiator_tag = None
1014
if getattr(self, "checker_initiator_tag", None) is not None:
1015
GLib.source_remove(self.checker_initiator_tag)
1016
self.checker_initiator_tag = None
1018
self.enabled = False
1020
self.send_changedstate()
1021
# Do not run this again if called by a GLib.timeout_add
1027
def init_checker(self):
323
1028
# Schedule a new checker to be started an 'interval' from now,
324
1029
# and every interval from then on.
325
self.checker_initiator_tag = (gobject.timeout_add
326
(self.interval_milliseconds(),
1030
if self.checker_initiator_tag is not None:
1031
GLib.source_remove(self.checker_initiator_tag)
1032
self.checker_initiator_tag = GLib.timeout_add(
1033
int(self.interval.total_seconds() * 1000),
1035
# Schedule a disable() when 'timeout' has passed
1036
if self.disable_initiator_tag is not None:
1037
GLib.source_remove(self.disable_initiator_tag)
1038
self.disable_initiator_tag = GLib.timeout_add(
1039
int(self.timeout.total_seconds() * 1000), self.disable)
328
1040
# Also start a new checker *right now*.
329
1041
self.start_checker()
330
# Schedule a disable() when 'timeout' has passed
331
self.disable_initiator_tag = (gobject.timeout_add
332
(self.timeout_milliseconds(),
337
"""Disable this client."""
338
if not getattr(self, "enabled", False):
340
logger.info(u"Disabling client %s", self.name)
341
if getattr(self, u"disable_initiator_tag", False):
342
gobject.source_remove(self.disable_initiator_tag)
343
self.disable_initiator_tag = None
344
if getattr(self, u"checker_initiator_tag", False):
345
gobject.source_remove(self.checker_initiator_tag)
346
self.checker_initiator_tag = None
348
if self.disable_hook:
349
self.disable_hook(self)
351
# Do not run this again if called by a gobject.timeout_add
355
self.disable_hook = None
358
def checker_callback(self, pid, condition, command):
1043
def checker_callback(self, source, condition, connection,
359
1045
"""The checker has completed, so take appropriate actions."""
1046
# Read return code from connection (see call_pipe)
1047
returncode = connection.recv()
360
1050
self.checker_callback_tag = None
361
1051
self.checker = None
362
if os.WIFEXITED(condition):
363
exitstatus = os.WEXITSTATUS(condition)
365
logger.info(u"Checker for %(name)s succeeded",
1054
self.last_checker_status = returncode
1055
self.last_checker_signal = None
1056
if self.last_checker_status == 0:
1057
logger.info("Checker for %(name)s succeeded",
367
1059
self.checked_ok()
369
logger.info(u"Checker for %(name)s failed",
1061
logger.info("Checker for %(name)s failed", vars(self))
372
logger.warning(u"Checker for %(name)s crashed?",
1063
self.last_checker_status = -1
1064
self.last_checker_signal = -returncode
1065
logger.warning("Checker for %(name)s crashed?",
375
1069
def checked_ok(self):
376
"""Bump up the timeout for this client.
378
This should only be called when the client has been seen,
1070
"""Assert that the client has been seen, alive and well."""
381
1071
self.last_checked_ok = datetime.datetime.utcnow()
382
gobject.source_remove(self.disable_initiator_tag)
383
self.disable_initiator_tag = (gobject.timeout_add
384
(self.timeout_milliseconds(),
1072
self.last_checker_status = 0
1073
self.last_checker_signal = None
1076
def bump_timeout(self, timeout=None):
1077
"""Bump up the timeout for this client."""
1079
timeout = self.timeout
1080
if self.disable_initiator_tag is not None:
1081
GLib.source_remove(self.disable_initiator_tag)
1082
self.disable_initiator_tag = None
1083
if getattr(self, "enabled", False):
1084
self.disable_initiator_tag = GLib.timeout_add(
1085
int(timeout.total_seconds() * 1000), self.disable)
1086
self.expires = datetime.datetime.utcnow() + timeout
1088
def need_approval(self):
1089
self.last_approval_request = datetime.datetime.utcnow()
387
1091
def start_checker(self):
388
1092
"""Start a new checker subprocess if one is not running.
390
1094
If a checker already exists, leave it running and do
392
1096
# The reason for not killing a running checker is that if we
393
# did that, then if a checker (for some reason) started
394
# running slowly and taking more than 'interval' time, the
395
# client would inevitably timeout, since no checker would get
396
# a chance to run to completion. If we instead leave running
1097
# did that, and if a checker (for some reason) started running
1098
# slowly and taking more than 'interval' time, then the client
1099
# would inevitably timeout, since no checker would get a
1100
# chance to run to completion. If we instead leave running
397
1101
# checkers alone, the checker would have to take more time
398
# than 'timeout' for the client to be declared invalid, which
399
# is as it should be.
401
# If a checker exists, make sure it is not a zombie
403
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
404
except (AttributeError, OSError), error:
405
if (isinstance(error, OSError)
406
and error.errno != errno.ECHILD):
410
logger.warning(u"Checker was a zombie")
411
gobject.source_remove(self.checker_callback_tag)
412
self.checker_callback(pid, status,
413
self.current_checker_command)
1102
# than 'timeout' for the client to be disabled, which is as it
1105
if self.checker is not None and not self.checker.is_alive():
1106
logger.warning("Checker was not alive; joining")
414
1109
# Start a new checker if needed
415
1110
if self.checker is None:
1111
# Escape attributes for the shell
1113
attr: re.escape(str(getattr(self, attr)))
1114
for attr in self.runtime_expansions}
417
# In case checker_command has exactly one % operator
418
command = self.checker_command % self.host
420
# Escape attributes for the shell
421
escaped_attrs = dict((key,
422
re.escape(unicode(str(val),
426
vars(self).iteritems())
428
command = self.checker_command % escaped_attrs
429
except TypeError, error:
430
logger.error(u'Could not format string "%s":'
431
u' %s', self.checker_command, error)
432
return True # Try again later
1116
command = self.checker_command % escaped_attrs
1117
except TypeError as error:
1118
logger.error('Could not format string "%s"',
1119
self.checker_command,
1121
return True # Try again later
433
1122
self.current_checker_command = command
435
logger.info(u"Starting checker %r for %s",
437
# We don't need to redirect stdout and stderr, since
438
# in normal mode, that is already done by daemon(),
439
# and in debug mode we don't want to. (Stdin is
440
# always replaced by /dev/null.)
441
self.checker = subprocess.Popen(command,
443
shell=True, cwd=u"/")
444
self.checker_callback_tag = (gobject.child_watch_add
446
self.checker_callback,
448
# The checker may have completed before the gobject
449
# watch was added. Check for this.
450
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
452
gobject.source_remove(self.checker_callback_tag)
453
self.checker_callback(pid, status, command)
454
except OSError, error:
455
logger.error(u"Failed to start subprocess: %s",
457
# Re-run this periodically if run by gobject.timeout_add
1123
logger.info("Starting checker %r for %s", command,
1125
# We don't need to redirect stdout and stderr, since
1126
# in normal mode, that is already done by daemon(),
1127
# and in debug mode we don't want to. (Stdin is
1128
# always replaced by /dev/null.)
1129
# The exception is when not debugging but nevertheless
1130
# running in the foreground; use the previously
1132
popen_args = {"close_fds": True,
1135
if (not self.server_settings["debug"]
1136
and self.server_settings["foreground"]):
1137
popen_args.update({"stdout": wnull,
1139
pipe = multiprocessing.Pipe(duplex=False)
1140
self.checker = multiprocessing.Process(
1142
args=(pipe[1], subprocess.call, command),
1144
self.checker.start()
1145
self.checker_callback_tag = GLib.io_add_watch(
1146
pipe[0].fileno(), GLib.IO_IN,
1147
self.checker_callback, pipe[0], command)
1148
# Re-run this periodically if run by GLib.timeout_add
460
1151
def stop_checker(self):
461
1152
"""Force the checker process, if any, to stop."""
462
1153
if self.checker_callback_tag:
463
gobject.source_remove(self.checker_callback_tag)
1154
GLib.source_remove(self.checker_callback_tag)
464
1155
self.checker_callback_tag = None
465
if getattr(self, u"checker", None) is None:
1156
if getattr(self, "checker", None) is None:
467
logger.debug(u"Stopping checker for %(name)s", vars(self))
469
os.kill(self.checker.pid, signal.SIGTERM)
471
#if self.checker.poll() is None:
472
# os.kill(self.checker.pid, signal.SIGKILL)
473
except OSError, error:
474
if error.errno != errno.ESRCH: # No such process
1158
logger.debug("Stopping checker for %(name)s", vars(self))
1159
self.checker.terminate()
476
1160
self.checker = None
478
def still_valid(self):
479
"""Has the timeout not yet passed for this client?"""
480
if not getattr(self, u"enabled", False):
482
now = datetime.datetime.utcnow()
483
if self.last_checked_ok is None:
484
return now < (self.created + self.timeout)
486
return now < (self.last_checked_ok + self.timeout)
489
def dbus_service_property(dbus_interface, signature=u"v",
490
access=u"readwrite", byte_arrays=False):
1163
def dbus_service_property(dbus_interface,
491
1167
"""Decorators for marking methods of a DBusObjectWithProperties to
492
1168
become properties on the D-Bus.
494
1170
The decorated method will be called with no arguments by "Get"
495
1171
and with one argument by "Set".
497
1173
The parameters, where they are supported, are the same as
498
1174
dbus.service.method, except there is only "signature", since the
499
1175
type from Get() and the type sent to Set() is the same.
1177
# Encoding deeply encoded byte arrays is not supported yet by the
1178
# "Set" method, so we fail early here:
1179
if byte_arrays and signature != "ay":
1180
raise ValueError("Byte arrays not supported for non-'ay'"
1181
" signature {!r}".format(signature))
501
1183
def decorator(func):
502
1184
func._dbus_is_property = True
503
1185
func._dbus_interface = dbus_interface
504
1186
func._dbus_signature = signature
505
1187
func._dbus_access = access
506
1188
func._dbus_name = func.__name__
507
if func._dbus_name.endswith(u"_dbus_property"):
1189
if func._dbus_name.endswith("_dbus_property"):
508
1190
func._dbus_name = func._dbus_name[:-14]
509
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
1191
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1197
def dbus_interface_annotations(dbus_interface):
1198
"""Decorator for marking functions returning interface annotations
1202
@dbus_interface_annotations("org.example.Interface")
1203
def _foo(self): # Function name does not matter
1204
return {"org.freedesktop.DBus.Deprecated": "true",
1205
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1209
def decorator(func):
1210
func._dbus_is_interface = True
1211
func._dbus_interface = dbus_interface
1212
func._dbus_name = dbus_interface
1218
def dbus_annotations(annotations):
1219
"""Decorator to annotate D-Bus methods, signals or properties
1222
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1223
"org.freedesktop.DBus.Property."
1224
"EmitsChangedSignal": "false"})
1225
@dbus_service_property("org.example.Interface", signature="b",
1227
def Property_dbus_property(self):
1228
return dbus.Boolean(False)
1230
See also the DBusObjectWithAnnotations class.
1233
def decorator(func):
1234
func._dbus_annotations = annotations
511
1237
return decorator
514
1240
class DBusPropertyException(dbus.exceptions.DBusException):
515
1241
"""A base class for D-Bus property-related exceptions
517
def __unicode__(self):
518
return unicode(str(self))
521
1246
class DBusPropertyAccessException(DBusPropertyException):
533
class DBusObjectWithProperties(dbus.service.Object):
1258
class DBusObjectWithAnnotations(dbus.service.Object):
1259
"""A D-Bus object with annotations.
1261
Classes inheriting from this can use the dbus_annotations
1262
decorator to add annotations to methods or signals.
1266
def _is_dbus_thing(thing):
1267
"""Returns a function testing if an attribute is a D-Bus thing
1269
If called like _is_dbus_thing("method") it returns a function
1270
suitable for use as predicate to inspect.getmembers().
1272
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1275
def _get_all_dbus_things(self, thing):
1276
"""Returns a generator of (name, attribute) pairs
1278
return ((getattr(athing.__get__(self), "_dbus_name", name),
1279
athing.__get__(self))
1280
for cls in self.__class__.__mro__
1282
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1284
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1286
path_keyword='object_path',
1287
connection_keyword='connection')
1288
def Introspect(self, object_path, connection):
1289
"""Overloading of standard D-Bus method.
1291
Inserts annotation tags on methods and signals.
1293
xmlstring = dbus.service.Object.Introspect(self, object_path,
1296
document = xml.dom.minidom.parseString(xmlstring)
1298
for if_tag in document.getElementsByTagName("interface"):
1299
# Add annotation tags
1300
for typ in ("method", "signal"):
1301
for tag in if_tag.getElementsByTagName(typ):
1303
for name, prop in (self.
1304
_get_all_dbus_things(typ)):
1305
if (name == tag.getAttribute("name")
1306
and prop._dbus_interface
1307
== if_tag.getAttribute("name")):
1308
annots.update(getattr(
1309
prop, "_dbus_annotations", {}))
1310
for name, value in annots.items():
1311
ann_tag = document.createElement(
1313
ann_tag.setAttribute("name", name)
1314
ann_tag.setAttribute("value", value)
1315
tag.appendChild(ann_tag)
1316
# Add interface annotation tags
1317
for annotation, value in dict(
1318
itertools.chain.from_iterable(
1319
annotations().items()
1320
for name, annotations
1321
in self._get_all_dbus_things("interface")
1322
if name == if_tag.getAttribute("name")
1324
ann_tag = document.createElement("annotation")
1325
ann_tag.setAttribute("name", annotation)
1326
ann_tag.setAttribute("value", value)
1327
if_tag.appendChild(ann_tag)
1328
# Fix argument name for the Introspect method itself
1329
if (if_tag.getAttribute("name")
1330
== dbus.INTROSPECTABLE_IFACE):
1331
for cn in if_tag.getElementsByTagName("method"):
1332
if cn.getAttribute("name") == "Introspect":
1333
for arg in cn.getElementsByTagName("arg"):
1334
if (arg.getAttribute("direction")
1336
arg.setAttribute("name",
1338
xmlstring = document.toxml("utf-8")
1340
except (AttributeError, xml.dom.DOMException,
1341
xml.parsers.expat.ExpatError) as error:
1342
logger.error("Failed to override Introspection method",
1347
class DBusObjectWithProperties(DBusObjectWithAnnotations):
534
1348
"""A D-Bus object with properties.
536
1350
Classes inheriting from this can use the dbus_service_property
537
1351
decorator to expose methods as D-Bus properties. It exposes the
538
1352
standard Get(), Set(), and GetAll() methods on the D-Bus.
542
def _is_dbus_property(obj):
543
return getattr(obj, u"_dbus_is_property", False)
545
def _get_all_dbus_properties(self):
546
"""Returns a generator of (name, attribute) pairs
548
return ((prop._dbus_name, prop)
550
inspect.getmembers(self, self._is_dbus_property))
552
1355
def _get_dbus_property(self, interface_name, property_name):
553
1356
"""Returns a bound method if one exists which is a D-Bus
554
1357
property with the specified name and interface.
556
for name in (property_name,
557
property_name + u"_dbus_property"):
558
prop = getattr(self, name, None)
560
or not self._is_dbus_property(prop)
561
or prop._dbus_name != property_name
562
or (interface_name and prop._dbus_interface
563
and interface_name != prop._dbus_interface)):
1359
for cls in self.__class__.__mro__:
1360
for name, value in inspect.getmembers(
1361
cls, self._is_dbus_thing("property")):
1362
if (value._dbus_name == property_name
1363
and value._dbus_interface == interface_name):
1364
return value.__get__(self)
566
1366
# No such property
567
raise DBusPropertyNotFound(self.dbus_object_path + u":"
568
+ interface_name + u"."
571
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
1367
raise DBusPropertyNotFound("{}:{}.{}".format(
1368
self.dbus_object_path, interface_name, property_name))
1371
def _get_all_interface_names(cls):
1372
"""Get a sequence of all interfaces supported by an object"""
1373
return (name for name in set(getattr(getattr(x, attr),
1374
"_dbus_interface", None)
1375
for x in (inspect.getmro(cls))
1377
if name is not None)
1379
@dbus.service.method(dbus.PROPERTIES_IFACE,
573
1382
def Get(self, interface_name, property_name):
574
1383
"""Standard D-Bus property Get() method, see D-Bus standard.
576
1385
prop = self._get_dbus_property(interface_name, property_name)
577
if prop._dbus_access == u"write":
1386
if prop._dbus_access == "write":
578
1387
raise DBusPropertyAccessException(property_name)
580
if not hasattr(value, u"variant_level"):
1389
if not hasattr(value, "variant_level"):
582
1391
return type(value)(value, variant_level=value.variant_level+1)
584
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1393
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
585
1394
def Set(self, interface_name, property_name, value):
586
1395
"""Standard D-Bus property Set() method, see D-Bus standard.
588
1397
prop = self._get_dbus_property(interface_name, property_name)
589
if prop._dbus_access == u"read":
1398
if prop._dbus_access == "read":
590
1399
raise DBusPropertyAccessException(property_name)
591
if prop._dbus_get_args_options[u"byte_arrays"]:
592
value = dbus.ByteArray(''.join(unichr(byte)
1400
if prop._dbus_get_args_options["byte_arrays"]:
1401
# The byte_arrays option is not supported yet on
1402
# signatures other than "ay".
1403
if prop._dbus_signature != "ay":
1404
raise ValueError("Byte arrays not supported for non-"
1405
"'ay' signature {!r}"
1406
.format(prop._dbus_signature))
1407
value = dbus.ByteArray(b''.join(chr(byte)
596
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
597
out_signature=u"a{sv}")
1411
@dbus.service.method(dbus.PROPERTIES_IFACE,
1413
out_signature="a{sv}")
598
1414
def GetAll(self, interface_name):
599
1415
"""Standard D-Bus property GetAll() method, see D-Bus
602
1418
Note: Will not include properties with access="write".
605
for name, prop in self._get_all_dbus_properties():
1421
for name, prop in self._get_all_dbus_things("property"):
606
1422
if (interface_name
607
1423
and interface_name != prop._dbus_interface):
608
1424
# Interface non-empty but did not match
610
1426
# Ignore write-only properties
611
if prop._dbus_access == u"write":
1427
if prop._dbus_access == "write":
614
if not hasattr(value, u"variant_level"):
1430
if not hasattr(value, "variant_level"):
1431
properties[name] = value
617
all[name] = type(value)(value, variant_level=
618
value.variant_level+1)
619
return dbus.Dictionary(all, signature=u"sv")
621
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
623
path_keyword='object_path',
624
connection_keyword='connection')
625
def Introspect(self, object_path, connection):
626
"""Standard D-Bus method, overloaded to insert property tags.
628
xmlstring = dbus.service.Object.Introspect(self, object_path,
630
document = xml.dom.minidom.parseString(xmlstring)
632
def make_tag(document, name, prop):
633
e = document.createElement(u"property")
634
e.setAttribute(u"name", name)
635
e.setAttribute(u"type", prop._dbus_signature)
636
e.setAttribute(u"access", prop._dbus_access)
638
for if_tag in document.getElementsByTagName(u"interface"):
639
for tag in (make_tag(document, name, prop)
641
in self._get_all_dbus_properties()
642
if prop._dbus_interface
643
== if_tag.getAttribute(u"name")):
644
if_tag.appendChild(tag)
645
# Add the names to the return values for the
646
# "org.freedesktop.DBus.Properties" methods
647
if (if_tag.getAttribute(u"name")
648
== u"org.freedesktop.DBus.Properties"):
649
for cn in if_tag.getElementsByTagName(u"method"):
650
if cn.getAttribute(u"name") == u"Get":
651
for arg in cn.getElementsByTagName(u"arg"):
652
if (arg.getAttribute(u"direction")
654
arg.setAttribute(u"name", u"value")
655
elif cn.getAttribute(u"name") == u"GetAll":
656
for arg in cn.getElementsByTagName(u"arg"):
657
if (arg.getAttribute(u"direction")
659
arg.setAttribute(u"name", u"props")
660
xmlstring = document.toxml(u"utf-8")
1433
properties[name] = type(value)(
1434
value, variant_level=value.variant_level + 1)
1435
return dbus.Dictionary(properties, signature="sv")
1437
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1438
def PropertiesChanged(self, interface_name, changed_properties,
1439
invalidated_properties):
1440
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
1445
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1447
path_keyword='object_path',
1448
connection_keyword='connection')
1449
def Introspect(self, object_path, connection):
1450
"""Overloading of standard D-Bus method.
1452
Inserts property tags and interface annotation tags.
1454
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1458
document = xml.dom.minidom.parseString(xmlstring)
1460
def make_tag(document, name, prop):
1461
e = document.createElement("property")
1462
e.setAttribute("name", name)
1463
e.setAttribute("type", prop._dbus_signature)
1464
e.setAttribute("access", prop._dbus_access)
1467
for if_tag in document.getElementsByTagName("interface"):
1469
for tag in (make_tag(document, name, prop)
1471
in self._get_all_dbus_things("property")
1472
if prop._dbus_interface
1473
== if_tag.getAttribute("name")):
1474
if_tag.appendChild(tag)
1475
# Add annotation tags for properties
1476
for tag in if_tag.getElementsByTagName("property"):
1478
for name, prop in self._get_all_dbus_things(
1480
if (name == tag.getAttribute("name")
1481
and prop._dbus_interface
1482
== if_tag.getAttribute("name")):
1483
annots.update(getattr(
1484
prop, "_dbus_annotations", {}))
1485
for name, value in annots.items():
1486
ann_tag = document.createElement(
1488
ann_tag.setAttribute("name", name)
1489
ann_tag.setAttribute("value", value)
1490
tag.appendChild(ann_tag)
1491
# Add the names to the return values for the
1492
# "org.freedesktop.DBus.Properties" methods
1493
if (if_tag.getAttribute("name")
1494
== "org.freedesktop.DBus.Properties"):
1495
for cn in if_tag.getElementsByTagName("method"):
1496
if cn.getAttribute("name") == "Get":
1497
for arg in cn.getElementsByTagName("arg"):
1498
if (arg.getAttribute("direction")
1500
arg.setAttribute("name", "value")
1501
elif cn.getAttribute("name") == "GetAll":
1502
for arg in cn.getElementsByTagName("arg"):
1503
if (arg.getAttribute("direction")
1505
arg.setAttribute("name", "props")
1506
xmlstring = document.toxml("utf-8")
1508
except (AttributeError, xml.dom.DOMException,
1509
xml.parsers.expat.ExpatError) as error:
1510
logger.error("Failed to override Introspection method",
1516
dbus.OBJECT_MANAGER_IFACE
1517
except AttributeError:
1518
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1521
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1522
"""A D-Bus object with an ObjectManager.
1524
Classes inheriting from this exposes the standard
1525
GetManagedObjects call and the InterfacesAdded and
1526
InterfacesRemoved signals on the standard
1527
"org.freedesktop.DBus.ObjectManager" interface.
1529
Note: No signals are sent automatically; they must be sent
1532
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1533
out_signature="a{oa{sa{sv}}}")
1534
def GetManagedObjects(self):
1535
"""This function must be overridden"""
1536
raise NotImplementedError()
1538
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1539
signature="oa{sa{sv}}")
1540
def InterfacesAdded(self, object_path, interfaces_and_properties):
1543
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1544
def InterfacesRemoved(self, object_path, interfaces):
1547
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1549
path_keyword='object_path',
1550
connection_keyword='connection')
1551
def Introspect(self, object_path, connection):
1552
"""Overloading of standard D-Bus method.
1554
Override return argument name of GetManagedObjects to be
1555
"objpath_interfaces_and_properties"
1557
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1561
document = xml.dom.minidom.parseString(xmlstring)
1563
for if_tag in document.getElementsByTagName("interface"):
1564
# Fix argument name for the GetManagedObjects method
1565
if (if_tag.getAttribute("name")
1566
== dbus.OBJECT_MANAGER_IFACE):
1567
for cn in if_tag.getElementsByTagName("method"):
1568
if (cn.getAttribute("name")
1569
== "GetManagedObjects"):
1570
for arg in cn.getElementsByTagName("arg"):
1571
if (arg.getAttribute("direction")
1575
"objpath_interfaces"
1577
xmlstring = document.toxml("utf-8")
1579
except (AttributeError, xml.dom.DOMException,
1580
xml.parsers.expat.ExpatError) as error:
1581
logger.error("Failed to override Introspection method",
1586
def datetime_to_dbus(dt, variant_level=0):
1587
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1589
return dbus.String("", variant_level=variant_level)
1590
return dbus.String(dt.isoformat(), variant_level=variant_level)
1593
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1594
"""A class decorator; applied to a subclass of
1595
dbus.service.Object, it will add alternate D-Bus attributes with
1596
interface names according to the "alt_interface_names" mapping.
1599
@alternate_dbus_interfaces({"org.example.Interface":
1600
"net.example.AlternateInterface"})
1601
class SampleDBusObject(dbus.service.Object):
1602
@dbus.service.method("org.example.Interface")
1603
def SampleDBusMethod():
1606
The above "SampleDBusMethod" on "SampleDBusObject" will be
1607
reachable via two interfaces: "org.example.Interface" and
1608
"net.example.AlternateInterface", the latter of which will have
1609
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1610
"true", unless "deprecate" is passed with a False value.
1612
This works for methods and signals, and also for D-Bus properties
1613
(from DBusObjectWithProperties) and interfaces (from the
1614
dbus_interface_annotations decorator).
1618
for orig_interface_name, alt_interface_name in (
1619
alt_interface_names.items()):
1621
interface_names = set()
1622
# Go though all attributes of the class
1623
for attrname, attribute in inspect.getmembers(cls):
1624
# Ignore non-D-Bus attributes, and D-Bus attributes
1625
# with the wrong interface name
1626
if (not hasattr(attribute, "_dbus_interface")
1627
or not attribute._dbus_interface.startswith(
1628
orig_interface_name)):
1630
# Create an alternate D-Bus interface name based on
1632
alt_interface = attribute._dbus_interface.replace(
1633
orig_interface_name, alt_interface_name)
1634
interface_names.add(alt_interface)
1635
# Is this a D-Bus signal?
1636
if getattr(attribute, "_dbus_is_signal", False):
1637
# Extract the original non-method undecorated
1638
# function by black magic
1639
if sys.version_info.major == 2:
1640
nonmethod_func = (dict(
1641
zip(attribute.func_code.co_freevars,
1642
attribute.__closure__))
1643
["func"].cell_contents)
1645
nonmethod_func = (dict(
1646
zip(attribute.__code__.co_freevars,
1647
attribute.__closure__))
1648
["func"].cell_contents)
1649
# Create a new, but exactly alike, function
1650
# object, and decorate it to be a new D-Bus signal
1651
# with the alternate D-Bus interface name
1652
new_function = copy_function(nonmethod_func)
1653
new_function = (dbus.service.signal(
1655
attribute._dbus_signature)(new_function))
1656
# Copy annotations, if any
1658
new_function._dbus_annotations = dict(
1659
attribute._dbus_annotations)
1660
except AttributeError:
1663
# Define a creator of a function to call both the
1664
# original and alternate functions, so both the
1665
# original and alternate signals gets sent when
1666
# the function is called
1667
def fixscope(func1, func2):
1668
"""This function is a scope container to pass
1669
func1 and func2 to the "call_both" function
1670
outside of its arguments"""
1672
@functools.wraps(func2)
1673
def call_both(*args, **kwargs):
1674
"""This function will emit two D-Bus
1675
signals by calling func1 and func2"""
1676
func1(*args, **kwargs)
1677
func2(*args, **kwargs)
1678
# Make wrapper function look like a D-Bus
1680
for name, attr in inspect.getmembers(func2):
1681
if name.startswith("_dbus_"):
1682
setattr(call_both, name, attr)
1685
# Create the "call_both" function and add it to
1687
attr[attrname] = fixscope(attribute, new_function)
1688
# Is this a D-Bus method?
1689
elif getattr(attribute, "_dbus_is_method", False):
1690
# Create a new, but exactly alike, function
1691
# object. Decorate it to be a new D-Bus method
1692
# with the alternate D-Bus interface name. Add it
1695
dbus.service.method(
1697
attribute._dbus_in_signature,
1698
attribute._dbus_out_signature)
1699
(copy_function(attribute)))
1700
# Copy annotations, if any
1702
attr[attrname]._dbus_annotations = dict(
1703
attribute._dbus_annotations)
1704
except AttributeError:
1706
# Is this a D-Bus property?
1707
elif getattr(attribute, "_dbus_is_property", False):
1708
# Create a new, but exactly alike, function
1709
# object, and decorate it to be a new D-Bus
1710
# property with the alternate D-Bus interface
1711
# name. Add it to the class.
1712
attr[attrname] = (dbus_service_property(
1713
alt_interface, attribute._dbus_signature,
1714
attribute._dbus_access,
1715
attribute._dbus_get_args_options
1717
(copy_function(attribute)))
1718
# Copy annotations, if any
1720
attr[attrname]._dbus_annotations = dict(
1721
attribute._dbus_annotations)
1722
except AttributeError:
1724
# Is this a D-Bus interface?
1725
elif getattr(attribute, "_dbus_is_interface", False):
1726
# Create a new, but exactly alike, function
1727
# object. Decorate it to be a new D-Bus interface
1728
# with the alternate D-Bus interface name. Add it
1731
dbus_interface_annotations(alt_interface)
1732
(copy_function(attribute)))
1734
# Deprecate all alternate interfaces
1735
iname = "_AlternateDBusNames_interface_annotation{}"
1736
for interface_name in interface_names:
1738
@dbus_interface_annotations(interface_name)
1740
return {"org.freedesktop.DBus.Deprecated":
1742
# Find an unused name
1743
for aname in (iname.format(i)
1744
for i in itertools.count()):
1745
if aname not in attr:
1749
# Replace the class with a new subclass of it with
1750
# methods, signals, etc. as created above.
1751
if sys.version_info.major == 2:
1752
cls = type(b"{}Alternate".format(cls.__name__),
1755
cls = type("{}Alternate".format(cls.__name__),
1762
@alternate_dbus_interfaces({"se.recompile.Mandos":
1763
"se.bsnet.fukt.Mandos"})
665
1764
class ClientDBus(Client, DBusObjectWithProperties):
666
1765
"""A Client class using D-Bus
669
1768
dbus_object_path: dbus.ObjectPath
670
1769
bus: dbus.SystemBus()
1772
runtime_expansions = (Client.runtime_expansions
1773
+ ("dbus_object_path", ))
1775
_interface = "se.recompile.Mandos.Client"
672
1777
# dbus.service.Object doesn't use super(), so we can't either.
674
def __init__(self, bus = None, *args, **kwargs):
1779
def __init__(self, bus=None, *args, **kwargs):
676
1781
Client.__init__(self, *args, **kwargs)
677
1782
# Only now, when this client is initialized, can it show up on
679
self.dbus_object_path = (dbus.ObjectPath
681
+ self.name.replace(u".", u"_")))
1784
client_object_name = str(self.name).translate(
1785
{ord("."): ord("_"),
1786
ord("-"): ord("_")})
1787
self.dbus_object_path = dbus.ObjectPath(
1788
"/clients/" + client_object_name)
682
1789
DBusObjectWithProperties.__init__(self, self.bus,
683
1790
self.dbus_object_path)
686
def _datetime_to_dbus(dt, variant_level=0):
687
"""Convert a UTC datetime.datetime() to a D-Bus type."""
688
return dbus.String(dt.isoformat(),
689
variant_level=variant_level)
692
oldstate = getattr(self, u"enabled", False)
693
r = Client.enable(self)
694
if oldstate != self.enabled:
696
self.PropertyChanged(dbus.String(u"enabled"),
697
dbus.Boolean(True, variant_level=1))
698
self.PropertyChanged(
699
dbus.String(u"last_enabled"),
700
self._datetime_to_dbus(self.last_enabled,
704
def disable(self, signal = True):
705
oldstate = getattr(self, u"enabled", False)
706
r = Client.disable(self)
707
if signal and oldstate != self.enabled:
709
self.PropertyChanged(dbus.String(u"enabled"),
710
dbus.Boolean(False, variant_level=1))
1792
def notifychangeproperty(transform_func, dbus_name,
1793
type_func=lambda x: x,
1795
invalidate_only=False,
1796
_interface=_interface):
1797
""" Modify a variable so that it's a property which announces
1798
its changes to DBus.
1800
transform_fun: Function that takes a value and a variant_level
1801
and transforms it to a D-Bus type.
1802
dbus_name: D-Bus name of the variable
1803
type_func: Function that transform the value before sending it
1804
to the D-Bus. Default: no transform
1805
variant_level: D-Bus variant level. Default: 1
1807
attrname = "_{}".format(dbus_name)
1809
def setter(self, value):
1810
if hasattr(self, "dbus_object_path"):
1811
if (not hasattr(self, attrname) or
1812
type_func(getattr(self, attrname, None))
1813
!= type_func(value)):
1815
self.PropertiesChanged(
1816
_interface, dbus.Dictionary(),
1817
dbus.Array((dbus_name, )))
1819
dbus_value = transform_func(
1821
variant_level=variant_level)
1822
self.PropertyChanged(dbus.String(dbus_name),
1824
self.PropertiesChanged(
1826
dbus.Dictionary({dbus.String(dbus_name):
1829
setattr(self, attrname, value)
1831
return property(lambda self: getattr(self, attrname), setter)
1833
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1834
approvals_pending = notifychangeproperty(dbus.Boolean,
1837
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1838
last_enabled = notifychangeproperty(datetime_to_dbus,
1840
checker = notifychangeproperty(
1841
dbus.Boolean, "CheckerRunning",
1842
type_func=lambda checker: checker is not None)
1843
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1845
last_checker_status = notifychangeproperty(dbus.Int16,
1846
"LastCheckerStatus")
1847
last_approval_request = notifychangeproperty(
1848
datetime_to_dbus, "LastApprovalRequest")
1849
approved_by_default = notifychangeproperty(dbus.Boolean,
1850
"ApprovedByDefault")
1851
approval_delay = notifychangeproperty(
1852
dbus.UInt64, "ApprovalDelay",
1853
type_func=lambda td: td.total_seconds() * 1000)
1854
approval_duration = notifychangeproperty(
1855
dbus.UInt64, "ApprovalDuration",
1856
type_func=lambda td: td.total_seconds() * 1000)
1857
host = notifychangeproperty(dbus.String, "Host")
1858
timeout = notifychangeproperty(
1859
dbus.UInt64, "Timeout",
1860
type_func=lambda td: td.total_seconds() * 1000)
1861
extended_timeout = notifychangeproperty(
1862
dbus.UInt64, "ExtendedTimeout",
1863
type_func=lambda td: td.total_seconds() * 1000)
1864
interval = notifychangeproperty(
1865
dbus.UInt64, "Interval",
1866
type_func=lambda td: td.total_seconds() * 1000)
1867
checker_command = notifychangeproperty(dbus.String, "Checker")
1868
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1869
invalidate_only=True)
1871
del notifychangeproperty
713
1873
def __del__(self, *args, **kwargs):
715
1875
self.remove_from_connection()
716
1876
except LookupError:
718
if hasattr(DBusObjectWithProperties, u"__del__"):
1878
if hasattr(DBusObjectWithProperties, "__del__"):
719
1879
DBusObjectWithProperties.__del__(self, *args, **kwargs)
720
1880
Client.__del__(self, *args, **kwargs)
722
def checker_callback(self, pid, condition, command,
724
self.checker_callback_tag = None
727
self.PropertyChanged(dbus.String(u"checker_running"),
728
dbus.Boolean(False, variant_level=1))
729
if os.WIFEXITED(condition):
730
exitstatus = os.WEXITSTATUS(condition)
1882
def checker_callback(self, source, condition,
1883
connection, command, *args, **kwargs):
1884
ret = Client.checker_callback(self, source, condition,
1885
connection, command, *args,
1887
exitstatus = self.last_checker_status
731
1889
# Emit D-Bus signal
732
1890
self.CheckerCompleted(dbus.Int16(exitstatus),
733
dbus.Int64(condition),
1891
# This is specific to GNU libC
1892
dbus.Int64(exitstatus << 8),
734
1893
dbus.String(command))
736
1895
# Emit D-Bus signal
737
1896
self.CheckerCompleted(dbus.Int16(-1),
738
dbus.Int64(condition),
1898
# This is specific to GNU libC
1900
| self.last_checker_signal),
739
1901
dbus.String(command))
741
return Client.checker_callback(self, pid, condition, command,
744
def checked_ok(self, *args, **kwargs):
745
r = Client.checked_ok(self, *args, **kwargs)
747
self.PropertyChanged(
748
dbus.String(u"last_checked_ok"),
749
(self._datetime_to_dbus(self.last_checked_ok,
753
1904
def start_checker(self, *args, **kwargs):
754
old_checker = self.checker
755
if self.checker is not None:
756
old_checker_pid = self.checker.pid
758
old_checker_pid = None
1905
old_checker_pid = getattr(self.checker, "pid", None)
759
1906
r = Client.start_checker(self, *args, **kwargs)
760
1907
# Only if new checker process was started
761
1908
if (self.checker is not None
762
1909
and old_checker_pid != self.checker.pid):
763
1910
# Emit D-Bus signal
764
1911
self.CheckerStarted(self.current_checker_command)
765
self.PropertyChanged(
766
dbus.String(u"checker_running"),
767
dbus.Boolean(True, variant_level=1))
770
def stop_checker(self, *args, **kwargs):
771
old_checker = getattr(self, u"checker", None)
772
r = Client.stop_checker(self, *args, **kwargs)
773
if (old_checker is not None
774
and getattr(self, u"checker", None) is None):
775
self.PropertyChanged(dbus.String(u"checker_running"),
776
dbus.Boolean(False, variant_level=1))
779
## D-Bus methods & signals
780
_interface = u"se.bsnet.fukt.Mandos.Client"
783
@dbus.service.method(_interface)
785
return self.checked_ok()
1914
def _reset_approved(self):
1915
self.approved = None
1918
def approve(self, value=True):
1919
self.approved = value
1920
GLib.timeout_add(int(self.approval_duration.total_seconds()
1921
* 1000), self._reset_approved)
1922
self.send_changedstate()
1924
# D-Bus methods, signals & properties
787
1930
# CheckerCompleted - signal
788
@dbus.service.signal(_interface, signature=u"nxs")
1931
@dbus.service.signal(_interface, signature="nxs")
789
1932
def CheckerCompleted(self, exitcode, waitstatus, command):
793
1936
# CheckerStarted - signal
794
@dbus.service.signal(_interface, signature=u"s")
1937
@dbus.service.signal(_interface, signature="s")
795
1938
def CheckerStarted(self, command):
799
1942
# PropertyChanged - signal
800
@dbus.service.signal(_interface, signature=u"sv")
1943
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1944
@dbus.service.signal(_interface, signature="sv")
801
1945
def PropertyChanged(self, property, value):
805
# ReceivedSecret - signal
1949
# GotSecret - signal
806
1950
@dbus.service.signal(_interface)
807
def ReceivedSecret(self):
1951
def GotSecret(self):
1953
Is sent after a successful transfer of secret from the Mandos
1954
server to mandos-client
811
1958
# Rejected - signal
812
@dbus.service.signal(_interface)
1959
@dbus.service.signal(_interface, signature="s")
1960
def Rejected(self, reason):
1964
# NeedApproval - signal
1965
@dbus.service.signal(_interface, signature="tb")
1966
def NeedApproval(self, timeout, default):
1968
return self.need_approval()
1973
@dbus.service.method(_interface, in_signature="b")
1974
def Approve(self, value):
1977
# CheckedOK - method
1978
@dbus.service.method(_interface)
1979
def CheckedOK(self):
817
1982
# Enable - method
1983
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
818
1984
@dbus.service.method(_interface)
819
1985
def Enable(self):
823
1989
# StartChecker - method
1990
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
824
1991
@dbus.service.method(_interface)
825
1992
def StartChecker(self):
827
1994
self.start_checker()
829
1996
# Disable - method
1997
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
830
1998
@dbus.service.method(_interface)
831
1999
def Disable(self):
835
2003
# StopChecker - method
2004
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
836
2005
@dbus.service.method(_interface)
837
2006
def StopChecker(self):
838
2007
self.stop_checker()
841
@dbus_service_property(_interface, signature=u"s", access=u"read")
842
def name_dbus_property(self):
2011
# ApprovalPending - property
2012
@dbus_service_property(_interface, signature="b", access="read")
2013
def ApprovalPending_dbus_property(self):
2014
return dbus.Boolean(bool(self.approvals_pending))
2016
# ApprovedByDefault - property
2017
@dbus_service_property(_interface,
2020
def ApprovedByDefault_dbus_property(self, value=None):
2021
if value is None: # get
2022
return dbus.Boolean(self.approved_by_default)
2023
self.approved_by_default = bool(value)
2025
# ApprovalDelay - property
2026
@dbus_service_property(_interface,
2029
def ApprovalDelay_dbus_property(self, value=None):
2030
if value is None: # get
2031
return dbus.UInt64(self.approval_delay.total_seconds()
2033
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2035
# ApprovalDuration - property
2036
@dbus_service_property(_interface,
2039
def ApprovalDuration_dbus_property(self, value=None):
2040
if value is None: # get
2041
return dbus.UInt64(self.approval_duration.total_seconds()
2043
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2047
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2048
@dbus_service_property(_interface, signature="s", access="read")
2049
def Name_dbus_property(self):
843
2050
return dbus.String(self.name)
845
# fingerprint - property
846
@dbus_service_property(_interface, signature=u"s", access=u"read")
847
def fingerprint_dbus_property(self):
2054
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2055
@dbus_service_property(_interface, signature="s", access="read")
2056
def KeyID_dbus_property(self):
2057
return dbus.String(self.key_id)
2059
# Fingerprint - property
2061
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2062
@dbus_service_property(_interface, signature="s", access="read")
2063
def Fingerprint_dbus_property(self):
848
2064
return dbus.String(self.fingerprint)
851
@dbus_service_property(_interface, signature=u"s",
853
def host_dbus_property(self, value=None):
2067
@dbus_service_property(_interface,
2070
def Host_dbus_property(self, value=None):
854
2071
if value is None: # get
855
2072
return dbus.String(self.host)
858
self.PropertyChanged(dbus.String(u"host"),
859
dbus.String(value, variant_level=1))
862
@dbus_service_property(_interface, signature=u"s", access=u"read")
863
def created_dbus_property(self):
864
return dbus.String(self._datetime_to_dbus(self.created))
866
# last_enabled - property
867
@dbus_service_property(_interface, signature=u"s", access=u"read")
868
def last_enabled_dbus_property(self):
869
if self.last_enabled is None:
870
return dbus.String(u"")
871
return dbus.String(self._datetime_to_dbus(self.last_enabled))
874
@dbus_service_property(_interface, signature=u"b",
876
def enabled_dbus_property(self, value=None):
2073
self.host = str(value)
2075
# Created - property
2077
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2078
@dbus_service_property(_interface, signature="s", access="read")
2079
def Created_dbus_property(self):
2080
return datetime_to_dbus(self.created)
2082
# LastEnabled - property
2083
@dbus_service_property(_interface, signature="s", access="read")
2084
def LastEnabled_dbus_property(self):
2085
return datetime_to_dbus(self.last_enabled)
2087
# Enabled - property
2088
@dbus_service_property(_interface,
2091
def Enabled_dbus_property(self, value=None):
877
2092
if value is None: # get
878
2093
return dbus.Boolean(self.enabled)
884
# last_checked_ok - property
885
@dbus_service_property(_interface, signature=u"s",
887
def last_checked_ok_dbus_property(self, value=None):
2099
# LastCheckedOK - property
2100
@dbus_service_property(_interface,
2103
def LastCheckedOK_dbus_property(self, value=None):
888
2104
if value is not None:
889
2105
self.checked_ok()
891
if self.last_checked_ok is None:
892
return dbus.String(u"")
893
return dbus.String(self._datetime_to_dbus(self
897
@dbus_service_property(_interface, signature=u"t",
899
def timeout_dbus_property(self, value=None):
2107
return datetime_to_dbus(self.last_checked_ok)
2109
# LastCheckerStatus - property
2110
@dbus_service_property(_interface, signature="n", access="read")
2111
def LastCheckerStatus_dbus_property(self):
2112
return dbus.Int16(self.last_checker_status)
2114
# Expires - property
2115
@dbus_service_property(_interface, signature="s", access="read")
2116
def Expires_dbus_property(self):
2117
return datetime_to_dbus(self.expires)
2119
# LastApprovalRequest - property
2120
@dbus_service_property(_interface, signature="s", access="read")
2121
def LastApprovalRequest_dbus_property(self):
2122
return datetime_to_dbus(self.last_approval_request)
2124
# Timeout - property
2125
@dbus_service_property(_interface,
2128
def Timeout_dbus_property(self, value=None):
900
2129
if value is None: # get
901
return dbus.UInt64(self.timeout_milliseconds())
2130
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2131
old_timeout = self.timeout
902
2132
self.timeout = datetime.timedelta(0, 0, 0, value)
904
self.PropertyChanged(dbus.String(u"timeout"),
905
dbus.UInt64(value, variant_level=1))
906
if getattr(self, u"disable_initiator_tag", None) is None:
909
gobject.source_remove(self.disable_initiator_tag)
910
self.disable_initiator_tag = None
912
_timedelta_to_milliseconds((self
918
# The timeout has passed
921
self.disable_initiator_tag = (gobject.timeout_add
922
(time_to_die, self.disable))
924
# interval - property
925
@dbus_service_property(_interface, signature=u"t",
927
def interval_dbus_property(self, value=None):
928
if value is None: # get
929
return dbus.UInt64(self.interval_milliseconds())
2133
# Reschedule disabling
2135
now = datetime.datetime.utcnow()
2136
self.expires += self.timeout - old_timeout
2137
if self.expires <= now:
2138
# The timeout has passed
2141
if (getattr(self, "disable_initiator_tag", None)
2144
GLib.source_remove(self.disable_initiator_tag)
2145
self.disable_initiator_tag = GLib.timeout_add(
2146
int((self.expires - now).total_seconds() * 1000),
2149
# ExtendedTimeout - property
2150
@dbus_service_property(_interface,
2153
def ExtendedTimeout_dbus_property(self, value=None):
2154
if value is None: # get
2155
return dbus.UInt64(self.extended_timeout.total_seconds()
2157
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2159
# Interval - property
2160
@dbus_service_property(_interface,
2163
def Interval_dbus_property(self, value=None):
2164
if value is None: # get
2165
return dbus.UInt64(self.interval.total_seconds() * 1000)
930
2166
self.interval = datetime.timedelta(0, 0, 0, value)
932
self.PropertyChanged(dbus.String(u"interval"),
933
dbus.UInt64(value, variant_level=1))
934
if getattr(self, u"checker_initiator_tag", None) is None:
2167
if getattr(self, "checker_initiator_tag", None) is None:
936
# Reschedule checker run
937
gobject.source_remove(self.checker_initiator_tag)
938
self.checker_initiator_tag = (gobject.timeout_add
939
(value, self.start_checker))
940
self.start_checker() # Start one now, too
2170
# Reschedule checker run
2171
GLib.source_remove(self.checker_initiator_tag)
2172
self.checker_initiator_tag = GLib.timeout_add(
2173
value, self.start_checker)
2174
self.start_checker() # Start one now, too
943
@dbus_service_property(_interface, signature=u"s",
945
def checker_dbus_property(self, value=None):
2176
# Checker - property
2177
@dbus_service_property(_interface,
2180
def Checker_dbus_property(self, value=None):
946
2181
if value is None: # get
947
2182
return dbus.String(self.checker_command)
948
self.checker_command = value
950
self.PropertyChanged(dbus.String(u"checker"),
951
dbus.String(self.checker_command,
954
# checker_running - property
955
@dbus_service_property(_interface, signature=u"b",
957
def checker_running_dbus_property(self, value=None):
2183
self.checker_command = str(value)
2185
# CheckerRunning - property
2186
@dbus_service_property(_interface,
2189
def CheckerRunning_dbus_property(self, value=None):
958
2190
if value is None: # get
959
2191
return dbus.Boolean(self.checker is not None)
961
2193
self.start_checker()
963
2195
self.stop_checker()
965
# object_path - property
966
@dbus_service_property(_interface, signature=u"o", access=u"read")
967
def object_path_dbus_property(self):
968
return self.dbus_object_path # is already a dbus.ObjectPath
971
@dbus_service_property(_interface, signature=u"ay",
972
access=u"write", byte_arrays=True)
973
def secret_dbus_property(self, value):
974
self.secret = str(value)
2197
# ObjectPath - property
2199
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2200
"org.freedesktop.DBus.Deprecated": "true"})
2201
@dbus_service_property(_interface, signature="o", access="read")
2202
def ObjectPath_dbus_property(self):
2203
return self.dbus_object_path # is already a dbus.ObjectPath
2207
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2209
@dbus_service_property(_interface,
2213
def Secret_dbus_property(self, value):
2214
self.secret = bytes(value)
2220
def __init__(self, child_pipe, key_id, fpr, address):
2221
self._pipe = child_pipe
2222
self._pipe.send(('init', key_id, fpr, address))
2223
if not self._pipe.recv():
2224
raise KeyError(key_id or fpr)
2226
def __getattribute__(self, name):
2228
return super(ProxyClient, self).__getattribute__(name)
2229
self._pipe.send(('getattr', name))
2230
data = self._pipe.recv()
2231
if data[0] == 'data':
2233
if data[0] == 'function':
2235
def func(*args, **kwargs):
2236
self._pipe.send(('funcall', name, args, kwargs))
2237
return self._pipe.recv()[1]
2241
def __setattr__(self, name, value):
2243
return super(ProxyClient, self).__setattr__(name, value)
2244
self._pipe.send(('setattr', name, value))
979
2247
class ClientHandler(socketserver.BaseRequestHandler, object):
980
2248
"""A class to handle client connections.
982
2250
Instantiated once for each connection to handle it.
983
2251
Note: This will run in its own forked process."""
985
2253
def handle(self):
986
logger.info(u"TCP connection from: %s",
987
unicode(self.client_address))
988
logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
989
# Open IPC pipe to parent process
990
with closing(os.fdopen(self.server.pipe[1], u"w", 1)) as ipc:
991
session = (gnutls.connection
992
.ClientSession(self.request,
996
line = self.request.makefile().readline()
997
logger.debug(u"Protocol version: %r", line)
999
if int(line.strip().split()[0]) > 1:
1001
except (ValueError, IndexError, RuntimeError), error:
1002
logger.error(u"Unknown protocol version: %s", error)
1005
# Note: gnutls.connection.X509Credentials is really a
1006
# generic GnuTLS certificate credentials object so long as
1007
# no X.509 keys are added to it. Therefore, we can use it
1008
# here despite using OpenPGP certificates.
1010
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1011
# u"+AES-256-CBC", u"+SHA1",
1012
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
2254
with contextlib.closing(self.server.child_pipe) as child_pipe:
2255
logger.info("TCP connection from: %s",
2256
str(self.client_address))
2257
logger.debug("Pipe FD: %d",
2258
self.server.child_pipe.fileno())
2260
session = gnutls.ClientSession(self.request)
2262
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2263
# "+AES-256-CBC", "+SHA1",
2264
# "+COMP-NULL", "+CTYPE-OPENPGP",
1014
2266
# Use a fallback default, since this MUST be set.
1015
2267
priority = self.server.gnutls_priority
1016
2268
if priority is None:
1017
priority = u"NORMAL"
1018
(gnutls.library.functions
1019
.gnutls_priority_set_direct(session._c_object,
2270
gnutls.priority_set_direct(session._c_object,
2271
priority.encode("utf-8"),
2274
# Start communication using the Mandos protocol
2275
# Get protocol number
2276
line = self.request.makefile().readline()
2277
logger.debug("Protocol version: %r", line)
2279
if int(line.strip().split()[0]) > 1:
2280
raise RuntimeError(line)
2281
except (ValueError, IndexError, RuntimeError) as error:
2282
logger.error("Unknown protocol version: %s", error)
2285
# Start GnuTLS connection
1023
2287
session.handshake()
1024
except gnutls.errors.GNUTLSError, error:
1025
logger.warning(u"Handshake failed: %s", error)
2288
except gnutls.Error as error:
2289
logger.warning("Handshake failed: %s", error)
1026
2290
# Do not run session.bye() here: the session is not
1027
2291
# established. Just abandon the request.
1029
logger.debug(u"Handshake succeeded")
2293
logger.debug("Handshake succeeded")
2295
approval_required = False
1031
fpr = self.fingerprint(self.peer_certificate(session))
1032
except (TypeError, gnutls.errors.GNUTLSError), error:
1033
logger.warning(u"Bad certificate: %s", error)
1036
logger.debug(u"Fingerprint: %s", fpr)
1038
for c in self.server.clients:
1039
if c.fingerprint == fpr:
1043
ipc.write(u"NOTFOUND %s %s\n"
1044
% (fpr, unicode(self.client_address)))
1047
# Have to check if client.still_valid(), since it is
1048
# possible that the client timed out while establishing
1049
# the GnuTLS session.
1050
if not client.still_valid():
1051
ipc.write(u"INVALID %s\n" % client.name)
1054
ipc.write(u"SENDING %s\n" % client.name)
1056
while sent_size < len(client.secret):
1057
sent = session.send(client.secret[sent_size:])
1058
logger.debug(u"Sent: %d, remaining: %d",
1059
sent, len(client.secret)
1060
- (sent_size + sent))
2297
if gnutls.has_rawpk:
2300
key_id = self.key_id(
2301
self.peer_certificate(session))
2302
except (TypeError, gnutls.Error) as error:
2303
logger.warning("Bad certificate: %s", error)
2305
logger.debug("Key ID: %s", key_id)
2310
fpr = self.fingerprint(
2311
self.peer_certificate(session))
2312
except (TypeError, gnutls.Error) as error:
2313
logger.warning("Bad certificate: %s", error)
2315
logger.debug("Fingerprint: %s", fpr)
2318
client = ProxyClient(child_pipe, key_id, fpr,
2319
self.client_address)
2323
if client.approval_delay:
2324
delay = client.approval_delay
2325
client.approvals_pending += 1
2326
approval_required = True
2329
if not client.enabled:
2330
logger.info("Client %s is disabled",
2332
if self.server.use_dbus:
2334
client.Rejected("Disabled")
2337
if client.approved or not client.approval_delay:
2338
# We are approved or approval is disabled
2340
elif client.approved is None:
2341
logger.info("Client %s needs approval",
2343
if self.server.use_dbus:
2345
client.NeedApproval(
2346
client.approval_delay.total_seconds()
2347
* 1000, client.approved_by_default)
2349
logger.warning("Client %s was not approved",
2351
if self.server.use_dbus:
2353
client.Rejected("Denied")
2356
# wait until timeout or approved
2357
time = datetime.datetime.now()
2358
client.changedstate.acquire()
2359
client.changedstate.wait(delay.total_seconds())
2360
client.changedstate.release()
2361
time2 = datetime.datetime.now()
2362
if (time2 - time) >= delay:
2363
if not client.approved_by_default:
2364
logger.warning("Client %s timed out while"
2365
" waiting for approval",
2367
if self.server.use_dbus:
2369
client.Rejected("Approval timed out")
2374
delay -= time2 - time
2377
session.send(client.secret)
2378
except gnutls.Error as error:
2379
logger.warning("gnutls send failed",
2383
logger.info("Sending secret to %s", client.name)
2384
# bump the timeout using extended_timeout
2385
client.bump_timeout(client.extended_timeout)
2386
if self.server.use_dbus:
2391
if approval_required:
2392
client.approvals_pending -= 1
2395
except gnutls.Error as error:
2396
logger.warning("GnuTLS bye failed",
1065
2400
def peer_certificate(session):
1066
"Return the peer's OpenPGP certificate as a bytestring"
1067
# If not an OpenPGP certificate...
1068
if (gnutls.library.functions
1069
.gnutls_certificate_type_get(session._c_object)
1070
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1071
# ...do the normal thing
1072
return session.peer_certificate
2401
"Return the peer's certificate as a bytestring"
2403
cert_type = gnutls.certificate_type_get2(session._c_object,
2405
except AttributeError:
2406
cert_type = gnutls.certificate_type_get(session._c_object)
2407
if gnutls.has_rawpk:
2408
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2410
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2411
# If not a valid certificate type...
2412
if cert_type not in valid_cert_types:
2413
logger.info("Cert type %r not in %r", cert_type,
2415
# ...return invalid data
1073
2417
list_size = ctypes.c_uint(1)
1074
cert_list = (gnutls.library.functions
1075
.gnutls_certificate_get_peers
2418
cert_list = (gnutls.certificate_get_peers
1076
2419
(session._c_object, ctypes.byref(list_size)))
1077
2420
if not bool(cert_list) and list_size.value != 0:
1078
raise gnutls.errors.GNUTLSError(u"error getting peer"
2421
raise gnutls.Error("error getting peer certificate")
1080
2422
if list_size.value == 0:
1082
2424
cert = cert_list[0]
1083
2425
return ctypes.string_at(cert.data, cert.size)
2428
def key_id(certificate):
2429
"Convert a certificate bytestring to a hexdigit key ID"
2430
# New GnuTLS "datum" with the public key
2431
datum = gnutls.datum_t(
2432
ctypes.cast(ctypes.c_char_p(certificate),
2433
ctypes.POINTER(ctypes.c_ubyte)),
2434
ctypes.c_uint(len(certificate)))
2435
# XXX all these need to be created in the gnutls "module"
2436
# New empty GnuTLS certificate
2437
pubkey = gnutls.pubkey_t()
2438
gnutls.pubkey_init(ctypes.byref(pubkey))
2439
# Import the raw public key into the certificate
2440
gnutls.pubkey_import(pubkey,
2441
ctypes.byref(datum),
2442
gnutls.X509_FMT_DER)
2443
# New buffer for the key ID
2444
buf = ctypes.create_string_buffer(32)
2445
buf_len = ctypes.c_size_t(len(buf))
2446
# Get the key ID from the raw public key into the buffer
2447
gnutls.pubkey_get_key_id(pubkey,
2448
gnutls.KEYID_USE_SHA256,
2449
ctypes.cast(ctypes.byref(buf),
2450
ctypes.POINTER(ctypes.c_ubyte)),
2451
ctypes.byref(buf_len))
2452
# Deinit the certificate
2453
gnutls.pubkey_deinit(pubkey)
2455
# Convert the buffer to a Python bytestring
2456
key_id = ctypes.string_at(buf, buf_len.value)
2457
# Convert the bytestring to hexadecimal notation
2458
hex_key_id = binascii.hexlify(key_id).upper()
1086
2462
def fingerprint(openpgp):
1087
2463
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1088
2464
# New GnuTLS "datum" with the OpenPGP public key
1089
datum = (gnutls.library.types
1090
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1093
ctypes.c_uint(len(openpgp))))
2465
datum = gnutls.datum_t(
2466
ctypes.cast(ctypes.c_char_p(openpgp),
2467
ctypes.POINTER(ctypes.c_ubyte)),
2468
ctypes.c_uint(len(openpgp)))
1094
2469
# New empty GnuTLS certificate
1095
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1096
(gnutls.library.functions
1097
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2470
crt = gnutls.openpgp_crt_t()
2471
gnutls.openpgp_crt_init(ctypes.byref(crt))
1098
2472
# Import the OpenPGP public key into the certificate
1099
(gnutls.library.functions
1100
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1101
gnutls.library.constants
1102
.GNUTLS_OPENPGP_FMT_RAW))
2473
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2474
gnutls.OPENPGP_FMT_RAW)
1103
2475
# Verify the self signature in the key
1104
2476
crtverify = ctypes.c_uint()
1105
(gnutls.library.functions
1106
.gnutls_openpgp_crt_verify_self(crt, 0,
1107
ctypes.byref(crtverify)))
2477
gnutls.openpgp_crt_verify_self(crt, 0,
2478
ctypes.byref(crtverify))
1108
2479
if crtverify.value != 0:
1109
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1110
raise (gnutls.errors.CertificateSecurityError
2480
gnutls.openpgp_crt_deinit(crt)
2481
raise gnutls.CertificateSecurityError(code
1112
2483
# New buffer for the fingerprint
1113
2484
buf = ctypes.create_string_buffer(20)
1114
2485
buf_len = ctypes.c_size_t()
1115
2486
# Get the fingerprint from the certificate into the buffer
1116
(gnutls.library.functions
1117
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1118
ctypes.byref(buf_len)))
2487
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2488
ctypes.byref(buf_len))
1119
2489
# Deinit the certificate
1120
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2490
gnutls.openpgp_crt_deinit(crt)
1121
2491
# Convert the buffer to a Python bytestring
1122
2492
fpr = ctypes.string_at(buf, buf_len.value)
1123
2493
# Convert the bytestring to hexadecimal notation
1124
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2494
hex_fpr = binascii.hexlify(fpr).upper()
1128
class ForkingMixInWithPipe(socketserver.ForkingMixIn, object):
1129
"""Like socketserver.ForkingMixIn, but also pass a pipe."""
2498
class MultiprocessingMixIn:
2499
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2501
def sub_process_main(self, request, address):
2503
self.finish_request(request, address)
2505
self.handle_error(request, address)
2506
self.close_request(request)
2508
def process_request(self, request, address):
2509
"""Start a new process to process the request."""
2510
proc = multiprocessing.Process(target=self.sub_process_main,
2511
args=(request, address))
2516
class MultiprocessingMixInWithPipe(MultiprocessingMixIn):
2517
""" adds a pipe to the MixIn """
1130
2519
def process_request(self, request, client_address):
1131
2520
"""Overrides and wraps the original process_request().
1133
2522
This function creates a new pipe in self.pipe
1135
self.pipe = os.pipe()
1136
super(ForkingMixInWithPipe,
1137
self).process_request(request, client_address)
1138
os.close(self.pipe[1]) # close write end
1139
self.add_pipe(self.pipe[0])
1140
def add_pipe(self, pipe):
2524
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2526
proc = MultiprocessingMixIn.process_request(self, request,
2528
self.child_pipe.close()
2529
self.add_pipe(parent_pipe, proc)
2531
def add_pipe(self, parent_pipe, proc):
1141
2532
"""Dummy function; override as necessary"""
1145
class IPv6_TCPServer(ForkingMixInWithPipe,
1146
socketserver.TCPServer, object):
2533
raise NotImplementedError()
2536
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2537
socketserver.TCPServer):
1147
2538
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1150
2541
enabled: Boolean; whether this server is activated yet
1151
2542
interface: None or a network interface name (string)
1152
2543
use_ipv6: Boolean; to use IPv6 or not
1154
2546
def __init__(self, server_address, RequestHandlerClass,
1155
interface=None, use_ipv6=True):
2550
"""If socketfd is set, use that file descriptor instead of
2551
creating a new one with socket.socket().
1156
2553
self.interface = interface
1158
2555
self.address_family = socket.AF_INET6
2556
if socketfd is not None:
2557
# Save the file descriptor
2558
self.socketfd = socketfd
2559
# Save the original socket.socket() function
2560
self.socket_socket = socket.socket
2562
# To implement --socket, we monkey patch socket.socket.
2564
# (When socketserver.TCPServer is a new-style class, we
2565
# could make self.socket into a property instead of monkey
2566
# patching socket.socket.)
2568
# Create a one-time-only replacement for socket.socket()
2569
@functools.wraps(socket.socket)
2570
def socket_wrapper(*args, **kwargs):
2571
# Restore original function so subsequent calls are
2573
socket.socket = self.socket_socket
2574
del self.socket_socket
2575
# This time only, return a new socket object from the
2576
# saved file descriptor.
2577
return socket.fromfd(self.socketfd, *args, **kwargs)
2578
# Replace socket.socket() function with wrapper
2579
socket.socket = socket_wrapper
2580
# The socketserver.TCPServer.__init__ will call
2581
# socket.socket(), which might be our replacement,
2582
# socket_wrapper(), if socketfd was set.
1159
2583
socketserver.TCPServer.__init__(self, server_address,
1160
2584
RequestHandlerClass)
1161
2586
def server_bind(self):
1162
2587
"""This overrides the normal server_bind() function
1163
2588
to bind to an interface if one was specified, and also NOT to
1164
2589
bind to an address or port if they were not specified."""
2590
global SO_BINDTODEVICE
1165
2591
if self.interface is not None:
1166
2592
if SO_BINDTODEVICE is None:
1167
logger.error(u"SO_BINDTODEVICE does not exist;"
1168
u" cannot bind to interface %s",
1172
self.socket.setsockopt(socket.SOL_SOCKET,
1176
except socket.error, error:
1177
if error[0] == errno.EPERM:
1178
logger.error(u"No permission to"
1179
u" bind to interface %s",
1181
elif error[0] == errno.ENOPROTOOPT:
1182
logger.error(u"SO_BINDTODEVICE not available;"
1183
u" cannot bind to interface %s",
2593
# Fall back to a hard-coded value which seems to be
2595
logger.warning("SO_BINDTODEVICE not found, trying 25")
2596
SO_BINDTODEVICE = 25
2598
self.socket.setsockopt(
2599
socket.SOL_SOCKET, SO_BINDTODEVICE,
2600
(self.interface + "\0").encode("utf-8"))
2601
except socket.error as error:
2602
if error.errno == errno.EPERM:
2603
logger.error("No permission to bind to"
2604
" interface %s", self.interface)
2605
elif error.errno == errno.ENOPROTOOPT:
2606
logger.error("SO_BINDTODEVICE not available;"
2607
" cannot bind to interface %s",
2609
elif error.errno == errno.ENODEV:
2610
logger.error("Interface %s does not exist,"
2611
" cannot bind", self.interface)
1187
2614
# Only bind(2) the socket if we really need to.
1188
2615
if self.server_address[0] or self.server_address[1]:
2616
if self.server_address[1]:
2617
self.allow_reuse_address = True
1189
2618
if not self.server_address[0]:
1190
2619
if self.address_family == socket.AF_INET6:
1191
any_address = u"::" # in6addr_any
2620
any_address = "::" # in6addr_any
1193
any_address = socket.INADDR_ANY
2622
any_address = "0.0.0.0" # INADDR_ANY
1194
2623
self.server_address = (any_address,
1195
2624
self.server_address[1])
1196
2625
elif not self.server_address[1]:
1197
self.server_address = (self.server_address[0],
2626
self.server_address = (self.server_address[0], 0)
1199
2627
# if self.interface:
1200
2628
# self.server_address = (self.server_address[0],
1208
2636
class MandosServer(IPv6_TCPServer):
1209
2637
"""Mandos server.
1212
2640
clients: set of Client objects
1213
2641
gnutls_priority GnuTLS priority string
1214
2642
use_dbus: Boolean; to emit D-Bus signals or not
1216
Assumes a gobject.MainLoop event loop.
2644
Assumes a GLib.MainLoop event loop.
1218
2647
def __init__(self, server_address, RequestHandlerClass,
1219
interface=None, use_ipv6=True, clients=None,
1220
gnutls_priority=None, use_dbus=True):
2651
gnutls_priority=None,
1221
2654
self.enabled = False
1222
2655
self.clients = clients
1223
2656
if self.clients is None:
1224
self.clients = set()
1225
2658
self.use_dbus = use_dbus
1226
2659
self.gnutls_priority = gnutls_priority
1227
2660
IPv6_TCPServer.__init__(self, server_address,
1228
2661
RequestHandlerClass,
1229
interface = interface,
1230
use_ipv6 = use_ipv6)
2662
interface=interface,
1231
2666
def server_activate(self):
1232
2667
if self.enabled:
1233
2668
return socketserver.TCPServer.server_activate(self)
1234
2670
def enable(self):
1235
2671
self.enabled = True
1236
def add_pipe(self, pipe):
2673
def add_pipe(self, parent_pipe, proc):
1237
2674
# Call "handle_ipc" for both data and EOF events
1238
gobject.io_add_watch(pipe, gobject.IO_IN | gobject.IO_HUP,
1240
def handle_ipc(self, source, condition, file_objects={}):
1242
gobject.IO_IN: u"IN", # There is data to read.
1243
gobject.IO_OUT: u"OUT", # Data can be written (without
1245
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1246
gobject.IO_ERR: u"ERR", # Error condition.
1247
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1248
# broken, usually for pipes and
1251
conditions_string = ' | '.join(name
1253
condition_names.iteritems()
1254
if cond & condition)
1255
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1258
# Turn the pipe file descriptor into a Python file object
1259
if source not in file_objects:
1260
file_objects[source] = os.fdopen(source, u"r", 1)
1262
# Read a line from the file object
1263
cmdline = file_objects[source].readline()
1264
if not cmdline: # Empty line means end of file
1265
# close the IPC pipe
1266
file_objects[source].close()
1267
del file_objects[source]
1269
# Stop calling this function
1272
logger.debug(u"IPC command: %r", cmdline)
1274
# Parse and act on command
1275
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1277
if cmd == u"NOTFOUND":
1278
logger.warning(u"Client not found for fingerprint: %s",
1282
mandos_dbus_service.ClientNotFound(args)
1283
elif cmd == u"INVALID":
1284
for client in self.clients:
1285
if client.name == args:
1286
logger.warning(u"Client %s is invalid", args)
1292
logger.error(u"Unknown client %s is invalid", args)
1293
elif cmd == u"SENDING":
1294
for client in self.clients:
1295
if client.name == args:
1296
logger.info(u"Sending secret to %s", client.name)
1300
client.ReceivedSecret()
1303
logger.error(u"Sending secret to unknown client %s",
2676
parent_pipe.fileno(),
2677
GLib.IO_IN | GLib.IO_HUP,
2678
functools.partial(self.handle_ipc,
2679
parent_pipe=parent_pipe,
2682
def handle_ipc(self, source, condition,
2685
client_object=None):
2686
# error, or the other end of multiprocessing.Pipe has closed
2687
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2688
# Wait for other process to exit
2692
# Read a request from the child
2693
request = parent_pipe.recv()
2694
command = request[0]
2696
if command == 'init':
2697
key_id = request[1].decode("ascii")
2698
fpr = request[2].decode("ascii")
2699
address = request[3]
2701
for c in self.clients.values():
2702
if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2704
if key_id and c.key_id == key_id:
2707
if fpr and c.fingerprint == fpr:
2711
logger.info("Client not found for key ID: %s, address"
2712
": %s", key_id or fpr, address)
2715
mandos_dbus_service.ClientNotFound(key_id or fpr,
2717
parent_pipe.send(False)
2721
parent_pipe.fileno(),
2722
GLib.IO_IN | GLib.IO_HUP,
2723
functools.partial(self.handle_ipc,
2724
parent_pipe=parent_pipe,
2726
client_object=client))
2727
parent_pipe.send(True)
2728
# remove the old hook in favor of the new above hook on
2731
if command == 'funcall':
2732
funcname = request[1]
2736
parent_pipe.send(('data', getattr(client_object,
2740
if command == 'getattr':
2741
attrname = request[1]
2742
if isinstance(client_object.__getattribute__(attrname),
2743
collections.Callable):
2744
parent_pipe.send(('function', ))
2747
'data', client_object.__getattribute__(attrname)))
2749
if command == 'setattr':
2750
attrname = request[1]
2752
setattr(client_object, attrname, value)
2757
def rfc3339_duration_to_delta(duration):
2758
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2760
>>> rfc3339_duration_to_delta("P7D")
2761
datetime.timedelta(7)
2762
>>> rfc3339_duration_to_delta("PT60S")
2763
datetime.timedelta(0, 60)
2764
>>> rfc3339_duration_to_delta("PT60M")
2765
datetime.timedelta(0, 3600)
2766
>>> rfc3339_duration_to_delta("PT24H")
2767
datetime.timedelta(1)
2768
>>> rfc3339_duration_to_delta("P1W")
2769
datetime.timedelta(7)
2770
>>> rfc3339_duration_to_delta("PT5M30S")
2771
datetime.timedelta(0, 330)
2772
>>> rfc3339_duration_to_delta("P1DT3M20S")
2773
datetime.timedelta(1, 200)
2776
# Parsing an RFC 3339 duration with regular expressions is not
2777
# possible - there would have to be multiple places for the same
2778
# values, like seconds. The current code, while more esoteric, is
2779
# cleaner without depending on a parsing library. If Python had a
2780
# built-in library for parsing we would use it, but we'd like to
2781
# avoid excessive use of external libraries.
2783
# New type for defining tokens, syntax, and semantics all-in-one
2784
Token = collections.namedtuple("Token", (
2785
"regexp", # To match token; if "value" is not None, must have
2786
# a "group" containing digits
2787
"value", # datetime.timedelta or None
2788
"followers")) # Tokens valid after this token
2789
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2790
# the "duration" ABNF definition in RFC 3339, Appendix A.
2791
token_end = Token(re.compile(r"$"), None, frozenset())
2792
token_second = Token(re.compile(r"(\d+)S"),
2793
datetime.timedelta(seconds=1),
2794
frozenset((token_end, )))
2795
token_minute = Token(re.compile(r"(\d+)M"),
2796
datetime.timedelta(minutes=1),
2797
frozenset((token_second, token_end)))
2798
token_hour = Token(re.compile(r"(\d+)H"),
2799
datetime.timedelta(hours=1),
2800
frozenset((token_minute, token_end)))
2801
token_time = Token(re.compile(r"T"),
2803
frozenset((token_hour, token_minute,
2805
token_day = Token(re.compile(r"(\d+)D"),
2806
datetime.timedelta(days=1),
2807
frozenset((token_time, token_end)))
2808
token_month = Token(re.compile(r"(\d+)M"),
2809
datetime.timedelta(weeks=4),
2810
frozenset((token_day, token_end)))
2811
token_year = Token(re.compile(r"(\d+)Y"),
2812
datetime.timedelta(weeks=52),
2813
frozenset((token_month, token_end)))
2814
token_week = Token(re.compile(r"(\d+)W"),
2815
datetime.timedelta(weeks=1),
2816
frozenset((token_end, )))
2817
token_duration = Token(re.compile(r"P"), None,
2818
frozenset((token_year, token_month,
2819
token_day, token_time,
2821
# Define starting values:
2823
value = datetime.timedelta()
2825
# Following valid tokens
2826
followers = frozenset((token_duration, ))
2827
# String left to parse
2829
# Loop until end token is found
2830
while found_token is not token_end:
2831
# Search for any currently valid tokens
2832
for token in followers:
2833
match = token.regexp.match(s)
2834
if match is not None:
2836
if token.value is not None:
2837
# Value found, parse digits
2838
factor = int(match.group(1), 10)
2839
# Add to value so far
2840
value += factor * token.value
2841
# Strip token from string
2842
s = token.regexp.sub("", s, 1)
2845
# Set valid next tokens
2846
followers = found_token.followers
1306
logger.error(u"Unknown IPC command: %r", cmdline)
1308
# Keep calling this function
2849
# No currently valid tokens were found
2850
raise ValueError("Invalid RFC 3339 duration: {!r}"
1312
2856
def string_to_delta(interval):
1313
2857
"""Parse a string and return a datetime.timedelta
1315
>>> string_to_delta(u'7d')
2859
>>> string_to_delta('7d')
1316
2860
datetime.timedelta(7)
1317
>>> string_to_delta(u'60s')
2861
>>> string_to_delta('60s')
1318
2862
datetime.timedelta(0, 60)
1319
>>> string_to_delta(u'60m')
2863
>>> string_to_delta('60m')
1320
2864
datetime.timedelta(0, 3600)
1321
>>> string_to_delta(u'24h')
2865
>>> string_to_delta('24h')
1322
2866
datetime.timedelta(1)
1323
>>> string_to_delta(u'1w')
2867
>>> string_to_delta('1w')
1324
2868
datetime.timedelta(7)
1325
>>> string_to_delta(u'5m 30s')
2869
>>> string_to_delta('5m 30s')
1326
2870
datetime.timedelta(0, 330)
2874
return rfc3339_duration_to_delta(interval)
1328
2878
timevalue = datetime.timedelta(0)
1329
2879
for s in interval.split():
1331
suffix = unicode(s[-1])
1332
2882
value = int(s[:-1])
1334
2884
delta = datetime.timedelta(value)
1335
elif suffix == u"s":
1336
2886
delta = datetime.timedelta(0, value)
1337
elif suffix == u"m":
1338
2888
delta = datetime.timedelta(0, 0, 0, 0, value)
1339
elif suffix == u"h":
1340
2890
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1341
elif suffix == u"w":
1342
2892
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1345
except (ValueError, IndexError):
2894
raise ValueError("Unknown suffix {!r}".format(suffix))
2895
except IndexError as e:
2896
raise ValueError(*(e.args))
1347
2897
timevalue += delta
1348
2898
return timevalue
1351
def if_nametoindex(interface):
1352
"""Call the C function if_nametoindex(), or equivalent
1354
Note: This function cannot accept a unicode string."""
1355
global if_nametoindex
1357
if_nametoindex = (ctypes.cdll.LoadLibrary
1358
(ctypes.util.find_library(u"c"))
1360
except (OSError, AttributeError):
1361
logger.warning(u"Doing if_nametoindex the hard way")
1362
def if_nametoindex(interface):
1363
"Get an interface index the hard way, i.e. using fcntl()"
1364
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1365
with closing(socket.socket()) as s:
1366
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1367
struct.pack(str(u"16s16x"),
1369
interface_index = struct.unpack(str(u"I"),
1371
return interface_index
1372
return if_nametoindex(interface)
1375
def daemon(nochdir = False, noclose = False):
2901
def daemon(nochdir=False, noclose=False):
1376
2902
"""See daemon(3). Standard BSD Unix function.
1378
2904
This should really exist as os.daemon, but it doesn't (yet)."""
1382
2908
if not nochdir:
1386
2912
if not noclose:
1387
2913
# Close all standard open file descriptors
1388
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2914
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1389
2915
if not stat.S_ISCHR(os.fstat(null).st_mode):
1390
2916
raise OSError(errno.ENODEV,
1391
u"/dev/null not a character device")
2917
"{} not a character device"
2918
.format(os.devnull))
1392
2919
os.dup2(null, sys.stdin.fileno())
1393
2920
os.dup2(null, sys.stdout.fileno())
1394
2921
os.dup2(null, sys.stderr.fileno())
1401
2928
##################################################################
1402
2929
# Parsing of options, both command line and config file
1404
parser = optparse.OptionParser(version = "%%prog %s" % version)
1405
parser.add_option("-i", u"--interface", type=u"string",
1406
metavar="IF", help=u"Bind to interface IF")
1407
parser.add_option("-a", u"--address", type=u"string",
1408
help=u"Address to listen for requests on")
1409
parser.add_option("-p", u"--port", type=u"int",
1410
help=u"Port number to receive requests on")
1411
parser.add_option("--check", action=u"store_true",
1412
help=u"Run self-test")
1413
parser.add_option("--debug", action=u"store_true",
1414
help=u"Debug mode; run in foreground and log to"
1416
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1417
u" priority string (see GnuTLS documentation)")
1418
parser.add_option("--servicename", type=u"string",
1419
metavar=u"NAME", help=u"Zeroconf service name")
1420
parser.add_option("--configdir", type=u"string",
1421
default=u"/etc/mandos", metavar=u"DIR",
1422
help=u"Directory to search for configuration"
1424
parser.add_option("--no-dbus", action=u"store_false",
1425
dest=u"use_dbus", help=u"Do not provide D-Bus"
1426
u" system bus interface")
1427
parser.add_option("--no-ipv6", action=u"store_false",
1428
dest=u"use_ipv6", help=u"Do not use IPv6")
1429
options = parser.parse_args()[0]
2931
parser = argparse.ArgumentParser()
2932
parser.add_argument("-v", "--version", action="version",
2933
version="%(prog)s {}".format(version),
2934
help="show version number and exit")
2935
parser.add_argument("-i", "--interface", metavar="IF",
2936
help="Bind to interface IF")
2937
parser.add_argument("-a", "--address",
2938
help="Address to listen for requests on")
2939
parser.add_argument("-p", "--port", type=int,
2940
help="Port number to receive requests on")
2941
parser.add_argument("--check", action="store_true",
2942
help="Run self-test")
2943
parser.add_argument("--debug", action="store_true",
2944
help="Debug mode; run in foreground and log"
2945
" to terminal", default=None)
2946
parser.add_argument("--debuglevel", metavar="LEVEL",
2947
help="Debug level for stdout output")
2948
parser.add_argument("--priority", help="GnuTLS"
2949
" priority string (see GnuTLS documentation)")
2950
parser.add_argument("--servicename",
2951
metavar="NAME", help="Zeroconf service name")
2952
parser.add_argument("--configdir",
2953
default="/etc/mandos", metavar="DIR",
2954
help="Directory to search for configuration"
2956
parser.add_argument("--no-dbus", action="store_false",
2957
dest="use_dbus", help="Do not provide D-Bus"
2958
" system bus interface", default=None)
2959
parser.add_argument("--no-ipv6", action="store_false",
2960
dest="use_ipv6", help="Do not use IPv6",
2962
parser.add_argument("--no-restore", action="store_false",
2963
dest="restore", help="Do not restore stored"
2964
" state", default=None)
2965
parser.add_argument("--socket", type=int,
2966
help="Specify a file descriptor to a network"
2967
" socket to use instead of creating one")
2968
parser.add_argument("--statedir", metavar="DIR",
2969
help="Directory to save/restore state in")
2970
parser.add_argument("--foreground", action="store_true",
2971
help="Run in foreground", default=None)
2972
parser.add_argument("--no-zeroconf", action="store_false",
2973
dest="zeroconf", help="Do not use Zeroconf",
2976
options = parser.parse_args()
1431
2978
if options.check:
2980
fail_count, test_count = doctest.testmod()
2981
sys.exit(os.EX_OK if fail_count == 0 else 1)
1436
2983
# Default values for config file for server-global settings
1437
server_defaults = { u"interface": u"",
1442
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1443
u"servicename": u"Mandos",
1444
u"use_dbus": u"True",
1445
u"use_ipv6": u"True",
2984
if gnutls.has_rawpk:
2985
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2986
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2988
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2989
":+SIGN-DSA-SHA256")
2990
server_defaults = {"interface": "",
2994
"priority": priority,
2995
"servicename": "Mandos",
3001
"statedir": "/var/lib/mandos",
3002
"foreground": "False",
1448
3007
# Parse config file for server-global settings
1449
server_config = configparser.SafeConfigParser(server_defaults)
3008
server_config = configparser.ConfigParser(server_defaults)
1450
3009
del server_defaults
1451
server_config.read(os.path.join(options.configdir,
1453
# Convert the SafeConfigParser object to a dict
3010
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3011
# Convert the ConfigParser object to a dict
1454
3012
server_settings = server_config.defaults()
1455
3013
# Use the appropriate methods on the non-string config options
1456
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1457
server_settings[option] = server_config.getboolean(u"DEFAULT",
3014
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3015
"foreground", "zeroconf"):
3016
server_settings[option] = server_config.getboolean("DEFAULT",
1459
3018
if server_settings["port"]:
1460
server_settings["port"] = server_config.getint(u"DEFAULT",
3019
server_settings["port"] = server_config.getint("DEFAULT",
3021
if server_settings["socket"]:
3022
server_settings["socket"] = server_config.getint("DEFAULT",
3024
# Later, stdin will, and stdout and stderr might, be dup'ed
3025
# over with an opened os.devnull. But we don't want this to
3026
# happen with a supplied network socket.
3027
if 0 <= server_settings["socket"] <= 2:
3028
server_settings["socket"] = os.dup(server_settings
1462
3030
del server_config
1464
3032
# Override the settings from the config file with command line
1465
3033
# options, if set.
1466
for option in (u"interface", u"address", u"port", u"debug",
1467
u"priority", u"servicename", u"configdir",
1468
u"use_dbus", u"use_ipv6"):
3034
for option in ("interface", "address", "port", "debug",
3035
"priority", "servicename", "configdir", "use_dbus",
3036
"use_ipv6", "debuglevel", "restore", "statedir",
3037
"socket", "foreground", "zeroconf"):
1469
3038
value = getattr(options, option)
1470
3039
if value is not None:
1471
3040
server_settings[option] = value
1473
3042
# Force all strings to be unicode
1474
3043
for option in server_settings.keys():
1475
if type(server_settings[option]) is str:
1476
server_settings[option] = unicode(server_settings[option])
3044
if isinstance(server_settings[option], bytes):
3045
server_settings[option] = (server_settings[option]
3047
# Force all boolean options to be boolean
3048
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3049
"foreground", "zeroconf"):
3050
server_settings[option] = bool(server_settings[option])
3051
# Debug implies foreground
3052
if server_settings["debug"]:
3053
server_settings["foreground"] = True
1477
3054
# Now we have our good server settings in "server_settings"
1479
3056
##################################################################
3058
if (not server_settings["zeroconf"]
3059
and not (server_settings["port"]
3060
or server_settings["socket"] != "")):
3061
parser.error("Needs port or socket to work without Zeroconf")
1481
3063
# For convenience
1482
debug = server_settings[u"debug"]
1483
use_dbus = server_settings[u"use_dbus"]
1484
use_ipv6 = server_settings[u"use_ipv6"]
1487
syslogger.setLevel(logging.WARNING)
1488
console.setLevel(logging.WARNING)
1490
if server_settings[u"servicename"] != u"Mandos":
1491
syslogger.setFormatter(logging.Formatter
1492
(u'Mandos (%s) [%%(process)d]:'
1493
u' %%(levelname)s: %%(message)s'
1494
% server_settings[u"servicename"]))
3064
debug = server_settings["debug"]
3065
debuglevel = server_settings["debuglevel"]
3066
use_dbus = server_settings["use_dbus"]
3067
use_ipv6 = server_settings["use_ipv6"]
3068
stored_state_path = os.path.join(server_settings["statedir"],
3070
foreground = server_settings["foreground"]
3071
zeroconf = server_settings["zeroconf"]
3074
initlogger(debug, logging.DEBUG)
3079
level = getattr(logging, debuglevel.upper())
3080
initlogger(debug, level)
3082
if server_settings["servicename"] != "Mandos":
3083
syslogger.setFormatter(
3084
logging.Formatter('Mandos ({}) [%(process)d]:'
3085
' %(levelname)s: %(message)s'.format(
3086
server_settings["servicename"])))
1496
3088
# Parse config file with clients
1497
client_defaults = { u"timeout": u"1h",
1499
u"checker": u"fping -q -- %%(host)s",
1502
client_config = configparser.SafeConfigParser(client_defaults)
1503
client_config.read(os.path.join(server_settings[u"configdir"],
3089
client_config = configparser.ConfigParser(Client.client_defaults)
3090
client_config.read(os.path.join(server_settings["configdir"],
1506
3093
global mandos_dbus_service
1507
3094
mandos_dbus_service = None
1509
tcp_server = MandosServer((server_settings[u"address"],
1510
server_settings[u"port"]),
1512
interface=server_settings[u"interface"],
1515
server_settings[u"priority"],
1517
pidfilename = u"/var/run/mandos.pid"
1519
pidfile = open(pidfilename, u"w")
1521
logger.error(u"Could not open file %r", pidfilename)
1524
uid = pwd.getpwnam(u"_mandos").pw_uid
1525
gid = pwd.getpwnam(u"_mandos").pw_gid
1528
uid = pwd.getpwnam(u"mandos").pw_uid
1529
gid = pwd.getpwnam(u"mandos").pw_gid
3097
if server_settings["socket"] != "":
3098
socketfd = server_settings["socket"]
3099
tcp_server = MandosServer(
3100
(server_settings["address"], server_settings["port"]),
3102
interface=(server_settings["interface"] or None),
3104
gnutls_priority=server_settings["priority"],
3108
pidfilename = "/run/mandos.pid"
3109
if not os.path.isdir("/run/."):
3110
pidfilename = "/var/run/mandos.pid"
3113
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3114
except IOError as e:
3115
logger.error("Could not open file %r", pidfilename,
3118
for name, group in (("_mandos", "_mandos"),
3119
("mandos", "mandos"),
3120
("nobody", "nogroup")):
3122
uid = pwd.getpwnam(name).pw_uid
3123
gid = pwd.getpwnam(group).pw_gid
1530
3125
except KeyError:
1532
uid = pwd.getpwnam(u"nobody").pw_uid
1533
gid = pwd.getpwnam(u"nobody").pw_gid
1540
except OSError, error:
1541
if error[0] != errno.EPERM:
1544
# Enable all possible GnuTLS debugging
3134
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3136
except OSError as error:
3137
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3138
.format(uid, gid, os.strerror(error.errno)))
3139
if error.errno != errno.EPERM:
3143
# Enable all possible GnuTLS debugging
1546
3145
# "Use a log level over 10 to enable all debugging options."
1547
3146
# - GnuTLS manual
1548
gnutls.library.functions.gnutls_global_set_log_level(11)
1550
@gnutls.library.types.gnutls_log_func
3147
gnutls.global_set_log_level(11)
1551
3150
def debug_gnutls(level, string):
1552
logger.debug(u"GnuTLS: %s", string[:-1])
1554
(gnutls.library.functions
1555
.gnutls_global_set_log_function(debug_gnutls))
3151
logger.debug("GnuTLS: %s", string[:-1])
3153
gnutls.global_set_log_function(debug_gnutls)
3155
# Redirect stdin so all checkers get /dev/null
3156
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3157
os.dup2(null, sys.stdin.fileno())
3161
# Need to fork before connecting to D-Bus
3163
# Close all input and output, do double fork, etc.
3166
if gi.version_info < (3, 10, 2):
3167
# multiprocessing will use threads, so before we use GLib we
3168
# need to inform GLib that threads will be used.
1557
3171
global main_loop
1558
3172
# From the Avahi example code
1559
DBusGMainLoop(set_as_default=True )
1560
main_loop = gobject.MainLoop()
3173
DBusGMainLoop(set_as_default=True)
3174
main_loop = GLib.MainLoop()
1561
3175
bus = dbus.SystemBus()
1562
3176
# End of Avahi example code
1564
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
1565
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1566
service = AvahiService(name = server_settings[u"servicename"],
1567
servicetype = u"_mandos._tcp",
1568
protocol = protocol, bus = bus)
1569
if server_settings["interface"]:
1570
service.interface = (if_nametoindex
1571
(str(server_settings[u"interface"])))
3179
bus_name = dbus.service.BusName("se.recompile.Mandos",
3182
old_bus_name = dbus.service.BusName(
3183
"se.bsnet.fukt.Mandos", bus,
3185
except dbus.exceptions.DBusException as e:
3186
logger.error("Disabling D-Bus:", exc_info=e)
3188
server_settings["use_dbus"] = False
3189
tcp_server.use_dbus = False
3191
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3192
service = AvahiServiceToSyslog(
3193
name=server_settings["servicename"],
3194
servicetype="_mandos._tcp",
3197
if server_settings["interface"]:
3198
service.interface = if_nametoindex(
3199
server_settings["interface"].encode("utf-8"))
3201
global multiprocessing_manager
3202
multiprocessing_manager = multiprocessing.Manager()
1573
3204
client_class = Client
1575
client_class = functools.partial(ClientDBus, bus = bus)
1576
tcp_server.clients.update(set(
1577
client_class(name = section,
1578
config= dict(client_config.items(section)))
1579
for section in client_config.sections()))
3206
client_class = functools.partial(ClientDBus, bus=bus)
3208
client_settings = Client.config_parser(client_config)
3209
old_client_settings = {}
3212
# This is used to redirect stdout and stderr for checker processes
3214
wnull = open(os.devnull, "w") # A writable /dev/null
3215
# Only used if server is running in foreground but not in debug
3217
if debug or not foreground:
3220
# Get client data and settings from last running state.
3221
if server_settings["restore"]:
3223
with open(stored_state_path, "rb") as stored_state:
3224
if sys.version_info.major == 2:
3225
clients_data, old_client_settings = pickle.load(
3228
bytes_clients_data, bytes_old_client_settings = (
3229
pickle.load(stored_state, encoding="bytes"))
3230
# Fix bytes to strings
3233
clients_data = {(key.decode("utf-8")
3234
if isinstance(key, bytes)
3237
bytes_clients_data.items()}
3238
del bytes_clients_data
3239
for key in clients_data:
3240
value = {(k.decode("utf-8")
3241
if isinstance(k, bytes) else k): v
3243
clients_data[key].items()}
3244
clients_data[key] = value
3246
value["client_structure"] = [
3248
if isinstance(s, bytes)
3250
value["client_structure"]]
3252
for k in ("name", "host"):
3253
if isinstance(value[k], bytes):
3254
value[k] = value[k].decode("utf-8")
3255
if "key_id" not in value:
3256
value["key_id"] = ""
3257
elif "fingerprint" not in value:
3258
value["fingerprint"] = ""
3259
# old_client_settings
3261
old_client_settings = {
3262
(key.decode("utf-8")
3263
if isinstance(key, bytes)
3266
bytes_old_client_settings.items()}
3267
del bytes_old_client_settings
3269
for value in old_client_settings.values():
3270
if isinstance(value["host"], bytes):
3271
value["host"] = (value["host"]
3273
os.remove(stored_state_path)
3274
except IOError as e:
3275
if e.errno == errno.ENOENT:
3276
logger.warning("Could not load persistent state:"
3277
" {}".format(os.strerror(e.errno)))
3279
logger.critical("Could not load persistent state:",
3282
except EOFError as e:
3283
logger.warning("Could not load persistent state: "
3287
with PGPEngine() as pgp:
3288
for client_name, client in clients_data.items():
3289
# Skip removed clients
3290
if client_name not in client_settings:
3293
# Decide which value to use after restoring saved state.
3294
# We have three different values: Old config file,
3295
# new config file, and saved state.
3296
# New config value takes precedence if it differs from old
3297
# config value, otherwise use saved state.
3298
for name, value in client_settings[client_name].items():
3300
# For each value in new config, check if it
3301
# differs from the old config value (Except for
3302
# the "secret" attribute)
3303
if (name != "secret"
3305
old_client_settings[client_name][name])):
3306
client[name] = value
3310
# Clients who has passed its expire date can still be
3311
# enabled if its last checker was successful. A Client
3312
# whose checker succeeded before we stored its state is
3313
# assumed to have successfully run all checkers during
3315
if client["enabled"]:
3316
if datetime.datetime.utcnow() >= client["expires"]:
3317
if not client["last_checked_ok"]:
3319
"disabling client {} - Client never "
3320
"performed a successful checker".format(
3322
client["enabled"] = False
3323
elif client["last_checker_status"] != 0:
3325
"disabling client {} - Client last"
3326
" checker failed with error code"
3329
client["last_checker_status"]))
3330
client["enabled"] = False
3332
client["expires"] = (
3333
datetime.datetime.utcnow()
3334
+ client["timeout"])
3335
logger.debug("Last checker succeeded,"
3336
" keeping {} enabled".format(
3339
client["secret"] = pgp.decrypt(
3340
client["encrypted_secret"],
3341
client_settings[client_name]["secret"])
3343
# If decryption fails, we use secret from new settings
3344
logger.debug("Failed to decrypt {} old secret".format(
3346
client["secret"] = (client_settings[client_name]
3349
# Add/remove clients based on new changes made to config
3350
for client_name in (set(old_client_settings)
3351
- set(client_settings)):
3352
del clients_data[client_name]
3353
for client_name in (set(client_settings)
3354
- set(old_client_settings)):
3355
clients_data[client_name] = client_settings[client_name]
3357
# Create all client objects
3358
for client_name, client in clients_data.items():
3359
tcp_server.clients[client_name] = client_class(
3362
server_settings=server_settings)
1580
3364
if not tcp_server.clients:
1581
logger.warning(u"No clients defined")
1584
# Redirect stdin so all checkers get /dev/null
1585
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1586
os.dup2(null, sys.stdin.fileno())
1590
# No console logging
1591
logger.removeHandler(console)
1592
# Close all input and output, do double fork, etc.
1596
with closing(pidfile):
3365
logger.warning("No clients defined")
3368
if pidfile is not None:
1597
3369
pid = os.getpid()
1598
pidfile.write(str(pid) + "\n")
3372
print(pid, file=pidfile)
3374
logger.error("Could not write to file %r with PID %d",
1601
logger.error(u"Could not write to file %r with PID %d",
1604
# "pidfile" was never created
1609
"Cleanup function; run on exit"
1612
while tcp_server.clients:
1613
client = tcp_server.clients.pop()
1614
client.disable_hook = None
1617
atexit.register(cleanup)
1620
signal.signal(signal.SIGINT, signal.SIG_IGN)
1621
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1622
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3379
for termsig in (signal.SIGHUP, signal.SIGTERM):
3380
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3381
lambda: main_loop.quit() and False)
1625
class MandosDBusService(dbus.service.Object):
3385
@alternate_dbus_interfaces(
3386
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3387
class MandosDBusService(DBusObjectWithObjectManager):
1626
3388
"""A D-Bus proxy object"""
1627
3390
def __init__(self):
1628
dbus.service.Object.__init__(self, bus, u"/")
1629
_interface = u"se.bsnet.fukt.Mandos"
1631
@dbus.service.signal(_interface, signature=u"oa{sv}")
1632
def ClientAdded(self, objpath, properties):
1636
@dbus.service.signal(_interface, signature=u"s")
1637
def ClientNotFound(self, fingerprint):
1641
@dbus.service.signal(_interface, signature=u"os")
3391
dbus.service.Object.__init__(self, bus, "/")
3393
_interface = "se.recompile.Mandos"
3395
@dbus.service.signal(_interface, signature="o")
3396
def ClientAdded(self, objpath):
3400
@dbus.service.signal(_interface, signature="ss")
3401
def ClientNotFound(self, key_id, address):
3405
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3407
@dbus.service.signal(_interface, signature="os")
1642
3408
def ClientRemoved(self, objpath, name):
1646
@dbus.service.method(_interface, out_signature=u"ao")
3412
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3414
@dbus.service.method(_interface, out_signature="ao")
1647
3415
def GetAllClients(self):
1649
return dbus.Array(c.dbus_object_path
1650
for c in tcp_server.clients)
3417
return dbus.Array(c.dbus_object_path for c in
3418
tcp_server.clients.values())
3420
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1652
3422
@dbus.service.method(_interface,
1653
out_signature=u"a{oa{sv}}")
3423
out_signature="a{oa{sv}}")
1654
3424
def GetAllClientsWithProperties(self):
1656
3426
return dbus.Dictionary(
1657
((c.dbus_object_path, c.GetAll(u""))
1658
for c in tcp_server.clients),
1659
signature=u"oa{sv}")
1661
@dbus.service.method(_interface, in_signature=u"o")
3427
{c.dbus_object_path: c.GetAll(
3428
"se.recompile.Mandos.Client")
3429
for c in tcp_server.clients.values()},
3432
@dbus.service.method(_interface, in_signature="o")
1662
3433
def RemoveClient(self, object_path):
1664
for c in tcp_server.clients:
3435
for c in tcp_server.clients.values():
1665
3436
if c.dbus_object_path == object_path:
1666
tcp_server.clients.remove(c)
3437
del tcp_server.clients[c.name]
1667
3438
c.remove_from_connection()
1668
# Don't signal anything except ClientRemoved
1669
c.disable(signal=False)
1671
self.ClientRemoved(object_path, c.name)
3439
# Don't signal the disabling
3440
c.disable(quiet=True)
3441
# Emit D-Bus signal for removal
3442
self.client_removed_signal(c)
3444
raise KeyError(object_path)
3448
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3449
out_signature="a{oa{sa{sv}}}")
3450
def GetManagedObjects(self):
3452
return dbus.Dictionary(
3453
{client.dbus_object_path:
3455
{interface: client.GetAll(interface)
3457
client._get_all_interface_names()})
3458
for client in tcp_server.clients.values()})
3460
def client_added_signal(self, client):
3461
"""Send the new standard signal and the old signal"""
3463
# New standard signal
3464
self.InterfacesAdded(
3465
client.dbus_object_path,
3467
{interface: client.GetAll(interface)
3469
client._get_all_interface_names()}))
3471
self.ClientAdded(client.dbus_object_path)
3473
def client_removed_signal(self, client):
3474
"""Send the new standard signal and the old signal"""
3476
# New standard signal
3477
self.InterfacesRemoved(
3478
client.dbus_object_path,
3479
client._get_all_interface_names())
3481
self.ClientRemoved(client.dbus_object_path,
1677
3484
mandos_dbus_service = MandosDBusService()
1679
for client in tcp_server.clients:
3486
# Save modules to variables to exempt the modules from being
3487
# unloaded before the function registered with atexit() is run.
3488
mp = multiprocessing
3492
"Cleanup function; run on exit"
3496
mp.active_children()
3498
if not (tcp_server.clients or client_settings):
3501
# Store client before exiting. Secrets are encrypted with key
3502
# based on what config file has. If config file is
3503
# removed/edited, old secret will thus be unrecovable.
3505
with PGPEngine() as pgp:
3506
for client in tcp_server.clients.values():
3507
key = client_settings[client.name]["secret"]
3508
client.encrypted_secret = pgp.encrypt(client.secret,
3512
# A list of attributes that can not be pickled
3514
exclude = {"bus", "changedstate", "secret",
3515
"checker", "server_settings"}
3516
for name, typ in inspect.getmembers(dbus.service
3520
client_dict["encrypted_secret"] = (client
3522
for attr in client.client_structure:
3523
if attr not in exclude:
3524
client_dict[attr] = getattr(client, attr)
3526
clients[client.name] = client_dict
3527
del client_settings[client.name]["secret"]
3530
with tempfile.NamedTemporaryFile(
3534
dir=os.path.dirname(stored_state_path),
3535
delete=False) as stored_state:
3536
pickle.dump((clients, client_settings), stored_state,
3538
tempname = stored_state.name
3539
os.rename(tempname, stored_state_path)
3540
except (IOError, OSError) as e:
3546
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3547
logger.warning("Could not save persistent state: {}"
3548
.format(os.strerror(e.errno)))
3550
logger.warning("Could not save persistent state:",
3554
# Delete all clients, and settings from config
3555
while tcp_server.clients:
3556
name, client = tcp_server.clients.popitem()
3558
client.remove_from_connection()
3559
# Don't signal the disabling
3560
client.disable(quiet=True)
3561
# Emit D-Bus signal for removal
3563
mandos_dbus_service.client_removed_signal(client)
3564
client_settings.clear()
3566
atexit.register(cleanup)
3568
for client in tcp_server.clients.values():
1682
mandos_dbus_service.ClientAdded(client.dbus_object_path,
3570
# Emit D-Bus signal for adding
3571
mandos_dbus_service.client_added_signal(client)
3572
# Need to initiate checking of clients
3574
client.init_checker()
1686
3576
tcp_server.enable()
1687
3577
tcp_server.server_activate()
1689
3579
# Find out what port we got
1690
service.port = tcp_server.socket.getsockname()[1]
3581
service.port = tcp_server.socket.getsockname()[1]
1692
logger.info(u"Now listening on address %r, port %d,"
1693
" flowinfo %d, scope_id %d"
1694
% tcp_server.socket.getsockname())
3583
logger.info("Now listening on address %r, port %d,"
3584
" flowinfo %d, scope_id %d",
3585
*tcp_server.socket.getsockname())
1696
logger.info(u"Now listening on address %r, port %d"
1697
% tcp_server.socket.getsockname())
1699
#service.interface = tcp_server.socket.getsockname()[3]
3587
logger.info("Now listening on address %r, port %d",
3588
*tcp_server.socket.getsockname())
3590
# service.interface = tcp_server.socket.getsockname()[3]
1702
# From the Avahi example code
1705
except dbus.exceptions.DBusException, error:
1706
logger.critical(u"DBusException: %s", error)
1708
# End of Avahi example code
1710
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1711
lambda *args, **kwargs:
1712
(tcp_server.handle_request
1713
(*args[2:], **kwargs) or True))
1715
logger.debug(u"Starting main loop")
3594
# From the Avahi example code
3597
except dbus.exceptions.DBusException as error:
3598
logger.critical("D-Bus Exception", exc_info=error)
3601
# End of Avahi example code
3603
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3604
lambda *args, **kwargs:
3605
(tcp_server.handle_request
3606
(*args[2:], **kwargs) or True))
3608
logger.debug("Starting main loop")
1716
3609
main_loop.run()
1717
except AvahiError, error:
1718
logger.critical(u"AvahiError: %s", error)
3610
except AvahiError as error:
3611
logger.critical("Avahi Error", exc_info=error)
1720
3614
except KeyboardInterrupt:
1723
logger.debug(u"Server received KeyboardInterrupt")
1724
logger.debug(u"Server exiting")
3616
print("", file=sys.stderr)
3617
logger.debug("Server received KeyboardInterrupt")
3618
logger.debug("Server exiting")
3619
# Must run before the D-Bus bus name gets deregistered
1726
3623
if __name__ == '__main__':