422
191
dbus.UInt16(self.port),
423
192
avahi.string_array_to_txt_array(self.TXT))
424
193
self.group.Commit()
426
194
def entry_group_state_changed(self, state, error):
427
195
"""Derived from the Avahi example code"""
428
logger.debug("Avahi entry group state change: %i", state)
196
logger.debug(u"Avahi state change: %i", state)
430
198
if state == avahi.ENTRY_GROUP_ESTABLISHED:
431
logger.debug("Zeroconf service established.")
199
logger.debug(u"Zeroconf service established.")
432
200
elif state == avahi.ENTRY_GROUP_COLLISION:
433
logger.info("Zeroconf service name collision.")
201
logger.warning(u"Zeroconf service name collision.")
435
203
elif state == avahi.ENTRY_GROUP_FAILURE:
436
logger.critical("Avahi: Error in group state changed %s",
438
raise AvahiGroupError("State changed: {!s}".format(error))
204
logger.critical(u"Avahi: Error in group state changed %s",
206
raise AvahiGroupError(u"State changed: %s"
440
208
def cleanup(self):
441
209
"""Derived from the Avahi example code"""
442
210
if self.group is not None:
445
except (dbus.exceptions.UnknownMethodException,
446
dbus.exceptions.DBusException):
448
212
self.group = None
451
def server_state_changed(self, state, error=None):
213
def server_state_changed(self, state):
452
214
"""Derived from the Avahi example code"""
453
logger.debug("Avahi server state change: %i", state)
455
avahi.SERVER_INVALID: "Zeroconf server invalid",
456
avahi.SERVER_REGISTERING: None,
457
avahi.SERVER_COLLISION: "Zeroconf server name collision",
458
avahi.SERVER_FAILURE: "Zeroconf server failure",
460
if state in bad_states:
461
if bad_states[state] is not None:
463
logger.error(bad_states[state])
465
logger.error(bad_states[state] + ": %r", error)
215
if state == avahi.SERVER_COLLISION:
216
logger.error(u"Zeroconf server name collision")
467
218
elif state == avahi.SERVER_RUNNING:
470
except dbus.exceptions.DBusException as error:
471
if (error.get_dbus_name()
472
== "org.freedesktop.Avahi.CollisionError"):
473
logger.info("Local Zeroconf service name"
475
return self.rename(remove=False)
477
logger.critical("D-Bus Exception", exc_info=error)
482
logger.debug("Unknown state: %r", state)
484
logger.debug("Unknown state: %r: %r", state, error)
486
220
def activate(self):
487
221
"""Derived from the Avahi example code"""
488
222
if self.server is None:
489
223
self.server = dbus.Interface(
490
224
self.bus.get_object(avahi.DBUS_NAME,
491
avahi.DBUS_PATH_SERVER,
492
follow_name_owner_changes=True),
225
avahi.DBUS_PATH_SERVER),
493
226
avahi.DBUS_INTERFACE_SERVER)
494
self.server.connect_to_signal("StateChanged",
495
self.server_state_changed)
227
self.server.connect_to_signal(u"StateChanged",
228
self.server_state_changed)
496
229
self.server_state_changed(self.server.GetState())
499
class AvahiServiceToSyslog(AvahiService):
500
def rename(self, *args, **kwargs):
501
"""Add the new name to the syslog messages"""
502
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
503
syslogger.setFormatter(logging.Formatter(
504
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
509
# Pretend that we have a GnuTLS module
510
class gnutls(object):
511
"""This isn't so much a class as it is a module-like namespace."""
513
library = ctypes.util.find_library("gnutls")
515
library = ctypes.util.find_library("gnutls-deb0")
516
_library = ctypes.cdll.LoadLibrary(library)
519
# Unless otherwise indicated, the constants and types below are
520
# all from the gnutls/gnutls.h C header file.
531
E_NO_CERTIFICATE_FOUND = -49
536
KEYID_USE_SHA256 = 1 # gnutls/x509.h
537
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
540
class session_int(ctypes.Structure):
542
session_t = ctypes.POINTER(session_int)
544
class certificate_credentials_st(ctypes.Structure):
546
certificate_credentials_t = ctypes.POINTER(
547
certificate_credentials_st)
548
certificate_type_t = ctypes.c_int
550
class datum_t(ctypes.Structure):
551
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
552
('size', ctypes.c_uint)]
554
class openpgp_crt_int(ctypes.Structure):
556
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
557
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
558
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
559
credentials_type_t = ctypes.c_int
560
transport_ptr_t = ctypes.c_void_p
561
close_request_t = ctypes.c_int
564
class Error(Exception):
565
def __init__(self, message=None, code=None, args=()):
566
# Default usage is by a message string, but if a return
567
# code is passed, convert it to a string with
570
if message is None and code is not None:
571
message = gnutls.strerror(code)
572
return super(gnutls.Error, self).__init__(
575
class CertificateSecurityError(Error):
579
class Credentials(object):
581
self._c_object = gnutls.certificate_credentials_t()
582
gnutls.certificate_allocate_credentials(
583
ctypes.byref(self._c_object))
584
self.type = gnutls.CRD_CERTIFICATE
587
gnutls.certificate_free_credentials(self._c_object)
589
class ClientSession(object):
590
def __init__(self, socket, credentials=None):
591
self._c_object = gnutls.session_t()
592
gnutls_flags = gnutls.CLIENT
593
if gnutls.check_version(b"3.5.6"):
594
gnutls_flags |= gnutls.NO_TICKETS
596
gnutls_flags |= gnutls.ENABLE_RAWPK
597
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
599
gnutls.set_default_priority(self._c_object)
600
gnutls.transport_set_ptr(self._c_object, socket.fileno())
601
gnutls.handshake_set_private_extensions(self._c_object,
604
if credentials is None:
605
credentials = gnutls.Credentials()
606
gnutls.credentials_set(self._c_object, credentials.type,
607
ctypes.cast(credentials._c_object,
609
self.credentials = credentials
612
gnutls.deinit(self._c_object)
615
return gnutls.handshake(self._c_object)
617
def send(self, data):
621
data_len -= gnutls.record_send(self._c_object,
626
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
628
# Error handling functions
629
def _error_code(result):
630
"""A function to raise exceptions on errors, suitable
631
for the 'restype' attribute on ctypes functions"""
634
if result == gnutls.E_NO_CERTIFICATE_FOUND:
635
raise gnutls.CertificateSecurityError(code=result)
636
raise gnutls.Error(code=result)
638
def _retry_on_error(result, func, arguments):
639
"""A function to retry on some errors, suitable
640
for the 'errcheck' attribute on ctypes functions"""
642
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
643
return _error_code(result)
644
result = func(*arguments)
647
# Unless otherwise indicated, the function declarations below are
648
# all from the gnutls/gnutls.h C header file.
651
priority_set_direct = _library.gnutls_priority_set_direct
652
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
653
ctypes.POINTER(ctypes.c_char_p)]
654
priority_set_direct.restype = _error_code
656
init = _library.gnutls_init
657
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
658
init.restype = _error_code
660
set_default_priority = _library.gnutls_set_default_priority
661
set_default_priority.argtypes = [session_t]
662
set_default_priority.restype = _error_code
664
record_send = _library.gnutls_record_send
665
record_send.argtypes = [session_t, ctypes.c_void_p,
667
record_send.restype = ctypes.c_ssize_t
668
record_send.errcheck = _retry_on_error
670
certificate_allocate_credentials = (
671
_library.gnutls_certificate_allocate_credentials)
672
certificate_allocate_credentials.argtypes = [
673
ctypes.POINTER(certificate_credentials_t)]
674
certificate_allocate_credentials.restype = _error_code
676
certificate_free_credentials = (
677
_library.gnutls_certificate_free_credentials)
678
certificate_free_credentials.argtypes = [
679
certificate_credentials_t]
680
certificate_free_credentials.restype = None
682
handshake_set_private_extensions = (
683
_library.gnutls_handshake_set_private_extensions)
684
handshake_set_private_extensions.argtypes = [session_t,
686
handshake_set_private_extensions.restype = None
688
credentials_set = _library.gnutls_credentials_set
689
credentials_set.argtypes = [session_t, credentials_type_t,
691
credentials_set.restype = _error_code
693
strerror = _library.gnutls_strerror
694
strerror.argtypes = [ctypes.c_int]
695
strerror.restype = ctypes.c_char_p
697
certificate_type_get = _library.gnutls_certificate_type_get
698
certificate_type_get.argtypes = [session_t]
699
certificate_type_get.restype = _error_code
701
certificate_get_peers = _library.gnutls_certificate_get_peers
702
certificate_get_peers.argtypes = [session_t,
703
ctypes.POINTER(ctypes.c_uint)]
704
certificate_get_peers.restype = ctypes.POINTER(datum_t)
706
global_set_log_level = _library.gnutls_global_set_log_level
707
global_set_log_level.argtypes = [ctypes.c_int]
708
global_set_log_level.restype = None
710
global_set_log_function = _library.gnutls_global_set_log_function
711
global_set_log_function.argtypes = [log_func]
712
global_set_log_function.restype = None
714
deinit = _library.gnutls_deinit
715
deinit.argtypes = [session_t]
716
deinit.restype = None
718
handshake = _library.gnutls_handshake
719
handshake.argtypes = [session_t]
720
handshake.restype = _error_code
721
handshake.errcheck = _retry_on_error
723
transport_set_ptr = _library.gnutls_transport_set_ptr
724
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
725
transport_set_ptr.restype = None
727
bye = _library.gnutls_bye
728
bye.argtypes = [session_t, close_request_t]
729
bye.restype = _error_code
730
bye.errcheck = _retry_on_error
732
check_version = _library.gnutls_check_version
733
check_version.argtypes = [ctypes.c_char_p]
734
check_version.restype = ctypes.c_char_p
736
_need_version = b"3.3.0"
737
if check_version(_need_version) is None:
738
raise self.Error("Needs GnuTLS {} or later"
739
.format(_need_version))
741
_tls_rawpk_version = b"3.6.6"
742
has_rawpk = bool(check_version(_tls_rawpk_version))
746
class pubkey_st(ctypes.Structure):
748
pubkey_t = ctypes.POINTER(pubkey_st)
750
x509_crt_fmt_t = ctypes.c_int
752
# All the function declarations below are from gnutls/abstract.h
753
pubkey_init = _library.gnutls_pubkey_init
754
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
755
pubkey_init.restype = _error_code
757
pubkey_import = _library.gnutls_pubkey_import
758
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
760
pubkey_import.restype = _error_code
762
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
763
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
764
ctypes.POINTER(ctypes.c_ubyte),
765
ctypes.POINTER(ctypes.c_size_t)]
766
pubkey_get_key_id.restype = _error_code
768
pubkey_deinit = _library.gnutls_pubkey_deinit
769
pubkey_deinit.argtypes = [pubkey_t]
770
pubkey_deinit.restype = None
772
# All the function declarations below are from gnutls/openpgp.h
774
openpgp_crt_init = _library.gnutls_openpgp_crt_init
775
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
776
openpgp_crt_init.restype = _error_code
778
openpgp_crt_import = _library.gnutls_openpgp_crt_import
779
openpgp_crt_import.argtypes = [openpgp_crt_t,
780
ctypes.POINTER(datum_t),
782
openpgp_crt_import.restype = _error_code
784
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
785
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
786
ctypes.POINTER(ctypes.c_uint)]
787
openpgp_crt_verify_self.restype = _error_code
789
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
790
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
791
openpgp_crt_deinit.restype = None
793
openpgp_crt_get_fingerprint = (
794
_library.gnutls_openpgp_crt_get_fingerprint)
795
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
799
openpgp_crt_get_fingerprint.restype = _error_code
801
if check_version(b"3.6.4"):
802
certificate_type_get2 = _library.gnutls_certificate_type_get2
803
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
804
certificate_type_get2.restype = _error_code
806
# Remove non-public functions
807
del _error_code, _retry_on_error
810
def call_pipe(connection, # : multiprocessing.Connection
811
func, *args, **kwargs):
812
"""This function is meant to be called by multiprocessing.Process
814
This function runs func(*args, **kwargs), and writes the resulting
815
return value on the provided multiprocessing.Connection.
817
connection.send(func(*args, **kwargs))
821
232
class Client(object):
822
233
"""A representation of a client host served by this server.
825
approved: bool(); 'None' if not yet approved/disapproved
826
approval_delay: datetime.timedelta(); Time to wait for approval
827
approval_duration: datetime.timedelta(); Duration of one approval
828
checker: multiprocessing.Process(); a running checker process used
829
to see if the client lives. 'None' if no process is
831
checker_callback_tag: a GLib event source tag, or None
832
checker_command: string; External command which is run to check
833
if client lives. %() expansions are done at
834
runtime with vars(self) as dict, so that for
835
instance %(name)s can be used in the command.
836
checker_initiator_tag: a GLib event source tag, or None
236
name: string; from the config file, used in log messages and
238
fingerprint: string (40 or 32 hexadecimal digits); used to
239
uniquely identify the client
240
secret: bytestring; sent verbatim (over TLS) to client
241
host: string; available for use by the checker command
837
242
created: datetime.datetime(); (UTC) object creation
838
client_structure: Object describing what attributes a client has
839
and is used for storing the client at exit
840
current_checker_command: string; current running checker_command
841
disable_initiator_tag: a GLib event source tag, or None
243
last_enabled: datetime.datetime(); (UTC)
843
fingerprint: string (40 or 32 hexadecimal digits); used to
844
uniquely identify an OpenPGP client
845
key_id: string (64 hexadecimal digits); used to uniquely identify
846
a client using raw public keys
847
host: string; available for use by the checker command
848
interval: datetime.timedelta(); How often to start a new checker
849
last_approval_request: datetime.datetime(); (UTC) or None
850
245
last_checked_ok: datetime.datetime(); (UTC) or None
851
last_checker_status: integer between 0 and 255 reflecting exit
852
status of last checker. -1 reflects crashed
853
checker, -2 means no checker completed yet.
854
last_checker_signal: The signal which killed the last checker, if
855
last_checker_status is -1
856
last_enabled: datetime.datetime(); (UTC) or None
857
name: string; from the config file, used in log messages and
859
secret: bytestring; sent verbatim (over TLS) to client
860
246
timeout: datetime.timedelta(); How long from last_checked_ok
861
247
until this client is disabled
862
extended_timeout: extra long timeout when secret has been sent
863
runtime_expansions: Allowed attributes for runtime expansion.
864
expires: datetime.datetime(); time (UTC) when a client will be
866
server_settings: The server_settings dict from main()
248
interval: datetime.timedelta(); How often to start a new checker
249
disable_hook: If set, called by disable() as disable_hook(self)
250
checker: subprocess.Popen(); a running checker process used
251
to see if the client lives.
252
'None' if no process is running.
253
checker_initiator_tag: a gobject event source tag, or None
254
disable_initiator_tag: - '' -
255
checker_callback_tag: - '' -
256
checker_command: string; External command which is run to check if
257
client lives. %() expansions are done at
258
runtime with vars(self) as dict, so that for
259
instance %(name)s can be used in the command.
260
current_checker_command: string; current running checker_command
261
approved_delay: datetime.timedelta(); Time to wait for approval
262
_approved: bool(); 'None' if not yet approved/disapproved
263
approved_duration: datetime.timedelta(); Duration of one approval
869
runtime_expansions = ("approval_delay", "approval_duration",
870
"created", "enabled", "expires", "key_id",
871
"fingerprint", "host", "interval",
872
"last_approval_request", "last_checked_ok",
873
"last_enabled", "name", "timeout")
876
"extended_timeout": "PT15M",
878
"checker": "fping -q -- %%(host)s",
880
"approval_delay": "PT0S",
881
"approval_duration": "PT1S",
882
"approved_by_default": "True",
887
def config_parser(config):
888
"""Construct a new dict of client settings of this form:
889
{ client_name: {setting_name: value, ...}, ...}
890
with exceptions for any special settings as defined above.
891
NOTE: Must be a pure function. Must return the same result
892
value given the same arguments.
895
for client_name in config.sections():
896
section = dict(config.items(client_name))
897
client = settings[client_name] = {}
899
client["host"] = section["host"]
900
# Reformat values from string types to Python types
901
client["approved_by_default"] = config.getboolean(
902
client_name, "approved_by_default")
903
client["enabled"] = config.getboolean(client_name,
906
# Uppercase and remove spaces from key_id and fingerprint
907
# for later comparison purposes with return value from the
908
# key_id() and fingerprint() functions
909
client["key_id"] = (section.get("key_id", "").upper()
911
client["fingerprint"] = (section["fingerprint"].upper()
913
if "secret" in section:
914
client["secret"] = codecs.decode(section["secret"]
917
elif "secfile" in section:
918
with open(os.path.expanduser(os.path.expandvars
919
(section["secfile"])),
921
client["secret"] = secfile.read()
923
raise TypeError("No secret or secfile for section {}"
925
client["timeout"] = string_to_delta(section["timeout"])
926
client["extended_timeout"] = string_to_delta(
927
section["extended_timeout"])
928
client["interval"] = string_to_delta(section["interval"])
929
client["approval_delay"] = string_to_delta(
930
section["approval_delay"])
931
client["approval_duration"] = string_to_delta(
932
section["approval_duration"])
933
client["checker_command"] = section["checker"]
934
client["last_approval_request"] = None
935
client["last_checked_ok"] = None
936
client["last_checker_status"] = -2
940
def __init__(self, settings, name=None, server_settings=None):
267
def _timedelta_to_milliseconds(td):
268
"Convert a datetime.timedelta() to milliseconds"
269
return ((td.days * 24 * 60 * 60 * 1000)
270
+ (td.seconds * 1000)
271
+ (td.microseconds // 1000))
273
def timeout_milliseconds(self):
274
"Return the 'timeout' attribute in milliseconds"
275
return self._timedelta_to_milliseconds(self.timeout)
277
def interval_milliseconds(self):
278
"Return the 'interval' attribute in milliseconds"
279
return self._timedelta_to_milliseconds(self.interval)
281
def approved_delay_milliseconds(self):
282
return self._timedelta_to_milliseconds(self.approved_delay)
284
def __init__(self, name = None, disable_hook=None, config=None):
285
"""Note: the 'checker' key in 'config' sets the
286
'checker_command' attribute and *not* the 'checker'
942
if server_settings is None:
944
self.server_settings = server_settings
945
# adding all client settings
946
for setting, value in settings.items():
947
setattr(self, setting, value)
950
if not hasattr(self, "last_enabled"):
951
self.last_enabled = datetime.datetime.utcnow()
952
if not hasattr(self, "expires"):
953
self.expires = (datetime.datetime.utcnow()
291
logger.debug(u"Creating client %r", self.name)
292
# Uppercase and remove spaces from fingerprint for later
293
# comparison purposes with return value from the fingerprint()
295
self.fingerprint = (config[u"fingerprint"].upper()
297
logger.debug(u" Fingerprint: %s", self.fingerprint)
298
if u"secret" in config:
299
self.secret = config[u"secret"].decode(u"base64")
300
elif u"secfile" in config:
301
with open(os.path.expanduser(os.path.expandvars
302
(config[u"secfile"])),
304
self.secret = secfile.read()
956
self.last_enabled = None
959
logger.debug("Creating client %r", self.name)
960
logger.debug(" Key ID: %s", self.key_id)
961
logger.debug(" Fingerprint: %s", self.fingerprint)
962
self.created = settings.get("created",
963
datetime.datetime.utcnow())
965
# attributes specific for this server instance
306
#XXX Need to allow secret on demand!
307
raise TypeError(u"No secret or secfile for client %s"
309
self.host = config.get(u"host", u"")
310
self.created = datetime.datetime.utcnow()
312
self.last_enabled = None
313
self.last_checked_ok = None
314
self.timeout = string_to_delta(config[u"timeout"])
315
self.interval = string_to_delta(config[u"interval"])
316
self.disable_hook = disable_hook
966
317
self.checker = None
967
318
self.checker_initiator_tag = None
968
319
self.disable_initiator_tag = None
969
320
self.checker_callback_tag = None
321
self.checker_command = config[u"checker"]
970
322
self.current_checker_command = None
323
self.last_connect = None
972
324
self.approvals_pending = 0
973
self.changedstate = multiprocessing_manager.Condition(
974
multiprocessing_manager.Lock())
975
self.client_structure = [attr
976
for attr in self.__dict__.keys()
977
if not attr.startswith("_")]
978
self.client_structure.append("client_structure")
980
for name, t in inspect.getmembers(
981
type(self), lambda obj: isinstance(obj, property)):
982
if not name.startswith("_"):
983
self.client_structure.append(name)
985
# Send notice to process children that client state has changed
325
self._approved = None
326
self.approved_by_default = config.get(u"approved_by_default",
328
self.approved_delay = string_to_delta(
329
config[u"approved_delay"])
330
self.approved_duration = string_to_delta(
331
config[u"approved_duration"])
332
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
986
334
def send_changedstate(self):
987
with self.changedstate:
988
self.changedstate.notify_all()
335
self.changedstate.acquire()
336
self.changedstate.notify_all()
337
self.changedstate.release()
990
339
def enable(self):
991
340
"""Start this client's checker and timeout hooks"""
992
if getattr(self, "enabled", False):
341
if getattr(self, u"enabled", False):
993
342
# Already enabled
995
self.expires = datetime.datetime.utcnow() + self.timeout
344
self.send_changedstate()
997
345
self.last_enabled = datetime.datetime.utcnow()
999
self.send_changedstate()
346
# Schedule a new checker to be started an 'interval' from now,
347
# and every interval from then on.
348
self.checker_initiator_tag = (gobject.timeout_add
349
(self.interval_milliseconds(),
351
# Schedule a disable() when 'timeout' has passed
352
self.disable_initiator_tag = (gobject.timeout_add
353
(self.timeout_milliseconds(),
356
# Also start a new checker *right now*.
1001
359
def disable(self, quiet=True):
1002
360
"""Disable this client."""
1003
361
if not getattr(self, "enabled", False):
1006
logger.info("Disabling client %s", self.name)
1007
if getattr(self, "disable_initiator_tag", None) is not None:
1008
GLib.source_remove(self.disable_initiator_tag)
364
self.send_changedstate()
366
logger.info(u"Disabling client %s", self.name)
367
if getattr(self, u"disable_initiator_tag", False):
368
gobject.source_remove(self.disable_initiator_tag)
1009
369
self.disable_initiator_tag = None
1011
if getattr(self, "checker_initiator_tag", None) is not None:
1012
GLib.source_remove(self.checker_initiator_tag)
370
if getattr(self, u"checker_initiator_tag", False):
371
gobject.source_remove(self.checker_initiator_tag)
1013
372
self.checker_initiator_tag = None
1014
373
self.stop_checker()
374
if self.disable_hook:
375
self.disable_hook(self)
1015
376
self.enabled = False
1017
self.send_changedstate()
1018
# Do not run this again if called by a GLib.timeout_add
377
# Do not run this again if called by a gobject.timeout_add
1021
380
def __del__(self):
381
self.disable_hook = None
1024
def init_checker(self):
1025
# Schedule a new checker to be started an 'interval' from now,
1026
# and every interval from then on.
1027
if self.checker_initiator_tag is not None:
1028
GLib.source_remove(self.checker_initiator_tag)
1029
self.checker_initiator_tag = GLib.timeout_add(
1030
int(self.interval.total_seconds() * 1000),
1032
# Schedule a disable() when 'timeout' has passed
1033
if self.disable_initiator_tag is not None:
1034
GLib.source_remove(self.disable_initiator_tag)
1035
self.disable_initiator_tag = GLib.timeout_add(
1036
int(self.timeout.total_seconds() * 1000), self.disable)
1037
# Also start a new checker *right now*.
1038
self.start_checker()
1040
def checker_callback(self, source, condition, connection,
384
def checker_callback(self, pid, condition, command):
1042
385
"""The checker has completed, so take appropriate actions."""
1043
# Read return code from connection (see call_pipe)
1044
returncode = connection.recv()
1047
386
self.checker_callback_tag = None
1048
387
self.checker = None
1051
self.last_checker_status = returncode
1052
self.last_checker_signal = None
1053
if self.last_checker_status == 0:
1054
logger.info("Checker for %(name)s succeeded",
388
if os.WIFEXITED(condition):
389
exitstatus = os.WEXITSTATUS(condition)
391
logger.info(u"Checker for %(name)s succeeded",
1056
393
self.checked_ok()
1058
logger.info("Checker for %(name)s failed", vars(self))
395
logger.info(u"Checker for %(name)s failed",
1060
self.last_checker_status = -1
1061
self.last_checker_signal = -returncode
1062
logger.warning("Checker for %(name)s crashed?",
398
logger.warning(u"Checker for %(name)s crashed?",
1066
401
def checked_ok(self):
1067
"""Assert that the client has been seen, alive and well."""
402
"""Bump up the timeout for this client.
404
This should only be called when the client has been seen,
1068
407
self.last_checked_ok = datetime.datetime.utcnow()
1069
self.last_checker_status = 0
1070
self.last_checker_signal = None
1073
def bump_timeout(self, timeout=None):
1074
"""Bump up the timeout for this client."""
1076
timeout = self.timeout
1077
if self.disable_initiator_tag is not None:
1078
GLib.source_remove(self.disable_initiator_tag)
1079
self.disable_initiator_tag = None
1080
if getattr(self, "enabled", False):
1081
self.disable_initiator_tag = GLib.timeout_add(
1082
int(timeout.total_seconds() * 1000), self.disable)
1083
self.expires = datetime.datetime.utcnow() + timeout
1085
def need_approval(self):
1086
self.last_approval_request = datetime.datetime.utcnow()
408
gobject.source_remove(self.disable_initiator_tag)
409
self.disable_initiator_tag = (gobject.timeout_add
410
(self.timeout_milliseconds(),
1088
413
def start_checker(self):
1089
414
"""Start a new checker subprocess if one is not running.
1091
416
If a checker already exists, leave it running and do
1093
418
# The reason for not killing a running checker is that if we
1094
# did that, and if a checker (for some reason) started running
1095
# slowly and taking more than 'interval' time, then the client
1096
# would inevitably timeout, since no checker would get a
1097
# chance to run to completion. If we instead leave running
419
# did that, then if a checker (for some reason) started
420
# running slowly and taking more than 'interval' time, the
421
# client would inevitably timeout, since no checker would get
422
# a chance to run to completion. If we instead leave running
1098
423
# checkers alone, the checker would have to take more time
1099
424
# than 'timeout' for the client to be disabled, which is as it
1102
if self.checker is not None and not self.checker.is_alive():
1103
logger.warning("Checker was not alive; joining")
427
# If a checker exists, make sure it is not a zombie
429
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
430
except (AttributeError, OSError), error:
431
if (isinstance(error, OSError)
432
and error.errno != errno.ECHILD):
436
logger.warning(u"Checker was a zombie")
437
gobject.source_remove(self.checker_callback_tag)
438
self.checker_callback(pid, status,
439
self.current_checker_command)
1106
440
# Start a new checker if needed
1107
441
if self.checker is None:
1108
# Escape attributes for the shell
1110
attr: re.escape(str(getattr(self, attr)))
1111
for attr in self.runtime_expansions}
1113
command = self.checker_command % escaped_attrs
1114
except TypeError as error:
1115
logger.error('Could not format string "%s"',
1116
self.checker_command,
1118
return True # Try again later
443
# In case checker_command has exactly one % operator
444
command = self.checker_command % self.host
446
# Escape attributes for the shell
447
escaped_attrs = dict((key,
448
re.escape(unicode(str(val),
452
vars(self).iteritems())
454
command = self.checker_command % escaped_attrs
455
except TypeError, error:
456
logger.error(u'Could not format string "%s":'
457
u' %s', self.checker_command, error)
458
return True # Try again later
1119
459
self.current_checker_command = command
1120
logger.info("Starting checker %r for %s", command,
1122
# We don't need to redirect stdout and stderr, since
1123
# in normal mode, that is already done by daemon(),
1124
# and in debug mode we don't want to. (Stdin is
1125
# always replaced by /dev/null.)
1126
# The exception is when not debugging but nevertheless
1127
# running in the foreground; use the previously
1129
popen_args = {"close_fds": True,
1132
if (not self.server_settings["debug"]
1133
and self.server_settings["foreground"]):
1134
popen_args.update({"stdout": wnull,
1136
pipe = multiprocessing.Pipe(duplex=False)
1137
self.checker = multiprocessing.Process(
1139
args=(pipe[1], subprocess.call, command),
1141
self.checker.start()
1142
self.checker_callback_tag = GLib.io_add_watch(
1143
pipe[0].fileno(), GLib.IO_IN,
1144
self.checker_callback, pipe[0], command)
1145
# Re-run this periodically if run by GLib.timeout_add
461
logger.info(u"Starting checker %r for %s",
463
# We don't need to redirect stdout and stderr, since
464
# in normal mode, that is already done by daemon(),
465
# and in debug mode we don't want to. (Stdin is
466
# always replaced by /dev/null.)
467
self.checker = subprocess.Popen(command,
469
shell=True, cwd=u"/")
470
self.checker_callback_tag = (gobject.child_watch_add
472
self.checker_callback,
474
# The checker may have completed before the gobject
475
# watch was added. Check for this.
476
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
478
gobject.source_remove(self.checker_callback_tag)
479
self.checker_callback(pid, status, command)
480
except OSError, error:
481
logger.error(u"Failed to start subprocess: %s",
483
# Re-run this periodically if run by gobject.timeout_add
1148
486
def stop_checker(self):
1149
487
"""Force the checker process, if any, to stop."""
1150
488
if self.checker_callback_tag:
1151
GLib.source_remove(self.checker_callback_tag)
489
gobject.source_remove(self.checker_callback_tag)
1152
490
self.checker_callback_tag = None
1153
if getattr(self, "checker", None) is None:
491
if getattr(self, u"checker", None) is None:
1155
logger.debug("Stopping checker for %(name)s", vars(self))
1156
self.checker.terminate()
493
logger.debug(u"Stopping checker for %(name)s", vars(self))
495
os.kill(self.checker.pid, signal.SIGTERM)
497
#if self.checker.poll() is None:
498
# os.kill(self.checker.pid, signal.SIGKILL)
499
except OSError, error:
500
if error.errno != errno.ESRCH: # No such process
1157
502
self.checker = None
1160
def dbus_service_property(dbus_interface,
504
def dbus_service_property(dbus_interface, signature=u"v",
505
access=u"readwrite", byte_arrays=False):
1164
506
"""Decorators for marking methods of a DBusObjectWithProperties to
1165
507
become properties on the D-Bus.
1167
509
The decorated method will be called with no arguments by "Get"
1168
510
and with one argument by "Set".
1170
512
The parameters, where they are supported, are the same as
1171
513
dbus.service.method, except there is only "signature", since the
1172
514
type from Get() and the type sent to Set() is the same.
1174
516
# Encoding deeply encoded byte arrays is not supported yet by the
1175
517
# "Set" method, so we fail early here:
1176
if byte_arrays and signature != "ay":
1177
raise ValueError("Byte arrays not supported for non-'ay'"
1178
" signature {!r}".format(signature))
518
if byte_arrays and signature != u"ay":
519
raise ValueError(u"Byte arrays not supported for non-'ay'"
520
u" signature %r" % signature)
1180
521
def decorator(func):
1181
522
func._dbus_is_property = True
1182
523
func._dbus_interface = dbus_interface
1183
524
func._dbus_signature = signature
1184
525
func._dbus_access = access
1185
526
func._dbus_name = func.__name__
1186
if func._dbus_name.endswith("_dbus_property"):
527
if func._dbus_name.endswith(u"_dbus_property"):
1187
528
func._dbus_name = func._dbus_name[:-14]
1188
func._dbus_get_args_options = {'byte_arrays': byte_arrays}
1194
def dbus_interface_annotations(dbus_interface):
1195
"""Decorator for marking functions returning interface annotations
1199
@dbus_interface_annotations("org.example.Interface")
1200
def _foo(self): # Function name does not matter
1201
return {"org.freedesktop.DBus.Deprecated": "true",
1202
"org.freedesktop.DBus.Property.EmitsChangedSignal":
1206
def decorator(func):
1207
func._dbus_is_interface = True
1208
func._dbus_interface = dbus_interface
1209
func._dbus_name = dbus_interface
1215
def dbus_annotations(annotations):
1216
"""Decorator to annotate D-Bus methods, signals or properties
1219
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true",
1220
"org.freedesktop.DBus.Property."
1221
"EmitsChangedSignal": "false"})
1222
@dbus_service_property("org.example.Interface", signature="b",
1224
def Property_dbus_property(self):
1225
return dbus.Boolean(False)
1227
See also the DBusObjectWithAnnotations class.
1230
def decorator(func):
1231
func._dbus_annotations = annotations
529
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
1234
531
return decorator
1237
534
class DBusPropertyException(dbus.exceptions.DBusException):
1238
535
"""A base class for D-Bus property-related exceptions
537
def __unicode__(self):
538
return unicode(str(self))
1243
541
class DBusPropertyAccessException(DBusPropertyException):
1255
class DBusObjectWithAnnotations(dbus.service.Object):
1256
"""A D-Bus object with annotations.
1258
Classes inheriting from this can use the dbus_annotations
1259
decorator to add annotations to methods or signals.
1263
def _is_dbus_thing(thing):
1264
"""Returns a function testing if an attribute is a D-Bus thing
1266
If called like _is_dbus_thing("method") it returns a function
1267
suitable for use as predicate to inspect.getmembers().
1269
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
1272
def _get_all_dbus_things(self, thing):
1273
"""Returns a generator of (name, attribute) pairs
1275
return ((getattr(athing.__get__(self), "_dbus_name", name),
1276
athing.__get__(self))
1277
for cls in self.__class__.__mro__
1279
inspect.getmembers(cls, self._is_dbus_thing(thing)))
1281
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1283
path_keyword='object_path',
1284
connection_keyword='connection')
1285
def Introspect(self, object_path, connection):
1286
"""Overloading of standard D-Bus method.
1288
Inserts annotation tags on methods and signals.
1290
xmlstring = dbus.service.Object.Introspect(self, object_path,
1293
document = xml.dom.minidom.parseString(xmlstring)
1295
for if_tag in document.getElementsByTagName("interface"):
1296
# Add annotation tags
1297
for typ in ("method", "signal"):
1298
for tag in if_tag.getElementsByTagName(typ):
1300
for name, prop in (self.
1301
_get_all_dbus_things(typ)):
1302
if (name == tag.getAttribute("name")
1303
and prop._dbus_interface
1304
== if_tag.getAttribute("name")):
1305
annots.update(getattr(
1306
prop, "_dbus_annotations", {}))
1307
for name, value in annots.items():
1308
ann_tag = document.createElement(
1310
ann_tag.setAttribute("name", name)
1311
ann_tag.setAttribute("value", value)
1312
tag.appendChild(ann_tag)
1313
# Add interface annotation tags
1314
for annotation, value in dict(
1315
itertools.chain.from_iterable(
1316
annotations().items()
1317
for name, annotations
1318
in self._get_all_dbus_things("interface")
1319
if name == if_tag.getAttribute("name")
1321
ann_tag = document.createElement("annotation")
1322
ann_tag.setAttribute("name", annotation)
1323
ann_tag.setAttribute("value", value)
1324
if_tag.appendChild(ann_tag)
1325
# Fix argument name for the Introspect method itself
1326
if (if_tag.getAttribute("name")
1327
== dbus.INTROSPECTABLE_IFACE):
1328
for cn in if_tag.getElementsByTagName("method"):
1329
if cn.getAttribute("name") == "Introspect":
1330
for arg in cn.getElementsByTagName("arg"):
1331
if (arg.getAttribute("direction")
1333
arg.setAttribute("name",
1335
xmlstring = document.toxml("utf-8")
1337
except (AttributeError, xml.dom.DOMException,
1338
xml.parsers.expat.ExpatError) as error:
1339
logger.error("Failed to override Introspection method",
1344
class DBusObjectWithProperties(DBusObjectWithAnnotations):
553
class DBusObjectWithProperties(dbus.service.Object):
1345
554
"""A D-Bus object with properties.
1347
556
Classes inheriting from this can use the dbus_service_property
1348
557
decorator to expose methods as D-Bus properties. It exposes the
1349
558
standard Get(), Set(), and GetAll() methods on the D-Bus.
562
def _is_dbus_property(obj):
563
return getattr(obj, u"_dbus_is_property", False)
565
def _get_all_dbus_properties(self):
566
"""Returns a generator of (name, attribute) pairs
568
return ((prop._dbus_name, prop)
570
inspect.getmembers(self, self._is_dbus_property))
1352
572
def _get_dbus_property(self, interface_name, property_name):
1353
573
"""Returns a bound method if one exists which is a D-Bus
1354
574
property with the specified name and interface.
1356
for cls in self.__class__.__mro__:
1357
for name, value in inspect.getmembers(
1358
cls, self._is_dbus_thing("property")):
1359
if (value._dbus_name == property_name
1360
and value._dbus_interface == interface_name):
1361
return value.__get__(self)
576
for name in (property_name,
577
property_name + u"_dbus_property"):
578
prop = getattr(self, name, None)
580
or not self._is_dbus_property(prop)
581
or prop._dbus_name != property_name
582
or (interface_name and prop._dbus_interface
583
and interface_name != prop._dbus_interface)):
1363
586
# No such property
1364
raise DBusPropertyNotFound("{}:{}.{}".format(
1365
self.dbus_object_path, interface_name, property_name))
1368
def _get_all_interface_names(cls):
1369
"""Get a sequence of all interfaces supported by an object"""
1370
return (name for name in set(getattr(getattr(x, attr),
1371
"_dbus_interface", None)
1372
for x in (inspect.getmro(cls))
1374
if name is not None)
1376
@dbus.service.method(dbus.PROPERTIES_IFACE,
587
raise DBusPropertyNotFound(self.dbus_object_path + u":"
588
+ interface_name + u"."
591
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
1379
593
def Get(self, interface_name, property_name):
1380
594
"""Standard D-Bus property Get() method, see D-Bus standard.
1382
596
prop = self._get_dbus_property(interface_name, property_name)
1383
if prop._dbus_access == "write":
597
if prop._dbus_access == u"write":
1384
598
raise DBusPropertyAccessException(property_name)
1386
if not hasattr(value, "variant_level"):
600
if not hasattr(value, u"variant_level"):
1388
602
return type(value)(value, variant_level=value.variant_level+1)
1390
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
604
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1391
605
def Set(self, interface_name, property_name, value):
1392
606
"""Standard D-Bus property Set() method, see D-Bus standard.
1394
608
prop = self._get_dbus_property(interface_name, property_name)
1395
if prop._dbus_access == "read":
609
if prop._dbus_access == u"read":
1396
610
raise DBusPropertyAccessException(property_name)
1397
if prop._dbus_get_args_options["byte_arrays"]:
611
if prop._dbus_get_args_options[u"byte_arrays"]:
1398
612
# The byte_arrays option is not supported yet on
1399
613
# signatures other than "ay".
1400
if prop._dbus_signature != "ay":
1401
raise ValueError("Byte arrays not supported for non-"
1402
"'ay' signature {!r}"
1403
.format(prop._dbus_signature))
1404
value = dbus.ByteArray(b''.join(chr(byte)
614
if prop._dbus_signature != u"ay":
616
value = dbus.ByteArray(''.join(unichr(byte)
1408
@dbus.service.method(dbus.PROPERTIES_IFACE,
1410
out_signature="a{sv}")
620
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
621
out_signature=u"a{sv}")
1411
622
def GetAll(self, interface_name):
1412
623
"""Standard D-Bus property GetAll() method, see D-Bus
1415
626
Note: Will not include properties with access="write".
1418
for name, prop in self._get_all_dbus_things("property"):
629
for name, prop in self._get_all_dbus_properties():
1419
630
if (interface_name
1420
631
and interface_name != prop._dbus_interface):
1421
632
# Interface non-empty but did not match
1423
634
# Ignore write-only properties
1424
if prop._dbus_access == "write":
635
if prop._dbus_access == u"write":
1427
if not hasattr(value, "variant_level"):
1428
properties[name] = value
638
if not hasattr(value, u"variant_level"):
1430
properties[name] = type(value)(
1431
value, variant_level=value.variant_level + 1)
1432
return dbus.Dictionary(properties, signature="sv")
1434
@dbus.service.signal(dbus.PROPERTIES_IFACE, signature="sa{sv}as")
1435
def PropertiesChanged(self, interface_name, changed_properties,
1436
invalidated_properties):
1437
"""Standard D-Bus PropertiesChanged() signal, see D-Bus
641
all[name] = type(value)(value, variant_level=
642
value.variant_level+1)
643
return dbus.Dictionary(all, signature=u"sv")
1442
645
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1444
647
path_keyword='object_path',
1445
648
connection_keyword='connection')
1446
649
def Introspect(self, object_path, connection):
1447
"""Overloading of standard D-Bus method.
1449
Inserts property tags and interface annotation tags.
650
"""Standard D-Bus method, overloaded to insert property tags.
1451
xmlstring = DBusObjectWithAnnotations.Introspect(self,
652
xmlstring = dbus.service.Object.Introspect(self, object_path,
1455
655
document = xml.dom.minidom.parseString(xmlstring)
1457
656
def make_tag(document, name, prop):
1458
e = document.createElement("property")
1459
e.setAttribute("name", name)
1460
e.setAttribute("type", prop._dbus_signature)
1461
e.setAttribute("access", prop._dbus_access)
657
e = document.createElement(u"property")
658
e.setAttribute(u"name", name)
659
e.setAttribute(u"type", prop._dbus_signature)
660
e.setAttribute(u"access", prop._dbus_access)
1464
for if_tag in document.getElementsByTagName("interface"):
662
for if_tag in document.getElementsByTagName(u"interface"):
1466
663
for tag in (make_tag(document, name, prop)
1468
in self._get_all_dbus_things("property")
665
in self._get_all_dbus_properties()
1469
666
if prop._dbus_interface
1470
== if_tag.getAttribute("name")):
667
== if_tag.getAttribute(u"name")):
1471
668
if_tag.appendChild(tag)
1472
# Add annotation tags for properties
1473
for tag in if_tag.getElementsByTagName("property"):
1475
for name, prop in self._get_all_dbus_things(
1477
if (name == tag.getAttribute("name")
1478
and prop._dbus_interface
1479
== if_tag.getAttribute("name")):
1480
annots.update(getattr(
1481
prop, "_dbus_annotations", {}))
1482
for name, value in annots.items():
1483
ann_tag = document.createElement(
1485
ann_tag.setAttribute("name", name)
1486
ann_tag.setAttribute("value", value)
1487
tag.appendChild(ann_tag)
1488
669
# Add the names to the return values for the
1489
670
# "org.freedesktop.DBus.Properties" methods
1490
if (if_tag.getAttribute("name")
1491
== "org.freedesktop.DBus.Properties"):
1492
for cn in if_tag.getElementsByTagName("method"):
1493
if cn.getAttribute("name") == "Get":
1494
for arg in cn.getElementsByTagName("arg"):
1495
if (arg.getAttribute("direction")
1497
arg.setAttribute("name", "value")
1498
elif cn.getAttribute("name") == "GetAll":
1499
for arg in cn.getElementsByTagName("arg"):
1500
if (arg.getAttribute("direction")
1502
arg.setAttribute("name", "props")
1503
xmlstring = document.toxml("utf-8")
1505
except (AttributeError, xml.dom.DOMException,
1506
xml.parsers.expat.ExpatError) as error:
1507
logger.error("Failed to override Introspection method",
1513
dbus.OBJECT_MANAGER_IFACE
1514
except AttributeError:
1515
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1518
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1519
"""A D-Bus object with an ObjectManager.
1521
Classes inheriting from this exposes the standard
1522
GetManagedObjects call and the InterfacesAdded and
1523
InterfacesRemoved signals on the standard
1524
"org.freedesktop.DBus.ObjectManager" interface.
1526
Note: No signals are sent automatically; they must be sent
1529
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1530
out_signature="a{oa{sa{sv}}}")
1531
def GetManagedObjects(self):
1532
"""This function must be overridden"""
1533
raise NotImplementedError()
1535
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1536
signature="oa{sa{sv}}")
1537
def InterfacesAdded(self, object_path, interfaces_and_properties):
1540
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1541
def InterfacesRemoved(self, object_path, interfaces):
1544
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1546
path_keyword='object_path',
1547
connection_keyword='connection')
1548
def Introspect(self, object_path, connection):
1549
"""Overloading of standard D-Bus method.
1551
Override return argument name of GetManagedObjects to be
1552
"objpath_interfaces_and_properties"
1554
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1558
document = xml.dom.minidom.parseString(xmlstring)
1560
for if_tag in document.getElementsByTagName("interface"):
1561
# Fix argument name for the GetManagedObjects method
1562
if (if_tag.getAttribute("name")
1563
== dbus.OBJECT_MANAGER_IFACE):
1564
for cn in if_tag.getElementsByTagName("method"):
1565
if (cn.getAttribute("name")
1566
== "GetManagedObjects"):
1567
for arg in cn.getElementsByTagName("arg"):
1568
if (arg.getAttribute("direction")
1572
"objpath_interfaces"
1574
xmlstring = document.toxml("utf-8")
1576
except (AttributeError, xml.dom.DOMException,
1577
xml.parsers.expat.ExpatError) as error:
1578
logger.error("Failed to override Introspection method",
1583
def datetime_to_dbus(dt, variant_level=0):
1584
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1586
return dbus.String("", variant_level=variant_level)
1587
return dbus.String(dt.isoformat(), variant_level=variant_level)
1590
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1591
"""A class decorator; applied to a subclass of
1592
dbus.service.Object, it will add alternate D-Bus attributes with
1593
interface names according to the "alt_interface_names" mapping.
1596
@alternate_dbus_interfaces({"org.example.Interface":
1597
"net.example.AlternateInterface"})
1598
class SampleDBusObject(dbus.service.Object):
1599
@dbus.service.method("org.example.Interface")
1600
def SampleDBusMethod():
1603
The above "SampleDBusMethod" on "SampleDBusObject" will be
1604
reachable via two interfaces: "org.example.Interface" and
1605
"net.example.AlternateInterface", the latter of which will have
1606
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1607
"true", unless "deprecate" is passed with a False value.
1609
This works for methods and signals, and also for D-Bus properties
1610
(from DBusObjectWithProperties) and interfaces (from the
1611
dbus_interface_annotations decorator).
1615
for orig_interface_name, alt_interface_name in (
1616
alt_interface_names.items()):
1618
interface_names = set()
1619
# Go though all attributes of the class
1620
for attrname, attribute in inspect.getmembers(cls):
1621
# Ignore non-D-Bus attributes, and D-Bus attributes
1622
# with the wrong interface name
1623
if (not hasattr(attribute, "_dbus_interface")
1624
or not attribute._dbus_interface.startswith(
1625
orig_interface_name)):
1627
# Create an alternate D-Bus interface name based on
1629
alt_interface = attribute._dbus_interface.replace(
1630
orig_interface_name, alt_interface_name)
1631
interface_names.add(alt_interface)
1632
# Is this a D-Bus signal?
1633
if getattr(attribute, "_dbus_is_signal", False):
1634
# Extract the original non-method undecorated
1635
# function by black magic
1636
if sys.version_info.major == 2:
1637
nonmethod_func = (dict(
1638
zip(attribute.func_code.co_freevars,
1639
attribute.__closure__))
1640
["func"].cell_contents)
1642
nonmethod_func = (dict(
1643
zip(attribute.__code__.co_freevars,
1644
attribute.__closure__))
1645
["func"].cell_contents)
1646
# Create a new, but exactly alike, function
1647
# object, and decorate it to be a new D-Bus signal
1648
# with the alternate D-Bus interface name
1649
new_function = copy_function(nonmethod_func)
1650
new_function = (dbus.service.signal(
1652
attribute._dbus_signature)(new_function))
1653
# Copy annotations, if any
1655
new_function._dbus_annotations = dict(
1656
attribute._dbus_annotations)
1657
except AttributeError:
1660
# Define a creator of a function to call both the
1661
# original and alternate functions, so both the
1662
# original and alternate signals gets sent when
1663
# the function is called
1664
def fixscope(func1, func2):
1665
"""This function is a scope container to pass
1666
func1 and func2 to the "call_both" function
1667
outside of its arguments"""
1669
@functools.wraps(func2)
1670
def call_both(*args, **kwargs):
1671
"""This function will emit two D-Bus
1672
signals by calling func1 and func2"""
1673
func1(*args, **kwargs)
1674
func2(*args, **kwargs)
1675
# Make wrapper function look like a D-Bus
1677
for name, attr in inspect.getmembers(func2):
1678
if name.startswith("_dbus_"):
1679
setattr(call_both, name, attr)
1682
# Create the "call_both" function and add it to
1684
attr[attrname] = fixscope(attribute, new_function)
1685
# Is this a D-Bus method?
1686
elif getattr(attribute, "_dbus_is_method", False):
1687
# Create a new, but exactly alike, function
1688
# object. Decorate it to be a new D-Bus method
1689
# with the alternate D-Bus interface name. Add it
1692
dbus.service.method(
1694
attribute._dbus_in_signature,
1695
attribute._dbus_out_signature)
1696
(copy_function(attribute)))
1697
# Copy annotations, if any
1699
attr[attrname]._dbus_annotations = dict(
1700
attribute._dbus_annotations)
1701
except AttributeError:
1703
# Is this a D-Bus property?
1704
elif getattr(attribute, "_dbus_is_property", False):
1705
# Create a new, but exactly alike, function
1706
# object, and decorate it to be a new D-Bus
1707
# property with the alternate D-Bus interface
1708
# name. Add it to the class.
1709
attr[attrname] = (dbus_service_property(
1710
alt_interface, attribute._dbus_signature,
1711
attribute._dbus_access,
1712
attribute._dbus_get_args_options
1714
(copy_function(attribute)))
1715
# Copy annotations, if any
1717
attr[attrname]._dbus_annotations = dict(
1718
attribute._dbus_annotations)
1719
except AttributeError:
1721
# Is this a D-Bus interface?
1722
elif getattr(attribute, "_dbus_is_interface", False):
1723
# Create a new, but exactly alike, function
1724
# object. Decorate it to be a new D-Bus interface
1725
# with the alternate D-Bus interface name. Add it
1728
dbus_interface_annotations(alt_interface)
1729
(copy_function(attribute)))
1731
# Deprecate all alternate interfaces
1732
iname = "_AlternateDBusNames_interface_annotation{}"
1733
for interface_name in interface_names:
1735
@dbus_interface_annotations(interface_name)
1737
return {"org.freedesktop.DBus.Deprecated":
1739
# Find an unused name
1740
for aname in (iname.format(i)
1741
for i in itertools.count()):
1742
if aname not in attr:
1746
# Replace the class with a new subclass of it with
1747
# methods, signals, etc. as created above.
1748
if sys.version_info.major == 2:
1749
cls = type(b"{}Alternate".format(cls.__name__),
1752
cls = type("{}Alternate".format(cls.__name__),
1759
@alternate_dbus_interfaces({"se.recompile.Mandos":
1760
"se.bsnet.fukt.Mandos"})
671
if (if_tag.getAttribute(u"name")
672
== u"org.freedesktop.DBus.Properties"):
673
for cn in if_tag.getElementsByTagName(u"method"):
674
if cn.getAttribute(u"name") == u"Get":
675
for arg in cn.getElementsByTagName(u"arg"):
676
if (arg.getAttribute(u"direction")
678
arg.setAttribute(u"name", u"value")
679
elif cn.getAttribute(u"name") == u"GetAll":
680
for arg in cn.getElementsByTagName(u"arg"):
681
if (arg.getAttribute(u"direction")
683
arg.setAttribute(u"name", u"props")
684
xmlstring = document.toxml(u"utf-8")
686
except (AttributeError, xml.dom.DOMException,
687
xml.parsers.expat.ExpatError), error:
688
logger.error(u"Failed to override Introspection method",
1761
693
class ClientDBus(Client, DBusObjectWithProperties):
1762
694
"""A Client class using D-Bus
1765
697
dbus_object_path: dbus.ObjectPath
1766
698
bus: dbus.SystemBus()
1769
runtime_expansions = (Client.runtime_expansions
1770
+ ("dbus_object_path", ))
1772
_interface = "se.recompile.Mandos.Client"
1774
700
# dbus.service.Object doesn't use super(), so we can't either.
1776
def __init__(self, bus=None, *args, **kwargs):
702
def __init__(self, bus = None, *args, **kwargs):
1778
704
Client.__init__(self, *args, **kwargs)
1779
705
# Only now, when this client is initialized, can it show up on
1781
client_object_name = str(self.name).translate(
1782
{ord("."): ord("_"),
1783
ord("-"): ord("_")})
1784
self.dbus_object_path = dbus.ObjectPath(
1785
"/clients/" + client_object_name)
707
self.dbus_object_path = (dbus.ObjectPath
709
+ self.name.replace(u".", u"_")))
1786
710
DBusObjectWithProperties.__init__(self, self.bus,
1787
711
self.dbus_object_path)
1789
def notifychangeproperty(transform_func, dbus_name,
1790
type_func=lambda x: x,
1792
invalidate_only=False,
1793
_interface=_interface):
1794
""" Modify a variable so that it's a property which announces
1795
its changes to DBus.
1797
transform_fun: Function that takes a value and a variant_level
1798
and transforms it to a D-Bus type.
1799
dbus_name: D-Bus name of the variable
1800
type_func: Function that transform the value before sending it
1801
to the D-Bus. Default: no transform
1802
variant_level: D-Bus variant level. Default: 1
1804
attrname = "_{}".format(dbus_name)
1806
def setter(self, value):
1807
if hasattr(self, "dbus_object_path"):
1808
if (not hasattr(self, attrname) or
1809
type_func(getattr(self, attrname, None))
1810
!= type_func(value)):
1812
self.PropertiesChanged(
1813
_interface, dbus.Dictionary(),
1814
dbus.Array((dbus_name, )))
1816
dbus_value = transform_func(
1818
variant_level=variant_level)
1819
self.PropertyChanged(dbus.String(dbus_name),
1821
self.PropertiesChanged(
1823
dbus.Dictionary({dbus.String(dbus_name):
1826
setattr(self, attrname, value)
1828
return property(lambda self: getattr(self, attrname), setter)
1830
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1831
approvals_pending = notifychangeproperty(dbus.Boolean,
1834
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1835
last_enabled = notifychangeproperty(datetime_to_dbus,
1837
checker = notifychangeproperty(
1838
dbus.Boolean, "CheckerRunning",
1839
type_func=lambda checker: checker is not None)
1840
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1842
last_checker_status = notifychangeproperty(dbus.Int16,
1843
"LastCheckerStatus")
1844
last_approval_request = notifychangeproperty(
1845
datetime_to_dbus, "LastApprovalRequest")
1846
approved_by_default = notifychangeproperty(dbus.Boolean,
1847
"ApprovedByDefault")
1848
approval_delay = notifychangeproperty(
1849
dbus.UInt64, "ApprovalDelay",
1850
type_func=lambda td: td.total_seconds() * 1000)
1851
approval_duration = notifychangeproperty(
1852
dbus.UInt64, "ApprovalDuration",
1853
type_func=lambda td: td.total_seconds() * 1000)
1854
host = notifychangeproperty(dbus.String, "Host")
1855
timeout = notifychangeproperty(
1856
dbus.UInt64, "Timeout",
1857
type_func=lambda td: td.total_seconds() * 1000)
1858
extended_timeout = notifychangeproperty(
1859
dbus.UInt64, "ExtendedTimeout",
1860
type_func=lambda td: td.total_seconds() * 1000)
1861
interval = notifychangeproperty(
1862
dbus.UInt64, "Interval",
1863
type_func=lambda td: td.total_seconds() * 1000)
1864
checker_command = notifychangeproperty(dbus.String, "Checker")
1865
secret = notifychangeproperty(dbus.ByteArray, "Secret",
1866
invalidate_only=True)
1868
del notifychangeproperty
714
def _datetime_to_dbus(dt, variant_level=0):
715
"""Convert a UTC datetime.datetime() to a D-Bus type."""
716
return dbus.String(dt.isoformat(),
717
variant_level=variant_level)
720
oldstate = getattr(self, u"enabled", False)
721
r = Client.enable(self)
722
if oldstate != self.enabled:
724
self.PropertyChanged(dbus.String(u"enabled"),
725
dbus.Boolean(True, variant_level=1))
726
self.PropertyChanged(
727
dbus.String(u"last_enabled"),
728
self._datetime_to_dbus(self.last_enabled,
732
def disable(self, quiet = False):
733
oldstate = getattr(self, u"enabled", False)
734
r = Client.disable(self, quiet=quiet)
735
if not quiet and oldstate != self.enabled:
737
self.PropertyChanged(dbus.String(u"enabled"),
738
dbus.Boolean(False, variant_level=1))
1870
741
def __del__(self, *args, **kwargs):
1872
743
self.remove_from_connection()
1873
744
except LookupError:
1875
if hasattr(DBusObjectWithProperties, "__del__"):
746
if hasattr(DBusObjectWithProperties, u"__del__"):
1876
747
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1877
748
Client.__del__(self, *args, **kwargs)
1879
def checker_callback(self, source, condition,
1880
connection, command, *args, **kwargs):
1881
ret = Client.checker_callback(self, source, condition,
1882
connection, command, *args,
1884
exitstatus = self.last_checker_status
750
def checker_callback(self, pid, condition, command,
752
self.checker_callback_tag = None
755
self.PropertyChanged(dbus.String(u"checker_running"),
756
dbus.Boolean(False, variant_level=1))
757
if os.WIFEXITED(condition):
758
exitstatus = os.WEXITSTATUS(condition)
1886
759
# Emit D-Bus signal
1887
760
self.CheckerCompleted(dbus.Int16(exitstatus),
1888
# This is specific to GNU libC
1889
dbus.Int64(exitstatus << 8),
761
dbus.Int64(condition),
1890
762
dbus.String(command))
1892
764
# Emit D-Bus signal
1893
765
self.CheckerCompleted(dbus.Int16(-1),
1895
# This is specific to GNU libC
1897
| self.last_checker_signal),
766
dbus.Int64(condition),
1898
767
dbus.String(command))
769
return Client.checker_callback(self, pid, condition, command,
772
def checked_ok(self, *args, **kwargs):
773
r = Client.checked_ok(self, *args, **kwargs)
775
self.PropertyChanged(
776
dbus.String(u"last_checked_ok"),
777
(self._datetime_to_dbus(self.last_checked_ok,
1901
781
def start_checker(self, *args, **kwargs):
1902
old_checker_pid = getattr(self.checker, "pid", None)
782
old_checker = self.checker
783
if self.checker is not None:
784
old_checker_pid = self.checker.pid
786
old_checker_pid = None
1903
787
r = Client.start_checker(self, *args, **kwargs)
1904
788
# Only if new checker process was started
1905
789
if (self.checker is not None
1906
790
and old_checker_pid != self.checker.pid):
1907
791
# Emit D-Bus signal
1908
792
self.CheckerStarted(self.current_checker_command)
793
self.PropertyChanged(
794
dbus.String(u"checker_running"),
795
dbus.Boolean(True, variant_level=1))
798
def stop_checker(self, *args, **kwargs):
799
old_checker = getattr(self, u"checker", None)
800
r = Client.stop_checker(self, *args, **kwargs)
801
if (old_checker is not None
802
and getattr(self, u"checker", None) is None):
803
self.PropertyChanged(dbus.String(u"checker_running"),
804
dbus.Boolean(False, variant_level=1))
1911
807
def _reset_approved(self):
1912
self.approved = None
808
self._approved = None
1915
811
def approve(self, value=True):
1916
self.approved = value
1917
GLib.timeout_add(int(self.approval_duration.total_seconds()
1918
* 1000), self._reset_approved)
1919
self.send_changedstate()
1921
# D-Bus methods, signals & properties
812
self._approved = value
813
gobject.timeout_add(self._timedelta_to_milliseconds(self.approved_duration, self._reset_approved))
815
def approved_pending(self):
816
return self.approvals_pending > 0
819
## D-Bus methods, signals & properties
820
_interface = u"se.bsnet.fukt.Mandos.Client"
1927
824
# CheckerCompleted - signal
1928
@dbus.service.signal(_interface, signature="nxs")
825
@dbus.service.signal(_interface, signature=u"nxs")
1929
826
def CheckerCompleted(self, exitcode, waitstatus, command):
1933
830
# CheckerStarted - signal
1934
@dbus.service.signal(_interface, signature="s")
831
@dbus.service.signal(_interface, signature=u"s")
1935
832
def CheckerStarted(self, command):
1939
836
# PropertyChanged - signal
1940
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1941
@dbus.service.signal(_interface, signature="sv")
837
@dbus.service.signal(_interface, signature=u"sv")
1942
838
def PropertyChanged(self, property, value):
1946
842
# GotSecret - signal
1947
843
@dbus.service.signal(_interface)
1948
844
def GotSecret(self):
1950
Is sent after a successful transfer of secret from the Mandos
1951
server to mandos-client
1955
848
# Rejected - signal
1956
@dbus.service.signal(_interface, signature="s")
849
@dbus.service.signal(_interface, signature=u"s")
1957
850
def Rejected(self, reason):
1961
854
# NeedApproval - signal
1962
@dbus.service.signal(_interface, signature="tb")
855
@dbus.service.signal(_interface, signature=u"db")
1963
856
def NeedApproval(self, timeout, default):
1965
return self.need_approval()
1969
862
# Approve - method
1970
@dbus.service.method(_interface, in_signature="b")
863
@dbus.service.method(_interface, in_signature=u"b")
1971
864
def Approve(self, value):
1972
865
self.approve(value)
1974
867
# CheckedOK - method
1975
868
@dbus.service.method(_interface)
1976
869
def CheckedOK(self):
870
return self.checked_ok()
1979
872
# Enable - method
1980
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1981
873
@dbus.service.method(_interface)
1982
874
def Enable(self):
1986
878
# StartChecker - method
1987
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1988
879
@dbus.service.method(_interface)
1989
880
def StartChecker(self):
1991
882
self.start_checker()
1993
884
# Disable - method
1994
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1995
885
@dbus.service.method(_interface)
1996
886
def Disable(self):
2000
890
# StopChecker - method
2001
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
2002
891
@dbus.service.method(_interface)
2003
892
def StopChecker(self):
2004
893
self.stop_checker()
2008
# ApprovalPending - property
2009
@dbus_service_property(_interface, signature="b", access="read")
2010
def ApprovalPending_dbus_property(self):
2011
return dbus.Boolean(bool(self.approvals_pending))
2013
# ApprovedByDefault - property
2014
@dbus_service_property(_interface,
2017
def ApprovedByDefault_dbus_property(self, value=None):
2018
if value is None: # get
2019
return dbus.Boolean(self.approved_by_default)
2020
self.approved_by_default = bool(value)
2022
# ApprovalDelay - property
2023
@dbus_service_property(_interface,
2026
def ApprovalDelay_dbus_property(self, value=None):
2027
if value is None: # get
2028
return dbus.UInt64(self.approval_delay.total_seconds()
2030
self.approval_delay = datetime.timedelta(0, 0, 0, value)
2032
# ApprovalDuration - property
2033
@dbus_service_property(_interface,
2036
def ApprovalDuration_dbus_property(self, value=None):
2037
if value is None: # get
2038
return dbus.UInt64(self.approval_duration.total_seconds()
2040
self.approval_duration = datetime.timedelta(0, 0, 0, value)
2044
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2045
@dbus_service_property(_interface, signature="s", access="read")
2046
def Name_dbus_property(self):
897
# approved_pending - property
898
@dbus_service_property(_interface, signature=u"b", access=u"read")
899
def approved_pending_dbus_property(self):
900
return dbus.Boolean(self.approved_pending())
902
# approved_by_default - property
903
@dbus_service_property(_interface, signature=u"b",
905
def approved_by_default_dbus_property(self):
906
return dbus.Boolean(self.approved_by_default)
908
# approved_delay - property
909
@dbus_service_property(_interface, signature=u"t",
911
def approved_delay_dbus_property(self):
912
return dbus.UInt64(self.approved_delay_milliseconds())
914
# approved_duration - property
915
@dbus_service_property(_interface, signature=u"t",
917
def approved_duration_dbus_property(self):
918
return dbus.UInt64(self._timedelta_to_milliseconds(
919
self.approved_duration))
922
@dbus_service_property(_interface, signature=u"s", access=u"read")
923
def name_dbus_property(self):
2047
924
return dbus.String(self.name)
2051
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2052
@dbus_service_property(_interface, signature="s", access="read")
2053
def KeyID_dbus_property(self):
2054
return dbus.String(self.key_id)
2056
# Fingerprint - property
2058
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2059
@dbus_service_property(_interface, signature="s", access="read")
2060
def Fingerprint_dbus_property(self):
926
# fingerprint - property
927
@dbus_service_property(_interface, signature=u"s", access=u"read")
928
def fingerprint_dbus_property(self):
2061
929
return dbus.String(self.fingerprint)
2064
@dbus_service_property(_interface,
2067
def Host_dbus_property(self, value=None):
932
@dbus_service_property(_interface, signature=u"s",
934
def host_dbus_property(self, value=None):
2068
935
if value is None: # get
2069
936
return dbus.String(self.host)
2070
self.host = str(value)
2072
# Created - property
2074
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const"})
2075
@dbus_service_property(_interface, signature="s", access="read")
2076
def Created_dbus_property(self):
2077
return datetime_to_dbus(self.created)
2079
# LastEnabled - property
2080
@dbus_service_property(_interface, signature="s", access="read")
2081
def LastEnabled_dbus_property(self):
2082
return datetime_to_dbus(self.last_enabled)
2084
# Enabled - property
2085
@dbus_service_property(_interface,
2088
def Enabled_dbus_property(self, value=None):
939
self.PropertyChanged(dbus.String(u"host"),
940
dbus.String(value, variant_level=1))
943
@dbus_service_property(_interface, signature=u"s", access=u"read")
944
def created_dbus_property(self):
945
return dbus.String(self._datetime_to_dbus(self.created))
947
# last_enabled - property
948
@dbus_service_property(_interface, signature=u"s", access=u"read")
949
def last_enabled_dbus_property(self):
950
if self.last_enabled is None:
951
return dbus.String(u"")
952
return dbus.String(self._datetime_to_dbus(self.last_enabled))
955
@dbus_service_property(_interface, signature=u"b",
957
def enabled_dbus_property(self, value=None):
2089
958
if value is None: # get
2090
959
return dbus.Boolean(self.enabled)
2096
# LastCheckedOK - property
2097
@dbus_service_property(_interface,
2100
def LastCheckedOK_dbus_property(self, value=None):
965
# last_checked_ok - property
966
@dbus_service_property(_interface, signature=u"s",
968
def last_checked_ok_dbus_property(self, value=None):
2101
969
if value is not None:
2102
970
self.checked_ok()
2104
return datetime_to_dbus(self.last_checked_ok)
2106
# LastCheckerStatus - property
2107
@dbus_service_property(_interface, signature="n", access="read")
2108
def LastCheckerStatus_dbus_property(self):
2109
return dbus.Int16(self.last_checker_status)
2111
# Expires - property
2112
@dbus_service_property(_interface, signature="s", access="read")
2113
def Expires_dbus_property(self):
2114
return datetime_to_dbus(self.expires)
2116
# LastApprovalRequest - property
2117
@dbus_service_property(_interface, signature="s", access="read")
2118
def LastApprovalRequest_dbus_property(self):
2119
return datetime_to_dbus(self.last_approval_request)
2121
# Timeout - property
2122
@dbus_service_property(_interface,
2125
def Timeout_dbus_property(self, value=None):
972
if self.last_checked_ok is None:
973
return dbus.String(u"")
974
return dbus.String(self._datetime_to_dbus(self
978
@dbus_service_property(_interface, signature=u"t",
980
def timeout_dbus_property(self, value=None):
2126
981
if value is None: # get
2127
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2128
old_timeout = self.timeout
982
return dbus.UInt64(self.timeout_milliseconds())
2129
983
self.timeout = datetime.timedelta(0, 0, 0, value)
2130
# Reschedule disabling
2132
now = datetime.datetime.utcnow()
2133
self.expires += self.timeout - old_timeout
2134
if self.expires <= now:
2135
# The timeout has passed
2138
if (getattr(self, "disable_initiator_tag", None)
2141
GLib.source_remove(self.disable_initiator_tag)
2142
self.disable_initiator_tag = GLib.timeout_add(
2143
int((self.expires - now).total_seconds() * 1000),
2146
# ExtendedTimeout - property
2147
@dbus_service_property(_interface,
2150
def ExtendedTimeout_dbus_property(self, value=None):
2151
if value is None: # get
2152
return dbus.UInt64(self.extended_timeout.total_seconds()
2154
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
2156
# Interval - property
2157
@dbus_service_property(_interface,
2160
def Interval_dbus_property(self, value=None):
2161
if value is None: # get
2162
return dbus.UInt64(self.interval.total_seconds() * 1000)
985
self.PropertyChanged(dbus.String(u"timeout"),
986
dbus.UInt64(value, variant_level=1))
987
if getattr(self, u"disable_initiator_tag", None) is None:
990
gobject.source_remove(self.disable_initiator_tag)
991
self.disable_initiator_tag = None
993
_timedelta_to_milliseconds((self
999
# The timeout has passed
1002
self.disable_initiator_tag = (gobject.timeout_add
1003
(time_to_die, self.disable))
1005
# interval - property
1006
@dbus_service_property(_interface, signature=u"t",
1007
access=u"readwrite")
1008
def interval_dbus_property(self, value=None):
1009
if value is None: # get
1010
return dbus.UInt64(self.interval_milliseconds())
2163
1011
self.interval = datetime.timedelta(0, 0, 0, value)
2164
if getattr(self, "checker_initiator_tag", None) is None:
1013
self.PropertyChanged(dbus.String(u"interval"),
1014
dbus.UInt64(value, variant_level=1))
1015
if getattr(self, u"checker_initiator_tag", None) is None:
2167
# Reschedule checker run
2168
GLib.source_remove(self.checker_initiator_tag)
2169
self.checker_initiator_tag = GLib.timeout_add(
2170
value, self.start_checker)
2171
self.start_checker() # Start one now, too
1017
# Reschedule checker run
1018
gobject.source_remove(self.checker_initiator_tag)
1019
self.checker_initiator_tag = (gobject.timeout_add
1020
(value, self.start_checker))
1021
self.start_checker() # Start one now, too
2173
# Checker - property
2174
@dbus_service_property(_interface,
2177
def Checker_dbus_property(self, value=None):
1023
# checker - property
1024
@dbus_service_property(_interface, signature=u"s",
1025
access=u"readwrite")
1026
def checker_dbus_property(self, value=None):
2178
1027
if value is None: # get
2179
1028
return dbus.String(self.checker_command)
2180
self.checker_command = str(value)
2182
# CheckerRunning - property
2183
@dbus_service_property(_interface,
2186
def CheckerRunning_dbus_property(self, value=None):
1029
self.checker_command = value
1031
self.PropertyChanged(dbus.String(u"checker"),
1032
dbus.String(self.checker_command,
1035
# checker_running - property
1036
@dbus_service_property(_interface, signature=u"b",
1037
access=u"readwrite")
1038
def checker_running_dbus_property(self, value=None):
2187
1039
if value is None: # get
2188
1040
return dbus.Boolean(self.checker is not None)
2190
1042
self.start_checker()
2192
1044
self.stop_checker()
2194
# ObjectPath - property
2196
{"org.freedesktop.DBus.Property.EmitsChangedSignal": "const",
2197
"org.freedesktop.DBus.Deprecated": "true"})
2198
@dbus_service_property(_interface, signature="o", access="read")
2199
def ObjectPath_dbus_property(self):
2200
return self.dbus_object_path # is already a dbus.ObjectPath
2204
{"org.freedesktop.DBus.Property.EmitsChangedSignal":
2206
@dbus_service_property(_interface,
2210
def Secret_dbus_property(self, value):
2211
self.secret = bytes(value)
1046
# object_path - property
1047
@dbus_service_property(_interface, signature=u"o", access=u"read")
1048
def object_path_dbus_property(self):
1049
return self.dbus_object_path # is already a dbus.ObjectPath
1052
@dbus_service_property(_interface, signature=u"ay",
1053
access=u"write", byte_arrays=True)
1054
def secret_dbus_property(self, value):
1055
self.secret = str(value)
2216
1060
class ProxyClient(object):
2217
def __init__(self, child_pipe, key_id, fpr, address):
1061
def __init__(self, child_pipe, fpr, address):
2218
1062
self._pipe = child_pipe
2219
self._pipe.send(('init', key_id, fpr, address))
1063
self._pipe.send(('init', fpr, address))
2220
1064
if not self._pipe.recv():
2221
raise KeyError(key_id or fpr)
2223
1067
def __getattribute__(self, name):
1068
if(name == '_pipe'):
2225
1069
return super(ProxyClient, self).__getattribute__(name)
2226
1070
self._pipe.send(('getattr', name))
2227
1071
data = self._pipe.recv()
2228
1072
if data[0] == 'data':
2230
1074
if data[0] == 'function':
2232
1075
def func(*args, **kwargs):
2233
1076
self._pipe.send(('funcall', name, args, kwargs))
2234
1077
return self._pipe.recv()[1]
2238
1080
def __setattr__(self, name, value):
1081
if(name == '_pipe'):
2240
1082
return super(ProxyClient, self).__setattr__(name, value)
2241
1083
self._pipe.send(('setattr', name, value))
2244
1086
class ClientHandler(socketserver.BaseRequestHandler, object):
2245
1087
"""A class to handle client connections.
2247
1089
Instantiated once for each connection to handle it.
2248
1090
Note: This will run in its own forked process."""
2250
1092
def handle(self):
2251
1093
with contextlib.closing(self.server.child_pipe) as child_pipe:
2252
logger.info("TCP connection from: %s",
2253
str(self.client_address))
2254
logger.debug("Pipe FD: %d",
1094
logger.info(u"TCP connection from: %s",
1095
unicode(self.client_address))
1096
logger.debug(u"Pipe FD: %d",
2255
1097
self.server.child_pipe.fileno())
2257
session = gnutls.ClientSession(self.request)
2259
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2260
# "+AES-256-CBC", "+SHA1",
2261
# "+COMP-NULL", "+CTYPE-OPENPGP",
1099
session = (gnutls.connection
1100
.ClientSession(self.request,
1102
.X509Credentials()))
1104
# Note: gnutls.connection.X509Credentials is really a
1105
# generic GnuTLS certificate credentials object so long as
1106
# no X.509 keys are added to it. Therefore, we can use it
1107
# here despite using OpenPGP certificates.
1109
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1110
# u"+AES-256-CBC", u"+SHA1",
1111
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
2263
1113
# Use a fallback default, since this MUST be set.
2264
1114
priority = self.server.gnutls_priority
2265
1115
if priority is None:
2267
gnutls.priority_set_direct(session._c_object,
2268
priority.encode("utf-8"),
1116
priority = u"NORMAL"
1117
(gnutls.library.functions
1118
.gnutls_priority_set_direct(session._c_object,
2271
1121
# Start communication using the Mandos protocol
2272
1122
# Get protocol number
2273
1123
line = self.request.makefile().readline()
2274
logger.debug("Protocol version: %r", line)
1124
logger.debug(u"Protocol version: %r", line)
2276
1126
if int(line.strip().split()[0]) > 1:
2277
raise RuntimeError(line)
2278
except (ValueError, IndexError, RuntimeError) as error:
2279
logger.error("Unknown protocol version: %s", error)
1128
except (ValueError, IndexError, RuntimeError), error:
1129
logger.error(u"Unknown protocol version: %s", error)
2282
1132
# Start GnuTLS connection
2284
1134
session.handshake()
2285
except gnutls.Error as error:
2286
logger.warning("Handshake failed: %s", error)
1135
except gnutls.errors.GNUTLSError, error:
1136
logger.warning(u"Handshake failed: %s", error)
2287
1137
# Do not run session.bye() here: the session is not
2288
1138
# established. Just abandon the request.
2290
logger.debug("Handshake succeeded")
1140
logger.debug(u"Handshake succeeded")
2292
1142
approval_required = False
2294
if gnutls.has_rawpk:
2297
key_id = self.key_id(
2298
self.peer_certificate(session))
2299
except (TypeError, gnutls.Error) as error:
2300
logger.warning("Bad certificate: %s", error)
2302
logger.debug("Key ID: %s", key_id)
2307
fpr = self.fingerprint(
2308
self.peer_certificate(session))
2309
except (TypeError, gnutls.Error) as error:
2310
logger.warning("Bad certificate: %s", error)
2312
logger.debug("Fingerprint: %s", fpr)
2315
client = ProxyClient(child_pipe, key_id, fpr,
1145
fpr = self.fingerprint(self.peer_certificate
1147
except (TypeError, gnutls.errors.GNUTLSError), error:
1148
logger.warning(u"Bad certificate: %s", error)
1150
logger.debug(u"Fingerprint: %s", fpr)
1153
client = ProxyClient(child_pipe, fpr,
2316
1154
self.client_address)
2317
1155
except KeyError:
2320
if client.approval_delay:
2321
delay = client.approval_delay
1158
if client.approved_delay:
1159
delay = client.approved_delay
2322
1160
client.approvals_pending += 1
2323
1161
approval_required = True
2326
1164
if not client.enabled:
2327
logger.info("Client %s is disabled",
1165
logger.warning(u"Client %s is disabled",
2329
1167
if self.server.use_dbus:
2330
1168
# Emit D-Bus signal
2331
client.Rejected("Disabled")
1169
client.Rejected("Disabled")
2334
if client.approved or not client.approval_delay:
2335
# We are approved or approval is disabled
1172
if client._approved or not client.approved_delay:
1173
#We are approved or approval is disabled
2337
elif client.approved is None:
2338
logger.info("Client %s needs approval",
1175
elif client._approved is None:
1176
logger.info(u"Client %s need approval",
2340
1178
if self.server.use_dbus:
2341
1179
# Emit D-Bus signal
2342
1180
client.NeedApproval(
2343
client.approval_delay.total_seconds()
2344
* 1000, client.approved_by_default)
1181
client.approved_delay_milliseconds(),
1182
client.approved_by_default)
2346
logger.warning("Client %s was not approved",
1184
logger.warning(u"Client %s was not approved",
2348
1186
if self.server.use_dbus:
2349
1187
# Emit D-Bus signal
2350
client.Rejected("Denied")
1188
client.Rejected("Disapproved")
2353
# wait until timeout or approved
1191
#wait until timeout or approved
1192
#x = float(client._timedelta_to_milliseconds(delay))
2354
1193
time = datetime.datetime.now()
2355
1194
client.changedstate.acquire()
2356
client.changedstate.wait(delay.total_seconds())
1195
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
2357
1196
client.changedstate.release()
2358
1197
time2 = datetime.datetime.now()
2359
1198
if (time2 - time) >= delay:
2364
1203
if self.server.use_dbus:
2365
1204
# Emit D-Bus signal
2366
client.Rejected("Approval timed out")
1205
client.Rejected("Time out")
2371
1210
delay -= time2 - time
2374
session.send(client.secret)
2375
except gnutls.Error as error:
2376
logger.warning("gnutls send failed",
2380
logger.info("Sending secret to %s", client.name)
2381
# bump the timeout using extended_timeout
2382
client.bump_timeout(client.extended_timeout)
1213
while sent_size < len(client.secret):
1214
# XXX handle session exception
1215
sent = session.send(client.secret[sent_size:])
1216
logger.debug(u"Sent: %d, remaining: %d",
1217
sent, len(client.secret)
1218
- (sent_size + sent))
1221
logger.info(u"Sending secret to %s", client.name)
1222
# bump the timeout as if seen
2383
1224
if self.server.use_dbus:
2384
1225
# Emit D-Bus signal
2385
1226
client.GotSecret()
2388
1229
if approval_required:
2389
1230
client.approvals_pending -= 1
2392
except gnutls.Error as error:
2393
logger.warning("GnuTLS bye failed",
2397
1234
def peer_certificate(session):
2398
"Return the peer's certificate as a bytestring"
2400
cert_type = gnutls.certificate_type_get2(session._c_object,
2402
except AttributeError:
2403
cert_type = gnutls.certificate_type_get(session._c_object)
2404
if gnutls.has_rawpk:
2405
valid_cert_types = frozenset((gnutls.CRT_RAWPK,))
2407
valid_cert_types = frozenset((gnutls.CRT_OPENPGP,))
2408
# If not a valid certificate type...
2409
if cert_type not in valid_cert_types:
2410
logger.info("Cert type %r not in %r", cert_type,
2412
# ...return invalid data
1235
"Return the peer's OpenPGP certificate as a bytestring"
1236
# If not an OpenPGP certificate...
1237
if (gnutls.library.functions
1238
.gnutls_certificate_type_get(session._c_object)
1239
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1240
# ...do the normal thing
1241
return session.peer_certificate
2414
1242
list_size = ctypes.c_uint(1)
2415
cert_list = (gnutls.certificate_get_peers
1243
cert_list = (gnutls.library.functions
1244
.gnutls_certificate_get_peers
2416
1245
(session._c_object, ctypes.byref(list_size)))
2417
1246
if not bool(cert_list) and list_size.value != 0:
2418
raise gnutls.Error("error getting peer certificate")
1247
raise gnutls.errors.GNUTLSError(u"error getting peer"
2419
1249
if list_size.value == 0:
2421
1251
cert = cert_list[0]
2422
1252
return ctypes.string_at(cert.data, cert.size)
2425
def key_id(certificate):
2426
"Convert a certificate bytestring to a hexdigit key ID"
2427
# New GnuTLS "datum" with the public key
2428
datum = gnutls.datum_t(
2429
ctypes.cast(ctypes.c_char_p(certificate),
2430
ctypes.POINTER(ctypes.c_ubyte)),
2431
ctypes.c_uint(len(certificate)))
2432
# XXX all these need to be created in the gnutls "module"
2433
# New empty GnuTLS certificate
2434
pubkey = gnutls.pubkey_t()
2435
gnutls.pubkey_init(ctypes.byref(pubkey))
2436
# Import the raw public key into the certificate
2437
gnutls.pubkey_import(pubkey,
2438
ctypes.byref(datum),
2439
gnutls.X509_FMT_DER)
2440
# New buffer for the key ID
2441
buf = ctypes.create_string_buffer(32)
2442
buf_len = ctypes.c_size_t(len(buf))
2443
# Get the key ID from the raw public key into the buffer
2444
gnutls.pubkey_get_key_id(pubkey,
2445
gnutls.KEYID_USE_SHA256,
2446
ctypes.cast(ctypes.byref(buf),
2447
ctypes.POINTER(ctypes.c_ubyte)),
2448
ctypes.byref(buf_len))
2449
# Deinit the certificate
2450
gnutls.pubkey_deinit(pubkey)
2452
# Convert the buffer to a Python bytestring
2453
key_id = ctypes.string_at(buf, buf_len.value)
2454
# Convert the bytestring to hexadecimal notation
2455
hex_key_id = binascii.hexlify(key_id).upper()
2459
1255
def fingerprint(openpgp):
2460
1256
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
2461
1257
# New GnuTLS "datum" with the OpenPGP public key
2462
datum = gnutls.datum_t(
2463
ctypes.cast(ctypes.c_char_p(openpgp),
2464
ctypes.POINTER(ctypes.c_ubyte)),
2465
ctypes.c_uint(len(openpgp)))
1258
datum = (gnutls.library.types
1259
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1262
ctypes.c_uint(len(openpgp))))
2466
1263
# New empty GnuTLS certificate
2467
crt = gnutls.openpgp_crt_t()
2468
gnutls.openpgp_crt_init(ctypes.byref(crt))
1264
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1265
(gnutls.library.functions
1266
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2469
1267
# Import the OpenPGP public key into the certificate
2470
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2471
gnutls.OPENPGP_FMT_RAW)
1268
(gnutls.library.functions
1269
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1270
gnutls.library.constants
1271
.GNUTLS_OPENPGP_FMT_RAW))
2472
1272
# Verify the self signature in the key
2473
1273
crtverify = ctypes.c_uint()
2474
gnutls.openpgp_crt_verify_self(crt, 0,
2475
ctypes.byref(crtverify))
1274
(gnutls.library.functions
1275
.gnutls_openpgp_crt_verify_self(crt, 0,
1276
ctypes.byref(crtverify)))
2476
1277
if crtverify.value != 0:
2477
gnutls.openpgp_crt_deinit(crt)
2478
raise gnutls.CertificateSecurityError(code
1278
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1279
raise (gnutls.errors.CertificateSecurityError
2480
1281
# New buffer for the fingerprint
2481
1282
buf = ctypes.create_string_buffer(20)
2482
1283
buf_len = ctypes.c_size_t()
2483
1284
# Get the fingerprint from the certificate into the buffer
2484
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2485
ctypes.byref(buf_len))
1285
(gnutls.library.functions
1286
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1287
ctypes.byref(buf_len)))
2486
1288
# Deinit the certificate
2487
gnutls.openpgp_crt_deinit(crt)
1289
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2488
1290
# Convert the buffer to a Python bytestring
2489
1291
fpr = ctypes.string_at(buf, buf_len.value)
2490
1292
# Convert the bytestring to hexadecimal notation
2491
hex_fpr = binascii.hexlify(fpr).upper()
1293
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2495
1297
class MultiprocessingMixIn(object):
2496
1298
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
2498
1299
def sub_process_main(self, request, address):
2500
1301
self.finish_request(request, address)
2502
1303
self.handle_error(request, address)
2503
1304
self.close_request(request)
2505
1306
def process_request(self, request, address):
2506
1307
"""Start a new process to process the request."""
2507
proc = multiprocessing.Process(target=self.sub_process_main,
2508
args=(request, address))
1308
multiprocessing.Process(target = self.sub_process_main,
1309
args = (request, address)).start()
2513
1311
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
2514
1312
""" adds a pipe to the MixIn """
2516
1313
def process_request(self, request, client_address):
2517
1314
"""Overrides and wraps the original process_request().
2519
1316
This function creates a new pipe in self.pipe
2521
1318
parent_pipe, self.child_pipe = multiprocessing.Pipe()
2523
proc = MultiprocessingMixIn.process_request(self, request,
1320
super(MultiprocessingMixInWithPipe,
1321
self).process_request(request, client_address)
2525
1322
self.child_pipe.close()
2526
self.add_pipe(parent_pipe, proc)
2528
def add_pipe(self, parent_pipe, proc):
1323
self.add_pipe(parent_pipe)
1325
def add_pipe(self, parent_pipe):
2529
1326
"""Dummy function; override as necessary"""
2530
raise NotImplementedError()
2533
1329
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
2534
1330
socketserver.TCPServer, object):
2535
1331
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
2538
1334
enabled: Boolean; whether this server is activated yet
2539
1335
interface: None or a network interface name (string)
2540
1336
use_ipv6: Boolean; to use IPv6 or not
2543
1338
def __init__(self, server_address, RequestHandlerClass,
2547
"""If socketfd is set, use that file descriptor instead of
2548
creating a new one with socket.socket().
1339
interface=None, use_ipv6=True):
2550
1340
self.interface = interface
2552
1342
self.address_family = socket.AF_INET6
2553
if socketfd is not None:
2554
# Save the file descriptor
2555
self.socketfd = socketfd
2556
# Save the original socket.socket() function
2557
self.socket_socket = socket.socket
2559
# To implement --socket, we monkey patch socket.socket.
2561
# (When socketserver.TCPServer is a new-style class, we
2562
# could make self.socket into a property instead of monkey
2563
# patching socket.socket.)
2565
# Create a one-time-only replacement for socket.socket()
2566
@functools.wraps(socket.socket)
2567
def socket_wrapper(*args, **kwargs):
2568
# Restore original function so subsequent calls are
2570
socket.socket = self.socket_socket
2571
del self.socket_socket
2572
# This time only, return a new socket object from the
2573
# saved file descriptor.
2574
return socket.fromfd(self.socketfd, *args, **kwargs)
2575
# Replace socket.socket() function with wrapper
2576
socket.socket = socket_wrapper
2577
# The socketserver.TCPServer.__init__ will call
2578
# socket.socket(), which might be our replacement,
2579
# socket_wrapper(), if socketfd was set.
2580
1343
socketserver.TCPServer.__init__(self, server_address,
2581
1344
RequestHandlerClass)
2583
1345
def server_bind(self):
2584
1346
"""This overrides the normal server_bind() function
2585
1347
to bind to an interface if one was specified, and also NOT to
2586
1348
bind to an address or port if they were not specified."""
2587
global SO_BINDTODEVICE
2588
1349
if self.interface is not None:
2589
1350
if SO_BINDTODEVICE is None:
2590
# Fall back to a hard-coded value which seems to be
2592
logger.warning("SO_BINDTODEVICE not found, trying 25")
2593
SO_BINDTODEVICE = 25
2595
self.socket.setsockopt(
2596
socket.SOL_SOCKET, SO_BINDTODEVICE,
2597
(self.interface + "\0").encode("utf-8"))
2598
except socket.error as error:
2599
if error.errno == errno.EPERM:
2600
logger.error("No permission to bind to"
2601
" interface %s", self.interface)
2602
elif error.errno == errno.ENOPROTOOPT:
2603
logger.error("SO_BINDTODEVICE not available;"
2604
" cannot bind to interface %s",
2606
elif error.errno == errno.ENODEV:
2607
logger.error("Interface %s does not exist,"
2608
" cannot bind", self.interface)
1351
logger.error(u"SO_BINDTODEVICE does not exist;"
1352
u" cannot bind to interface %s",
1356
self.socket.setsockopt(socket.SOL_SOCKET,
1360
except socket.error, error:
1361
if error[0] == errno.EPERM:
1362
logger.error(u"No permission to"
1363
u" bind to interface %s",
1365
elif error[0] == errno.ENOPROTOOPT:
1366
logger.error(u"SO_BINDTODEVICE not available;"
1367
u" cannot bind to interface %s",
2611
1371
# Only bind(2) the socket if we really need to.
2612
1372
if self.server_address[0] or self.server_address[1]:
2613
if self.server_address[1]:
2614
self.allow_reuse_address = True
2615
1373
if not self.server_address[0]:
2616
1374
if self.address_family == socket.AF_INET6:
2617
any_address = "::" # in6addr_any
1375
any_address = u"::" # in6addr_any
2619
any_address = "0.0.0.0" # INADDR_ANY
1377
any_address = socket.INADDR_ANY
2620
1378
self.server_address = (any_address,
2621
1379
self.server_address[1])
2622
1380
elif not self.server_address[1]:
2623
self.server_address = (self.server_address[0], 0)
1381
self.server_address = (self.server_address[0],
2624
1383
# if self.interface:
2625
1384
# self.server_address = (self.server_address[0],
2633
1392
class MandosServer(IPv6_TCPServer):
2634
1393
"""Mandos server.
2637
1396
clients: set of Client objects
2638
1397
gnutls_priority GnuTLS priority string
2639
1398
use_dbus: Boolean; to emit D-Bus signals or not
2641
Assumes a GLib.MainLoop event loop.
1400
Assumes a gobject.MainLoop event loop.
2644
1402
def __init__(self, server_address, RequestHandlerClass,
2648
gnutls_priority=None,
1403
interface=None, use_ipv6=True, clients=None,
1404
gnutls_priority=None, use_dbus=True):
2651
1405
self.enabled = False
2652
1406
self.clients = clients
2653
1407
if self.clients is None:
1408
self.clients = set()
2655
1409
self.use_dbus = use_dbus
2656
1410
self.gnutls_priority = gnutls_priority
2657
1411
IPv6_TCPServer.__init__(self, server_address,
2658
1412
RequestHandlerClass,
2659
interface=interface,
1413
interface = interface,
1414
use_ipv6 = use_ipv6)
2663
1415
def server_activate(self):
2664
1416
if self.enabled:
2665
1417
return socketserver.TCPServer.server_activate(self)
2667
1418
def enable(self):
2668
1419
self.enabled = True
2670
def add_pipe(self, parent_pipe, proc):
1420
def add_pipe(self, parent_pipe):
2671
1421
# Call "handle_ipc" for both data and EOF events
2673
parent_pipe.fileno(),
2674
GLib.IO_IN | GLib.IO_HUP,
2675
functools.partial(self.handle_ipc,
2676
parent_pipe=parent_pipe,
2679
def handle_ipc(self, source, condition,
1422
gobject.io_add_watch(parent_pipe.fileno(),
1423
gobject.IO_IN | gobject.IO_HUP,
1424
functools.partial(self.handle_ipc,
1425
parent_pipe = parent_pipe))
1427
def handle_ipc(self, source, condition, parent_pipe=None,
2682
1428
client_object=None):
2683
# error, or the other end of multiprocessing.Pipe has closed
2684
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2685
# Wait for other process to exit
1430
gobject.IO_IN: u"IN", # There is data to read.
1431
gobject.IO_OUT: u"OUT", # Data can be written (without
1433
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1434
gobject.IO_ERR: u"ERR", # Error condition.
1435
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1436
# broken, usually for pipes and
1439
conditions_string = ' | '.join(name
1441
condition_names.iteritems()
1442
if cond & condition)
1443
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1446
# error or the other end of multiprocessing.Pipe has closed
1447
if condition & gobject.IO_HUP or condition & gobject.IO_ERR:
2689
1450
# Read a request from the child
2690
1451
request = parent_pipe.recv()
1452
logger.debug(u"IPC request: %s", repr(request))
2691
1453
command = request[0]
2693
1455
if command == 'init':
2694
key_id = request[1].decode("ascii")
2695
fpr = request[2].decode("ascii")
2696
address = request[3]
2698
for c in self.clients.values():
2699
if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2701
if key_id and c.key_id == key_id:
2704
if fpr and c.fingerprint == fpr:
1457
address = request[2]
1459
for c in self.clients:
1460
if c.fingerprint == fpr:
2708
logger.info("Client not found for key ID: %s, address"
2709
": %s", key_id or fpr, address)
1464
logger.warning(u"Client not found for fingerprint: %s, ad"
1465
u"dress: %s", fpr, address)
2710
1466
if self.use_dbus:
2711
1467
# Emit D-Bus signal
2712
mandos_dbus_service.ClientNotFound(key_id or fpr,
1468
mandos_dbus_service.ClientNotFound(fpr, address)
2714
1469
parent_pipe.send(False)
2718
parent_pipe.fileno(),
2719
GLib.IO_IN | GLib.IO_HUP,
2720
functools.partial(self.handle_ipc,
2721
parent_pipe=parent_pipe,
2723
client_object=client))
1472
gobject.io_add_watch(parent_pipe.fileno(),
1473
gobject.IO_IN | gobject.IO_HUP,
1474
functools.partial(self.handle_ipc,
1475
parent_pipe = parent_pipe,
1476
client_object = client))
2724
1477
parent_pipe.send(True)
2725
# remove the old hook in favor of the new above hook on
1478
# remove the old hook in favor of the new above hook on same fileno
2728
1480
if command == 'funcall':
2729
1481
funcname = request[1]
2730
1482
args = request[2]
2731
1483
kwargs = request[3]
2733
parent_pipe.send(('data', getattr(client_object,
1485
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
2737
1487
if command == 'getattr':
2738
1488
attrname = request[1]
2739
if isinstance(client_object.__getattribute__(attrname),
2740
collections.Callable):
2741
parent_pipe.send(('function', ))
1489
if callable(client_object.__getattribute__(attrname)):
1490
parent_pipe.send(('function',))
2744
'data', client_object.__getattribute__(attrname)))
1492
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2746
1494
if command == 'setattr':
2747
1495
attrname = request[1]
2748
1496
value = request[2]
2749
1497
setattr(client_object, attrname, value)
2754
def rfc3339_duration_to_delta(duration):
2755
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2757
>>> rfc3339_duration_to_delta("P7D")
2758
datetime.timedelta(7)
2759
>>> rfc3339_duration_to_delta("PT60S")
2760
datetime.timedelta(0, 60)
2761
>>> rfc3339_duration_to_delta("PT60M")
2762
datetime.timedelta(0, 3600)
2763
>>> rfc3339_duration_to_delta("PT24H")
2764
datetime.timedelta(1)
2765
>>> rfc3339_duration_to_delta("P1W")
2766
datetime.timedelta(7)
2767
>>> rfc3339_duration_to_delta("PT5M30S")
2768
datetime.timedelta(0, 330)
2769
>>> rfc3339_duration_to_delta("P1DT3M20S")
2770
datetime.timedelta(1, 200)
2773
# Parsing an RFC 3339 duration with regular expressions is not
2774
# possible - there would have to be multiple places for the same
2775
# values, like seconds. The current code, while more esoteric, is
2776
# cleaner without depending on a parsing library. If Python had a
2777
# built-in library for parsing we would use it, but we'd like to
2778
# avoid excessive use of external libraries.
2780
# New type for defining tokens, syntax, and semantics all-in-one
2781
Token = collections.namedtuple("Token", (
2782
"regexp", # To match token; if "value" is not None, must have
2783
# a "group" containing digits
2784
"value", # datetime.timedelta or None
2785
"followers")) # Tokens valid after this token
2786
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2787
# the "duration" ABNF definition in RFC 3339, Appendix A.
2788
token_end = Token(re.compile(r"$"), None, frozenset())
2789
token_second = Token(re.compile(r"(\d+)S"),
2790
datetime.timedelta(seconds=1),
2791
frozenset((token_end, )))
2792
token_minute = Token(re.compile(r"(\d+)M"),
2793
datetime.timedelta(minutes=1),
2794
frozenset((token_second, token_end)))
2795
token_hour = Token(re.compile(r"(\d+)H"),
2796
datetime.timedelta(hours=1),
2797
frozenset((token_minute, token_end)))
2798
token_time = Token(re.compile(r"T"),
2800
frozenset((token_hour, token_minute,
2802
token_day = Token(re.compile(r"(\d+)D"),
2803
datetime.timedelta(days=1),
2804
frozenset((token_time, token_end)))
2805
token_month = Token(re.compile(r"(\d+)M"),
2806
datetime.timedelta(weeks=4),
2807
frozenset((token_day, token_end)))
2808
token_year = Token(re.compile(r"(\d+)Y"),
2809
datetime.timedelta(weeks=52),
2810
frozenset((token_month, token_end)))
2811
token_week = Token(re.compile(r"(\d+)W"),
2812
datetime.timedelta(weeks=1),
2813
frozenset((token_end, )))
2814
token_duration = Token(re.compile(r"P"), None,
2815
frozenset((token_year, token_month,
2816
token_day, token_time,
2818
# Define starting values:
2820
value = datetime.timedelta()
2822
# Following valid tokens
2823
followers = frozenset((token_duration, ))
2824
# String left to parse
2826
# Loop until end token is found
2827
while found_token is not token_end:
2828
# Search for any currently valid tokens
2829
for token in followers:
2830
match = token.regexp.match(s)
2831
if match is not None:
2833
if token.value is not None:
2834
# Value found, parse digits
2835
factor = int(match.group(1), 10)
2836
# Add to value so far
2837
value += factor * token.value
2838
# Strip token from string
2839
s = token.regexp.sub("", s, 1)
2842
# Set valid next tokens
2843
followers = found_token.followers
2846
# No currently valid tokens were found
2847
raise ValueError("Invalid RFC 3339 duration: {!r}"
2853
1502
def string_to_delta(interval):
2854
1503
"""Parse a string and return a datetime.timedelta
2856
>>> string_to_delta('7d')
1505
>>> string_to_delta(u'7d')
2857
1506
datetime.timedelta(7)
2858
>>> string_to_delta('60s')
1507
>>> string_to_delta(u'60s')
2859
1508
datetime.timedelta(0, 60)
2860
>>> string_to_delta('60m')
1509
>>> string_to_delta(u'60m')
2861
1510
datetime.timedelta(0, 3600)
2862
>>> string_to_delta('24h')
1511
>>> string_to_delta(u'24h')
2863
1512
datetime.timedelta(1)
2864
>>> string_to_delta('1w')
1513
>>> string_to_delta(u'1w')
2865
1514
datetime.timedelta(7)
2866
>>> string_to_delta('5m 30s')
1515
>>> string_to_delta(u'5m 30s')
2867
1516
datetime.timedelta(0, 330)
2871
return rfc3339_duration_to_delta(interval)
2875
1518
timevalue = datetime.timedelta(0)
2876
1519
for s in interval.split():
1521
suffix = unicode(s[-1])
2879
1522
value = int(s[:-1])
2881
1524
delta = datetime.timedelta(value)
1525
elif suffix == u"s":
2883
1526
delta = datetime.timedelta(0, value)
1527
elif suffix == u"m":
2885
1528
delta = datetime.timedelta(0, 0, 0, 0, value)
1529
elif suffix == u"h":
2887
1530
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1531
elif suffix == u"w":
2889
1532
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2891
raise ValueError("Unknown suffix {!r}".format(suffix))
2892
except IndexError as e:
2893
raise ValueError(*(e.args))
1534
raise ValueError(u"Unknown suffix %r" % suffix)
1535
except (ValueError, IndexError), e:
1536
raise ValueError(e.message)
2894
1537
timevalue += delta
2895
1538
return timevalue
2898
def daemon(nochdir=False, noclose=False):
1541
def if_nametoindex(interface):
1542
"""Call the C function if_nametoindex(), or equivalent
1544
Note: This function cannot accept a unicode string."""
1545
global if_nametoindex
1547
if_nametoindex = (ctypes.cdll.LoadLibrary
1548
(ctypes.util.find_library(u"c"))
1550
except (OSError, AttributeError):
1551
logger.warning(u"Doing if_nametoindex the hard way")
1552
def if_nametoindex(interface):
1553
"Get an interface index the hard way, i.e. using fcntl()"
1554
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1555
with contextlib.closing(socket.socket()) as s:
1556
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1557
struct.pack(str(u"16s16x"),
1559
interface_index = struct.unpack(str(u"I"),
1561
return interface_index
1562
return if_nametoindex(interface)
1565
def daemon(nochdir = False, noclose = False):
2899
1566
"""See daemon(3). Standard BSD Unix function.
2901
1568
This should really exist as os.daemon, but it doesn't (yet)."""
2905
1572
if not nochdir:
2909
1576
if not noclose:
2910
1577
# Close all standard open file descriptors
2911
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1578
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2912
1579
if not stat.S_ISCHR(os.fstat(null).st_mode):
2913
1580
raise OSError(errno.ENODEV,
2914
"{} not a character device"
2915
.format(os.devnull))
1581
u"%s not a character device"
2916
1583
os.dup2(null, sys.stdin.fileno())
2917
1584
os.dup2(null, sys.stdout.fileno())
2918
1585
os.dup2(null, sys.stderr.fileno())
2925
1592
##################################################################
2926
1593
# Parsing of options, both command line and config file
2928
parser = argparse.ArgumentParser()
2929
parser.add_argument("-v", "--version", action="version",
2930
version="%(prog)s {}".format(version),
2931
help="show version number and exit")
2932
parser.add_argument("-i", "--interface", metavar="IF",
2933
help="Bind to interface IF")
2934
parser.add_argument("-a", "--address",
2935
help="Address to listen for requests on")
2936
parser.add_argument("-p", "--port", type=int,
2937
help="Port number to receive requests on")
2938
parser.add_argument("--check", action="store_true",
2939
help="Run self-test")
2940
parser.add_argument("--debug", action="store_true",
2941
help="Debug mode; run in foreground and log"
2942
" to terminal", default=None)
2943
parser.add_argument("--debuglevel", metavar="LEVEL",
2944
help="Debug level for stdout output")
2945
parser.add_argument("--priority", help="GnuTLS"
2946
" priority string (see GnuTLS documentation)")
2947
parser.add_argument("--servicename",
2948
metavar="NAME", help="Zeroconf service name")
2949
parser.add_argument("--configdir",
2950
default="/etc/mandos", metavar="DIR",
2951
help="Directory to search for configuration"
2953
parser.add_argument("--no-dbus", action="store_false",
2954
dest="use_dbus", help="Do not provide D-Bus"
2955
" system bus interface", default=None)
2956
parser.add_argument("--no-ipv6", action="store_false",
2957
dest="use_ipv6", help="Do not use IPv6",
2959
parser.add_argument("--no-restore", action="store_false",
2960
dest="restore", help="Do not restore stored"
2961
" state", default=None)
2962
parser.add_argument("--socket", type=int,
2963
help="Specify a file descriptor to a network"
2964
" socket to use instead of creating one")
2965
parser.add_argument("--statedir", metavar="DIR",
2966
help="Directory to save/restore state in")
2967
parser.add_argument("--foreground", action="store_true",
2968
help="Run in foreground", default=None)
2969
parser.add_argument("--no-zeroconf", action="store_false",
2970
dest="zeroconf", help="Do not use Zeroconf",
2973
options = parser.parse_args()
1595
parser = optparse.OptionParser(version = "%%prog %s" % version)
1596
parser.add_option("-i", u"--interface", type=u"string",
1597
metavar="IF", help=u"Bind to interface IF")
1598
parser.add_option("-a", u"--address", type=u"string",
1599
help=u"Address to listen for requests on")
1600
parser.add_option("-p", u"--port", type=u"int",
1601
help=u"Port number to receive requests on")
1602
parser.add_option("--check", action=u"store_true",
1603
help=u"Run self-test")
1604
parser.add_option("--debug", action=u"store_true",
1605
help=u"Debug mode; run in foreground and log to"
1607
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1608
u" priority string (see GnuTLS documentation)")
1609
parser.add_option("--servicename", type=u"string",
1610
metavar=u"NAME", help=u"Zeroconf service name")
1611
parser.add_option("--configdir", type=u"string",
1612
default=u"/etc/mandos", metavar=u"DIR",
1613
help=u"Directory to search for configuration"
1615
parser.add_option("--no-dbus", action=u"store_false",
1616
dest=u"use_dbus", help=u"Do not provide D-Bus"
1617
u" system bus interface")
1618
parser.add_option("--no-ipv6", action=u"store_false",
1619
dest=u"use_ipv6", help=u"Do not use IPv6")
1620
options = parser.parse_args()[0]
2975
1622
if options.check:
2977
fail_count, test_count = doctest.testmod()
2978
sys.exit(os.EX_OK if fail_count == 0 else 1)
2980
1627
# Default values for config file for server-global settings
2981
if gnutls.has_rawpk:
2982
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2983
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2985
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2986
":+SIGN-DSA-SHA256")
2987
server_defaults = {"interface": "",
2991
"priority": priority,
2992
"servicename": "Mandos",
2998
"statedir": "/var/lib/mandos",
2999
"foreground": "False",
1628
server_defaults = { u"interface": u"",
1633
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1634
u"servicename": u"Mandos",
1635
u"use_dbus": u"True",
1636
u"use_ipv6": u"True",
3004
1639
# Parse config file for server-global settings
3005
server_config = configparser.ConfigParser(server_defaults)
1640
server_config = configparser.SafeConfigParser(server_defaults)
3006
1641
del server_defaults
3007
server_config.read(os.path.join(options.configdir, "mandos.conf"))
3008
# Convert the ConfigParser object to a dict
1642
server_config.read(os.path.join(options.configdir,
1644
# Convert the SafeConfigParser object to a dict
3009
1645
server_settings = server_config.defaults()
3010
1646
# Use the appropriate methods on the non-string config options
3011
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3012
"foreground", "zeroconf"):
3013
server_settings[option] = server_config.getboolean("DEFAULT",
1647
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1648
server_settings[option] = server_config.getboolean(u"DEFAULT",
3015
1650
if server_settings["port"]:
3016
server_settings["port"] = server_config.getint("DEFAULT",
3018
if server_settings["socket"]:
3019
server_settings["socket"] = server_config.getint("DEFAULT",
3021
# Later, stdin will, and stdout and stderr might, be dup'ed
3022
# over with an opened os.devnull. But we don't want this to
3023
# happen with a supplied network socket.
3024
if 0 <= server_settings["socket"] <= 2:
3025
server_settings["socket"] = os.dup(server_settings
1651
server_settings["port"] = server_config.getint(u"DEFAULT",
3027
1653
del server_config
3029
1655
# Override the settings from the config file with command line
3030
1656
# options, if set.
3031
for option in ("interface", "address", "port", "debug",
3032
"priority", "servicename", "configdir", "use_dbus",
3033
"use_ipv6", "debuglevel", "restore", "statedir",
3034
"socket", "foreground", "zeroconf"):
1657
for option in (u"interface", u"address", u"port", u"debug",
1658
u"priority", u"servicename", u"configdir",
1659
u"use_dbus", u"use_ipv6"):
3035
1660
value = getattr(options, option)
3036
1661
if value is not None:
3037
1662
server_settings[option] = value
3039
1664
# Force all strings to be unicode
3040
1665
for option in server_settings.keys():
3041
if isinstance(server_settings[option], bytes):
3042
server_settings[option] = (server_settings[option]
3044
# Force all boolean options to be boolean
3045
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3046
"foreground", "zeroconf"):
3047
server_settings[option] = bool(server_settings[option])
3048
# Debug implies foreground
3049
if server_settings["debug"]:
3050
server_settings["foreground"] = True
1666
if type(server_settings[option]) is str:
1667
server_settings[option] = unicode(server_settings[option])
3051
1668
# Now we have our good server settings in "server_settings"
3053
1670
##################################################################
3055
if (not server_settings["zeroconf"]
3056
and not (server_settings["port"]
3057
or server_settings["socket"] != "")):
3058
parser.error("Needs port or socket to work without Zeroconf")
3060
1672
# For convenience
3061
debug = server_settings["debug"]
3062
debuglevel = server_settings["debuglevel"]
3063
use_dbus = server_settings["use_dbus"]
3064
use_ipv6 = server_settings["use_ipv6"]
3065
stored_state_path = os.path.join(server_settings["statedir"],
3067
foreground = server_settings["foreground"]
3068
zeroconf = server_settings["zeroconf"]
3071
initlogger(debug, logging.DEBUG)
3076
level = getattr(logging, debuglevel.upper())
3077
initlogger(debug, level)
3079
if server_settings["servicename"] != "Mandos":
3080
syslogger.setFormatter(
3081
logging.Formatter('Mandos ({}) [%(process)d]:'
3082
' %(levelname)s: %(message)s'.format(
3083
server_settings["servicename"])))
1673
debug = server_settings[u"debug"]
1674
use_dbus = server_settings[u"use_dbus"]
1675
use_ipv6 = server_settings[u"use_ipv6"]
1678
syslogger.setLevel(logging.WARNING)
1679
console.setLevel(logging.WARNING)
1681
if server_settings[u"servicename"] != u"Mandos":
1682
syslogger.setFormatter(logging.Formatter
1683
(u'Mandos (%s) [%%(process)d]:'
1684
u' %%(levelname)s: %%(message)s'
1685
% server_settings[u"servicename"]))
3085
1687
# Parse config file with clients
3086
client_config = configparser.ConfigParser(Client.client_defaults)
3087
client_config.read(os.path.join(server_settings["configdir"],
1688
client_defaults = { u"timeout": u"1h",
1690
u"checker": u"fping -q -- %%(host)s",
1692
u"approved_delay": u"5m",
1693
u"approved_duration": u"1s",
1695
client_config = configparser.SafeConfigParser(client_defaults)
1696
client_config.read(os.path.join(server_settings[u"configdir"],
3090
1699
global mandos_dbus_service
3091
1700
mandos_dbus_service = None
3094
if server_settings["socket"] != "":
3095
socketfd = server_settings["socket"]
3096
tcp_server = MandosServer(
3097
(server_settings["address"], server_settings["port"]),
3099
interface=(server_settings["interface"] or None),
3101
gnutls_priority=server_settings["priority"],
3105
pidfilename = "/run/mandos.pid"
3106
if not os.path.isdir("/run/."):
3107
pidfilename = "/var/run/mandos.pid"
3110
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3111
except IOError as e:
3112
logger.error("Could not open file %r", pidfilename,
3115
for name, group in (("_mandos", "_mandos"),
3116
("mandos", "mandos"),
3117
("nobody", "nogroup")):
3119
uid = pwd.getpwnam(name).pw_uid
3120
gid = pwd.getpwnam(group).pw_gid
1702
tcp_server = MandosServer((server_settings[u"address"],
1703
server_settings[u"port"]),
1705
interface=server_settings[u"interface"],
1708
server_settings[u"priority"],
1710
pidfilename = u"/var/run/mandos.pid"
1712
pidfile = open(pidfilename, u"w")
1714
logger.error(u"Could not open file %r", pidfilename)
1717
uid = pwd.getpwnam(u"_mandos").pw_uid
1718
gid = pwd.getpwnam(u"_mandos").pw_gid
1721
uid = pwd.getpwnam(u"mandos").pw_uid
1722
gid = pwd.getpwnam(u"mandos").pw_gid
3122
1723
except KeyError:
1725
uid = pwd.getpwnam(u"nobody").pw_uid
1726
gid = pwd.getpwnam(u"nobody").pw_gid
3131
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3133
except OSError as error:
3134
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3135
.format(uid, gid, os.strerror(error.errno)))
3136
if error.errno != errno.EPERM:
1733
except OSError, error:
1734
if error[0] != errno.EPERM:
1737
# Enable all possible GnuTLS debugging
3140
# Enable all possible GnuTLS debugging
3142
1739
# "Use a log level over 10 to enable all debugging options."
3143
1740
# - GnuTLS manual
3144
gnutls.global_set_log_level(11)
1741
gnutls.library.functions.gnutls_global_set_log_level(11)
1743
@gnutls.library.types.gnutls_log_func
3147
1744
def debug_gnutls(level, string):
3148
logger.debug("GnuTLS: %s", string[:-1])
3150
gnutls.global_set_log_function(debug_gnutls)
3152
# Redirect stdin so all checkers get /dev/null
3153
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3154
os.dup2(null, sys.stdin.fileno())
3158
# Need to fork before connecting to D-Bus
3160
# Close all input and output, do double fork, etc.
3163
if gi.version_info < (3, 10, 2):
3164
# multiprocessing will use threads, so before we use GLib we
3165
# need to inform GLib that threads will be used.
1745
logger.debug(u"GnuTLS: %s", string[:-1])
1747
(gnutls.library.functions
1748
.gnutls_global_set_log_function(debug_gnutls))
3168
1750
global main_loop
3169
1751
# From the Avahi example code
3170
DBusGMainLoop(set_as_default=True)
3171
main_loop = GLib.MainLoop()
1752
DBusGMainLoop(set_as_default=True )
1753
main_loop = gobject.MainLoop()
3172
1754
bus = dbus.SystemBus()
3173
1755
# End of Avahi example code
3176
bus_name = dbus.service.BusName("se.recompile.Mandos",
3179
old_bus_name = dbus.service.BusName(
3180
"se.bsnet.fukt.Mandos", bus,
3182
except dbus.exceptions.DBusException as e:
3183
logger.error("Disabling D-Bus:", exc_info=e)
1758
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1759
bus, do_not_queue=True)
1760
except dbus.exceptions.NameExistsException, e:
1761
logger.error(unicode(e) + u", disabling D-Bus")
3184
1762
use_dbus = False
3185
server_settings["use_dbus"] = False
1763
server_settings[u"use_dbus"] = False
3186
1764
tcp_server.use_dbus = False
3188
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3189
service = AvahiServiceToSyslog(
3190
name=server_settings["servicename"],
3191
servicetype="_mandos._tcp",
3194
if server_settings["interface"]:
3195
service.interface = if_nametoindex(
3196
server_settings["interface"].encode("utf-8"))
1765
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1766
service = AvahiService(name = server_settings[u"servicename"],
1767
servicetype = u"_mandos._tcp",
1768
protocol = protocol, bus = bus)
1769
if server_settings["interface"]:
1770
service.interface = (if_nametoindex
1771
(str(server_settings[u"interface"])))
3198
1773
global multiprocessing_manager
3199
1774
multiprocessing_manager = multiprocessing.Manager()
3201
1776
client_class = Client
3203
client_class = functools.partial(ClientDBus, bus=bus)
3205
client_settings = Client.config_parser(client_config)
3206
old_client_settings = {}
3209
# This is used to redirect stdout and stderr for checker processes
3211
wnull = open(os.devnull, "w") # A writable /dev/null
3212
# Only used if server is running in foreground but not in debug
3214
if debug or not foreground:
3217
# Get client data and settings from last running state.
3218
if server_settings["restore"]:
3220
with open(stored_state_path, "rb") as stored_state:
3221
if sys.version_info.major == 2:
3222
clients_data, old_client_settings = pickle.load(
3225
bytes_clients_data, bytes_old_client_settings = (
3226
pickle.load(stored_state, encoding="bytes"))
3227
# Fix bytes to strings
3230
clients_data = {(key.decode("utf-8")
3231
if isinstance(key, bytes)
3234
bytes_clients_data.items()}
3235
del bytes_clients_data
3236
for key in clients_data:
3237
value = {(k.decode("utf-8")
3238
if isinstance(k, bytes) else k): v
3240
clients_data[key].items()}
3241
clients_data[key] = value
3243
value["client_structure"] = [
3245
if isinstance(s, bytes)
3247
value["client_structure"]]
3249
for k in ("name", "host"):
3250
if isinstance(value[k], bytes):
3251
value[k] = value[k].decode("utf-8")
3252
if "key_id" not in value:
3253
value["key_id"] = ""
3254
elif "fingerprint" not in value:
3255
value["fingerprint"] = ""
3256
# old_client_settings
3258
old_client_settings = {
3259
(key.decode("utf-8")
3260
if isinstance(key, bytes)
3263
bytes_old_client_settings.items()}
3264
del bytes_old_client_settings
3266
for value in old_client_settings.values():
3267
if isinstance(value["host"], bytes):
3268
value["host"] = (value["host"]
3270
os.remove(stored_state_path)
3271
except IOError as e:
3272
if e.errno == errno.ENOENT:
3273
logger.warning("Could not load persistent state:"
3274
" {}".format(os.strerror(e.errno)))
3276
logger.critical("Could not load persistent state:",
3279
except EOFError as e:
3280
logger.warning("Could not load persistent state: "
3284
with PGPEngine() as pgp:
3285
for client_name, client in clients_data.items():
3286
# Skip removed clients
3287
if client_name not in client_settings:
3290
# Decide which value to use after restoring saved state.
3291
# We have three different values: Old config file,
3292
# new config file, and saved state.
3293
# New config value takes precedence if it differs from old
3294
# config value, otherwise use saved state.
3295
for name, value in client_settings[client_name].items():
3297
# For each value in new config, check if it
3298
# differs from the old config value (Except for
3299
# the "secret" attribute)
3300
if (name != "secret"
3302
old_client_settings[client_name][name])):
3303
client[name] = value
3307
# Clients who has passed its expire date can still be
3308
# enabled if its last checker was successful. A Client
3309
# whose checker succeeded before we stored its state is
3310
# assumed to have successfully run all checkers during
3312
if client["enabled"]:
3313
if datetime.datetime.utcnow() >= client["expires"]:
3314
if not client["last_checked_ok"]:
3316
"disabling client {} - Client never "
3317
"performed a successful checker".format(
3319
client["enabled"] = False
3320
elif client["last_checker_status"] != 0:
3322
"disabling client {} - Client last"
3323
" checker failed with error code"
3326
client["last_checker_status"]))
3327
client["enabled"] = False
3329
client["expires"] = (
3330
datetime.datetime.utcnow()
3331
+ client["timeout"])
3332
logger.debug("Last checker succeeded,"
3333
" keeping {} enabled".format(
1778
client_class = functools.partial(ClientDBus, bus = bus)
1779
def client_config_items(config, section):
1780
special_settings = {
1781
"approved_by_default":
1782
lambda: config.getboolean(section,
1783
"approved_by_default"),
1785
for name, value in config.items(section):
3336
client["secret"] = pgp.decrypt(
3337
client["encrypted_secret"],
3338
client_settings[client_name]["secret"])
3340
# If decryption fails, we use secret from new settings
3341
logger.debug("Failed to decrypt {} old secret".format(
3343
client["secret"] = (client_settings[client_name]
3346
# Add/remove clients based on new changes made to config
3347
for client_name in (set(old_client_settings)
3348
- set(client_settings)):
3349
del clients_data[client_name]
3350
for client_name in (set(client_settings)
3351
- set(old_client_settings)):
3352
clients_data[client_name] = client_settings[client_name]
3354
# Create all client objects
3355
for client_name, client in clients_data.items():
3356
tcp_server.clients[client_name] = client_class(
3359
server_settings=server_settings)
1787
yield (name, special_settings[name]())
1791
tcp_server.clients.update(set(
1792
client_class(name = section,
1793
config= dict(client_config_items(
1794
client_config, section)))
1795
for section in client_config.sections()))
3361
1796
if not tcp_server.clients:
3362
logger.warning("No clients defined")
3365
if pidfile is not None:
1797
logger.warning(u"No clients defined")
1800
# Redirect stdin so all checkers get /dev/null
1801
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1802
os.dup2(null, sys.stdin.fileno())
1806
# No console logging
1807
logger.removeHandler(console)
1808
# Close all input and output, do double fork, etc.
3366
1813
pid = os.getpid()
3369
print(pid, file=pidfile)
3371
logger.error("Could not write to file %r with PID %d",
1814
pidfile.write(str(pid) + "\n")
3376
for termsig in (signal.SIGHUP, signal.SIGTERM):
3377
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3378
lambda: main_loop.quit() and False)
1817
logger.error(u"Could not write to file %r with PID %d",
1820
# "pidfile" was never created
1825
signal.signal(signal.SIGINT, signal.SIG_IGN)
1826
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1827
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3382
@alternate_dbus_interfaces(
3383
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3384
class MandosDBusService(DBusObjectWithObjectManager):
1830
class MandosDBusService(dbus.service.Object):
3385
1831
"""A D-Bus proxy object"""
3387
1832
def __init__(self):
3388
dbus.service.Object.__init__(self, bus, "/")
3390
_interface = "se.recompile.Mandos"
3392
@dbus.service.signal(_interface, signature="o")
1833
dbus.service.Object.__init__(self, bus, u"/")
1834
_interface = u"se.bsnet.fukt.Mandos"
1836
@dbus.service.signal(_interface, signature=u"o")
3393
1837
def ClientAdded(self, objpath):
3397
@dbus.service.signal(_interface, signature="ss")
3398
def ClientNotFound(self, key_id, address):
1841
@dbus.service.signal(_interface, signature=u"ss")
1842
def ClientNotFound(self, fingerprint, address):
3402
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3404
@dbus.service.signal(_interface, signature="os")
1846
@dbus.service.signal(_interface, signature=u"os")
3405
1847
def ClientRemoved(self, objpath, name):
3409
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3411
@dbus.service.method(_interface, out_signature="ao")
1851
@dbus.service.method(_interface, out_signature=u"ao")
3412
1852
def GetAllClients(self):
3414
return dbus.Array(c.dbus_object_path for c in
3415
tcp_server.clients.values())
3417
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1854
return dbus.Array(c.dbus_object_path
1855
for c in tcp_server.clients)
3419
1857
@dbus.service.method(_interface,
3420
out_signature="a{oa{sv}}")
1858
out_signature=u"a{oa{sv}}")
3421
1859
def GetAllClientsWithProperties(self):
3423
1861
return dbus.Dictionary(
3424
{c.dbus_object_path: c.GetAll(
3425
"se.recompile.Mandos.Client")
3426
for c in tcp_server.clients.values()},
3429
@dbus.service.method(_interface, in_signature="o")
1862
((c.dbus_object_path, c.GetAll(u""))
1863
for c in tcp_server.clients),
1864
signature=u"oa{sv}")
1866
@dbus.service.method(_interface, in_signature=u"o")
3430
1867
def RemoveClient(self, object_path):
3432
for c in tcp_server.clients.values():
1869
for c in tcp_server.clients:
3433
1870
if c.dbus_object_path == object_path:
3434
del tcp_server.clients[c.name]
1871
tcp_server.clients.remove(c)
3435
1872
c.remove_from_connection()
3436
# Don't signal the disabling
1873
# Don't signal anything except ClientRemoved
3437
1874
c.disable(quiet=True)
3438
# Emit D-Bus signal for removal
3439
self.client_removed_signal(c)
1876
self.ClientRemoved(object_path, c.name)
3441
1878
raise KeyError(object_path)
3445
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3446
out_signature="a{oa{sa{sv}}}")
3447
def GetManagedObjects(self):
3449
return dbus.Dictionary(
3450
{client.dbus_object_path:
3452
{interface: client.GetAll(interface)
3454
client._get_all_interface_names()})
3455
for client in tcp_server.clients.values()})
3457
def client_added_signal(self, client):
3458
"""Send the new standard signal and the old signal"""
3460
# New standard signal
3461
self.InterfacesAdded(
3462
client.dbus_object_path,
3464
{interface: client.GetAll(interface)
3466
client._get_all_interface_names()}))
3468
self.ClientAdded(client.dbus_object_path)
3470
def client_removed_signal(self, client):
3471
"""Send the new standard signal and the old signal"""
3473
# New standard signal
3474
self.InterfacesRemoved(
3475
client.dbus_object_path,
3476
client._get_all_interface_names())
3478
self.ClientRemoved(client.dbus_object_path,
3481
1882
mandos_dbus_service = MandosDBusService()
3483
# Save modules to variables to exempt the modules from being
3484
# unloaded before the function registered with atexit() is run.
3485
mp = multiprocessing
3489
1885
"Cleanup function; run on exit"
3493
mp.active_children()
3495
if not (tcp_server.clients or client_settings):
3498
# Store client before exiting. Secrets are encrypted with key
3499
# based on what config file has. If config file is
3500
# removed/edited, old secret will thus be unrecovable.
3502
with PGPEngine() as pgp:
3503
for client in tcp_server.clients.values():
3504
key = client_settings[client.name]["secret"]
3505
client.encrypted_secret = pgp.encrypt(client.secret,
3509
# A list of attributes that can not be pickled
3511
exclude = {"bus", "changedstate", "secret",
3512
"checker", "server_settings"}
3513
for name, typ in inspect.getmembers(dbus.service
3517
client_dict["encrypted_secret"] = (client
3519
for attr in client.client_structure:
3520
if attr not in exclude:
3521
client_dict[attr] = getattr(client, attr)
3523
clients[client.name] = client_dict
3524
del client_settings[client.name]["secret"]
3527
with tempfile.NamedTemporaryFile(
3531
dir=os.path.dirname(stored_state_path),
3532
delete=False) as stored_state:
3533
pickle.dump((clients, client_settings), stored_state,
3535
tempname = stored_state.name
3536
os.rename(tempname, stored_state_path)
3537
except (IOError, OSError) as e:
3543
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3544
logger.warning("Could not save persistent state: {}"
3545
.format(os.strerror(e.errno)))
3547
logger.warning("Could not save persistent state:",
3551
# Delete all clients, and settings from config
3552
1888
while tcp_server.clients:
3553
name, client = tcp_server.clients.popitem()
1889
client = tcp_server.clients.pop()
3555
1891
client.remove_from_connection()
3556
# Don't signal the disabling
1892
client.disable_hook = None
1893
# Don't signal anything except ClientRemoved
3557
1894
client.disable(quiet=True)
3558
# Emit D-Bus signal for removal
3560
mandos_dbus_service.client_removed_signal(client)
3561
client_settings.clear()
1897
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3563
1900
atexit.register(cleanup)
3565
for client in tcp_server.clients.values():
1902
for client in tcp_server.clients:
3567
# Emit D-Bus signal for adding
3568
mandos_dbus_service.client_added_signal(client)
3569
# Need to initiate checking of clients
3571
client.init_checker()
1905
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3573
1908
tcp_server.enable()
3574
1909
tcp_server.server_activate()
3576
1911
# Find out what port we got
3578
service.port = tcp_server.socket.getsockname()[1]
1912
service.port = tcp_server.socket.getsockname()[1]
3580
logger.info("Now listening on address %r, port %d,"
3581
" flowinfo %d, scope_id %d",
3582
*tcp_server.socket.getsockname())
1914
logger.info(u"Now listening on address %r, port %d,"
1915
" flowinfo %d, scope_id %d"
1916
% tcp_server.socket.getsockname())
3584
logger.info("Now listening on address %r, port %d",
3585
*tcp_server.socket.getsockname())
3587
# service.interface = tcp_server.socket.getsockname()[3]
1918
logger.info(u"Now listening on address %r, port %d"
1919
% tcp_server.socket.getsockname())
1921
#service.interface = tcp_server.socket.getsockname()[3]
3591
# From the Avahi example code
3594
except dbus.exceptions.DBusException as error:
3595
logger.critical("D-Bus Exception", exc_info=error)
3598
# End of Avahi example code
3600
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3601
lambda *args, **kwargs:
3602
(tcp_server.handle_request
3603
(*args[2:], **kwargs) or True))
3605
logger.debug("Starting main loop")
1924
# From the Avahi example code
1927
except dbus.exceptions.DBusException, error:
1928
logger.critical(u"DBusException: %s", error)
1931
# End of Avahi example code
1933
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1934
lambda *args, **kwargs:
1935
(tcp_server.handle_request
1936
(*args[2:], **kwargs) or True))
1938
logger.debug(u"Starting main loop")
3606
1939
main_loop.run()
3607
except AvahiError as error:
3608
logger.critical("Avahi Error", exc_info=error)
1940
except AvahiError, error:
1941
logger.critical(u"AvahiError: %s", error)
3611
1944
except KeyboardInterrupt:
3613
print("", file=sys.stderr)
3614
logger.debug("Server received KeyboardInterrupt")
3615
logger.debug("Server exiting")
1947
logger.debug(u"Server received KeyboardInterrupt")
1948
logger.debug(u"Server exiting")
3616
1949
# Must run before the D-Bus bus name gets deregistered
3620
1952
if __name__ == '__main__':