517
365
follow_name_owner_changes=True),
518
366
avahi.DBUS_INTERFACE_SERVER)
519
367
self.server.connect_to_signal("StateChanged",
520
self.server_state_changed)
368
self.server_state_changed)
521
369
self.server_state_changed(self.server.GetState())
524
371
class AvahiServiceToSyslog(AvahiService):
525
def rename(self, *args, **kwargs):
526
373
"""Add the new name to the syslog messages"""
527
ret = super(AvahiServiceToSyslog, self).rename(*args, **kwargs)
528
syslogger.setFormatter(logging.Formatter(
529
'Mandos ({}) [%(process)d]: %(levelname)s: %(message)s'
374
ret = AvahiService.rename(self)
375
syslogger.setFormatter(logging.Formatter
376
('Mandos (%s) [%%(process)d]:'
377
' %%(levelname)s: %%(message)s'
534
# Pretend that we have a GnuTLS module
536
"""This isn't so much a class as it is a module-like namespace."""
538
library = ctypes.util.find_library("gnutls")
540
library = ctypes.util.find_library("gnutls-deb0")
541
_library = ctypes.cdll.LoadLibrary(library)
544
# Unless otherwise indicated, the constants and types below are
545
# all from the gnutls/gnutls.h C header file.
556
E_NO_CERTIFICATE_FOUND = -49
561
KEYID_USE_SHA256 = 1 # gnutls/x509.h
562
OPENPGP_FMT_RAW = 0 # gnutls/openpgp.h
565
class session_int(ctypes.Structure):
567
session_t = ctypes.POINTER(session_int)
569
class certificate_credentials_st(ctypes.Structure):
571
certificate_credentials_t = ctypes.POINTER(
572
certificate_credentials_st)
573
certificate_type_t = ctypes.c_int
575
class datum_t(ctypes.Structure):
576
_fields_ = [('data', ctypes.POINTER(ctypes.c_ubyte)),
577
('size', ctypes.c_uint)]
579
class openpgp_crt_int(ctypes.Structure):
581
openpgp_crt_t = ctypes.POINTER(openpgp_crt_int)
582
openpgp_crt_fmt_t = ctypes.c_int # gnutls/openpgp.h
583
log_func = ctypes.CFUNCTYPE(None, ctypes.c_int, ctypes.c_char_p)
584
credentials_type_t = ctypes.c_int
585
transport_ptr_t = ctypes.c_void_p
586
close_request_t = ctypes.c_int
589
class Error(Exception):
590
def __init__(self, message=None, code=None, args=()):
591
# Default usage is by a message string, but if a return
592
# code is passed, convert it to a string with
595
if message is None and code is not None:
596
message = gnutls.strerror(code)
597
return super(gnutls.Error, self).__init__(
600
class CertificateSecurityError(Error):
606
self._c_object = gnutls.certificate_credentials_t()
607
gnutls.certificate_allocate_credentials(
608
ctypes.byref(self._c_object))
609
self.type = gnutls.CRD_CERTIFICATE
612
gnutls.certificate_free_credentials(self._c_object)
615
def __init__(self, socket, credentials=None):
616
self._c_object = gnutls.session_t()
617
gnutls_flags = gnutls.CLIENT
618
if gnutls.check_version(b"3.5.6"):
619
gnutls_flags |= gnutls.NO_TICKETS
621
gnutls_flags |= gnutls.ENABLE_RAWPK
622
gnutls.init(ctypes.byref(self._c_object), gnutls_flags)
624
gnutls.set_default_priority(self._c_object)
625
gnutls.transport_set_ptr(self._c_object, socket.fileno())
626
gnutls.handshake_set_private_extensions(self._c_object,
629
if credentials is None:
630
credentials = gnutls.Credentials()
631
gnutls.credentials_set(self._c_object, credentials.type,
632
ctypes.cast(credentials._c_object,
634
self.credentials = credentials
637
gnutls.deinit(self._c_object)
640
return gnutls.handshake(self._c_object)
642
def send(self, data):
646
data_len -= gnutls.record_send(self._c_object,
651
return gnutls.bye(self._c_object, gnutls.SHUT_RDWR)
653
# Error handling functions
654
def _error_code(result):
655
"""A function to raise exceptions on errors, suitable
656
for the 'restype' attribute on ctypes functions"""
659
if result == gnutls.E_NO_CERTIFICATE_FOUND:
660
raise gnutls.CertificateSecurityError(code=result)
661
raise gnutls.Error(code=result)
663
def _retry_on_error(result, func, arguments):
664
"""A function to retry on some errors, suitable
665
for the 'errcheck' attribute on ctypes functions"""
667
if result not in (gnutls.E_INTERRUPTED, gnutls.E_AGAIN):
668
return _error_code(result)
669
result = func(*arguments)
672
# Unless otherwise indicated, the function declarations below are
673
# all from the gnutls/gnutls.h C header file.
676
priority_set_direct = _library.gnutls_priority_set_direct
677
priority_set_direct.argtypes = [session_t, ctypes.c_char_p,
678
ctypes.POINTER(ctypes.c_char_p)]
679
priority_set_direct.restype = _error_code
681
init = _library.gnutls_init
682
init.argtypes = [ctypes.POINTER(session_t), ctypes.c_int]
683
init.restype = _error_code
685
set_default_priority = _library.gnutls_set_default_priority
686
set_default_priority.argtypes = [session_t]
687
set_default_priority.restype = _error_code
689
record_send = _library.gnutls_record_send
690
record_send.argtypes = [session_t, ctypes.c_void_p,
692
record_send.restype = ctypes.c_ssize_t
693
record_send.errcheck = _retry_on_error
695
certificate_allocate_credentials = (
696
_library.gnutls_certificate_allocate_credentials)
697
certificate_allocate_credentials.argtypes = [
698
ctypes.POINTER(certificate_credentials_t)]
699
certificate_allocate_credentials.restype = _error_code
701
certificate_free_credentials = (
702
_library.gnutls_certificate_free_credentials)
703
certificate_free_credentials.argtypes = [
704
certificate_credentials_t]
705
certificate_free_credentials.restype = None
707
handshake_set_private_extensions = (
708
_library.gnutls_handshake_set_private_extensions)
709
handshake_set_private_extensions.argtypes = [session_t,
711
handshake_set_private_extensions.restype = None
713
credentials_set = _library.gnutls_credentials_set
714
credentials_set.argtypes = [session_t, credentials_type_t,
716
credentials_set.restype = _error_code
718
strerror = _library.gnutls_strerror
719
strerror.argtypes = [ctypes.c_int]
720
strerror.restype = ctypes.c_char_p
722
certificate_type_get = _library.gnutls_certificate_type_get
723
certificate_type_get.argtypes = [session_t]
724
certificate_type_get.restype = _error_code
726
certificate_get_peers = _library.gnutls_certificate_get_peers
727
certificate_get_peers.argtypes = [session_t,
728
ctypes.POINTER(ctypes.c_uint)]
729
certificate_get_peers.restype = ctypes.POINTER(datum_t)
731
global_set_log_level = _library.gnutls_global_set_log_level
732
global_set_log_level.argtypes = [ctypes.c_int]
733
global_set_log_level.restype = None
735
global_set_log_function = _library.gnutls_global_set_log_function
736
global_set_log_function.argtypes = [log_func]
737
global_set_log_function.restype = None
739
deinit = _library.gnutls_deinit
740
deinit.argtypes = [session_t]
741
deinit.restype = None
743
handshake = _library.gnutls_handshake
744
handshake.argtypes = [session_t]
745
handshake.restype = _error_code
746
handshake.errcheck = _retry_on_error
748
transport_set_ptr = _library.gnutls_transport_set_ptr
749
transport_set_ptr.argtypes = [session_t, transport_ptr_t]
750
transport_set_ptr.restype = None
752
bye = _library.gnutls_bye
753
bye.argtypes = [session_t, close_request_t]
754
bye.restype = _error_code
755
bye.errcheck = _retry_on_error
757
check_version = _library.gnutls_check_version
758
check_version.argtypes = [ctypes.c_char_p]
759
check_version.restype = ctypes.c_char_p
761
_need_version = b"3.3.0"
762
if check_version(_need_version) is None:
763
raise self.Error("Needs GnuTLS {} or later"
764
.format(_need_version))
766
_tls_rawpk_version = b"3.6.6"
767
has_rawpk = bool(check_version(_tls_rawpk_version))
771
class pubkey_st(ctypes.Structure):
773
pubkey_t = ctypes.POINTER(pubkey_st)
775
x509_crt_fmt_t = ctypes.c_int
777
# All the function declarations below are from gnutls/abstract.h
778
pubkey_init = _library.gnutls_pubkey_init
779
pubkey_init.argtypes = [ctypes.POINTER(pubkey_t)]
780
pubkey_init.restype = _error_code
782
pubkey_import = _library.gnutls_pubkey_import
783
pubkey_import.argtypes = [pubkey_t, ctypes.POINTER(datum_t),
785
pubkey_import.restype = _error_code
787
pubkey_get_key_id = _library.gnutls_pubkey_get_key_id
788
pubkey_get_key_id.argtypes = [pubkey_t, ctypes.c_int,
789
ctypes.POINTER(ctypes.c_ubyte),
790
ctypes.POINTER(ctypes.c_size_t)]
791
pubkey_get_key_id.restype = _error_code
793
pubkey_deinit = _library.gnutls_pubkey_deinit
794
pubkey_deinit.argtypes = [pubkey_t]
795
pubkey_deinit.restype = None
797
# All the function declarations below are from gnutls/openpgp.h
799
openpgp_crt_init = _library.gnutls_openpgp_crt_init
800
openpgp_crt_init.argtypes = [ctypes.POINTER(openpgp_crt_t)]
801
openpgp_crt_init.restype = _error_code
803
openpgp_crt_import = _library.gnutls_openpgp_crt_import
804
openpgp_crt_import.argtypes = [openpgp_crt_t,
805
ctypes.POINTER(datum_t),
807
openpgp_crt_import.restype = _error_code
809
openpgp_crt_verify_self = _library.gnutls_openpgp_crt_verify_self
810
openpgp_crt_verify_self.argtypes = [openpgp_crt_t, ctypes.c_uint,
811
ctypes.POINTER(ctypes.c_uint)]
812
openpgp_crt_verify_self.restype = _error_code
814
openpgp_crt_deinit = _library.gnutls_openpgp_crt_deinit
815
openpgp_crt_deinit.argtypes = [openpgp_crt_t]
816
openpgp_crt_deinit.restype = None
818
openpgp_crt_get_fingerprint = (
819
_library.gnutls_openpgp_crt_get_fingerprint)
820
openpgp_crt_get_fingerprint.argtypes = [openpgp_crt_t,
824
openpgp_crt_get_fingerprint.restype = _error_code
826
if check_version(b"3.6.4"):
827
certificate_type_get2 = _library.gnutls_certificate_type_get2
828
certificate_type_get2.argtypes = [session_t, ctypes.c_int]
829
certificate_type_get2.restype = _error_code
831
# Remove non-public functions
832
del _error_code, _retry_on_error
835
def call_pipe(connection, # : multiprocessing.Connection
836
func, *args, **kwargs):
837
"""This function is meant to be called by multiprocessing.Process
839
This function runs func(*args, **kwargs), and writes the resulting
840
return value on the provided multiprocessing.Connection.
842
connection.send(func(*args, **kwargs))
381
def timedelta_to_milliseconds(td):
382
"Convert a datetime.timedelta() to milliseconds"
383
return ((td.days * 24 * 60 * 60 * 1000)
384
+ (td.seconds * 1000)
385
+ (td.microseconds // 1000))
387
class Client(object):
847
388
"""A representation of a client host served by this server.
850
391
approved: bool(); 'None' if not yet approved/disapproved
851
392
approval_delay: datetime.timedelta(); Time to wait for approval
852
393
approval_duration: datetime.timedelta(); Duration of one approval
853
checker: multiprocessing.Process(); a running checker process used
854
to see if the client lives. 'None' if no process is
856
checker_callback_tag: a GLib event source tag, or None
394
checker: subprocess.Popen(); a running checker process used
395
to see if the client lives.
396
'None' if no process is running.
397
checker_callback_tag: a gobject event source tag, or None
857
398
checker_command: string; External command which is run to check
858
399
if client lives. %() expansions are done at
859
400
runtime with vars(self) as dict, so that for
860
401
instance %(name)s can be used in the command.
861
checker_initiator_tag: a GLib event source tag, or None
402
checker_initiator_tag: a gobject event source tag, or None
862
403
created: datetime.datetime(); (UTC) object creation
863
404
client_structure: Object describing what attributes a client has
864
405
and is used for storing the client at exit
865
406
current_checker_command: string; current running checker_command
866
disable_initiator_tag: a GLib event source tag, or None
407
disable_initiator_tag: a gobject event source tag, or None
868
409
fingerprint: string (40 or 32 hexadecimal digits); used to
869
uniquely identify an OpenPGP client
870
key_id: string (64 hexadecimal digits); used to uniquely identify
871
a client using raw public keys
410
uniquely identify the client
872
411
host: string; available for use by the checker command
873
412
interval: datetime.timedelta(); How often to start a new checker
874
413
last_approval_request: datetime.datetime(); (UTC) or None
875
414
last_checked_ok: datetime.datetime(); (UTC) or None
876
416
last_checker_status: integer between 0 and 255 reflecting exit
877
417
status of last checker. -1 reflects crashed
878
checker, -2 means no checker completed yet.
879
last_checker_signal: The signal which killed the last checker, if
880
last_checker_status is -1
881
419
last_enabled: datetime.datetime(); (UTC) or None
882
420
name: string; from the config file, used in log messages and
883
421
D-Bus identifiers
884
422
secret: bytestring; sent verbatim (over TLS) to client
885
423
timeout: datetime.timedelta(); How long from last_checked_ok
886
424
until this client is disabled
887
extended_timeout: extra long timeout when secret has been sent
425
extended_timeout: extra long timeout when password has been sent
888
426
runtime_expansions: Allowed attributes for runtime expansion.
889
427
expires: datetime.datetime(); time (UTC) when a client will be
890
428
disabled, or None
891
server_settings: The server_settings dict from main()
894
431
runtime_expansions = ("approval_delay", "approval_duration",
895
"created", "enabled", "expires", "key_id",
896
"fingerprint", "host", "interval",
897
"last_approval_request", "last_checked_ok",
432
"created", "enabled", "fingerprint",
433
"host", "interval", "last_checked_ok",
898
434
"last_enabled", "name", "timeout")
901
"extended_timeout": "PT15M",
903
"checker": "fping -q -- %%(host)s",
905
"approval_delay": "PT0S",
906
"approval_duration": "PT1S",
907
"approved_by_default": "True",
912
def config_parser(config):
913
"""Construct a new dict of client settings of this form:
914
{ client_name: {setting_name: value, ...}, ...}
915
with exceptions for any special settings as defined above.
916
NOTE: Must be a pure function. Must return the same result
917
value given the same arguments.
920
for client_name in config.sections():
921
section = dict(config.items(client_name))
922
client = settings[client_name] = {}
924
client["host"] = section["host"]
925
# Reformat values from string types to Python types
926
client["approved_by_default"] = config.getboolean(
927
client_name, "approved_by_default")
928
client["enabled"] = config.getboolean(client_name,
931
# Uppercase and remove spaces from key_id and fingerprint
932
# for later comparison purposes with return value from the
933
# key_id() and fingerprint() functions
934
client["key_id"] = (section.get("key_id", "").upper()
936
client["fingerprint"] = (section["fingerprint"].upper()
938
if "secret" in section:
939
client["secret"] = codecs.decode(section["secret"]
942
elif "secfile" in section:
943
with open(os.path.expanduser(os.path.expandvars
944
(section["secfile"])),
946
client["secret"] = secfile.read()
948
raise TypeError("No secret or secfile for section {}"
950
client["timeout"] = string_to_delta(section["timeout"])
951
client["extended_timeout"] = string_to_delta(
952
section["extended_timeout"])
953
client["interval"] = string_to_delta(section["interval"])
954
client["approval_delay"] = string_to_delta(
955
section["approval_delay"])
956
client["approval_duration"] = string_to_delta(
957
section["approval_duration"])
958
client["checker_command"] = section["checker"]
959
client["last_approval_request"] = None
960
client["last_checked_ok"] = None
961
client["last_checker_status"] = -2
965
def __init__(self, settings, name=None, server_settings=None):
436
def timeout_milliseconds(self):
437
"Return the 'timeout' attribute in milliseconds"
438
return timedelta_to_milliseconds(self.timeout)
440
def extended_timeout_milliseconds(self):
441
"Return the 'extended_timeout' attribute in milliseconds"
442
return timedelta_to_milliseconds(self.extended_timeout)
444
def interval_milliseconds(self):
445
"Return the 'interval' attribute in milliseconds"
446
return timedelta_to_milliseconds(self.interval)
448
def approval_delay_milliseconds(self):
449
return timedelta_to_milliseconds(self.approval_delay)
451
def __init__(self, name = None, config=None):
452
"""Note: the 'checker' key in 'config' sets the
453
'checker_command' attribute and *not* the 'checker'
967
if server_settings is None:
969
self.server_settings = server_settings
970
# adding all client settings
971
for setting, value in settings.items():
972
setattr(self, setting, value)
975
if not hasattr(self, "last_enabled"):
976
self.last_enabled = datetime.datetime.utcnow()
977
if not hasattr(self, "expires"):
978
self.expires = (datetime.datetime.utcnow()
981
self.last_enabled = None
984
458
logger.debug("Creating client %r", self.name)
985
logger.debug(" Key ID: %s", self.key_id)
459
# Uppercase and remove spaces from fingerprint for later
460
# comparison purposes with return value from the fingerprint()
462
self.fingerprint = (config["fingerprint"].upper()
986
464
logger.debug(" Fingerprint: %s", self.fingerprint)
987
self.created = settings.get("created",
988
datetime.datetime.utcnow())
990
# attributes specific for this server instance
465
if "secret" in config:
466
self.secret = config["secret"].decode("base64")
467
elif "secfile" in config:
468
with open(os.path.expanduser(os.path.expandvars
469
(config["secfile"])),
471
self.secret = secfile.read()
473
raise TypeError("No secret or secfile for client %s"
475
self.host = config.get("host", "")
476
self.created = datetime.datetime.utcnow()
477
self.enabled = config.get("enabled", True)
478
self.last_approval_request = None
480
self.last_enabled = datetime.datetime.utcnow()
482
self.last_enabled = None
483
self.last_checked_ok = None
484
self.last_checker_status = None
485
self.timeout = string_to_delta(config["timeout"])
486
self.extended_timeout = string_to_delta(config
487
["extended_timeout"])
488
self.interval = string_to_delta(config["interval"])
991
489
self.checker = None
992
490
self.checker_initiator_tag = None
993
491
self.disable_initiator_tag = None
493
self.expires = datetime.datetime.utcnow() + self.timeout
994
496
self.checker_callback_tag = None
497
self.checker_command = config["checker"]
995
498
self.current_checker_command = None
996
499
self.approved = None
500
self.approved_by_default = config.get("approved_by_default",
997
502
self.approvals_pending = 0
998
self.changedstate = multiprocessing_manager.Condition(
999
multiprocessing_manager.Lock())
1000
self.client_structure = [attr
1001
for attr in self.__dict__.keys()
503
self.approval_delay = string_to_delta(
504
config["approval_delay"])
505
self.approval_duration = string_to_delta(
506
config["approval_duration"])
507
self.changedstate = (multiprocessing_manager
508
.Condition(multiprocessing_manager
510
self.client_structure = [attr for attr in
511
self.__dict__.iterkeys()
1002
512
if not attr.startswith("_")]
1003
513
self.client_structure.append("client_structure")
1005
for name, t in inspect.getmembers(
1006
type(self), lambda obj: isinstance(obj, property)):
515
for name, t in inspect.getmembers(type(self),
1007
519
if not name.startswith("_"):
1008
520
self.client_structure.append(name)
1010
522
# Send notice to process children that client state has changed
1011
523
def send_changedstate(self):
1012
524
with self.changedstate:
1013
525
self.changedstate.notify_all()
1015
527
def enable(self):
1016
528
"""Start this client's checker and timeout hooks"""
1017
529
if getattr(self, "enabled", False):
1018
530
# Already enabled
532
self.send_changedstate()
1020
533
self.expires = datetime.datetime.utcnow() + self.timeout
1021
534
self.enabled = True
1022
535
self.last_enabled = datetime.datetime.utcnow()
1023
536
self.init_checker()
1024
self.send_changedstate()
1026
538
def disable(self, quiet=True):
1027
539
"""Disable this client."""
1028
540
if not getattr(self, "enabled", False):
543
self.send_changedstate()
1031
545
logger.info("Disabling client %s", self.name)
1032
if getattr(self, "disable_initiator_tag", None) is not None:
1033
GLib.source_remove(self.disable_initiator_tag)
546
if getattr(self, "disable_initiator_tag", False):
547
gobject.source_remove(self.disable_initiator_tag)
1034
548
self.disable_initiator_tag = None
1035
549
self.expires = None
1036
if getattr(self, "checker_initiator_tag", None) is not None:
1037
GLib.source_remove(self.checker_initiator_tag)
550
if getattr(self, "checker_initiator_tag", False):
551
gobject.source_remove(self.checker_initiator_tag)
1038
552
self.checker_initiator_tag = None
1039
553
self.stop_checker()
1040
554
self.enabled = False
1042
self.send_changedstate()
1043
# Do not run this again if called by a GLib.timeout_add
555
# Do not run this again if called by a gobject.timeout_add
1046
558
def __del__(self):
1049
561
def init_checker(self):
1050
562
# Schedule a new checker to be started an 'interval' from now,
1051
563
# and every interval from then on.
1052
if self.checker_initiator_tag is not None:
1053
GLib.source_remove(self.checker_initiator_tag)
1054
self.checker_initiator_tag = GLib.timeout_add(
1055
random.randrange(int(self.interval.total_seconds() * 1000
564
self.checker_initiator_tag = (gobject.timeout_add
565
(self.interval_milliseconds(),
1058
567
# Schedule a disable() when 'timeout' has passed
1059
if self.disable_initiator_tag is not None:
1060
GLib.source_remove(self.disable_initiator_tag)
1061
self.disable_initiator_tag = GLib.timeout_add(
1062
int(self.timeout.total_seconds() * 1000), self.disable)
568
self.disable_initiator_tag = (gobject.timeout_add
569
(self.timeout_milliseconds(),
1063
571
# Also start a new checker *right now*.
1064
572
self.start_checker()
1066
def checker_callback(self, source, condition, connection,
574
def checker_callback(self, pid, condition, command):
1068
575
"""The checker has completed, so take appropriate actions."""
1069
# Read return code from connection (see call_pipe)
1070
returncode = connection.recv()
1072
if self.checker is not None:
1074
576
self.checker_callback_tag = None
1075
577
self.checker = None
1078
self.last_checker_status = returncode
1079
self.last_checker_signal = None
578
if os.WIFEXITED(condition):
579
self.last_checker_status = os.WEXITSTATUS(condition)
1080
580
if self.last_checker_status == 0:
1081
581
logger.info("Checker for %(name)s succeeded",
1083
583
self.checked_ok()
1085
logger.info("Checker for %(name)s failed", vars(self))
585
logger.info("Checker for %(name)s failed",
1087
588
self.last_checker_status = -1
1088
self.last_checker_signal = -returncode
1089
589
logger.warning("Checker for %(name)s crashed?",
1093
def checked_ok(self):
1094
"""Assert that the client has been seen, alive and well."""
1095
self.last_checked_ok = datetime.datetime.utcnow()
1096
self.last_checker_status = 0
1097
self.last_checker_signal = None
1100
def bump_timeout(self, timeout=None):
1101
"""Bump up the timeout for this client."""
592
def checked_ok(self, timeout=None):
593
"""Bump up the timeout for this client.
595
This should only be called when the client has been seen,
1102
598
if timeout is None:
1103
599
timeout = self.timeout
600
self.last_checked_ok = datetime.datetime.utcnow()
1104
601
if self.disable_initiator_tag is not None:
1105
GLib.source_remove(self.disable_initiator_tag)
1106
self.disable_initiator_tag = None
602
gobject.source_remove(self.disable_initiator_tag)
1107
603
if getattr(self, "enabled", False):
1108
self.disable_initiator_tag = GLib.timeout_add(
1109
int(timeout.total_seconds() * 1000), self.disable)
604
self.disable_initiator_tag = (gobject.timeout_add
605
(timedelta_to_milliseconds
606
(timeout), self.disable))
1110
607
self.expires = datetime.datetime.utcnow() + timeout
1112
609
def need_approval(self):
1113
610
self.last_approval_request = datetime.datetime.utcnow()
1115
612
def start_checker(self):
1116
613
"""Start a new checker subprocess if one is not running.
1118
615
If a checker already exists, leave it running and do
1120
617
# The reason for not killing a running checker is that if we
1121
# did that, and if a checker (for some reason) started running
1122
# slowly and taking more than 'interval' time, then the client
1123
# would inevitably timeout, since no checker would get a
1124
# chance to run to completion. If we instead leave running
618
# did that, then if a checker (for some reason) started
619
# running slowly and taking more than 'interval' time, the
620
# client would inevitably timeout, since no checker would get
621
# a chance to run to completion. If we instead leave running
1125
622
# checkers alone, the checker would have to take more time
1126
623
# than 'timeout' for the client to be disabled, which is as it
1129
if self.checker is not None and not self.checker.is_alive():
1130
logger.warning("Checker was not alive; joining")
626
# If a checker exists, make sure it is not a zombie
628
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
629
except (AttributeError, OSError) as error:
630
if (isinstance(error, OSError)
631
and error.errno != errno.ECHILD):
635
logger.warning("Checker was a zombie")
636
gobject.source_remove(self.checker_callback_tag)
637
self.checker_callback(pid, status,
638
self.current_checker_command)
1133
639
# Start a new checker if needed
1134
640
if self.checker is None:
1135
# Escape attributes for the shell
1137
attr: shlex.quote(str(getattr(self, attr)))
1138
for attr in self.runtime_expansions}
1140
command = self.checker_command % escaped_attrs
1141
except TypeError as error:
1142
logger.error('Could not format string "%s"',
1143
self.checker_command,
1145
return True # Try again later
642
# In case checker_command has exactly one % operator
643
command = self.checker_command % self.host
645
# Escape attributes for the shell
646
escaped_attrs = dict(
648
re.escape(unicode(str(getattr(self, attr, "")),
652
self.runtime_expansions)
655
command = self.checker_command % escaped_attrs
656
except TypeError as error:
657
logger.error('Could not format string "%s":'
658
' %s', self.checker_command, error)
659
return True # Try again later
1146
660
self.current_checker_command = command
1147
logger.info("Starting checker %r for %s", command,
1149
# We don't need to redirect stdout and stderr, since
1150
# in normal mode, that is already done by daemon(),
1151
# and in debug mode we don't want to. (Stdin is
1152
# always replaced by /dev/null.)
1153
# The exception is when not debugging but nevertheless
1154
# running in the foreground; use the previously
1156
popen_args = {"close_fds": True,
1159
if (not self.server_settings["debug"]
1160
and self.server_settings["foreground"]):
1161
popen_args.update({"stdout": wnull,
1163
pipe = multiprocessing.Pipe(duplex=False)
1164
self.checker = multiprocessing.Process(
1166
args=(pipe[1], subprocess.call, command),
1168
self.checker.start()
1169
self.checker_callback_tag = GLib.io_add_watch(
1170
GLib.IOChannel.unix_new(pipe[0].fileno()),
1171
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
1172
self.checker_callback, pipe[0], command)
1173
# Re-run this periodically if run by GLib.timeout_add
662
logger.info("Starting checker %r for %s",
664
# We don't need to redirect stdout and stderr, since
665
# in normal mode, that is already done by daemon(),
666
# and in debug mode we don't want to. (Stdin is
667
# always replaced by /dev/null.)
668
self.checker = subprocess.Popen(command,
671
self.checker_callback_tag = (gobject.child_watch_add
673
self.checker_callback,
675
# The checker may have completed before the gobject
676
# watch was added. Check for this.
677
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
679
gobject.source_remove(self.checker_callback_tag)
680
self.checker_callback(pid, status, command)
681
except OSError as error:
682
logger.error("Failed to start subprocess: %s",
684
# Re-run this periodically if run by gobject.timeout_add
1176
687
def stop_checker(self):
1177
688
"""Force the checker process, if any, to stop."""
1178
689
if self.checker_callback_tag:
1179
GLib.source_remove(self.checker_callback_tag)
690
gobject.source_remove(self.checker_callback_tag)
1180
691
self.checker_callback_tag = None
1181
692
if getattr(self, "checker", None) is None:
1183
694
logger.debug("Stopping checker for %(name)s", vars(self))
1184
self.checker.terminate()
696
os.kill(self.checker.pid, signal.SIGTERM)
698
#if self.checker.poll() is None:
699
# os.kill(self.checker.pid, signal.SIGKILL)
700
except OSError as error:
701
if error.errno != errno.ESRCH: # No such process
1185
703
self.checker = None
1188
def dbus_service_property(dbus_interface,
706
def dbus_service_property(dbus_interface, signature="v",
707
access="readwrite", byte_arrays=False):
1192
708
"""Decorators for marking methods of a DBusObjectWithProperties to
1193
709
become properties on the D-Bus.
1195
711
The decorated method will be called with no arguments by "Get"
1196
712
and with one argument by "Set".
1198
714
The parameters, where they are supported, are the same as
1199
715
dbus.service.method, except there is only "signature", since the
1200
716
type from Get() and the type sent to Set() is the same.
1532
886
except (AttributeError, xml.dom.DOMException,
1533
887
xml.parsers.expat.ExpatError) as error:
1534
888
logger.error("Failed to override Introspection method",
1540
dbus.OBJECT_MANAGER_IFACE
1541
except AttributeError:
1542
dbus.OBJECT_MANAGER_IFACE = "org.freedesktop.DBus.ObjectManager"
1545
class DBusObjectWithObjectManager(DBusObjectWithAnnotations):
1546
"""A D-Bus object with an ObjectManager.
1548
Classes inheriting from this exposes the standard
1549
GetManagedObjects call and the InterfacesAdded and
1550
InterfacesRemoved signals on the standard
1551
"org.freedesktop.DBus.ObjectManager" interface.
1553
Note: No signals are sent automatically; they must be sent
1556
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
1557
out_signature="a{oa{sa{sv}}}")
1558
def GetManagedObjects(self):
1559
"""This function must be overridden"""
1560
raise NotImplementedError()
1562
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE,
1563
signature="oa{sa{sv}}")
1564
def InterfacesAdded(self, object_path, interfaces_and_properties):
1567
@dbus.service.signal(dbus.OBJECT_MANAGER_IFACE, signature="oas")
1568
def InterfacesRemoved(self, object_path, interfaces):
1571
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
1573
path_keyword='object_path',
1574
connection_keyword='connection')
1575
def Introspect(self, object_path, connection):
1576
"""Overloading of standard D-Bus method.
1578
Override return argument name of GetManagedObjects to be
1579
"objpath_interfaces_and_properties"
1581
xmlstring = DBusObjectWithAnnotations.Introspect(self,
1585
document = xml.dom.minidom.parseString(xmlstring)
1587
for if_tag in document.getElementsByTagName("interface"):
1588
# Fix argument name for the GetManagedObjects method
1589
if (if_tag.getAttribute("name")
1590
== dbus.OBJECT_MANAGER_IFACE):
1591
for cn in if_tag.getElementsByTagName("method"):
1592
if (cn.getAttribute("name")
1593
== "GetManagedObjects"):
1594
for arg in cn.getElementsByTagName("arg"):
1595
if (arg.getAttribute("direction")
1599
"objpath_interfaces"
1601
xmlstring = document.toxml("utf-8")
1603
except (AttributeError, xml.dom.DOMException,
1604
xml.parsers.expat.ExpatError) as error:
1605
logger.error("Failed to override Introspection method",
1610
def datetime_to_dbus(dt, variant_level=0):
893
def datetime_to_dbus (dt, variant_level=0):
1611
894
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1613
return dbus.String("", variant_level=variant_level)
1614
return dbus.String(dt.isoformat(), variant_level=variant_level)
1617
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1618
"""A class decorator; applied to a subclass of
1619
dbus.service.Object, it will add alternate D-Bus attributes with
1620
interface names according to the "alt_interface_names" mapping.
1623
@alternate_dbus_interfaces({"org.example.Interface":
1624
"net.example.AlternateInterface"})
1625
class SampleDBusObject(dbus.service.Object):
1626
@dbus.service.method("org.example.Interface")
1627
def SampleDBusMethod():
1630
The above "SampleDBusMethod" on "SampleDBusObject" will be
1631
reachable via two interfaces: "org.example.Interface" and
1632
"net.example.AlternateInterface", the latter of which will have
1633
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1634
"true", unless "deprecate" is passed with a False value.
1636
This works for methods and signals, and also for D-Bus properties
1637
(from DBusObjectWithProperties) and interfaces (from the
1638
dbus_interface_annotations decorator).
896
return dbus.String("", variant_level = variant_level)
897
return dbus.String(dt.isoformat(),
898
variant_level=variant_level)
901
class AlternateDBusNamesMetaclass(DBusObjectWithProperties
903
"""Applied to an empty subclass of a D-Bus object, this metaclass
904
will add additional D-Bus attributes matching a certain pattern.
1642
for orig_interface_name, alt_interface_name in (
1643
alt_interface_names.items()):
1645
interface_names = set()
1646
# Go though all attributes of the class
1647
for attrname, attribute in inspect.getmembers(cls):
906
def __new__(mcs, name, bases, attr):
907
# Go through all the base classes which could have D-Bus
908
# methods, signals, or properties in them
909
for base in (b for b in bases
910
if issubclass(b, dbus.service.Object)):
911
# Go though all attributes of the base class
912
for attrname, attribute in inspect.getmembers(base):
1648
913
# Ignore non-D-Bus attributes, and D-Bus attributes
1649
914
# with the wrong interface name
1650
915
if (not hasattr(attribute, "_dbus_interface")
1651
or not attribute._dbus_interface.startswith(
1652
orig_interface_name)):
916
or not attribute._dbus_interface
917
.startswith("se.recompile.Mandos")):
1654
919
# Create an alternate D-Bus interface name based on
1655
920
# the current name
1656
alt_interface = attribute._dbus_interface.replace(
1657
orig_interface_name, alt_interface_name)
1658
interface_names.add(alt_interface)
921
alt_interface = (attribute._dbus_interface
922
.replace("se.recompile.Mandos",
923
"se.bsnet.fukt.Mandos"))
1659
924
# Is this a D-Bus signal?
1660
925
if getattr(attribute, "_dbus_is_signal", False):
1661
# Extract the original non-method undecorated
1662
# function by black magic
1663
if sys.version_info.major == 2:
1664
nonmethod_func = (dict(
926
# Extract the original non-method function by
928
nonmethod_func = (dict(
1665
929
zip(attribute.func_code.co_freevars,
1666
attribute.__closure__))
1667
["func"].cell_contents)
1669
nonmethod_func = (dict(
1670
zip(attribute.__code__.co_freevars,
1671
attribute.__closure__))
1672
["func"].cell_contents)
930
attribute.__closure__))["func"]
1673
932
# Create a new, but exactly alike, function
1674
933
# object, and decorate it to be a new D-Bus signal
1675
934
# with the alternate D-Bus interface name
1676
new_function = copy_function(nonmethod_func)
1677
new_function = (dbus.service.signal(
1679
attribute._dbus_signature)(new_function))
1680
# Copy annotations, if any
1682
new_function._dbus_annotations = dict(
1683
attribute._dbus_annotations)
1684
except AttributeError:
935
new_function = (dbus.service.signal
937
attribute._dbus_signature)
939
nonmethod_func.func_code,
940
nonmethod_func.func_globals,
941
nonmethod_func.func_name,
942
nonmethod_func.func_defaults,
943
nonmethod_func.func_closure)))
1687
944
# Define a creator of a function to call both the
1688
# original and alternate functions, so both the
1689
# original and alternate signals gets sent when
1690
# the function is called
945
# old and new functions, so both the old and new
946
# signals gets sent when the function is called
1691
947
def fixscope(func1, func2):
1692
948
"""This function is a scope container to pass
1693
949
func1 and func2 to the "call_both" function
1694
950
outside of its arguments"""
1696
@functools.wraps(func2)
1697
951
def call_both(*args, **kwargs):
1698
952
"""This function will emit two D-Bus
1699
953
signals by calling func1 and func2"""
1700
954
func1(*args, **kwargs)
1701
955
func2(*args, **kwargs)
1702
# Make wrapper function look like a D-Bus
1704
for name, attr in inspect.getmembers(func2):
1705
if name.startswith("_dbus_"):
1706
setattr(call_both, name, attr)
1708
956
return call_both
1709
957
# Create the "call_both" function and add it to
1711
attr[attrname] = fixscope(attribute, new_function)
959
attr[attrname] = fixscope(attribute,
1712
961
# Is this a D-Bus method?
1713
962
elif getattr(attribute, "_dbus_is_method", False):
1714
963
# Create a new, but exactly alike, function
1715
964
# object. Decorate it to be a new D-Bus method
1716
965
# with the alternate D-Bus interface name. Add it
1719
dbus.service.method(
1721
attribute._dbus_in_signature,
1722
attribute._dbus_out_signature)
1723
(copy_function(attribute)))
1724
# Copy annotations, if any
1726
attr[attrname]._dbus_annotations = dict(
1727
attribute._dbus_annotations)
1728
except AttributeError:
967
attr[attrname] = (dbus.service.method
969
attribute._dbus_in_signature,
970
attribute._dbus_out_signature)
972
(attribute.func_code,
973
attribute.func_globals,
975
attribute.func_defaults,
976
attribute.func_closure)))
1730
977
# Is this a D-Bus property?
1731
978
elif getattr(attribute, "_dbus_is_property", False):
1732
979
# Create a new, but exactly alike, function
1733
980
# object, and decorate it to be a new D-Bus
1734
981
# property with the alternate D-Bus interface
1735
982
# name. Add it to the class.
1736
attr[attrname] = (dbus_service_property(
1737
alt_interface, attribute._dbus_signature,
1738
attribute._dbus_access,
1739
attribute._dbus_get_args_options
1741
(copy_function(attribute)))
1742
# Copy annotations, if any
1744
attr[attrname]._dbus_annotations = dict(
1745
attribute._dbus_annotations)
1746
except AttributeError:
1748
# Is this a D-Bus interface?
1749
elif getattr(attribute, "_dbus_is_interface", False):
1750
# Create a new, but exactly alike, function
1751
# object. Decorate it to be a new D-Bus interface
1752
# with the alternate D-Bus interface name. Add it
1755
dbus_interface_annotations(alt_interface)
1756
(copy_function(attribute)))
1758
# Deprecate all alternate interfaces
1759
iname = "_AlternateDBusNames_interface_annotation{}"
1760
for interface_name in interface_names:
1762
@dbus_interface_annotations(interface_name)
1764
return {"org.freedesktop.DBus.Deprecated":
1766
# Find an unused name
1767
for aname in (iname.format(i)
1768
for i in itertools.count()):
1769
if aname not in attr:
1773
# Replace the class with a new subclass of it with
1774
# methods, signals, etc. as created above.
1775
if sys.version_info.major == 2:
1776
cls = type(b"{}Alternate".format(cls.__name__),
1779
cls = type("{}Alternate".format(cls.__name__),
1786
@alternate_dbus_interfaces({"se.recompile.Mandos":
1787
"se.bsnet.fukt.Mandos"})
983
attr[attrname] = (dbus_service_property
985
attribute._dbus_signature,
986
attribute._dbus_access,
988
._dbus_get_args_options
991
(attribute.func_code,
992
attribute.func_globals,
994
attribute.func_defaults,
995
attribute.func_closure)))
996
return type.__new__(mcs, name, bases, attr)
1788
999
class ClientDBus(Client, DBusObjectWithProperties):
1789
1000
"""A Client class using D-Bus
1792
1003
dbus_object_path: dbus.ObjectPath
1793
1004
bus: dbus.SystemBus()
1796
1007
runtime_expansions = (Client.runtime_expansions
1797
+ ("dbus_object_path", ))
1799
_interface = "se.recompile.Mandos.Client"
1008
+ ("dbus_object_path",))
1801
1010
# dbus.service.Object doesn't use super(), so we can't either.
1803
def __init__(self, bus=None, *args, **kwargs):
1012
def __init__(self, bus = None, *args, **kwargs):
1805
1014
Client.__init__(self, *args, **kwargs)
1016
self._approvals_pending = 0
1806
1017
# Only now, when this client is initialized, can it show up on
1808
client_object_name = str(self.name).translate(
1019
client_object_name = unicode(self.name).translate(
1809
1020
{ord("."): ord("_"),
1810
1021
ord("-"): ord("_")})
1811
self.dbus_object_path = dbus.ObjectPath(
1812
"/clients/" + client_object_name)
1022
self.dbus_object_path = (dbus.ObjectPath
1023
("/clients/" + client_object_name))
1813
1024
DBusObjectWithProperties.__init__(self, self.bus,
1814
1025
self.dbus_object_path)
1816
def notifychangeproperty(transform_func, dbus_name,
1817
type_func=lambda x: x,
1819
invalidate_only=False,
1820
_interface=_interface):
1027
def notifychangeproperty(transform_func,
1028
dbus_name, type_func=lambda x: x,
1821
1030
""" Modify a variable so that it's a property which announces
1822
1031
its changes to DBus.
1824
1033
transform_fun: Function that takes a value and a variant_level
1825
1034
and transforms it to a D-Bus type.
1826
1035
dbus_name: D-Bus name of the variable
3086
2048
use_ipv6 = server_settings["use_ipv6"]
3087
2049
stored_state_path = os.path.join(server_settings["statedir"],
3088
2050
stored_state_file)
3089
foreground = server_settings["foreground"]
3090
zeroconf = server_settings["zeroconf"]
3093
initlogger(debug, logging.DEBUG)
2053
initlogger(logging.DEBUG)
3095
2055
if not debuglevel:
3098
2058
level = getattr(logging, debuglevel.upper())
3099
initlogger(debug, level)
3101
2061
if server_settings["servicename"] != "Mandos":
3102
syslogger.setFormatter(
3103
logging.Formatter('Mandos ({}) [%(process)d]:'
3104
' %(levelname)s: %(message)s'.format(
3105
server_settings["servicename"])))
2062
syslogger.setFormatter(logging.Formatter
2063
('Mandos (%s) [%%(process)d]:'
2064
' %%(levelname)s: %%(message)s'
2065
% server_settings["servicename"]))
3107
2067
# Parse config file with clients
3108
client_config = configparser.ConfigParser(Client.client_defaults)
2068
client_defaults = { "timeout": "5m",
2069
"extended_timeout": "15m",
2071
"checker": "fping -q -- %%(host)s",
2073
"approval_delay": "0s",
2074
"approval_duration": "1s",
2076
client_config = configparser.SafeConfigParser(client_defaults)
3109
2077
client_config.read(os.path.join(server_settings["configdir"],
3110
2078
"clients.conf"))
3112
2080
global mandos_dbus_service
3113
2081
mandos_dbus_service = None
3116
if server_settings["socket"] != "":
3117
socketfd = server_settings["socket"]
3118
tcp_server = MandosServer(
3119
(server_settings["address"], server_settings["port"]),
3121
interface=(server_settings["interface"] or None),
3123
gnutls_priority=server_settings["priority"],
3127
pidfilename = "/run/mandos.pid"
3128
if not os.path.isdir("/run/."):
3129
pidfilename = "/var/run/mandos.pid"
3132
pidfile = codecs.open(pidfilename, "w", encoding="utf-8")
3133
except IOError as e:
3134
logger.error("Could not open file %r", pidfilename,
3137
for name, group in (("_mandos", "_mandos"),
3138
("mandos", "mandos"),
3139
("nobody", "nogroup")):
3141
uid = pwd.getpwnam(name).pw_uid
3142
gid = pwd.getpwnam(group).pw_gid
2083
tcp_server = MandosServer((server_settings["address"],
2084
server_settings["port"]),
2086
interface=(server_settings["interface"]
2090
server_settings["priority"],
2093
pidfilename = "/var/run/mandos.pid"
2095
pidfile = open(pidfilename, "w")
2097
logger.error("Could not open file %r", pidfilename)
2100
uid = pwd.getpwnam("_mandos").pw_uid
2101
gid = pwd.getpwnam("_mandos").pw_gid
2104
uid = pwd.getpwnam("mandos").pw_uid
2105
gid = pwd.getpwnam("mandos").pw_gid
3144
2106
except KeyError:
2108
uid = pwd.getpwnam("nobody").pw_uid
2109
gid = pwd.getpwnam("nobody").pw_gid
3153
logger.debug("Did setuid/setgid to {}:{}".format(uid,
3155
2116
except OSError as error:
3156
logger.warning("Failed to setuid/setgid to {}:{}: {}"
3157
.format(uid, gid, os.strerror(error.errno)))
3158
if error.errno != errno.EPERM:
2117
if error[0] != errno.EPERM:
3162
2121
# Enable all possible GnuTLS debugging
3164
2123
# "Use a log level over 10 to enable all debugging options."
3165
2124
# - GnuTLS manual
3166
gnutls.global_set_log_level(11)
2125
gnutls.library.functions.gnutls_global_set_log_level(11)
2127
@gnutls.library.types.gnutls_log_func
3169
2128
def debug_gnutls(level, string):
3170
2129
logger.debug("GnuTLS: %s", string[:-1])
3172
gnutls.global_set_log_function(debug_gnutls)
2131
(gnutls.library.functions
2132
.gnutls_global_set_log_function(debug_gnutls))
3174
2134
# Redirect stdin so all checkers get /dev/null
3175
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2135
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
3176
2136
os.dup2(null, sys.stdin.fileno())
2140
# No console logging
2141
logger.removeHandler(console)
3180
2143
# Need to fork before connecting to D-Bus
3182
2145
# Close all input and output, do double fork, etc.
3185
if gi.version_info < (3, 10, 2):
3186
# multiprocessing will use threads, so before we use GLib we
3187
# need to inform GLib that threads will be used.
3190
2148
global main_loop
3191
2149
# From the Avahi example code
3192
DBusGMainLoop(set_as_default=True)
3193
main_loop = GLib.MainLoop()
2150
DBusGMainLoop(set_as_default=True )
2151
main_loop = gobject.MainLoop()
3194
2152
bus = dbus.SystemBus()
3195
2153
# End of Avahi example code
3198
2156
bus_name = dbus.service.BusName("se.recompile.Mandos",
3201
old_bus_name = dbus.service.BusName(
3202
"se.bsnet.fukt.Mandos", bus,
3204
except dbus.exceptions.DBusException as e:
3205
logger.error("Disabling D-Bus:", exc_info=e)
2157
bus, do_not_queue=True)
2158
old_bus_name = (dbus.service.BusName
2159
("se.bsnet.fukt.Mandos", bus,
2161
except dbus.exceptions.NameExistsException as e:
2162
logger.error(unicode(e) + ", disabling D-Bus")
3206
2163
use_dbus = False
3207
2164
server_settings["use_dbus"] = False
3208
2165
tcp_server.use_dbus = False
3210
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
3211
service = AvahiServiceToSyslog(
3212
name=server_settings["servicename"],
3213
servicetype="_mandos._tcp",
3216
if server_settings["interface"]:
3217
service.interface = if_nametoindex(
3218
server_settings["interface"].encode("utf-8"))
2166
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2167
service = AvahiServiceToSyslog(name =
2168
server_settings["servicename"],
2169
servicetype = "_mandos._tcp",
2170
protocol = protocol, bus = bus)
2171
if server_settings["interface"]:
2172
service.interface = (if_nametoindex
2173
(str(server_settings["interface"])))
3220
2175
global multiprocessing_manager
3221
2176
multiprocessing_manager = multiprocessing.Manager()
3223
2178
client_class = Client
3225
client_class = functools.partial(ClientDBus, bus=bus)
3227
client_settings = Client.config_parser(client_config)
2180
client_class = functools.partial(ClientDBusTransitional,
2183
special_settings = {
2184
# Some settings need to be accessd by special methods;
2185
# booleans need .getboolean(), etc. Here is a list of them:
2186
"approved_by_default":
2188
client_config.getboolean(section, "approved_by_default"),
2191
client_config.getboolean(section, "enabled"),
2193
# Construct a new dict of client settings of this form:
2194
# { client_name: {setting_name: value, ...}, ...}
2195
# with exceptions for any special settings as defined above
2196
client_settings = dict((clientname,
2199
if setting not in special_settings
2200
else special_settings[setting]
2202
for setting, value in
2203
client_config.items(clientname)))
2204
for clientname in client_config.sections())
3228
2206
old_client_settings = {}
3231
# This is used to redirect stdout and stderr for checker processes
3233
wnull = open(os.devnull, "w") # A writable /dev/null
3234
# Only used if server is running in foreground but not in debug
3236
if debug or not foreground:
3239
2209
# Get client data and settings from last running state.
3240
2210
if server_settings["restore"]:
3242
2212
with open(stored_state_path, "rb") as stored_state:
3243
if sys.version_info.major == 2:
3244
clients_data, old_client_settings = pickle.load(
3247
bytes_clients_data, bytes_old_client_settings = (
3248
pickle.load(stored_state, encoding="bytes"))
3249
# Fix bytes to strings
3252
clients_data = {(key.decode("utf-8")
3253
if isinstance(key, bytes)
3256
bytes_clients_data.items()}
3257
del bytes_clients_data
3258
for key in clients_data:
3259
value = {(k.decode("utf-8")
3260
if isinstance(k, bytes) else k): v
3262
clients_data[key].items()}
3263
clients_data[key] = value
3265
value["client_structure"] = [
3267
if isinstance(s, bytes)
3269
value["client_structure"]]
3270
# .name, .host, and .checker_command
3271
for k in ("name", "host", "checker_command"):
3272
if isinstance(value[k], bytes):
3273
value[k] = value[k].decode("utf-8")
3274
if "key_id" not in value:
3275
value["key_id"] = ""
3276
elif "fingerprint" not in value:
3277
value["fingerprint"] = ""
3278
# old_client_settings
3280
old_client_settings = {
3281
(key.decode("utf-8")
3282
if isinstance(key, bytes)
3285
bytes_old_client_settings.items()}
3286
del bytes_old_client_settings
3287
# .host and .checker_command
3288
for value in old_client_settings.values():
3289
for attribute in ("host", "checker_command"):
3290
if isinstance(value[attribute], bytes):
3291
value[attribute] = (value[attribute]
2213
clients_data, old_client_settings = (pickle.load
3293
2215
os.remove(stored_state_path)
3294
2216
except IOError as e:
3295
if e.errno == errno.ENOENT:
3296
logger.warning("Could not load persistent state:"
3297
" {}".format(os.strerror(e.errno)))
3299
logger.critical("Could not load persistent state:",
2217
logger.warning("Could not load persistent state: {0}"
2219
if e.errno != errno.ENOENT:
3302
except EOFError as e:
3303
logger.warning("Could not load persistent state: "
3307
2222
with PGPEngine() as pgp:
3308
for client_name, client in clients_data.items():
3309
# Skip removed clients
3310
if client_name not in client_settings:
2223
for client in clients_data:
2224
client_name = client["name"]
3313
2226
# Decide which value to use after restoring saved state.
3314
2227
# We have three different values: Old config file,
3315
2228
# new config file, and saved state.
3320
2233
# For each value in new config, check if it
3321
2234
# differs from the old config value (Except for
3322
2235
# the "secret" attribute)
3323
if (name != "secret"
3325
old_client_settings[client_name][name])):
3326
client[name] = value
2236
if (name != "secret" and
2237
value != old_client_settings[client_name]
2239
setattr(client, name, value)
3327
2240
except KeyError:
3330
2243
# Clients who has passed its expire date can still be
3331
# enabled if its last checker was successful. A Client
3332
# whose checker succeeded before we stored its state is
3333
# assumed to have successfully run all checkers during
2244
# enabled if its last checker was sucessful. Clients
2245
# whose checker failed before we stored its state is
2246
# assumed to have failed all checkers during downtime.
3335
2247
if client["enabled"]:
3336
if datetime.datetime.utcnow() >= client["expires"]:
3337
if not client["last_checked_ok"]:
3339
"disabling client {} - Client never "
3340
"performed a successful checker".format(
3342
client["enabled"] = False
3343
elif client["last_checker_status"] != 0:
3345
"disabling client {} - Client last"
3346
" checker failed with error code"
3349
client["last_checker_status"]))
2248
if client["expires"] <= (datetime.datetime
2250
# Client has expired
2251
if client["last_checker_status"] != 0:
3350
2252
client["enabled"] = False
3352
client["expires"] = (
3353
datetime.datetime.utcnow()
3354
+ client["timeout"])
3355
logger.debug("Last checker succeeded,"
3356
" keeping {} enabled".format(
2254
client["expires"] = (datetime.datetime
2256
+ client["timeout"])
2258
client["changedstate"] = (multiprocessing_manager
2260
(multiprocessing_manager
2263
new_client = (ClientDBusTransitional.__new__
2264
(ClientDBusTransitional))
2265
tcp_server.clients[client_name] = new_client
2266
new_client.bus = bus
2267
for name, value in client.iteritems():
2268
setattr(new_client, name, value)
2269
client_object_name = unicode(client_name).translate(
2270
{ord("."): ord("_"),
2271
ord("-"): ord("_")})
2272
new_client.dbus_object_path = (dbus.ObjectPath
2274
+ client_object_name))
2275
DBusObjectWithProperties.__init__(new_client,
2280
tcp_server.clients[client_name] = (Client.__new__
2282
for name, value in client.iteritems():
2283
setattr(tcp_server.clients[client_name],
3359
client["secret"] = pgp.decrypt(
3360
client["encrypted_secret"],
3361
client_settings[client_name]["secret"])
2287
tcp_server.clients[client_name].secret = (
2288
pgp.decrypt(tcp_server.clients[client_name]
2290
client_settings[client_name]
3362
2292
except PGPError:
3363
2293
# If decryption fails, we use secret from new settings
3364
logger.debug("Failed to decrypt {} old secret".format(
3366
client["secret"] = (client_settings[client_name]
3369
# Add/remove clients based on new changes made to config
3370
for client_name in (set(old_client_settings)
3371
- set(client_settings)):
3372
del clients_data[client_name]
3373
for client_name in (set(client_settings)
3374
- set(old_client_settings)):
3375
clients_data[client_name] = client_settings[client_name]
3377
# Create all client objects
3378
for client_name, client in clients_data.items():
3379
tcp_server.clients[client_name] = client_class(
3382
server_settings=server_settings)
2294
logger.debug("Failed to decrypt {0} old secret"
2295
.format(client_name))
2296
tcp_server.clients[client_name].secret = (
2297
client_settings[client_name]["secret"])
2299
# Create/remove clients based on new changes made to config
2300
for clientname in set(old_client_settings) - set(client_settings):
2301
del tcp_server.clients[clientname]
2302
for clientname in set(client_settings) - set(old_client_settings):
2303
tcp_server.clients[clientname] = (client_class(name
3384
2309
if not tcp_server.clients:
3385
2310
logger.warning("No clients defined")
3388
if pidfile is not None:
3392
print(pid, file=pidfile)
3394
logger.error("Could not write to file %r with PID %d",
2316
pidfile.write(str(pid) + "\n".encode("utf-8"))
2319
logger.error("Could not write to file %r with PID %d",
2322
# "pidfile" was never created
3397
2324
del pidfilename
3399
for termsig in (signal.SIGHUP, signal.SIGTERM):
3400
GLib.unix_signal_add(GLib.PRIORITY_HIGH, termsig,
3401
lambda: main_loop.quit() and False)
2326
signal.signal(signal.SIGINT, signal.SIG_IGN)
2328
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2329
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
3405
@alternate_dbus_interfaces(
3406
{"se.recompile.Mandos": "se.bsnet.fukt.Mandos"})
3407
class MandosDBusService(DBusObjectWithObjectManager):
2332
class MandosDBusService(dbus.service.Object):
3408
2333
"""A D-Bus proxy object"""
3410
2334
def __init__(self):
3411
2335
dbus.service.Object.__init__(self, bus, "/")
3413
2336
_interface = "se.recompile.Mandos"
3415
2338
@dbus.service.signal(_interface, signature="o")
3416
2339
def ClientAdded(self, objpath):
3420
2343
@dbus.service.signal(_interface, signature="ss")
3421
def ClientNotFound(self, key_id, address):
2344
def ClientNotFound(self, fingerprint, address):
3425
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3427
2348
@dbus.service.signal(_interface, signature="os")
3428
2349
def ClientRemoved(self, objpath, name):
3432
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
3434
2353
@dbus.service.method(_interface, out_signature="ao")
3435
2354
def GetAllClients(self):
3437
return dbus.Array(c.dbus_object_path for c in
3438
tcp_server.clients.values())
3440
@dbus_annotations({"org.freedesktop.DBus.Deprecated":
2356
return dbus.Array(c.dbus_object_path
2358
tcp_server.clients.itervalues())
3442
2360
@dbus.service.method(_interface,
3443
2361
out_signature="a{oa{sv}}")
3444
2362
def GetAllClientsWithProperties(self):
3446
2364
return dbus.Dictionary(
3447
{c.dbus_object_path: c.GetAll(
3448
"se.recompile.Mandos.Client")
3449
for c in tcp_server.clients.values()},
2365
((c.dbus_object_path, c.GetAll(""))
2366
for c in tcp_server.clients.itervalues()),
3450
2367
signature="oa{sv}")
3452
2369
@dbus.service.method(_interface, in_signature="o")
3453
2370
def RemoveClient(self, object_path):
3455
for c in tcp_server.clients.values():
2372
for c in tcp_server.clients.itervalues():
3456
2373
if c.dbus_object_path == object_path:
3457
2374
del tcp_server.clients[c.name]
3458
2375
c.remove_from_connection()
3459
# Don't signal the disabling
2376
# Don't signal anything except ClientRemoved
3460
2377
c.disable(quiet=True)
3461
# Emit D-Bus signal for removal
3462
self.client_removed_signal(c)
2379
self.ClientRemoved(object_path, c.name)
3464
2381
raise KeyError(object_path)
3468
@dbus.service.method(dbus.OBJECT_MANAGER_IFACE,
3469
out_signature="a{oa{sa{sv}}}")
3470
def GetManagedObjects(self):
3472
return dbus.Dictionary(
3473
{client.dbus_object_path:
3475
{interface: client.GetAll(interface)
3477
client._get_all_interface_names()})
3478
for client in tcp_server.clients.values()})
3480
def client_added_signal(self, client):
3481
"""Send the new standard signal and the old signal"""
3483
# New standard signal
3484
self.InterfacesAdded(
3485
client.dbus_object_path,
3487
{interface: client.GetAll(interface)
3489
client._get_all_interface_names()}))
3491
self.ClientAdded(client.dbus_object_path)
3493
def client_removed_signal(self, client):
3494
"""Send the new standard signal and the old signal"""
3496
# New standard signal
3497
self.InterfacesRemoved(
3498
client.dbus_object_path,
3499
client._get_all_interface_names())
3501
self.ClientRemoved(client.dbus_object_path,
3504
mandos_dbus_service = MandosDBusService()
3506
# Save modules to variables to exempt the modules from being
3507
# unloaded before the function registered with atexit() is run.
3508
mp = multiprocessing
2385
class MandosDBusServiceTransitional(MandosDBusService):
2386
__metaclass__ = AlternateDBusNamesMetaclass
2387
mandos_dbus_service = MandosDBusServiceTransitional()
3512
2390
"Cleanup function; run on exit"
3516
mp.active_children()
2393
multiprocessing.active_children()
3518
2394
if not (tcp_server.clients or client_settings):
3521
2397
# Store client before exiting. Secrets are encrypted with key
3522
2398
# based on what config file has. If config file is
3523
2399
# removed/edited, old secret will thus be unrecovable.
3525
2401
with PGPEngine() as pgp:
3526
for client in tcp_server.clients.values():
2402
for client in tcp_server.clients.itervalues():
3527
2403
key = client_settings[client.name]["secret"]
3528
2404
client.encrypted_secret = pgp.encrypt(client.secret,
3530
2406
client_dict = {}
3532
# A list of attributes that can not be pickled
3534
exclude = {"bus", "changedstate", "secret",
3535
"checker", "server_settings"}
3536
for name, typ in inspect.getmembers(dbus.service
2408
# A list of attributes that will not be stored when
2410
exclude = set(("bus", "changedstate", "secret"))
2411
for name, typ in (inspect.getmembers
2412
(dbus.service.Object)):
3538
2413
exclude.add(name)
3540
2415
client_dict["encrypted_secret"] = (client
3541
2416
.encrypted_secret)
3542
2417
for attr in client.client_structure:
3543
2418
if attr not in exclude:
3544
2419
client_dict[attr] = getattr(client, attr)
3546
clients[client.name] = client_dict
2421
clients.append(client_dict)
3547
2422
del client_settings[client.name]["secret"]
3550
with tempfile.NamedTemporaryFile(
3554
dir=os.path.dirname(stored_state_path),
3555
delete=False) as stored_state:
3556
pickle.dump((clients, client_settings), stored_state,
3558
tempname = stored_state.name
3559
os.rename(tempname, stored_state_path)
2425
with os.fdopen(os.open(stored_state_path,
2426
os.O_CREAT|os.O_WRONLY|os.O_TRUNC,
2427
0600), "wb") as stored_state:
2428
pickle.dump((clients, client_settings), stored_state)
3560
2429
except (IOError, OSError) as e:
3566
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
3567
logger.warning("Could not save persistent state: {}"
3568
.format(os.strerror(e.errno)))
3570
logger.warning("Could not save persistent state:",
2430
logger.warning("Could not save persistent state: {0}"
2432
if e.errno not in (errno.ENOENT, errno.EACCES):
3574
2435
# Delete all clients, and settings from config
3575
2436
while tcp_server.clients:
3576
2437
name, client = tcp_server.clients.popitem()
3578
2439
client.remove_from_connection()
3579
# Don't signal the disabling
2440
# Don't signal anything except ClientRemoved
3580
2441
client.disable(quiet=True)
3581
# Emit D-Bus signal for removal
3583
mandos_dbus_service.client_removed_signal(client)
2444
mandos_dbus_service.ClientRemoved(client
3584
2447
client_settings.clear()
3586
2449
atexit.register(cleanup)
3588
for client in tcp_server.clients.values():
2451
for client in tcp_server.clients.itervalues():
3590
# Emit D-Bus signal for adding
3591
mandos_dbus_service.client_added_signal(client)
2454
mandos_dbus_service.ClientAdded(client.dbus_object_path)
3592
2455
# Need to initiate checking of clients
3593
2456
if client.enabled:
3594
2457
client.init_checker()
3596
2459
tcp_server.enable()
3597
2460
tcp_server.server_activate()
3599
2462
# Find out what port we got
3601
service.port = tcp_server.socket.getsockname()[1]
2463
service.port = tcp_server.socket.getsockname()[1]
3603
2465
logger.info("Now listening on address %r, port %d,"
3604
" flowinfo %d, scope_id %d",
3605
*tcp_server.socket.getsockname())
2466
" flowinfo %d, scope_id %d"
2467
% tcp_server.socket.getsockname())
3607
logger.info("Now listening on address %r, port %d",
3608
*tcp_server.socket.getsockname())
3610
# service.interface = tcp_server.socket.getsockname()[3]
2469
logger.info("Now listening on address %r, port %d"
2470
% tcp_server.socket.getsockname())
2472
#service.interface = tcp_server.socket.getsockname()[3]
3614
# From the Avahi example code
3617
except dbus.exceptions.DBusException as error:
3618
logger.critical("D-Bus Exception", exc_info=error)
3621
# End of Avahi example code
3624
GLib.IOChannel.unix_new(tcp_server.fileno()),
3625
GLib.PRIORITY_DEFAULT, GLib.IO_IN,
3626
lambda *args, **kwargs: (tcp_server.handle_request
3627
(*args[2:], **kwargs) or True))
2475
# From the Avahi example code
2478
except dbus.exceptions.DBusException as error:
2479
logger.critical("DBusException: %s", error)
2482
# End of Avahi example code
2484
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2485
lambda *args, **kwargs:
2486
(tcp_server.handle_request
2487
(*args[2:], **kwargs) or True))
3629
2489
logger.debug("Starting main loop")
3630
2490
main_loop.run()
3631
2491
except AvahiError as error:
3632
logger.critical("Avahi Error", exc_info=error)
2492
logger.critical("AvahiError: %s", error)
3635
2495
except KeyboardInterrupt: