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