193
418
dbus.UInt16(self.port),
194
419
avahi.string_array_to_txt_array(self.TXT))
195
420
self.group.Commit()
196
422
def entry_group_state_changed(self, state, error):
197
423
"""Derived from the Avahi example code"""
198
logger.debug(u"Avahi state change: %i", state)
424
logger.debug("Avahi entry group state change: %i", state)
200
426
if state == avahi.ENTRY_GROUP_ESTABLISHED:
201
logger.debug(u"Zeroconf service established.")
427
logger.debug("Zeroconf service established.")
202
428
elif state == avahi.ENTRY_GROUP_COLLISION:
203
logger.warning(u"Zeroconf service name collision.")
429
logger.info("Zeroconf service name collision.")
205
431
elif state == avahi.ENTRY_GROUP_FAILURE:
206
logger.critical(u"Avahi: Error in group state changed %s",
208
raise AvahiGroupError(u"State changed: %s"
432
logger.critical("Avahi: Error in group state changed %s",
434
raise AvahiGroupError("State changed: {!s}".format(error))
210
436
def cleanup(self):
211
437
"""Derived from the Avahi example code"""
212
438
if self.group is not None:
441
except (dbus.exceptions.UnknownMethodException,
442
dbus.exceptions.DBusException):
214
444
self.group = None
215
def server_state_changed(self, state):
447
def server_state_changed(self, state, error=None):
216
448
"""Derived from the Avahi example code"""
217
if state == avahi.SERVER_COLLISION:
218
logger.error(u"Zeroconf server name collision")
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)
220
463
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)
222
482
def activate(self):
223
483
"""Derived from the Avahi example code"""
224
484
if self.server is None:
225
485
self.server = dbus.Interface(
226
486
self.bus.get_object(avahi.DBUS_NAME,
227
avahi.DBUS_PATH_SERVER),
487
avahi.DBUS_PATH_SERVER,
488
follow_name_owner_changes=True),
228
489
avahi.DBUS_INTERFACE_SERVER)
229
self.server.connect_to_signal(u"StateChanged",
230
self.server_state_changed)
490
self.server.connect_to_signal("StateChanged",
491
self.server_state_changed)
231
492
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))
234
817
class Client(object):
235
818
"""A representation of a client host served by this server.
238
name: string; from the config file, used in log messages and
240
fingerprint: string (40 or 32 hexadecimal digits); used to
241
uniquely identify the client
242
secret: bytestring; sent verbatim (over TLS) to client
243
host: string; available for use by the checker command
244
created: datetime.datetime(); (UTC) object creation
245
last_enabled: datetime.datetime(); (UTC)
247
last_checked_ok: datetime.datetime(); (UTC) or None
248
timeout: datetime.timedelta(); How long from last_checked_ok
249
until this client is disabled
250
interval: datetime.timedelta(); How often to start a new checker
251
disable_hook: If set, called by disable() as disable_hook(self)
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
252
824
checker: subprocess.Popen(); a running checker process used
253
825
to see if the client lives.
254
826
'None' if no process is running.
255
checker_initiator_tag: a gobject event source tag, or None
256
disable_initiator_tag: - '' -
257
checker_callback_tag: - '' -
258
checker_command: string; External command which is run to check if
259
client lives. %() expansions are done at
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
260
830
runtime with vars(self) as dict, so that for
261
831
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
262
836
current_checker_command: string; current running checker_command
263
approved_delay: datetime.timedelta(); Time to wait for approval
264
_approved: bool(); 'None' if not yet approved/disapproved
265
approved_duration: datetime.timedelta(); Duration of one approval
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",
269
def _timedelta_to_milliseconds(td):
270
"Convert a datetime.timedelta() to milliseconds"
271
return ((td.days * 24 * 60 * 60 * 1000)
272
+ (td.seconds * 1000)
273
+ (td.microseconds // 1000))
275
def timeout_milliseconds(self):
276
"Return the 'timeout' attribute in milliseconds"
277
return self._timedelta_to_milliseconds(self.timeout)
279
def interval_milliseconds(self):
280
"Return the 'interval' attribute in milliseconds"
281
return self._timedelta_to_milliseconds(self.interval)
283
def approved_delay_milliseconds(self):
284
return self._timedelta_to_milliseconds(self.approved_delay)
286
def __init__(self, name = None, disable_hook=None, config=None):
287
"""Note: the 'checker' key in 'config' sets the
288
'checker_command' attribute and *not* the 'checker'
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):
293
logger.debug(u"Creating client %r", self.name)
294
# Uppercase and remove spaces from fingerprint for later
295
# comparison purposes with return value from the fingerprint()
297
self.fingerprint = (config[u"fingerprint"].upper()
299
logger.debug(u" Fingerprint: %s", self.fingerprint)
300
if u"secret" in config:
301
self.secret = config[u"secret"].decode(u"base64")
302
elif u"secfile" in config:
303
with open(os.path.expanduser(os.path.expandvars
304
(config[u"secfile"])),
306
self.secret = secfile.read()
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()
308
#XXX Need to allow secret on demand!
309
raise TypeError(u"No secret or secfile for client %s"
311
self.host = config.get(u"host", u"")
312
self.created = datetime.datetime.utcnow()
314
self.last_enabled = None
315
self.last_checked_ok = None
316
self.timeout = string_to_delta(config[u"timeout"])
317
self.interval = string_to_delta(config[u"interval"])
318
self.disable_hook = disable_hook
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
319
962
self.checker = None
320
963
self.checker_initiator_tag = None
321
964
self.disable_initiator_tag = None
322
965
self.checker_callback_tag = None
323
self.checker_command = config[u"checker"]
324
966
self.current_checker_command = None
325
self.last_connect = None
326
968
self.approvals_pending = 0
327
self._approved = None
328
self.approved_by_default = config.get(u"approved_by_default",
330
self.approved_delay = string_to_delta(
331
config[u"approved_delay"])
332
self.approved_duration = string_to_delta(
333
config[u"approved_duration"])
334
self.changedstate = multiprocessing_manager.Condition(multiprocessing_manager.Lock())
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
336
982
def send_changedstate(self):
337
self.changedstate.acquire()
338
self.changedstate.notify_all()
339
self.changedstate.release()
983
with self.changedstate:
984
self.changedstate.notify_all()
341
986
def enable(self):
342
987
"""Start this client's checker and timeout hooks"""
343
if getattr(self, u"enabled", False):
988
if getattr(self, "enabled", False):
344
989
# Already enabled
346
self.send_changedstate()
991
self.expires = datetime.datetime.utcnow() + self.timeout
347
993
self.last_enabled = datetime.datetime.utcnow()
995
self.send_changedstate()
997
def disable(self, quiet=True):
998
"""Disable this client."""
999
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)
1005
self.disable_initiator_tag = None
1007
if getattr(self, "checker_initiator_tag", None) is not None:
1008
GLib.source_remove(self.checker_initiator_tag)
1009
self.checker_initiator_tag = None
1011
self.enabled = False
1013
self.send_changedstate()
1014
# Do not run this again if called by a GLib.timeout_add
1020
def init_checker(self):
348
1021
# Schedule a new checker to be started an 'interval' from now,
349
1022
# and every interval from then on.
350
self.checker_initiator_tag = (gobject.timeout_add
351
(self.interval_milliseconds(),
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),
353
1028
# Schedule a disable() when 'timeout' has passed
354
self.disable_initiator_tag = (gobject.timeout_add
355
(self.timeout_milliseconds(),
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)
358
1033
# Also start a new checker *right now*.
359
1034
self.start_checker()
361
def disable(self, quiet=True):
362
"""Disable this client."""
363
if not getattr(self, "enabled", False):
366
self.send_changedstate()
368
logger.info(u"Disabling client %s", self.name)
369
if getattr(self, u"disable_initiator_tag", False):
370
gobject.source_remove(self.disable_initiator_tag)
371
self.disable_initiator_tag = None
372
if getattr(self, u"checker_initiator_tag", False):
373
gobject.source_remove(self.checker_initiator_tag)
374
self.checker_initiator_tag = None
376
if self.disable_hook:
377
self.disable_hook(self)
379
# Do not run this again if called by a gobject.timeout_add
383
self.disable_hook = None
386
def checker_callback(self, pid, condition, command):
1036
def checker_callback(self, source, condition, connection,
387
1038
"""The checker has completed, so take appropriate actions."""
388
1039
self.checker_callback_tag = None
389
1040
self.checker = None
390
if os.WIFEXITED(condition):
391
exitstatus = os.WEXITSTATUS(condition)
393
logger.info(u"Checker for %(name)s succeeded",
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",
395
1051
self.checked_ok()
397
logger.info(u"Checker for %(name)s failed",
1053
logger.info("Checker for %(name)s failed", vars(self))
400
logger.warning(u"Checker for %(name)s crashed?",
1055
self.last_checker_status = -1
1056
self.last_checker_signal = -returncode
1057
logger.warning("Checker for %(name)s crashed?",
403
1061
def checked_ok(self):
404
"""Bump up the timeout for this client.
406
This should only be called when the client has been seen,
1062
"""Assert that the client has been seen, alive and well."""
409
1063
self.last_checked_ok = datetime.datetime.utcnow()
410
gobject.source_remove(self.disable_initiator_tag)
411
self.disable_initiator_tag = (gobject.timeout_add
412
(self.timeout_milliseconds(),
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()
415
1083
def start_checker(self):
416
1084
"""Start a new checker subprocess if one is not running.
418
1086
If a checker already exists, leave it running and do
420
1088
# The reason for not killing a running checker is that if we
421
# did that, then if a checker (for some reason) started
422
# running slowly and taking more than 'interval' time, the
423
# client would inevitably timeout, since no checker would get
424
# a chance to run to completion. If we instead leave running
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
425
1093
# checkers alone, the checker would have to take more time
426
1094
# than 'timeout' for the client to be disabled, which is as it
429
# If a checker exists, make sure it is not a zombie
431
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
432
except (AttributeError, OSError), error:
433
if (isinstance(error, OSError)
434
and error.errno != errno.ECHILD):
438
logger.warning(u"Checker was a zombie")
439
gobject.source_remove(self.checker_callback_tag)
440
self.checker_callback(pid, status,
441
self.current_checker_command)
1097
if self.checker is not None and not self.checker.is_alive():
1098
logger.warning("Checker was not alive; joining")
442
1101
# Start a new checker if needed
443
1102
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}
445
# In case checker_command has exactly one % operator
446
command = self.checker_command % self.host
448
# Escape attributes for the shell
449
escaped_attrs = dict((key,
450
re.escape(unicode(str(val),
454
vars(self).iteritems())
456
command = self.checker_command % escaped_attrs
457
except TypeError, error:
458
logger.error(u'Could not format string "%s":'
459
u' %s', self.checker_command, error)
460
return True # Try again later
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
461
1114
self.current_checker_command = command
463
logger.info(u"Starting checker %r for %s",
465
# We don't need to redirect stdout and stderr, since
466
# in normal mode, that is already done by daemon(),
467
# and in debug mode we don't want to. (Stdin is
468
# always replaced by /dev/null.)
469
self.checker = subprocess.Popen(command,
471
shell=True, cwd=u"/")
472
self.checker_callback_tag = (gobject.child_watch_add
474
self.checker_callback,
476
# The checker may have completed before the gobject
477
# watch was added. Check for this.
478
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
480
gobject.source_remove(self.checker_callback_tag)
481
self.checker_callback(pid, status, command)
482
except OSError, error:
483
logger.error(u"Failed to start subprocess: %s",
485
# Re-run this periodically if run by gobject.timeout_add
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
488
1143
def stop_checker(self):
489
1144
"""Force the checker process, if any, to stop."""
490
1145
if self.checker_callback_tag:
491
gobject.source_remove(self.checker_callback_tag)
1146
GLib.source_remove(self.checker_callback_tag)
492
1147
self.checker_callback_tag = None
493
if getattr(self, u"checker", None) is None:
1148
if getattr(self, "checker", None) is None:
495
logger.debug(u"Stopping checker for %(name)s", vars(self))
497
os.kill(self.checker.pid, signal.SIGTERM)
499
#if self.checker.poll() is None:
500
# os.kill(self.checker.pid, signal.SIGKILL)
501
except OSError, error:
502
if error.errno != errno.ESRCH: # No such process
1150
logger.debug("Stopping checker for %(name)s", vars(self))
1151
self.checker.terminate()
504
1152
self.checker = None
506
def dbus_service_property(dbus_interface, signature=u"v",
507
access=u"readwrite", byte_arrays=False):
1155
def dbus_service_property(dbus_interface,
508
1159
"""Decorators for marking methods of a DBusObjectWithProperties to
509
1160
become properties on the D-Bus.
511
1162
The decorated method will be called with no arguments by "Get"
512
1163
and with one argument by "Set".
514
1165
The parameters, where they are supported, are the same as
515
1166
dbus.service.method, except there is only "signature", since the
516
1167
type from Get() and the type sent to Set() is the same.
518
1169
# Encoding deeply encoded byte arrays is not supported yet by the
519
1170
# "Set" method, so we fail early here:
520
if byte_arrays and signature != u"ay":
521
raise ValueError(u"Byte arrays not supported for non-'ay'"
522
u" signature %r" % signature)
1171
if byte_arrays and signature != "ay":
1172
raise ValueError("Byte arrays not supported for non-'ay'"
1173
" signature {!r}".format(signature))
523
1175
def decorator(func):
524
1176
func._dbus_is_property = True
525
1177
func._dbus_interface = dbus_interface
526
1178
func._dbus_signature = signature
527
1179
func._dbus_access = access
528
1180
func._dbus_name = func.__name__
529
if func._dbus_name.endswith(u"_dbus_property"):
1181
if func._dbus_name.endswith("_dbus_property"):
530
1182
func._dbus_name = func._dbus_name[:-14]
531
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
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
533
1229
return decorator
536
1232
class DBusPropertyException(dbus.exceptions.DBusException):
537
1233
"""A base class for D-Bus property-related exceptions
539
def __unicode__(self):
540
return unicode(str(self))
543
1238
class DBusPropertyAccessException(DBusPropertyException):
555
class DBusObjectWithProperties(dbus.service.Object):
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):
556
1340
"""A D-Bus object with properties.
558
1342
Classes inheriting from this can use the dbus_service_property
559
1343
decorator to expose methods as D-Bus properties. It exposes the
560
1344
standard Get(), Set(), and GetAll() methods on the D-Bus.
564
def _is_dbus_property(obj):
565
return getattr(obj, u"_dbus_is_property", False)
567
def _get_all_dbus_properties(self):
568
"""Returns a generator of (name, attribute) pairs
570
return ((prop._dbus_name, prop)
572
inspect.getmembers(self, self._is_dbus_property))
574
1347
def _get_dbus_property(self, interface_name, property_name):
575
1348
"""Returns a bound method if one exists which is a D-Bus
576
1349
property with the specified name and interface.
578
for name in (property_name,
579
property_name + u"_dbus_property"):
580
prop = getattr(self, name, None)
582
or not self._is_dbus_property(prop)
583
or prop._dbus_name != property_name
584
or (interface_name and prop._dbus_interface
585
and interface_name != prop._dbus_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)
588
1358
# No such property
589
raise DBusPropertyNotFound(self.dbus_object_path + u":"
590
+ interface_name + u"."
593
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
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,
595
1374
def Get(self, interface_name, property_name):
596
1375
"""Standard D-Bus property Get() method, see D-Bus standard.
598
1377
prop = self._get_dbus_property(interface_name, property_name)
599
if prop._dbus_access == u"write":
1378
if prop._dbus_access == "write":
600
1379
raise DBusPropertyAccessException(property_name)
602
if not hasattr(value, u"variant_level"):
1381
if not hasattr(value, "variant_level"):
604
1383
return type(value)(value, variant_level=value.variant_level+1)
606
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
1385
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
607
1386
def Set(self, interface_name, property_name, value):
608
1387
"""Standard D-Bus property Set() method, see D-Bus standard.
610
1389
prop = self._get_dbus_property(interface_name, property_name)
611
if prop._dbus_access == u"read":
1390
if prop._dbus_access == "read":
612
1391
raise DBusPropertyAccessException(property_name)
613
if prop._dbus_get_args_options[u"byte_arrays"]:
1392
if prop._dbus_get_args_options["byte_arrays"]:
614
1393
# The byte_arrays option is not supported yet on
615
1394
# signatures other than "ay".
616
if prop._dbus_signature != u"ay":
618
value = dbus.ByteArray(''.join(unichr(byte)
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)
622
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
623
out_signature=u"a{sv}")
1403
@dbus.service.method(dbus.PROPERTIES_IFACE,
1405
out_signature="a{sv}")
624
1406
def GetAll(self, interface_name):
625
1407
"""Standard D-Bus property GetAll() method, see D-Bus
628
1410
Note: Will not include properties with access="write".
631
for name, prop in self._get_all_dbus_properties():
1413
for name, prop in self._get_all_dbus_things("property"):
632
1414
if (interface_name
633
1415
and interface_name != prop._dbus_interface):
634
1416
# Interface non-empty but did not match
636
1418
# Ignore write-only properties
637
if prop._dbus_access == u"write":
1419
if prop._dbus_access == "write":
640
if not hasattr(value, u"variant_level"):
1422
if not hasattr(value, "variant_level"):
1423
properties[name] = value
643
all[name] = type(value)(value, variant_level=
644
value.variant_level+1)
645
return dbus.Dictionary(all, signature=u"sv")
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
647
1437
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
649
1439
path_keyword='object_path',
650
1440
connection_keyword='connection')
651
1441
def Introspect(self, object_path, connection):
652
"""Standard D-Bus method, overloaded to insert property tags.
1442
"""Overloading of standard D-Bus method.
1444
Inserts property tags and interface annotation tags.
654
xmlstring = dbus.service.Object.Introspect(self, object_path,
1446
xmlstring = DBusObjectWithAnnotations.Introspect(self,
657
1450
document = xml.dom.minidom.parseString(xmlstring)
658
1452
def make_tag(document, name, prop):
659
e = document.createElement(u"property")
660
e.setAttribute(u"name", name)
661
e.setAttribute(u"type", prop._dbus_signature)
662
e.setAttribute(u"access", prop._dbus_access)
1453
e = document.createElement("property")
1454
e.setAttribute("name", name)
1455
e.setAttribute("type", prop._dbus_signature)
1456
e.setAttribute("access", prop._dbus_access)
664
for if_tag in document.getElementsByTagName(u"interface"):
1459
for if_tag in document.getElementsByTagName("interface"):
665
1461
for tag in (make_tag(document, name, prop)
667
in self._get_all_dbus_properties()
1463
in self._get_all_dbus_things("property")
668
1464
if prop._dbus_interface
669
== if_tag.getAttribute(u"name")):
1465
== if_tag.getAttribute("name")):
670
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)
671
1483
# Add the names to the return values for the
672
1484
# "org.freedesktop.DBus.Properties" methods
673
if (if_tag.getAttribute(u"name")
674
== u"org.freedesktop.DBus.Properties"):
675
for cn in if_tag.getElementsByTagName(u"method"):
676
if cn.getAttribute(u"name") == u"Get":
677
for arg in cn.getElementsByTagName(u"arg"):
678
if (arg.getAttribute(u"direction")
680
arg.setAttribute(u"name", u"value")
681
elif cn.getAttribute(u"name") == u"GetAll":
682
for arg in cn.getElementsByTagName(u"arg"):
683
if (arg.getAttribute(u"direction")
685
arg.setAttribute(u"name", u"props")
686
xmlstring = document.toxml(u"utf-8")
688
except (AttributeError, xml.dom.DOMException,
689
xml.parsers.expat.ExpatError), error:
690
logger.error(u"Failed to override Introspection method",
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"})
695
1756
class ClientDBus(Client, DBusObjectWithProperties):
696
1757
"""A Client class using D-Bus
699
1760
dbus_object_path: dbus.ObjectPath
700
1761
bus: dbus.SystemBus()
1764
runtime_expansions = (Client.runtime_expansions
1765
+ ("dbus_object_path", ))
1767
_interface = "se.recompile.Mandos.Client"
702
1769
# dbus.service.Object doesn't use super(), so we can't either.
704
def __init__(self, bus = None, *args, **kwargs):
705
self._approvals_pending = 0
1771
def __init__(self, bus=None, *args, **kwargs):
707
1773
Client.__init__(self, *args, **kwargs)
708
1774
# Only now, when this client is initialized, can it show up on
710
self.dbus_object_path = (dbus.ObjectPath
712
+ self.name.replace(u".", u"_")))
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)
713
1781
DBusObjectWithProperties.__init__(self, self.bus,
714
1782
self.dbus_object_path)
716
def _get_approvals_pending(self, value):
717
return self._approvals_pending
718
def _set_approvals_pending(self, value):
719
old_value = self._approvals_pending
720
self._approvals_pending = value
722
if (hasattr(self, "dbus_object_path")
723
and bval is bool(old_value)):
724
dbus_bool = dbus.Boolean(bval, variant_level=1)
725
self.PropertyChanged(dbus.String(u"approved_pending"),
728
approvals_pending = property(_get_approvals_pending,
729
_set_approvals_pending)
730
del _get_approvals_pending, _set_approvals_pending
733
def _datetime_to_dbus(dt, variant_level=0):
734
"""Convert a UTC datetime.datetime() to a D-Bus type."""
735
return dbus.String(dt.isoformat(),
736
variant_level=variant_level)
739
oldstate = getattr(self, u"enabled", False)
740
r = Client.enable(self)
741
if oldstate != self.enabled:
743
self.PropertyChanged(dbus.String(u"enabled"),
744
dbus.Boolean(True, variant_level=1))
745
self.PropertyChanged(
746
dbus.String(u"last_enabled"),
747
self._datetime_to_dbus(self.last_enabled,
751
def disable(self, quiet = False):
752
oldstate = getattr(self, u"enabled", False)
753
r = Client.disable(self, quiet=quiet)
754
if not quiet and oldstate != self.enabled:
756
self.PropertyChanged(dbus.String(u"enabled"),
757
dbus.Boolean(False, variant_level=1))
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
760
1865
def __del__(self, *args, **kwargs):
762
1867
self.remove_from_connection()
763
1868
except LookupError:
765
if hasattr(DBusObjectWithProperties, u"__del__"):
1870
if hasattr(DBusObjectWithProperties, "__del__"):
766
1871
DBusObjectWithProperties.__del__(self, *args, **kwargs)
767
1872
Client.__del__(self, *args, **kwargs)
769
def checker_callback(self, pid, condition, command,
771
self.checker_callback_tag = None
774
self.PropertyChanged(dbus.String(u"checker_running"),
775
dbus.Boolean(False, variant_level=1))
776
if os.WIFEXITED(condition):
777
exitstatus = os.WEXITSTATUS(condition)
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
778
1881
# Emit D-Bus signal
779
1882
self.CheckerCompleted(dbus.Int16(exitstatus),
780
dbus.Int64(condition),
1883
# This is specific to GNU libC
1884
dbus.Int64(exitstatus << 8),
781
1885
dbus.String(command))
783
1887
# Emit D-Bus signal
784
1888
self.CheckerCompleted(dbus.Int16(-1),
785
dbus.Int64(condition),
1890
# This is specific to GNU libC
1892
| self.last_checker_signal),
786
1893
dbus.String(command))
788
return Client.checker_callback(self, pid, condition, command,
791
def checked_ok(self, *args, **kwargs):
792
r = Client.checked_ok(self, *args, **kwargs)
794
self.PropertyChanged(
795
dbus.String(u"last_checked_ok"),
796
(self._datetime_to_dbus(self.last_checked_ok,
800
1896
def start_checker(self, *args, **kwargs):
801
old_checker = self.checker
802
if self.checker is not None:
803
old_checker_pid = self.checker.pid
805
old_checker_pid = None
1897
old_checker_pid = getattr(self.checker, "pid", None)
806
1898
r = Client.start_checker(self, *args, **kwargs)
807
1899
# Only if new checker process was started
808
1900
if (self.checker is not None
809
1901
and old_checker_pid != self.checker.pid):
810
1902
# Emit D-Bus signal
811
1903
self.CheckerStarted(self.current_checker_command)
812
self.PropertyChanged(
813
dbus.String(u"checker_running"),
814
dbus.Boolean(True, variant_level=1))
817
def stop_checker(self, *args, **kwargs):
818
old_checker = getattr(self, u"checker", None)
819
r = Client.stop_checker(self, *args, **kwargs)
820
if (old_checker is not None
821
and getattr(self, u"checker", None) is None):
822
self.PropertyChanged(dbus.String(u"checker_running"),
823
dbus.Boolean(False, variant_level=1))
826
1906
def _reset_approved(self):
827
self._approved = None
1907
self.approved = None
830
1910
def approve(self, value=True):
831
self._approved = value
832
gobject.timeout_add(self._timedelta_to_milliseconds(self.approved_duration, self._reset_approved))
835
## D-Bus methods, signals & properties
836
_interface = u"se.bsnet.fukt.Mandos.Client"
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
840
1922
# CheckerCompleted - signal
841
@dbus.service.signal(_interface, signature=u"nxs")
1923
@dbus.service.signal(_interface, signature="nxs")
842
1924
def CheckerCompleted(self, exitcode, waitstatus, command):
846
1928
# CheckerStarted - signal
847
@dbus.service.signal(_interface, signature=u"s")
1929
@dbus.service.signal(_interface, signature="s")
848
1930
def CheckerStarted(self, command):
852
1934
# PropertyChanged - signal
853
@dbus.service.signal(_interface, signature=u"sv")
1935
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
1936
@dbus.service.signal(_interface, signature="sv")
854
1937
def PropertyChanged(self, property, value):
858
1941
# GotSecret - signal
859
1942
@dbus.service.signal(_interface)
860
1943
def GotSecret(self):
1945
Is sent after a successful transfer of secret from the Mandos
1946
server to mandos-client
864
1950
# Rejected - signal
865
@dbus.service.signal(_interface, signature=u"s")
1951
@dbus.service.signal(_interface, signature="s")
866
1952
def Rejected(self, reason):
870
1956
# NeedApproval - signal
871
@dbus.service.signal(_interface, signature=u"db")
1957
@dbus.service.signal(_interface, signature="tb")
872
1958
def NeedApproval(self, timeout, default):
1960
return self.need_approval()
878
1964
# Approve - method
879
@dbus.service.method(_interface, in_signature=u"b")
1965
@dbus.service.method(_interface, in_signature="b")
880
1966
def Approve(self, value):
881
1967
self.approve(value)
883
1969
# CheckedOK - method
884
1970
@dbus.service.method(_interface)
885
1971
def CheckedOK(self):
886
return self.checked_ok()
888
1974
# Enable - method
1975
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
889
1976
@dbus.service.method(_interface)
890
1977
def Enable(self):
894
1981
# StartChecker - method
1982
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
895
1983
@dbus.service.method(_interface)
896
1984
def StartChecker(self):
898
1986
self.start_checker()
900
1988
# Disable - method
1989
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
901
1990
@dbus.service.method(_interface)
902
1991
def Disable(self):
906
1995
# StopChecker - method
1996
@dbus_annotations({"org.freedesktop.DBus.Deprecated": "true"})
907
1997
@dbus.service.method(_interface)
908
1998
def StopChecker(self):
909
1999
self.stop_checker()
913
# approved_pending - property
914
@dbus_service_property(_interface, signature=u"b", access=u"read")
915
def approved_pending_dbus_property(self):
2003
# ApprovalPending - property
2004
@dbus_service_property(_interface, signature="b", access="read")
2005
def ApprovalPending_dbus_property(self):
916
2006
return dbus.Boolean(bool(self.approvals_pending))
918
# approved_by_default - property
919
@dbus_service_property(_interface, signature=u"b",
921
def approved_by_default_dbus_property(self):
922
return dbus.Boolean(self.approved_by_default)
924
# approved_delay - property
925
@dbus_service_property(_interface, signature=u"t",
927
def approved_delay_dbus_property(self):
928
return dbus.UInt64(self.approved_delay_milliseconds())
930
# approved_duration - property
931
@dbus_service_property(_interface, signature=u"t",
933
def approved_duration_dbus_property(self):
934
return dbus.UInt64(self._timedelta_to_milliseconds(
935
self.approved_duration))
938
@dbus_service_property(_interface, signature=u"s", access=u"read")
939
def name_dbus_property(self):
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):
940
2042
return dbus.String(self.name)
942
# fingerprint - property
943
@dbus_service_property(_interface, signature=u"s", access=u"read")
944
def fingerprint_dbus_property(self):
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):
945
2056
return dbus.String(self.fingerprint)
948
@dbus_service_property(_interface, signature=u"s",
950
def host_dbus_property(self, value=None):
2059
@dbus_service_property(_interface,
2062
def Host_dbus_property(self, value=None):
951
2063
if value is None: # get
952
2064
return dbus.String(self.host)
955
self.PropertyChanged(dbus.String(u"host"),
956
dbus.String(value, variant_level=1))
959
@dbus_service_property(_interface, signature=u"s", access=u"read")
960
def created_dbus_property(self):
961
return dbus.String(self._datetime_to_dbus(self.created))
963
# last_enabled - property
964
@dbus_service_property(_interface, signature=u"s", access=u"read")
965
def last_enabled_dbus_property(self):
966
if self.last_enabled is None:
967
return dbus.String(u"")
968
return dbus.String(self._datetime_to_dbus(self.last_enabled))
971
@dbus_service_property(_interface, signature=u"b",
973
def enabled_dbus_property(self, value=None):
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):
974
2084
if value is None: # get
975
2085
return dbus.Boolean(self.enabled)
981
# last_checked_ok - property
982
@dbus_service_property(_interface, signature=u"s",
984
def last_checked_ok_dbus_property(self, value=None):
2091
# LastCheckedOK - property
2092
@dbus_service_property(_interface,
2095
def LastCheckedOK_dbus_property(self, value=None):
985
2096
if value is not None:
986
2097
self.checked_ok()
988
if self.last_checked_ok is None:
989
return dbus.String(u"")
990
return dbus.String(self._datetime_to_dbus(self
994
@dbus_service_property(_interface, signature=u"t",
996
def timeout_dbus_property(self, value=None):
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):
997
2121
if value is None: # get
998
return dbus.UInt64(self.timeout_milliseconds())
2122
return dbus.UInt64(self.timeout.total_seconds() * 1000)
2123
old_timeout = self.timeout
999
2124
self.timeout = datetime.timedelta(0, 0, 0, value)
1001
self.PropertyChanged(dbus.String(u"timeout"),
1002
dbus.UInt64(value, variant_level=1))
1003
if getattr(self, u"disable_initiator_tag", None) is None:
1005
# Reschedule timeout
1006
gobject.source_remove(self.disable_initiator_tag)
1007
self.disable_initiator_tag = None
1008
time_to_die = (self.
1009
_timedelta_to_milliseconds((self
1014
if time_to_die <= 0:
1015
# The timeout has passed
1018
self.disable_initiator_tag = (gobject.timeout_add
1019
(time_to_die, self.disable))
1021
# interval - property
1022
@dbus_service_property(_interface, signature=u"t",
1023
access=u"readwrite")
1024
def interval_dbus_property(self, value=None):
1025
if value is None: # get
1026
return dbus.UInt64(self.interval_milliseconds())
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)
1027
2158
self.interval = datetime.timedelta(0, 0, 0, value)
1029
self.PropertyChanged(dbus.String(u"interval"),
1030
dbus.UInt64(value, variant_level=1))
1031
if getattr(self, u"checker_initiator_tag", None) is None:
2159
if getattr(self, "checker_initiator_tag", None) is None:
1033
# Reschedule checker run
1034
gobject.source_remove(self.checker_initiator_tag)
1035
self.checker_initiator_tag = (gobject.timeout_add
1036
(value, self.start_checker))
1037
self.start_checker() # Start one now, too
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
1039
# checker - property
1040
@dbus_service_property(_interface, signature=u"s",
1041
access=u"readwrite")
1042
def checker_dbus_property(self, value=None):
2168
# Checker - property
2169
@dbus_service_property(_interface,
2172
def Checker_dbus_property(self, value=None):
1043
2173
if value is None: # get
1044
2174
return dbus.String(self.checker_command)
1045
self.checker_command = value
1047
self.PropertyChanged(dbus.String(u"checker"),
1048
dbus.String(self.checker_command,
1051
# checker_running - property
1052
@dbus_service_property(_interface, signature=u"b",
1053
access=u"readwrite")
1054
def checker_running_dbus_property(self, value=None):
2175
self.checker_command = str(value)
2177
# CheckerRunning - property
2178
@dbus_service_property(_interface,
2181
def CheckerRunning_dbus_property(self, value=None):
1055
2182
if value is None: # get
1056
2183
return dbus.Boolean(self.checker is not None)
1058
2185
self.start_checker()
1060
2187
self.stop_checker()
1062
# object_path - property
1063
@dbus_service_property(_interface, signature=u"o", access=u"read")
1064
def object_path_dbus_property(self):
1065
return self.dbus_object_path # is already a dbus.ObjectPath
1068
@dbus_service_property(_interface, signature=u"ay",
1069
access=u"write", byte_arrays=True)
1070
def secret_dbus_property(self, value):
1071
self.secret = str(value)
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)
1076
2211
class ProxyClient(object):
1077
def __init__(self, child_pipe, fpr, address):
2212
def __init__(self, child_pipe, key_id, fpr, address):
1078
2213
self._pipe = child_pipe
1079
self._pipe.send(('init', fpr, address))
2214
self._pipe.send(('init', key_id, fpr, address))
1080
2215
if not self._pipe.recv():
2216
raise KeyError(key_id or fpr)
1083
2218
def __getattribute__(self, name):
1084
if(name == '_pipe'):
1085
2220
return super(ProxyClient, self).__getattribute__(name)
1086
2221
self._pipe.send(('getattr', name))
1087
2222
data = self._pipe.recv()
1088
2223
if data[0] == 'data':
1090
2225
if data[0] == 'function':
1091
2227
def func(*args, **kwargs):
1092
2228
self._pipe.send(('funcall', name, args, kwargs))
1093
2229
return self._pipe.recv()[1]
1096
2233
def __setattr__(self, name, value):
1097
if(name == '_pipe'):
1098
2235
return super(ProxyClient, self).__setattr__(name, value)
1099
2236
self._pipe.send(('setattr', name, value))
1102
2239
class ClientHandler(socketserver.BaseRequestHandler, object):
1103
2240
"""A class to handle client connections.
1105
2242
Instantiated once for each connection to handle it.
1106
2243
Note: This will run in its own forked process."""
1108
2245
def handle(self):
1109
2246
with contextlib.closing(self.server.child_pipe) as child_pipe:
1110
logger.info(u"TCP connection from: %s",
1111
unicode(self.client_address))
1112
logger.debug(u"Pipe FD: %d",
2247
logger.info("TCP connection from: %s",
2248
str(self.client_address))
2249
logger.debug("Pipe FD: %d",
1113
2250
self.server.child_pipe.fileno())
1115
session = (gnutls.connection
1116
.ClientSession(self.request,
1118
.X509Credentials()))
1120
# Note: gnutls.connection.X509Credentials is really a
1121
# generic GnuTLS certificate credentials object so long as
1122
# no X.509 keys are added to it. Therefore, we can use it
1123
# here despite using OpenPGP certificates.
1125
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1126
# u"+AES-256-CBC", u"+SHA1",
1127
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
2252
session = gnutls.ClientSession(self.request)
2254
# priority = ':'.join(("NONE", "+VERS-TLS1.1",
2255
# "+AES-256-CBC", "+SHA1",
2256
# "+COMP-NULL", "+CTYPE-OPENPGP",
1129
2258
# Use a fallback default, since this MUST be set.
1130
2259
priority = self.server.gnutls_priority
1131
2260
if priority is None:
1132
priority = u"NORMAL"
1133
(gnutls.library.functions
1134
.gnutls_priority_set_direct(session._c_object,
2262
gnutls.priority_set_direct(session._c_object,
2263
priority.encode("utf-8"),
1137
2266
# Start communication using the Mandos protocol
1138
2267
# Get protocol number
1139
2268
line = self.request.makefile().readline()
1140
logger.debug(u"Protocol version: %r", line)
2269
logger.debug("Protocol version: %r", line)
1142
2271
if int(line.strip().split()[0]) > 1:
1144
except (ValueError, IndexError, RuntimeError), error:
1145
logger.error(u"Unknown protocol version: %s", error)
2272
raise RuntimeError(line)
2273
except (ValueError, IndexError, RuntimeError) as error:
2274
logger.error("Unknown protocol version: %s", error)
1148
2277
# Start GnuTLS connection
1150
2279
session.handshake()
1151
except gnutls.errors.GNUTLSError, error:
1152
logger.warning(u"Handshake failed: %s", error)
2280
except gnutls.Error as error:
2281
logger.warning("Handshake failed: %s", error)
1153
2282
# Do not run session.bye() here: the session is not
1154
2283
# established. Just abandon the request.
1156
logger.debug(u"Handshake succeeded")
2285
logger.debug("Handshake succeeded")
1158
2287
approval_required = False
1161
fpr = self.fingerprint(self.peer_certificate
1163
except (TypeError, gnutls.errors.GNUTLSError), error:
1164
logger.warning(u"Bad certificate: %s", error)
1166
logger.debug(u"Fingerprint: %s", fpr)
1169
client = ProxyClient(child_pipe, fpr,
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,
1170
2311
self.client_address)
1171
2312
except KeyError:
1174
if client.approved_delay:
1175
delay = client.approved_delay
2315
if client.approval_delay:
2316
delay = client.approval_delay
1176
2317
client.approvals_pending += 1
1177
2318
approval_required = True
1180
2321
if not client.enabled:
1181
logger.warning(u"Client %s is disabled",
2322
logger.info("Client %s is disabled",
1183
2324
if self.server.use_dbus:
1184
2325
# Emit D-Bus signal
1185
client.Rejected("Disabled")
2326
client.Rejected("Disabled")
1188
if client._approved or not client.approved_delay:
1189
#We are approved or approval is disabled
2329
if client.approved or not client.approval_delay:
2330
# We are approved or approval is disabled
1191
elif client._approved is None:
1192
logger.info(u"Client %s need approval",
2332
elif client.approved is None:
2333
logger.info("Client %s needs approval",
1194
2335
if self.server.use_dbus:
1195
2336
# Emit D-Bus signal
1196
2337
client.NeedApproval(
1197
client.approved_delay_milliseconds(),
1198
client.approved_by_default)
2338
client.approval_delay.total_seconds()
2339
* 1000, client.approved_by_default)
1200
logger.warning(u"Client %s was not approved",
2341
logger.warning("Client %s was not approved",
1202
2343
if self.server.use_dbus:
1203
2344
# Emit D-Bus signal
1204
client.Rejected("Disapproved")
2345
client.Rejected("Denied")
1207
#wait until timeout or approved
1208
#x = float(client._timedelta_to_milliseconds(delay))
2348
# wait until timeout or approved
1209
2349
time = datetime.datetime.now()
1210
2350
client.changedstate.acquire()
1211
client.changedstate.wait(float(client._timedelta_to_milliseconds(delay) / 1000))
2351
client.changedstate.wait(delay.total_seconds())
1212
2352
client.changedstate.release()
1213
2353
time2 = datetime.datetime.now()
1214
2354
if (time2 - time) >= delay:
1219
2359
if self.server.use_dbus:
1220
2360
# Emit D-Bus signal
1221
client.Rejected("Time out")
2361
client.Rejected("Approval timed out")
1226
2366
delay -= time2 - time
1229
while sent_size < len(client.secret):
1230
# XXX handle session exception
1231
sent = session.send(client.secret[sent_size:])
1232
logger.debug(u"Sent: %d, remaining: %d",
1233
sent, len(client.secret)
1234
- (sent_size + sent))
1237
logger.info(u"Sending secret to %s", client.name)
1238
# bump the timeout as if seen
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)
1240
2378
if self.server.use_dbus:
1241
2379
# Emit D-Bus signal
1242
2380
client.GotSecret()
1245
2383
if approval_required:
1246
2384
client.approvals_pending -= 1
2387
except gnutls.Error as error:
2388
logger.warning("GnuTLS bye failed",
1250
2392
def peer_certificate(session):
1251
"Return the peer's OpenPGP certificate as a bytestring"
1252
# If not an OpenPGP certificate...
1253
if (gnutls.library.functions
1254
.gnutls_certificate_type_get(session._c_object)
1255
!= gnutls.library.constants.GNUTLS_CRT_OPENPGP):
1256
# ...do the normal thing
1257
return session.peer_certificate
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
1258
2409
list_size = ctypes.c_uint(1)
1259
cert_list = (gnutls.library.functions
1260
.gnutls_certificate_get_peers
2410
cert_list = (gnutls.certificate_get_peers
1261
2411
(session._c_object, ctypes.byref(list_size)))
1262
2412
if not bool(cert_list) and list_size.value != 0:
1263
raise gnutls.errors.GNUTLSError(u"error getting peer"
2413
raise gnutls.Error("error getting peer certificate")
1265
2414
if list_size.value == 0:
1267
2416
cert = cert_list[0]
1268
2417
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()
1271
2454
def fingerprint(openpgp):
1272
2455
"Convert an OpenPGP bytestring to a hexdigit fingerprint"
1273
2456
# New GnuTLS "datum" with the OpenPGP public key
1274
datum = (gnutls.library.types
1275
.gnutls_datum_t(ctypes.cast(ctypes.c_char_p(openpgp),
1278
ctypes.c_uint(len(openpgp))))
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)))
1279
2461
# New empty GnuTLS certificate
1280
crt = gnutls.library.types.gnutls_openpgp_crt_t()
1281
(gnutls.library.functions
1282
.gnutls_openpgp_crt_init(ctypes.byref(crt)))
2462
crt = gnutls.openpgp_crt_t()
2463
gnutls.openpgp_crt_init(ctypes.byref(crt))
1283
2464
# Import the OpenPGP public key into the certificate
1284
(gnutls.library.functions
1285
.gnutls_openpgp_crt_import(crt, ctypes.byref(datum),
1286
gnutls.library.constants
1287
.GNUTLS_OPENPGP_FMT_RAW))
2465
gnutls.openpgp_crt_import(crt, ctypes.byref(datum),
2466
gnutls.OPENPGP_FMT_RAW)
1288
2467
# Verify the self signature in the key
1289
2468
crtverify = ctypes.c_uint()
1290
(gnutls.library.functions
1291
.gnutls_openpgp_crt_verify_self(crt, 0,
1292
ctypes.byref(crtverify)))
2469
gnutls.openpgp_crt_verify_self(crt, 0,
2470
ctypes.byref(crtverify))
1293
2471
if crtverify.value != 0:
1294
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1295
raise (gnutls.errors.CertificateSecurityError
2472
gnutls.openpgp_crt_deinit(crt)
2473
raise gnutls.CertificateSecurityError(code
1297
2475
# New buffer for the fingerprint
1298
2476
buf = ctypes.create_string_buffer(20)
1299
2477
buf_len = ctypes.c_size_t()
1300
2478
# Get the fingerprint from the certificate into the buffer
1301
(gnutls.library.functions
1302
.gnutls_openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
1303
ctypes.byref(buf_len)))
2479
gnutls.openpgp_crt_get_fingerprint(crt, ctypes.byref(buf),
2480
ctypes.byref(buf_len))
1304
2481
# Deinit the certificate
1305
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
2482
gnutls.openpgp_crt_deinit(crt)
1306
2483
# Convert the buffer to a Python bytestring
1307
2484
fpr = ctypes.string_at(buf, buf_len.value)
1308
2485
# Convert the bytestring to hexadecimal notation
1309
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
2486
hex_fpr = binascii.hexlify(fpr).upper()
1313
2490
class MultiprocessingMixIn(object):
1314
2491
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1315
2493
def sub_process_main(self, request, address):
1317
2495
self.finish_request(request, address)
1319
2497
self.handle_error(request, address)
1320
2498
self.close_request(request)
1322
2500
def process_request(self, request, address):
1323
2501
"""Start a new process to process the request."""
1324
multiprocessing.Process(target = self.sub_process_main,
1325
args = (request, address)).start()
2502
proc = multiprocessing.Process(target=self.sub_process_main,
2503
args=(request, address))
1327
2508
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1328
2509
""" adds a pipe to the MixIn """
1329
2511
def process_request(self, request, client_address):
1330
2512
"""Overrides and wraps the original process_request().
1332
2514
This function creates a new pipe in self.pipe
1334
2516
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1336
super(MultiprocessingMixInWithPipe,
1337
self).process_request(request, client_address)
1338
self.add_pipe(parent_pipe)
1339
def add_pipe(self, parent_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):
1340
2524
"""Dummy function; override as necessary"""
2525
raise NotImplementedError()
1343
2528
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1344
2529
socketserver.TCPServer, object):
1345
2530
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1348
2533
enabled: Boolean; whether this server is activated yet
1349
2534
interface: None or a network interface name (string)
1350
2535
use_ipv6: Boolean; to use IPv6 or not
1352
2538
def __init__(self, server_address, RequestHandlerClass,
1353
interface=None, use_ipv6=True):
2542
"""If socketfd is set, use that file descriptor instead of
2543
creating a new one with socket.socket().
1354
2545
self.interface = interface
1356
2547
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.
1357
2575
socketserver.TCPServer.__init__(self, server_address,
1358
2576
RequestHandlerClass)
1359
2578
def server_bind(self):
1360
2579
"""This overrides the normal server_bind() function
1361
2580
to bind to an interface if one was specified, and also NOT to
1362
2581
bind to an address or port if they were not specified."""
2582
global SO_BINDTODEVICE
1363
2583
if self.interface is not None:
1364
2584
if SO_BINDTODEVICE is None:
1365
logger.error(u"SO_BINDTODEVICE does not exist;"
1366
u" cannot bind to interface %s",
1370
self.socket.setsockopt(socket.SOL_SOCKET,
1374
except socket.error, error:
1375
if error[0] == errno.EPERM:
1376
logger.error(u"No permission to"
1377
u" bind to interface %s",
1379
elif error[0] == errno.ENOPROTOOPT:
1380
logger.error(u"SO_BINDTODEVICE not available;"
1381
u" cannot bind to interface %s",
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)
1385
2606
# Only bind(2) the socket if we really need to.
1386
2607
if self.server_address[0] or self.server_address[1]:
2608
if self.server_address[1]:
2609
self.allow_reuse_address = True
1387
2610
if not self.server_address[0]:
1388
2611
if self.address_family == socket.AF_INET6:
1389
any_address = u"::" # in6addr_any
2612
any_address = "::" # in6addr_any
1391
any_address = socket.INADDR_ANY
2614
any_address = "0.0.0.0" # INADDR_ANY
1392
2615
self.server_address = (any_address,
1393
2616
self.server_address[1])
1394
2617
elif not self.server_address[1]:
1395
self.server_address = (self.server_address[0],
2618
self.server_address = (self.server_address[0], 0)
1397
2619
# if self.interface:
1398
2620
# self.server_address = (self.server_address[0],
1406
2628
class MandosServer(IPv6_TCPServer):
1407
2629
"""Mandos server.
1410
2632
clients: set of Client objects
1411
2633
gnutls_priority GnuTLS priority string
1412
2634
use_dbus: Boolean; to emit D-Bus signals or not
1414
Assumes a gobject.MainLoop event loop.
2636
Assumes a GLib.MainLoop event loop.
1416
2639
def __init__(self, server_address, RequestHandlerClass,
1417
interface=None, use_ipv6=True, clients=None,
1418
gnutls_priority=None, use_dbus=True):
2643
gnutls_priority=None,
1419
2646
self.enabled = False
1420
2647
self.clients = clients
1421
2648
if self.clients is None:
1422
self.clients = set()
1423
2650
self.use_dbus = use_dbus
1424
2651
self.gnutls_priority = gnutls_priority
1425
2652
IPv6_TCPServer.__init__(self, server_address,
1426
2653
RequestHandlerClass,
1427
interface = interface,
1428
use_ipv6 = use_ipv6)
2654
interface=interface,
1429
2658
def server_activate(self):
1430
2659
if self.enabled:
1431
2660
return socketserver.TCPServer.server_activate(self)
1432
2662
def enable(self):
1433
2663
self.enabled = True
1434
def add_pipe(self, parent_pipe):
2665
def add_pipe(self, parent_pipe, proc):
1435
2666
# Call "handle_ipc" for both data and EOF events
1436
gobject.io_add_watch(parent_pipe.fileno(),
1437
gobject.IO_IN | gobject.IO_HUP,
1438
functools.partial(self.handle_ipc,
1439
parent_pipe = parent_pipe))
1441
def handle_ipc(self, source, condition, parent_pipe=None,
2668
parent_pipe.fileno(),
2669
GLib.IO_IN | GLib.IO_HUP,
2670
functools.partial(self.handle_ipc,
2671
parent_pipe=parent_pipe,
2674
def handle_ipc(self, source, condition,
1442
2677
client_object=None):
1444
gobject.IO_IN: u"IN", # There is data to read.
1445
gobject.IO_OUT: u"OUT", # Data can be written (without
1447
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1448
gobject.IO_ERR: u"ERR", # Error condition.
1449
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1450
# broken, usually for pipes and
1453
conditions_string = ' | '.join(name
1455
condition_names.iteritems()
1456
if cond & condition)
1457
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
2678
# error, or the other end of multiprocessing.Pipe has closed
2679
if condition & (GLib.IO_ERR | GLib.IO_HUP):
2680
# Wait for other process to exit
1460
2684
# Read a request from the child
1461
2685
request = parent_pipe.recv()
1462
2686
command = request[0]
1464
2688
if command == 'init':
1466
address = request[2]
1468
for c in self.clients:
1469
if c.fingerprint == fpr:
2689
key_id = request[1].decode("ascii")
2690
fpr = request[2].decode("ascii")
2691
address = request[3]
2693
for c in self.clients.values():
2694
if key_id == "E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855":
2696
if key_id and c.key_id == key_id:
2699
if fpr and c.fingerprint == fpr:
1473
logger.warning(u"Client not found for fingerprint: %s, ad"
1474
u"dress: %s", fpr, address)
2703
logger.info("Client not found for key ID: %s, address"
2704
": %s", key_id or fpr, address)
1475
2705
if self.use_dbus:
1476
2706
# Emit D-Bus signal
1477
mandos_dbus_service.ClientNotFound(fpr, address)
2707
mandos_dbus_service.ClientNotFound(key_id or fpr,
1478
2709
parent_pipe.send(False)
1481
gobject.io_add_watch(parent_pipe.fileno(),
1482
gobject.IO_IN | gobject.IO_HUP,
1483
functools.partial(self.handle_ipc,
1484
parent_pipe = parent_pipe,
1485
client_object = client))
2713
parent_pipe.fileno(),
2714
GLib.IO_IN | GLib.IO_HUP,
2715
functools.partial(self.handle_ipc,
2716
parent_pipe=parent_pipe,
2718
client_object=client))
1486
2719
parent_pipe.send(True)
1487
# remove the old hook in favor of the new above hook on same fileno
2720
# remove the old hook in favor of the new above hook on
1489
2723
if command == 'funcall':
1490
2724
funcname = request[1]
1491
2725
args = request[2]
1492
2726
kwargs = request[3]
1494
parent_pipe.send(('data', getattr(client_object, funcname)(*args, **kwargs)))
2728
parent_pipe.send(('data', getattr(client_object,
1496
2732
if command == 'getattr':
1497
2733
attrname = request[1]
1498
if callable(client_object.__getattribute__(attrname)):
1499
parent_pipe.send(('function',))
2734
if isinstance(client_object.__getattribute__(attrname),
2735
collections.Callable):
2736
parent_pipe.send(('function', ))
1501
parent_pipe.send(('data', client_object.__getattribute__(attrname)))
2739
'data', client_object.__getattribute__(attrname)))
1503
2741
if command == 'setattr':
1504
2742
attrname = request[1]
1505
2743
value = request[2]
1506
2744
setattr(client_object, attrname, value)
2749
def rfc3339_duration_to_delta(duration):
2750
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2752
>>> rfc3339_duration_to_delta("P7D")
2753
datetime.timedelta(7)
2754
>>> rfc3339_duration_to_delta("PT60S")
2755
datetime.timedelta(0, 60)
2756
>>> rfc3339_duration_to_delta("PT60M")
2757
datetime.timedelta(0, 3600)
2758
>>> rfc3339_duration_to_delta("PT24H")
2759
datetime.timedelta(1)
2760
>>> rfc3339_duration_to_delta("P1W")
2761
datetime.timedelta(7)
2762
>>> rfc3339_duration_to_delta("PT5M30S")
2763
datetime.timedelta(0, 330)
2764
>>> rfc3339_duration_to_delta("P1DT3M20S")
2765
datetime.timedelta(1, 200)
2768
# Parsing an RFC 3339 duration with regular expressions is not
2769
# possible - there would have to be multiple places for the same
2770
# values, like seconds. The current code, while more esoteric, is
2771
# cleaner without depending on a parsing library. If Python had a
2772
# built-in library for parsing we would use it, but we'd like to
2773
# avoid excessive use of external libraries.
2775
# New type for defining tokens, syntax, and semantics all-in-one
2776
Token = collections.namedtuple("Token", (
2777
"regexp", # To match token; if "value" is not None, must have
2778
# a "group" containing digits
2779
"value", # datetime.timedelta or None
2780
"followers")) # Tokens valid after this token
2781
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2782
# the "duration" ABNF definition in RFC 3339, Appendix A.
2783
token_end = Token(re.compile(r"$"), None, frozenset())
2784
token_second = Token(re.compile(r"(\d+)S"),
2785
datetime.timedelta(seconds=1),
2786
frozenset((token_end, )))
2787
token_minute = Token(re.compile(r"(\d+)M"),
2788
datetime.timedelta(minutes=1),
2789
frozenset((token_second, token_end)))
2790
token_hour = Token(re.compile(r"(\d+)H"),
2791
datetime.timedelta(hours=1),
2792
frozenset((token_minute, token_end)))
2793
token_time = Token(re.compile(r"T"),
2795
frozenset((token_hour, token_minute,
2797
token_day = Token(re.compile(r"(\d+)D"),
2798
datetime.timedelta(days=1),
2799
frozenset((token_time, token_end)))
2800
token_month = Token(re.compile(r"(\d+)M"),
2801
datetime.timedelta(weeks=4),
2802
frozenset((token_day, token_end)))
2803
token_year = Token(re.compile(r"(\d+)Y"),
2804
datetime.timedelta(weeks=52),
2805
frozenset((token_month, token_end)))
2806
token_week = Token(re.compile(r"(\d+)W"),
2807
datetime.timedelta(weeks=1),
2808
frozenset((token_end, )))
2809
token_duration = Token(re.compile(r"P"), None,
2810
frozenset((token_year, token_month,
2811
token_day, token_time,
2813
# Define starting values:
2815
value = datetime.timedelta()
2817
# Following valid tokens
2818
followers = frozenset((token_duration, ))
2819
# String left to parse
2821
# Loop until end token is found
2822
while found_token is not token_end:
2823
# Search for any currently valid tokens
2824
for token in followers:
2825
match = token.regexp.match(s)
2826
if match is not None:
2828
if token.value is not None:
2829
# Value found, parse digits
2830
factor = int(match.group(1), 10)
2831
# Add to value so far
2832
value += factor * token.value
2833
# Strip token from string
2834
s = token.regexp.sub("", s, 1)
2837
# Set valid next tokens
2838
followers = found_token.followers
2841
# No currently valid tokens were found
2842
raise ValueError("Invalid RFC 3339 duration: {!r}"
1511
2848
def string_to_delta(interval):
1512
2849
"""Parse a string and return a datetime.timedelta
1514
>>> string_to_delta(u'7d')
2851
>>> string_to_delta('7d')
1515
2852
datetime.timedelta(7)
1516
>>> string_to_delta(u'60s')
2853
>>> string_to_delta('60s')
1517
2854
datetime.timedelta(0, 60)
1518
>>> string_to_delta(u'60m')
2855
>>> string_to_delta('60m')
1519
2856
datetime.timedelta(0, 3600)
1520
>>> string_to_delta(u'24h')
2857
>>> string_to_delta('24h')
1521
2858
datetime.timedelta(1)
1522
>>> string_to_delta(u'1w')
2859
>>> string_to_delta('1w')
1523
2860
datetime.timedelta(7)
1524
>>> string_to_delta(u'5m 30s')
2861
>>> string_to_delta('5m 30s')
1525
2862
datetime.timedelta(0, 330)
2866
return rfc3339_duration_to_delta(interval)
1527
2870
timevalue = datetime.timedelta(0)
1528
2871
for s in interval.split():
1530
suffix = unicode(s[-1])
1531
2874
value = int(s[:-1])
1533
2876
delta = datetime.timedelta(value)
1534
elif suffix == u"s":
1535
2878
delta = datetime.timedelta(0, value)
1536
elif suffix == u"m":
1537
2880
delta = datetime.timedelta(0, 0, 0, 0, value)
1538
elif suffix == u"h":
1539
2882
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
1540
elif suffix == u"w":
1541
2884
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
1543
raise ValueError(u"Unknown suffix %r" % suffix)
1544
except (ValueError, IndexError), e:
1545
raise ValueError(e.message)
2886
raise ValueError("Unknown suffix {!r}".format(suffix))
2887
except IndexError as e:
2888
raise ValueError(*(e.args))
1546
2889
timevalue += delta
1547
2890
return timevalue
1550
def if_nametoindex(interface):
1551
"""Call the C function if_nametoindex(), or equivalent
1553
Note: This function cannot accept a unicode string."""
1554
global if_nametoindex
1556
if_nametoindex = (ctypes.cdll.LoadLibrary
1557
(ctypes.util.find_library(u"c"))
1559
except (OSError, AttributeError):
1560
logger.warning(u"Doing if_nametoindex the hard way")
1561
def if_nametoindex(interface):
1562
"Get an interface index the hard way, i.e. using fcntl()"
1563
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1564
with contextlib.closing(socket.socket()) as s:
1565
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1566
struct.pack(str(u"16s16x"),
1568
interface_index = struct.unpack(str(u"I"),
1570
return interface_index
1571
return if_nametoindex(interface)
1574
def daemon(nochdir = False, noclose = False):
2893
def daemon(nochdir=False, noclose=False):
1575
2894
"""See daemon(3). Standard BSD Unix function.
1577
2896
This should really exist as os.daemon, but it doesn't (yet)."""
1581
2900
if not nochdir:
1585
2904
if not noclose:
1586
2905
# Close all standard open file descriptors
1587
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2906
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1588
2907
if not stat.S_ISCHR(os.fstat(null).st_mode):
1589
2908
raise OSError(errno.ENODEV,
1590
u"%s not a character device"
2909
"{} not a character device"
2910
.format(os.devnull))
1592
2911
os.dup2(null, sys.stdin.fileno())
1593
2912
os.dup2(null, sys.stdout.fileno())
1594
2913
os.dup2(null, sys.stderr.fileno())
1601
2920
##################################################################
1602
2921
# Parsing of options, both command line and config file
1604
parser = optparse.OptionParser(version = "%%prog %s" % version)
1605
parser.add_option("-i", u"--interface", type=u"string",
1606
metavar="IF", help=u"Bind to interface IF")
1607
parser.add_option("-a", u"--address", type=u"string",
1608
help=u"Address to listen for requests on")
1609
parser.add_option("-p", u"--port", type=u"int",
1610
help=u"Port number to receive requests on")
1611
parser.add_option("--check", action=u"store_true",
1612
help=u"Run self-test")
1613
parser.add_option("--debug", action=u"store_true",
1614
help=u"Debug mode; run in foreground and log to"
1616
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1617
u" priority string (see GnuTLS documentation)")
1618
parser.add_option("--servicename", type=u"string",
1619
metavar=u"NAME", help=u"Zeroconf service name")
1620
parser.add_option("--configdir", type=u"string",
1621
default=u"/etc/mandos", metavar=u"DIR",
1622
help=u"Directory to search for configuration"
1624
parser.add_option("--no-dbus", action=u"store_false",
1625
dest=u"use_dbus", help=u"Do not provide D-Bus"
1626
u" system bus interface")
1627
parser.add_option("--no-ipv6", action=u"store_false",
1628
dest=u"use_ipv6", help=u"Do not use IPv6")
1629
options = parser.parse_args()[0]
2923
parser = argparse.ArgumentParser()
2924
parser.add_argument("-v", "--version", action="version",
2925
version="%(prog)s {}".format(version),
2926
help="show version number and exit")
2927
parser.add_argument("-i", "--interface", metavar="IF",
2928
help="Bind to interface IF")
2929
parser.add_argument("-a", "--address",
2930
help="Address to listen for requests on")
2931
parser.add_argument("-p", "--port", type=int,
2932
help="Port number to receive requests on")
2933
parser.add_argument("--check", action="store_true",
2934
help="Run self-test")
2935
parser.add_argument("--debug", action="store_true",
2936
help="Debug mode; run in foreground and log"
2937
" to terminal", default=None)
2938
parser.add_argument("--debuglevel", metavar="LEVEL",
2939
help="Debug level for stdout output")
2940
parser.add_argument("--priority", help="GnuTLS"
2941
" priority string (see GnuTLS documentation)")
2942
parser.add_argument("--servicename",
2943
metavar="NAME", help="Zeroconf service name")
2944
parser.add_argument("--configdir",
2945
default="/etc/mandos", metavar="DIR",
2946
help="Directory to search for configuration"
2948
parser.add_argument("--no-dbus", action="store_false",
2949
dest="use_dbus", help="Do not provide D-Bus"
2950
" system bus interface", default=None)
2951
parser.add_argument("--no-ipv6", action="store_false",
2952
dest="use_ipv6", help="Do not use IPv6",
2954
parser.add_argument("--no-restore", action="store_false",
2955
dest="restore", help="Do not restore stored"
2956
" state", default=None)
2957
parser.add_argument("--socket", type=int,
2958
help="Specify a file descriptor to a network"
2959
" socket to use instead of creating one")
2960
parser.add_argument("--statedir", metavar="DIR",
2961
help="Directory to save/restore state in")
2962
parser.add_argument("--foreground", action="store_true",
2963
help="Run in foreground", default=None)
2964
parser.add_argument("--no-zeroconf", action="store_false",
2965
dest="zeroconf", help="Do not use Zeroconf",
2968
options = parser.parse_args()
1631
2970
if options.check:
2972
fail_count, test_count = doctest.testmod()
2973
sys.exit(os.EX_OK if fail_count == 0 else 1)
1636
2975
# Default values for config file for server-global settings
1637
server_defaults = { u"interface": u"",
1642
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1643
u"servicename": u"Mandos",
1644
u"use_dbus": u"True",
1645
u"use_ipv6": u"True",
2976
if gnutls.has_rawpk:
2977
priority = ("SECURE128:!CTYPE-X.509:+CTYPE-RAWPK:!RSA"
2978
":!VERS-ALL:+VERS-TLS1.3:%PROFILE_ULTRA")
2980
priority = ("SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:!RSA"
2981
":+SIGN-DSA-SHA256")
2982
server_defaults = {"interface": "",
2986
"priority": priority,
2987
"servicename": "Mandos",
2993
"statedir": "/var/lib/mandos",
2994
"foreground": "False",
1648
2999
# Parse config file for server-global settings
1649
3000
server_config = configparser.SafeConfigParser(server_defaults)
1650
3001
del server_defaults
1651
server_config.read(os.path.join(options.configdir,
3002
server_config.read(os.path.join(options.configdir, "mandos.conf"))
1653
3003
# Convert the SafeConfigParser object to a dict
1654
3004
server_settings = server_config.defaults()
1655
3005
# Use the appropriate methods on the non-string config options
1656
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1657
server_settings[option] = server_config.getboolean(u"DEFAULT",
3006
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3007
"foreground", "zeroconf"):
3008
server_settings[option] = server_config.getboolean("DEFAULT",
1659
3010
if server_settings["port"]:
1660
server_settings["port"] = server_config.getint(u"DEFAULT",
3011
server_settings["port"] = server_config.getint("DEFAULT",
3013
if server_settings["socket"]:
3014
server_settings["socket"] = server_config.getint("DEFAULT",
3016
# Later, stdin will, and stdout and stderr might, be dup'ed
3017
# over with an opened os.devnull. But we don't want this to
3018
# happen with a supplied network socket.
3019
if 0 <= server_settings["socket"] <= 2:
3020
server_settings["socket"] = os.dup(server_settings
1662
3022
del server_config
1664
3024
# Override the settings from the config file with command line
1665
3025
# options, if set.
1666
for option in (u"interface", u"address", u"port", u"debug",
1667
u"priority", u"servicename", u"configdir",
1668
u"use_dbus", u"use_ipv6"):
3026
for option in ("interface", "address", "port", "debug",
3027
"priority", "servicename", "configdir", "use_dbus",
3028
"use_ipv6", "debuglevel", "restore", "statedir",
3029
"socket", "foreground", "zeroconf"):
1669
3030
value = getattr(options, option)
1670
3031
if value is not None:
1671
3032
server_settings[option] = value
1673
3034
# Force all strings to be unicode
1674
3035
for option in server_settings.keys():
1675
if type(server_settings[option]) is str:
1676
server_settings[option] = unicode(server_settings[option])
3036
if isinstance(server_settings[option], bytes):
3037
server_settings[option] = (server_settings[option]
3039
# Force all boolean options to be boolean
3040
for option in ("debug", "use_dbus", "use_ipv6", "restore",
3041
"foreground", "zeroconf"):
3042
server_settings[option] = bool(server_settings[option])
3043
# Debug implies foreground
3044
if server_settings["debug"]:
3045
server_settings["foreground"] = True
1677
3046
# Now we have our good server settings in "server_settings"
1679
3048
##################################################################
3050
if (not server_settings["zeroconf"]
3051
and not (server_settings["port"]
3052
or server_settings["socket"] != "")):
3053
parser.error("Needs port or socket to work without Zeroconf")
1681
3055
# For convenience
1682
debug = server_settings[u"debug"]
1683
use_dbus = server_settings[u"use_dbus"]
1684
use_ipv6 = server_settings[u"use_ipv6"]
1687
syslogger.setLevel(logging.WARNING)
1688
console.setLevel(logging.WARNING)
1690
if server_settings[u"servicename"] != u"Mandos":
1691
syslogger.setFormatter(logging.Formatter
1692
(u'Mandos (%s) [%%(process)d]:'
1693
u' %%(levelname)s: %%(message)s'
1694
% server_settings[u"servicename"]))
3056
debug = server_settings["debug"]
3057
debuglevel = server_settings["debuglevel"]
3058
use_dbus = server_settings["use_dbus"]
3059
use_ipv6 = server_settings["use_ipv6"]
3060
stored_state_path = os.path.join(server_settings["statedir"],
3062
foreground = server_settings["foreground"]
3063
zeroconf = server_settings["zeroconf"]
3066
initlogger(debug, logging.DEBUG)
3071
level = getattr(logging, debuglevel.upper())
3072
initlogger(debug, level)
3074
if server_settings["servicename"] != "Mandos":
3075
syslogger.setFormatter(
3076
logging.Formatter('Mandos ({}) [%(process)d]:'
3077
' %(levelname)s: %(message)s'.format(
3078
server_settings["servicename"])))
1696
3080
# Parse config file with clients
1697
client_defaults = { u"timeout": u"1h",
1699
u"checker": u"fping -q -- %%(host)s",
1701
u"approved_delay": u"0s",
1702
u"approved_duration": u"1s",
1704
client_config = configparser.SafeConfigParser(client_defaults)
1705
client_config.read(os.path.join(server_settings[u"configdir"],
3081
client_config = configparser.SafeConfigParser(Client
3083
client_config.read(os.path.join(server_settings["configdir"],
1708
3086
global mandos_dbus_service
1709
3087
mandos_dbus_service = None
1711
tcp_server = MandosServer((server_settings[u"address"],
1712
server_settings[u"port"]),
1714
interface=server_settings[u"interface"],
1717
server_settings[u"priority"],
1719
pidfilename = u"/var/run/mandos.pid"
1721
pidfile = open(pidfilename, u"w")
1723
logger.error(u"Could not open file %r", pidfilename)
1726
uid = pwd.getpwnam(u"_mandos").pw_uid
1727
gid = pwd.getpwnam(u"_mandos").pw_gid
1730
uid = pwd.getpwnam(u"mandos").pw_uid
1731
gid = pwd.getpwnam(u"mandos").pw_gid
3090
if server_settings["socket"] != "":
3091
socketfd = server_settings["socket"]
3092
tcp_server = MandosServer(
3093
(server_settings["address"], server_settings["port"]),
3095
interface=(server_settings["interface"] or None),
3097
gnutls_priority=server_settings["priority"],
3101
pidfilename = "/run/mandos.pid"
3102
if not os.path.isdir("/run/."):
3103
pidfilename = "/var/run/mandos.pid"
3106
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3107
except IOError as e:
3108
logger.error("Could not open file %r", pidfilename,
3111
for name, group in (("_mandos", "_mandos"),
3112
("mandos", "mandos"),
3113
("nobody", "nogroup")):
3115
uid = pwd.getpwnam(name).pw_uid
3116
gid = pwd.getpwnam(group).pw_gid
1732
3118
except KeyError:
1734
uid = pwd.getpwnam(u"nobody").pw_uid
1735
gid = pwd.getpwnam(u"nobody").pw_gid
1742
except OSError, error:
1743
if error[0] != errno.EPERM:
1746
# Enable all possible GnuTLS debugging
3127
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3129
except OSError as error:
3130
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3131
.format(uid, gid, os.strerror(error.errno)))
3132
if error.errno != errno.EPERM:
3136
# Enable all possible GnuTLS debugging
1748
3138
# "Use a log level over 10 to enable all debugging options."
1749
3139
# - GnuTLS manual
1750
gnutls.library.functions.gnutls_global_set_log_level(11)
1752
@gnutls.library.types.gnutls_log_func
3140
gnutls.global_set_log_level(11)
1753
3143
def debug_gnutls(level, string):
1754
logger.debug(u"GnuTLS: %s", string[:-1])
1756
(gnutls.library.functions
1757
.gnutls_global_set_log_function(debug_gnutls))
3144
logger.debug("GnuTLS: %s", string[:-1])
3146
gnutls.global_set_log_function(debug_gnutls)
3148
# Redirect stdin so all checkers get /dev/null
3149
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
3150
os.dup2(null, sys.stdin.fileno())
3154
# Need to fork before connecting to D-Bus
3156
# Close all input and output, do double fork, etc.
3159
# multiprocessing will use threads, so before we use GLib we need
3160
# to inform GLib that threads will be used.
1759
3163
global main_loop
1760
3164
# From the Avahi example code
1761
DBusGMainLoop(set_as_default=True )
1762
main_loop = gobject.MainLoop()
3165
DBusGMainLoop(set_as_default=True)
3166
main_loop = GLib.MainLoop()
1763
3167
bus = dbus.SystemBus()
1764
3168
# End of Avahi example code
1767
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos",
1768
bus, do_not_queue=True)
1769
except dbus.exceptions.NameExistsException, e:
1770
logger.error(unicode(e) + u", disabling D-Bus")
3171
bus_name = dbus.service.BusName("se.recompile.Mandos",
3174
old_bus_name = dbus.service.BusName(
3175
"se.bsnet.fukt.Mandos", bus,
3177
except dbus.exceptions.DBusException as e:
3178
logger.error("Disabling D-Bus:", exc_info=e)
1771
3179
use_dbus = False
1772
server_settings[u"use_dbus"] = False
3180
server_settings["use_dbus"] = False
1773
3181
tcp_server.use_dbus = False
1774
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1775
service = AvahiService(name = server_settings[u"servicename"],
1776
servicetype = u"_mandos._tcp",
1777
protocol = protocol, bus = bus)
1778
if server_settings["interface"]:
1779
service.interface = (if_nametoindex
1780
(str(server_settings[u"interface"])))
3183
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3184
service = AvahiServiceToSyslog(
3185
name=server_settings["servicename"],
3186
servicetype="_mandos._tcp",
3189
if server_settings["interface"]:
3190
service.interface = if_nametoindex(
3191
server_settings["interface"].encode("utf-8"))
3193
global multiprocessing_manager
3194
multiprocessing_manager = multiprocessing.Manager()
1782
3196
client_class = Client
1784
client_class = functools.partial(ClientDBus, bus = bus)
1785
def client_config_items(config, section):
1786
special_settings = {
1787
"approved_by_default":
1788
lambda: config.getboolean(section,
1789
"approved_by_default"),
1791
for name, value in config.items(section):
3198
client_class = functools.partial(ClientDBus, bus=bus)
3200
client_settings = Client.config_parser(client_config)
3201
old_client_settings = {}
3204
# This is used to redirect stdout and stderr for checker processes
3206
wnull = open(os.devnull, "w") # A writable /dev/null
3207
# Only used if server is running in foreground but not in debug
3209
if debug or not foreground:
3212
# Get client data and settings from last running state.
3213
if server_settings["restore"]:
3215
with open(stored_state_path, "rb") as stored_state:
3216
if sys.version_info.major == 2:
3217
clients_data, old_client_settings = pickle.load(
3220
bytes_clients_data, bytes_old_client_settings = (
3221
pickle.load(stored_state, encoding="bytes"))
3222
# Fix bytes to strings
3225
clients_data = {(key.decode("utf-8")
3226
if isinstance(key, bytes)
3229
bytes_clients_data.items()}
3230
del bytes_clients_data
3231
for key in clients_data:
3232
value = {(k.decode("utf-8")
3233
if isinstance(k, bytes) else k): v
3235
clients_data[key].items()}
3236
clients_data[key] = value
3238
value["client_structure"] = [
3240
if isinstance(s, bytes)
3242
value["client_structure"]]
3244
for k in ("name", "host"):
3245
if isinstance(value[k], bytes):
3246
value[k] = value[k].decode("utf-8")
3247
if not value.has_key("key_id"):
3248
value["key_id"] = ""
3249
elif not value.has_key("fingerprint"):
3250
value["fingerprint"] = ""
3251
# old_client_settings
3253
old_client_settings = {
3254
(key.decode("utf-8")
3255
if isinstance(key, bytes)
3258
bytes_old_client_settings.items()}
3259
del bytes_old_client_settings
3261
for value in old_client_settings.values():
3262
if isinstance(value["host"], bytes):
3263
value["host"] = (value["host"]
3265
os.remove(stored_state_path)
3266
except IOError as e:
3267
if e.errno == errno.ENOENT:
3268
logger.warning("Could not load persistent state:"
3269
" {}".format(os.strerror(e.errno)))
3271
logger.critical("Could not load persistent state:",
3274
except EOFError as e:
3275
logger.warning("Could not load persistent state: "
3279
with PGPEngine() as pgp:
3280
for client_name, client in clients_data.items():
3281
# Skip removed clients
3282
if client_name not in client_settings:
3285
# Decide which value to use after restoring saved state.
3286
# We have three different values: Old config file,
3287
# new config file, and saved state.
3288
# New config value takes precedence if it differs from old
3289
# config value, otherwise use saved state.
3290
for name, value in client_settings[client_name].items():
3292
# For each value in new config, check if it
3293
# differs from the old config value (Except for
3294
# the "secret" attribute)
3295
if (name != "secret"
3297
old_client_settings[client_name][name])):
3298
client[name] = value
3302
# Clients who has passed its expire date can still be
3303
# enabled if its last checker was successful. A Client
3304
# whose checker succeeded before we stored its state is
3305
# assumed to have successfully run all checkers during
3307
if client["enabled"]:
3308
if datetime.datetime.utcnow() >= client["expires"]:
3309
if not client["last_checked_ok"]:
3311
"disabling client {} - Client never "
3312
"performed a successful checker".format(
3314
client["enabled"] = False
3315
elif client["last_checker_status"] != 0:
3317
"disabling client {} - Client last"
3318
" checker failed with error code"
3321
client["last_checker_status"]))
3322
client["enabled"] = False
3324
client["expires"] = (
3325
datetime.datetime.utcnow()
3326
+ client["timeout"])
3327
logger.debug("Last checker succeeded,"
3328
" keeping {} enabled".format(
1793
yield (name, special_settings[name]())
1797
tcp_server.clients.update(set(
1798
client_class(name = section,
1799
config= dict(client_config_items(
1800
client_config, section)))
1801
for section in client_config.sections()))
3331
client["secret"] = pgp.decrypt(
3332
client["encrypted_secret"],
3333
client_settings[client_name]["secret"])
3335
# If decryption fails, we use secret from new settings
3336
logger.debug("Failed to decrypt {} old secret".format(
3338
client["secret"] = (client_settings[client_name]
3341
# Add/remove clients based on new changes made to config
3342
for client_name in (set(old_client_settings)
3343
- set(client_settings)):
3344
del clients_data[client_name]
3345
for client_name in (set(client_settings)
3346
- set(old_client_settings)):
3347
clients_data[client_name] = client_settings[client_name]
3349
# Create all client objects
3350
for client_name, client in clients_data.items():
3351
tcp_server.clients[client_name] = client_class(
3354
server_settings=server_settings)
1802
3356
if not tcp_server.clients:
1803
logger.warning(u"No clients defined")
1806
# Redirect stdin so all checkers get /dev/null
1807
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1808
os.dup2(null, sys.stdin.fileno())
1812
# No console logging
1813
logger.removeHandler(console)
1814
# Close all input and output, do double fork, etc.
3357
logger.warning("No clients defined")
3360
if pidfile is not None:
1819
3361
pid = os.getpid()
1820
pidfile.write(str(pid) + "\n")
3364
print(pid, file=pidfile)
3366
logger.error("Could not write to file %r with PID %d",
1823
logger.error(u"Could not write to file %r with PID %d",
1826
# "pidfile" was never created
1831
signal.signal(signal.SIGINT, signal.SIG_IGN)
1832
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
1833
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3371
for termsig in (signal.SIGHUP, signal.SIGTERM):
3372
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3373
lambda: main_loop.quit() and False)
1836
class MandosDBusService(dbus.service.Object):
3377
@alternate_dbus_interfaces(
3378
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3379
class MandosDBusService(DBusObjectWithObjectManager):
1837
3380
"""A D-Bus proxy object"""
1838
3382
def __init__(self):
1839
dbus.service.Object.__init__(self, bus, u"/")
1840
_interface = u"se.bsnet.fukt.Mandos"
1842
@dbus.service.signal(_interface, signature=u"o")
3383
dbus.service.Object.__init__(self, bus, "/")
3385
_interface = "se.recompile.Mandos"
3387
@dbus.service.signal(_interface, signature="o")
1843
3388
def ClientAdded(self, objpath):
1847
@dbus.service.signal(_interface, signature=u"ss")
1848
def ClientNotFound(self, fingerprint, address):
3392
@dbus.service.signal(_interface, signature="ss")
3393
def ClientNotFound(self, key_id, address):
1852
@dbus.service.signal(_interface, signature=u"os")
3397
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3399
@dbus.service.signal(_interface, signature="os")
1853
3400
def ClientRemoved(self, objpath, name):
1857
@dbus.service.method(_interface, out_signature=u"ao")
3404
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3406
@dbus.service.method(_interface, out_signature="ao")
1858
3407
def GetAllClients(self):
1860
return dbus.Array(c.dbus_object_path
1861
for c in tcp_server.clients)
3409
return dbus.Array(c.dbus_object_path for c in
3410
tcp_server.clients.values())
3412
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
1863
3414
@dbus.service.method(_interface,
1864
out_signature=u"a{oa{sv}}")
3415
out_signature="a{oa{sv}}")
1865
3416
def GetAllClientsWithProperties(self):
1867
3418
return dbus.Dictionary(
1868
((c.dbus_object_path, c.GetAll(u""))
1869
for c in tcp_server.clients),
1870
signature=u"oa{sv}")
1872
@dbus.service.method(_interface, in_signature=u"o")
3419
{c.dbus_object_path: c.GetAll(
3420
"se.recompile.Mandos.Client")
3421
for c in tcp_server.clients.values()},
3424
@dbus.service.method(_interface, in_signature="o")
1873
3425
def RemoveClient(self, object_path):
1875
for c in tcp_server.clients:
3427
for c in tcp_server.clients.values():
1876
3428
if c.dbus_object_path == object_path:
1877
tcp_server.clients.remove(c)
3429
del tcp_server.clients[c.name]
1878
3430
c.remove_from_connection()
1879
# Don't signal anything except ClientRemoved
3431
# Don't signal the disabling
1880
3432
c.disable(quiet=True)
1882
self.ClientRemoved(object_path, c.name)
3433
# Emit D-Bus signal for removal
3434
self.client_removed_signal(c)
1884
3436
raise KeyError(object_path)
3440
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3441
out_signature="a{oa{sa{sv}}}")
3442
def GetManagedObjects(self):
3444
return dbus.Dictionary(
3445
{client.dbus_object_path:
3447
{interface: client.GetAll(interface)
3449
client._get_all_interface_names()})
3450
for client in tcp_server.clients.values()})
3452
def client_added_signal(self, client):
3453
"""Send the new standard signal and the old signal"""
3455
# New standard signal
3456
self.InterfacesAdded(
3457
client.dbus_object_path,
3459
{interface: client.GetAll(interface)
3461
client._get_all_interface_names()}))
3463
self.ClientAdded(client.dbus_object_path)
3465
def client_removed_signal(self, client):
3466
"""Send the new standard signal and the old signal"""
3468
# New standard signal
3469
self.InterfacesRemoved(
3470
client.dbus_object_path,
3471
client._get_all_interface_names())
3473
self.ClientRemoved(client.dbus_object_path,
1888
3476
mandos_dbus_service = MandosDBusService()
3478
# Save modules to variables to exempt the modules from being
3479
# unloaded before the function registered with atexit() is run.
3480
mp = multiprocessing
1891
3484
"Cleanup function; run on exit"
3488
mp.active_children()
3490
if not (tcp_server.clients or client_settings):
3493
# Store client before exiting. Secrets are encrypted with key
3494
# based on what config file has. If config file is
3495
# removed/edited, old secret will thus be unrecovable.
3497
with PGPEngine() as pgp:
3498
for client in tcp_server.clients.values():
3499
key = client_settings[client.name]["secret"]
3500
client.encrypted_secret = pgp.encrypt(client.secret,
3504
# A list of attributes that can not be pickled
3506
exclude = {"bus", "changedstate", "secret",
3507
"checker", "server_settings"}
3508
for name, typ in inspect.getmembers(dbus.service
3512
client_dict["encrypted_secret"] = (client
3514
for attr in client.client_structure:
3515
if attr not in exclude:
3516
client_dict[attr] = getattr(client, attr)
3518
clients[client.name] = client_dict
3519
del client_settings[client.name]["secret"]
3522
with tempfile.NamedTemporaryFile(
3526
dir=os.path.dirname(stored_state_path),
3527
delete=False) as stored_state:
3528
pickle.dump((clients, client_settings), stored_state,
3530
tempname = stored_state.name
3531
os.rename(tempname, stored_state_path)
3532
except (IOError, OSError) as e:
3538
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3539
logger.warning("Could not save persistent state: {}"
3540
.format(os.strerror(e.errno)))
3542
logger.warning("Could not save persistent state:",
3546
# Delete all clients, and settings from config
1894
3547
while tcp_server.clients:
1895
client = tcp_server.clients.pop()
3548
name, client = tcp_server.clients.popitem()
1897
3550
client.remove_from_connection()
1898
client.disable_hook = None
1899
# Don't signal anything except ClientRemoved
3551
# Don't signal the disabling
1900
3552
client.disable(quiet=True)
3553
# Emit D-Bus signal for removal
1903
mandos_dbus_service.ClientRemoved(client.dbus_object_path,
3555
mandos_dbus_service.client_removed_signal(client)
3556
client_settings.clear()
1906
3558
atexit.register(cleanup)
1908
for client in tcp_server.clients:
3560
for client in tcp_server.clients.values():
1911
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3562
# Emit D-Bus signal for adding
3563
mandos_dbus_service.client_added_signal(client)
3564
# Need to initiate checking of clients
3566
client.init_checker()
1914
3568
tcp_server.enable()
1915
3569
tcp_server.server_activate()
1917
3571
# Find out what port we got
1918
service.port = tcp_server.socket.getsockname()[1]
3573
service.port = tcp_server.socket.getsockname()[1]
1920
logger.info(u"Now listening on address %r, port %d,"
1921
" flowinfo %d, scope_id %d"
1922
% tcp_server.socket.getsockname())
3575
logger.info("Now listening on address %r, port %d,"
3576
" flowinfo %d, scope_id %d",
3577
*tcp_server.socket.getsockname())
1924
logger.info(u"Now listening on address %r, port %d"
1925
% tcp_server.socket.getsockname())
1927
#service.interface = tcp_server.socket.getsockname()[3]
3579
logger.info("Now listening on address %r, port %d",
3580
*tcp_server.socket.getsockname())
3582
# service.interface = tcp_server.socket.getsockname()[3]
1930
# From the Avahi example code
1933
except dbus.exceptions.DBusException, error:
1934
logger.critical(u"DBusException: %s", error)
1937
# End of Avahi example code
1939
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
1940
lambda *args, **kwargs:
1941
(tcp_server.handle_request
1942
(*args[2:], **kwargs) or True))
1944
logger.debug(u"Starting main loop")
3586
# From the Avahi example code
3589
except dbus.exceptions.DBusException as error:
3590
logger.critical("D-Bus Exception", exc_info=error)
3593
# End of Avahi example code
3595
GLib.io_add_watch(tcp_server.fileno(), GLib.IO_IN,
3596
lambda *args, **kwargs:
3597
(tcp_server.handle_request
3598
(*args[2:], **kwargs) or True))
3600
logger.debug("Starting main loop")
1945
3601
main_loop.run()
1946
except AvahiError, error:
1947
logger.critical(u"AvahiError: %s", error)
3602
except AvahiError as error:
3603
logger.critical("Avahi Error", exc_info=error)
1950
3606
except KeyboardInterrupt:
1953
logger.debug(u"Server received KeyboardInterrupt")
1954
logger.debug(u"Server exiting")
3608
print("", file=sys.stderr)
3609
logger.debug("Server received KeyboardInterrupt")
3610
logger.debug("Server exiting")
1955
3611
# Must run before the D-Bus bus name gets deregistered
1958
3615
if __name__ == '__main__':